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 is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1213 /* Subroutine of pos_visible_p below. Extracts a display string, if
1214 any, from the display spec given as its argument. */
1216 string_from_display_spec (Lisp_Object spec
)
1220 while (CONSP (spec
))
1222 if (STRINGP (XCAR (spec
)))
1227 else if (VECTORP (spec
))
1231 for (i
= 0; i
< ASIZE (spec
); i
++)
1233 if (STRINGP (AREF (spec
, i
)))
1234 return AREF (spec
, i
);
1242 /* Return 1 if position CHARPOS is visible in window W.
1243 CHARPOS < 0 means return info about WINDOW_END position.
1244 If visible, set *X and *Y to pixel coordinates of top left corner.
1245 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1246 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1249 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1250 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1253 void *itdata
= bidi_shelve_cache ();
1254 struct text_pos top
;
1256 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->buffer
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1269 /* Compute exact mode line heights. */
1270 if (WINDOW_WANTS_MODELINE_P (w
))
1271 current_mode_line_height
1272 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1273 BVAR (current_buffer
, mode_line_format
));
1275 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1276 current_header_line_height
1277 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1278 BVAR (current_buffer
, header_line_format
));
1280 start_display (&it
, w
, top
);
1281 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1282 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1285 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1286 && IT_CHARPOS (it
) >= charpos
)
1287 /* When scanning backwards under bidi iteration, move_it_to
1288 stops at or _before_ CHARPOS, because it stops at or to
1289 the _right_ of the character at CHARPOS. */
1290 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1291 && IT_CHARPOS (it
) <= charpos
)))
1293 /* We have reached CHARPOS, or passed it. How the call to
1294 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1295 or covered by a display property, move_it_to stops at the end
1296 of the invisible text, to the right of CHARPOS. (ii) If
1297 CHARPOS is in a display vector, move_it_to stops on its last
1299 int top_x
= it
.current_x
;
1300 int top_y
= it
.current_y
;
1301 enum it_method it_method
= it
.method
;
1302 /* Calling line_bottom_y may change it.method, it.position, etc. */
1303 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1304 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1306 if (top_y
< window_top_y
)
1307 visible_p
= bottom_y
> window_top_y
;
1308 else if (top_y
< it
.last_visible_y
)
1312 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1314 /* We stopped on the last glyph of a display vector.
1315 Try and recompute. Hack alert! */
1316 if (charpos
< 2 || top
.charpos
>= charpos
)
1317 top_x
= it
.glyph_row
->x
;
1321 start_display (&it2
, w
, top
);
1322 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1323 get_next_display_element (&it2
);
1324 PRODUCE_GLYPHS (&it2
);
1325 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1326 || it2
.current_x
> it2
.last_visible_x
)
1327 top_x
= it
.glyph_row
->x
;
1330 top_x
= it2
.current_x
;
1331 top_y
= it2
.current_y
;
1335 else if (IT_CHARPOS (it
) != charpos
)
1337 Lisp_Object cpos
= make_number (charpos
);
1338 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1339 Lisp_Object string
= string_from_display_spec (spec
);
1340 int newline_in_string
= 0;
1342 if (STRINGP (string
))
1344 const char *s
= SSDATA (string
);
1345 const char *e
= s
+ SBYTES (string
);
1350 newline_in_string
= 1;
1355 /* The tricky code below is needed because there's a
1356 discrepancy between move_it_to and how we set cursor
1357 when the display line ends in a newline from a
1358 display string. move_it_to will stop _after_ such
1359 display strings, whereas set_cursor_from_row
1360 conspires with cursor_row_p to place the cursor on
1361 the first glyph produced from the display string. */
1363 /* We have overshoot PT because it is covered by a
1364 display property whose value is a string. If the
1365 string includes embedded newlines, we are also in the
1366 wrong display line. Backtrack to the correct line,
1367 where the display string begins. */
1368 if (newline_in_string
)
1370 Lisp_Object startpos
, endpos
;
1371 EMACS_INT start
, end
;
1374 /* Find the first and the last buffer positions
1375 covered by the display string. */
1377 Fnext_single_char_property_change (cpos
, Qdisplay
,
1380 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1382 start
= XFASTINT (startpos
);
1383 end
= XFASTINT (endpos
);
1384 /* Move to the last buffer position before the
1385 display property. */
1386 start_display (&it3
, w
, top
);
1387 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1388 /* Move forward one more line if the position before
1389 the display string is a newline or if it is the
1390 rightmost character on a line that is
1391 continued or word-wrapped. */
1392 if (it3
.method
== GET_FROM_BUFFER
1394 move_it_by_lines (&it3
, 1);
1395 else if (move_it_in_display_line_to (&it3
, -1,
1399 == MOVE_LINE_CONTINUED
)
1401 move_it_by_lines (&it3
, 1);
1402 /* When we are under word-wrap, the #$@%!
1403 move_it_by_lines moves 2 lines, so we need to
1405 if (it3
.line_wrap
== WORD_WRAP
)
1406 move_it_by_lines (&it3
, -1);
1409 /* Record the vertical coordinate of the display
1410 line where we wound up. */
1411 top_y
= it3
.current_y
;
1414 /* When characters are reordered for display,
1415 the character displayed to the left of the
1416 display string could be _after_ the display
1417 property in the logical order. Use the
1418 smallest vertical position of these two. */
1419 start_display (&it3
, w
, top
);
1420 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1421 if (it3
.current_y
< top_y
)
1422 top_y
= it3
.current_y
;
1424 /* Move from the top of the window to the beginning
1425 of the display line where the display string
1427 start_display (&it3
, w
, top
);
1428 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1429 /* Finally, advance the iterator until we hit the
1430 first display element whose character position is
1431 CHARPOS, or until the first newline from the
1432 display string, which signals the end of the
1434 while (get_next_display_element (&it3
))
1436 PRODUCE_GLYPHS (&it3
);
1437 if (IT_CHARPOS (it3
) == charpos
1438 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1440 set_iterator_to_next (&it3
, 0);
1442 top_x
= it3
.current_x
- it3
.pixel_width
;
1443 /* Normally, we would exit the above loop because we
1444 found the display element whose character
1445 position is CHARPOS. For the contingency that we
1446 didn't, and stopped at the first newline from the
1447 display string, move back over the glyphs
1448 produced from the string, until we find the
1449 rightmost glyph not from the string. */
1450 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1452 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1453 + it3
.glyph_row
->used
[TEXT_AREA
];
1455 while (EQ ((g
- 1)->object
, string
))
1458 top_x
-= g
->pixel_width
;
1460 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1461 + it3
.glyph_row
->used
[TEXT_AREA
]);
1467 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1468 *rtop
= max (0, window_top_y
- top_y
);
1469 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1470 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1471 - max (top_y
, window_top_y
)));
1477 /* We were asked to provide info about WINDOW_END. */
1479 void *it2data
= NULL
;
1481 SAVE_IT (it2
, it
, it2data
);
1482 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1483 move_it_by_lines (&it
, 1);
1484 if (charpos
< IT_CHARPOS (it
)
1485 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1488 RESTORE_IT (&it2
, &it2
, it2data
);
1489 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1491 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1492 *rtop
= max (0, -it2
.current_y
);
1493 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1494 - it
.last_visible_y
));
1495 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1497 - max (it2
.current_y
,
1498 WINDOW_HEADER_LINE_HEIGHT (w
))));
1502 bidi_unshelve_cache (it2data
, 1);
1504 bidi_unshelve_cache (itdata
, 0);
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR. Return in *LEN the length of
1528 the character. This is like STRING_CHAR_AND_LENGTH but never
1529 returns an invalid character. If we find one, we return a `?', but
1530 with the length of the invalid character. */
1533 string_char_and_length (const unsigned char *str
, int *len
)
1537 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1538 if (!CHAR_VALID_P (c
))
1539 /* We may not change the length here because other places in Emacs
1540 don't use this function, i.e. they silently accept invalid
1549 /* Given a position POS containing a valid character and byte position
1550 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1552 static struct text_pos
1553 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1555 xassert (STRINGP (string
) && nchars
>= 0);
1557 if (STRING_MULTIBYTE (string
))
1559 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1564 string_char_and_length (p
, &len
);
1567 BYTEPOS (pos
) += len
;
1571 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1577 /* Value is the text position, i.e. character and byte position,
1578 for character position CHARPOS in STRING. */
1580 static inline struct text_pos
1581 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1583 struct text_pos pos
;
1584 xassert (STRINGP (string
));
1585 xassert (charpos
>= 0);
1586 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1591 /* Value is a text position, i.e. character and byte position, for
1592 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1593 means recognize multibyte characters. */
1595 static struct text_pos
1596 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1598 struct text_pos pos
;
1600 xassert (s
!= NULL
);
1601 xassert (charpos
>= 0);
1607 SET_TEXT_POS (pos
, 0, 0);
1610 string_char_and_length ((const unsigned char *) s
, &len
);
1613 BYTEPOS (pos
) += len
;
1617 SET_TEXT_POS (pos
, charpos
, charpos
);
1623 /* Value is the number of characters in C string S. MULTIBYTE_P
1624 non-zero means recognize multibyte characters. */
1627 number_of_chars (const char *s
, int multibyte_p
)
1633 EMACS_INT rest
= strlen (s
);
1635 const unsigned char *p
= (const unsigned char *) s
;
1637 for (nchars
= 0; rest
> 0; ++nchars
)
1639 string_char_and_length (p
, &len
);
1640 rest
-= len
, p
+= len
;
1644 nchars
= strlen (s
);
1650 /* Compute byte position NEWPOS->bytepos corresponding to
1651 NEWPOS->charpos. POS is a known position in string STRING.
1652 NEWPOS->charpos must be >= POS.charpos. */
1655 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1657 xassert (STRINGP (string
));
1658 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1660 if (STRING_MULTIBYTE (string
))
1661 *newpos
= string_pos_nchars_ahead (pos
, string
,
1662 CHARPOS (*newpos
) - CHARPOS (pos
));
1664 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1668 Return an estimation of the pixel height of mode or header lines on
1669 frame F. FACE_ID specifies what line's height to estimate. */
1672 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1674 #ifdef HAVE_WINDOW_SYSTEM
1675 if (FRAME_WINDOW_P (f
))
1677 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1679 /* This function is called so early when Emacs starts that the face
1680 cache and mode line face are not yet initialized. */
1681 if (FRAME_FACE_CACHE (f
))
1683 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1687 height
= FONT_HEIGHT (face
->font
);
1688 if (face
->box_line_width
> 0)
1689 height
+= 2 * face
->box_line_width
;
1700 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1701 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1702 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1703 not force the value into range. */
1706 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1707 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1710 #ifdef HAVE_WINDOW_SYSTEM
1711 if (FRAME_WINDOW_P (f
))
1713 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1714 even for negative values. */
1716 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1718 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1720 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1721 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1724 STORE_NATIVE_RECT (*bounds
,
1725 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1726 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1727 FRAME_COLUMN_WIDTH (f
) - 1,
1728 FRAME_LINE_HEIGHT (f
) - 1);
1734 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1735 pix_x
= FRAME_TOTAL_COLS (f
);
1739 else if (pix_y
> FRAME_LINES (f
))
1740 pix_y
= FRAME_LINES (f
);
1750 /* Find the glyph under window-relative coordinates X/Y in window W.
1751 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1752 strings. Return in *HPOS and *VPOS the row and column number of
1753 the glyph found. Return in *AREA the glyph area containing X.
1754 Value is a pointer to the glyph found or null if X/Y is not on
1755 text, or we can't tell because W's current matrix is not up to
1760 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1761 int *dx
, int *dy
, int *area
)
1763 struct glyph
*glyph
, *end
;
1764 struct glyph_row
*row
= NULL
;
1767 /* Find row containing Y. Give up if some row is not enabled. */
1768 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1770 row
= MATRIX_ROW (w
->current_matrix
, i
);
1771 if (!row
->enabled_p
)
1773 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1780 /* Give up if Y is not in the window. */
1781 if (i
== w
->current_matrix
->nrows
)
1784 /* Get the glyph area containing X. */
1785 if (w
->pseudo_window_p
)
1792 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1794 *area
= LEFT_MARGIN_AREA
;
1795 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1797 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1800 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1804 *area
= RIGHT_MARGIN_AREA
;
1805 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1809 /* Find glyph containing X. */
1810 glyph
= row
->glyphs
[*area
];
1811 end
= glyph
+ row
->used
[*area
];
1813 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1815 x
-= glyph
->pixel_width
;
1825 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1828 *hpos
= glyph
- row
->glyphs
[*area
];
1832 /* Convert frame-relative x/y to coordinates relative to window W.
1833 Takes pseudo-windows into account. */
1836 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1838 if (w
->pseudo_window_p
)
1840 /* A pseudo-window is always full-width, and starts at the
1841 left edge of the frame, plus a frame border. */
1842 struct frame
*f
= XFRAME (w
->frame
);
1843 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1844 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1848 *x
-= WINDOW_LEFT_EDGE_X (w
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 #ifdef HAVE_WINDOW_SYSTEM
1856 Return in RECTS[] at most N clipping rectangles for glyph string S.
1857 Return the number of stored rectangles. */
1860 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1867 if (s
->row
->full_width_p
)
1869 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1870 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1871 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1873 /* Unless displaying a mode or menu bar line, which are always
1874 fully visible, clip to the visible part of the row. */
1875 if (s
->w
->pseudo_window_p
)
1876 r
.height
= s
->row
->visible_height
;
1878 r
.height
= s
->height
;
1882 /* This is a text line that may be partially visible. */
1883 r
.x
= window_box_left (s
->w
, s
->area
);
1884 r
.width
= window_box_width (s
->w
, s
->area
);
1885 r
.height
= s
->row
->visible_height
;
1889 if (r
.x
< s
->clip_head
->x
)
1891 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1892 r
.width
-= s
->clip_head
->x
- r
.x
;
1895 r
.x
= s
->clip_head
->x
;
1898 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1900 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1901 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1906 /* If S draws overlapping rows, it's sufficient to use the top and
1907 bottom of the window for clipping because this glyph string
1908 intentionally draws over other lines. */
1909 if (s
->for_overlaps
)
1911 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1912 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1914 /* Alas, the above simple strategy does not work for the
1915 environments with anti-aliased text: if the same text is
1916 drawn onto the same place multiple times, it gets thicker.
1917 If the overlap we are processing is for the erased cursor, we
1918 take the intersection with the rectangle of the cursor. */
1919 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1921 XRectangle rc
, r_save
= r
;
1923 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1924 rc
.y
= s
->w
->phys_cursor
.y
;
1925 rc
.width
= s
->w
->phys_cursor_width
;
1926 rc
.height
= s
->w
->phys_cursor_height
;
1928 x_intersect_rectangles (&r_save
, &rc
, &r
);
1933 /* Don't use S->y for clipping because it doesn't take partially
1934 visible lines into account. For example, it can be negative for
1935 partially visible lines at the top of a window. */
1936 if (!s
->row
->full_width_p
1937 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1938 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1940 r
.y
= max (0, s
->row
->y
);
1943 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1945 /* If drawing the cursor, don't let glyph draw outside its
1946 advertised boundaries. Cleartype does this under some circumstances. */
1947 if (s
->hl
== DRAW_CURSOR
)
1949 struct glyph
*glyph
= s
->first_glyph
;
1954 r
.width
-= s
->x
- r
.x
;
1957 r
.width
= min (r
.width
, glyph
->pixel_width
);
1959 /* If r.y is below window bottom, ensure that we still see a cursor. */
1960 height
= min (glyph
->ascent
+ glyph
->descent
,
1961 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1962 max_y
= window_text_bottom_y (s
->w
) - height
;
1963 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1964 if (s
->ybase
- glyph
->ascent
> max_y
)
1971 /* Don't draw cursor glyph taller than our actual glyph. */
1972 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1973 if (height
< r
.height
)
1975 max_y
= r
.y
+ r
.height
;
1976 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1977 r
.height
= min (max_y
- r
.y
, height
);
1984 XRectangle r_save
= r
;
1986 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1990 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1991 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1993 #ifdef CONVERT_FROM_XRECT
1994 CONVERT_FROM_XRECT (r
, *rects
);
2002 /* If we are processing overlapping and allowed to return
2003 multiple clipping rectangles, we exclude the row of the glyph
2004 string from the clipping rectangle. This is to avoid drawing
2005 the same text on the environment with anti-aliasing. */
2006 #ifdef CONVERT_FROM_XRECT
2009 XRectangle
*rs
= rects
;
2011 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2013 if (s
->for_overlaps
& OVERLAPS_PRED
)
2016 if (r
.y
+ r
.height
> row_y
)
2019 rs
[i
].height
= row_y
- r
.y
;
2025 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2028 if (r
.y
< row_y
+ s
->row
->visible_height
)
2030 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2032 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2033 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2042 #ifdef CONVERT_FROM_XRECT
2043 for (i
= 0; i
< n
; i
++)
2044 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2051 Return in *NR the clipping rectangle for glyph string S. */
2054 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2056 get_glyph_string_clip_rects (s
, nr
, 1);
2061 Return the position and height of the phys cursor in window W.
2062 Set w->phys_cursor_width to width of phys cursor.
2066 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2067 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2070 int x
, y
, wd
, h
, h0
, y0
;
2072 /* Compute the width of the rectangle to draw. If on a stretch
2073 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2074 rectangle as wide as the glyph, but use a canonical character
2076 wd
= glyph
->pixel_width
- 1;
2077 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2081 x
= w
->phys_cursor
.x
;
2088 if (glyph
->type
== STRETCH_GLYPH
2089 && !x_stretch_cursor_p
)
2090 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2091 w
->phys_cursor_width
= wd
;
2093 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2095 /* If y is below window bottom, ensure that we still see a cursor. */
2096 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2098 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2099 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2101 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2104 h
= max (h
- (y0
- y
) + 1, h0
);
2109 y0
= window_text_bottom_y (w
) - h0
;
2117 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2118 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2123 * Remember which glyph the mouse is over.
2127 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2131 struct glyph_row
*r
, *gr
, *end_row
;
2132 enum window_part part
;
2133 enum glyph_row_area area
;
2134 int x
, y
, width
, height
;
2136 /* Try to determine frame pixel position and size of the glyph under
2137 frame pixel coordinates X/Y on frame F. */
2139 if (!f
->glyphs_initialized_p
2140 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2143 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2144 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2148 w
= XWINDOW (window
);
2149 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2150 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2152 x
= window_relative_x_coord (w
, part
, gx
);
2153 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2155 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2156 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2158 if (w
->pseudo_window_p
)
2161 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2167 case ON_LEFT_MARGIN
:
2168 area
= LEFT_MARGIN_AREA
;
2171 case ON_RIGHT_MARGIN
:
2172 area
= RIGHT_MARGIN_AREA
;
2175 case ON_HEADER_LINE
:
2177 gr
= (part
== ON_HEADER_LINE
2178 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2179 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2182 goto text_glyph_row_found
;
2189 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2190 if (r
->y
+ r
->height
> y
)
2196 text_glyph_row_found
:
2199 struct glyph
*g
= gr
->glyphs
[area
];
2200 struct glyph
*end
= g
+ gr
->used
[area
];
2202 height
= gr
->height
;
2203 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2204 if (gx
+ g
->pixel_width
> x
)
2209 if (g
->type
== IMAGE_GLYPH
)
2211 /* Don't remember when mouse is over image, as
2212 image may have hot-spots. */
2213 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2216 width
= g
->pixel_width
;
2220 /* Use nominal char spacing at end of line. */
2222 gx
+= (x
/ width
) * width
;
2225 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2226 gx
+= window_box_left_offset (w
, area
);
2230 /* Use nominal line height at end of window. */
2231 gx
= (x
/ width
) * width
;
2233 gy
+= (y
/ height
) * height
;
2237 case ON_LEFT_FRINGE
:
2238 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2239 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2240 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2241 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2244 case ON_RIGHT_FRINGE
:
2245 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2246 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2247 : window_box_right_offset (w
, TEXT_AREA
));
2248 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2252 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2254 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2255 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2256 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2258 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2262 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2263 if (r
->y
+ r
->height
> y
)
2270 height
= gr
->height
;
2273 /* Use nominal line height at end of window. */
2275 gy
+= (y
/ height
) * height
;
2282 /* If there is no glyph under the mouse, then we divide the screen
2283 into a grid of the smallest glyph in the frame, and use that
2286 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2287 round down even for negative values. */
2293 gx
= (gx
/ width
) * width
;
2294 gy
= (gy
/ height
) * height
;
2299 gx
+= WINDOW_LEFT_EDGE_X (w
);
2300 gy
+= WINDOW_TOP_EDGE_Y (w
);
2303 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2305 /* Visible feedback for debugging. */
2308 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2309 f
->output_data
.x
->normal_gc
,
2310 gx
, gy
, width
, height
);
2316 #endif /* HAVE_WINDOW_SYSTEM */
2319 /***********************************************************************
2320 Lisp form evaluation
2321 ***********************************************************************/
2323 /* Error handler for safe_eval and safe_call. */
2326 safe_eval_handler (Lisp_Object arg
)
2328 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2333 /* Evaluate SEXPR and return the result, or nil if something went
2334 wrong. Prevent redisplay during the evaluation. */
2336 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2337 Return the result, or nil if something went wrong. Prevent
2338 redisplay during the evaluation. */
2341 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2345 if (inhibit_eval_during_redisplay
)
2349 int count
= SPECPDL_INDEX ();
2350 struct gcpro gcpro1
;
2353 gcpro1
.nvars
= nargs
;
2354 specbind (Qinhibit_redisplay
, Qt
);
2355 /* Use Qt to ensure debugger does not run,
2356 so there is no possibility of wanting to redisplay. */
2357 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2360 val
= unbind_to (count
, val
);
2367 /* Call function FN with one argument ARG.
2368 Return the result, or nil if something went wrong. */
2371 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2373 Lisp_Object args
[2];
2376 return safe_call (2, args
);
2379 static Lisp_Object Qeval
;
2382 safe_eval (Lisp_Object sexpr
)
2384 return safe_call1 (Qeval
, sexpr
);
2387 /* Call function FN with one argument ARG.
2388 Return the result, or nil if something went wrong. */
2391 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2393 Lisp_Object args
[3];
2397 return safe_call (3, args
);
2402 /***********************************************************************
2404 ***********************************************************************/
2408 /* Define CHECK_IT to perform sanity checks on iterators.
2409 This is for debugging. It is too slow to do unconditionally. */
2412 check_it (struct it
*it
)
2414 if (it
->method
== GET_FROM_STRING
)
2416 xassert (STRINGP (it
->string
));
2417 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2421 xassert (IT_STRING_CHARPOS (*it
) < 0);
2422 if (it
->method
== GET_FROM_BUFFER
)
2424 /* Check that character and byte positions agree. */
2425 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2430 xassert (it
->current
.dpvec_index
>= 0);
2432 xassert (it
->current
.dpvec_index
< 0);
2435 #define CHECK_IT(IT) check_it ((IT))
2439 #define CHECK_IT(IT) (void) 0
2444 #if GLYPH_DEBUG && XASSERTS
2446 /* Check that the window end of window W is what we expect it
2447 to be---the last row in the current matrix displaying text. */
2450 check_window_end (struct window
*w
)
2452 if (!MINI_WINDOW_P (w
)
2453 && !NILP (w
->window_end_valid
))
2455 struct glyph_row
*row
;
2456 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2457 XFASTINT (w
->window_end_vpos
)),
2459 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2460 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2464 #define CHECK_WINDOW_END(W) check_window_end ((W))
2468 #define CHECK_WINDOW_END(W) (void) 0
2474 /***********************************************************************
2475 Iterator initialization
2476 ***********************************************************************/
2478 /* Initialize IT for displaying current_buffer in window W, starting
2479 at character position CHARPOS. CHARPOS < 0 means that no buffer
2480 position is specified which is useful when the iterator is assigned
2481 a position later. BYTEPOS is the byte position corresponding to
2482 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2484 If ROW is not null, calls to produce_glyphs with IT as parameter
2485 will produce glyphs in that row.
2487 BASE_FACE_ID is the id of a base face to use. It must be one of
2488 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2489 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2490 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2492 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2493 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2494 will be initialized to use the corresponding mode line glyph row of
2495 the desired matrix of W. */
2498 init_iterator (struct it
*it
, struct window
*w
,
2499 EMACS_INT charpos
, EMACS_INT bytepos
,
2500 struct glyph_row
*row
, enum face_id base_face_id
)
2502 int highlight_region_p
;
2503 enum face_id remapped_base_face_id
= base_face_id
;
2505 /* Some precondition checks. */
2506 xassert (w
!= NULL
&& it
!= NULL
);
2507 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2510 /* If face attributes have been changed since the last redisplay,
2511 free realized faces now because they depend on face definitions
2512 that might have changed. Don't free faces while there might be
2513 desired matrices pending which reference these faces. */
2514 if (face_change_count
&& !inhibit_free_realized_faces
)
2516 face_change_count
= 0;
2517 free_all_realized_faces (Qnil
);
2520 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2521 if (! NILP (Vface_remapping_alist
))
2522 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2524 /* Use one of the mode line rows of W's desired matrix if
2528 if (base_face_id
== MODE_LINE_FACE_ID
2529 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2530 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2531 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2532 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2536 memset (it
, 0, sizeof *it
);
2537 it
->current
.overlay_string_index
= -1;
2538 it
->current
.dpvec_index
= -1;
2539 it
->base_face_id
= remapped_base_face_id
;
2541 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2542 it
->paragraph_embedding
= L2R
;
2543 it
->bidi_it
.string
.lstring
= Qnil
;
2544 it
->bidi_it
.string
.s
= NULL
;
2545 it
->bidi_it
.string
.bufpos
= 0;
2547 /* The window in which we iterate over current_buffer: */
2548 XSETWINDOW (it
->window
, w
);
2550 it
->f
= XFRAME (w
->frame
);
2554 /* Extra space between lines (on window systems only). */
2555 if (base_face_id
== DEFAULT_FACE_ID
2556 && FRAME_WINDOW_P (it
->f
))
2558 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2559 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2560 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2561 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2562 * FRAME_LINE_HEIGHT (it
->f
));
2563 else if (it
->f
->extra_line_spacing
> 0)
2564 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2565 it
->max_extra_line_spacing
= 0;
2568 /* If realized faces have been removed, e.g. because of face
2569 attribute changes of named faces, recompute them. When running
2570 in batch mode, the face cache of the initial frame is null. If
2571 we happen to get called, make a dummy face cache. */
2572 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2573 init_frame_faces (it
->f
);
2574 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2575 recompute_basic_faces (it
->f
);
2577 /* Current value of the `slice', `space-width', and 'height' properties. */
2578 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2579 it
->space_width
= Qnil
;
2580 it
->font_height
= Qnil
;
2581 it
->override_ascent
= -1;
2583 /* Are control characters displayed as `^C'? */
2584 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2586 /* -1 means everything between a CR and the following line end
2587 is invisible. >0 means lines indented more than this value are
2589 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2590 ? XINT (BVAR (current_buffer
, selective_display
))
2591 : (!NILP (BVAR (current_buffer
, selective_display
))
2593 it
->selective_display_ellipsis_p
2594 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2596 /* Display table to use. */
2597 it
->dp
= window_display_table (w
);
2599 /* Are multibyte characters enabled in current_buffer? */
2600 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2602 /* Non-zero if we should highlight the region. */
2604 = (!NILP (Vtransient_mark_mode
)
2605 && !NILP (BVAR (current_buffer
, mark_active
))
2606 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2608 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2609 start and end of a visible region in window IT->w. Set both to
2610 -1 to indicate no region. */
2611 if (highlight_region_p
2612 /* Maybe highlight only in selected window. */
2613 && (/* Either show region everywhere. */
2614 highlight_nonselected_windows
2615 /* Or show region in the selected window. */
2616 || w
== XWINDOW (selected_window
)
2617 /* Or show the region if we are in the mini-buffer and W is
2618 the window the mini-buffer refers to. */
2619 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2620 && WINDOWP (minibuf_selected_window
)
2621 && w
== XWINDOW (minibuf_selected_window
))))
2623 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2624 it
->region_beg_charpos
= min (PT
, markpos
);
2625 it
->region_end_charpos
= max (PT
, markpos
);
2628 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2630 /* Get the position at which the redisplay_end_trigger hook should
2631 be run, if it is to be run at all. */
2632 if (MARKERP (w
->redisplay_end_trigger
)
2633 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2634 it
->redisplay_end_trigger_charpos
2635 = marker_position (w
->redisplay_end_trigger
);
2636 else if (INTEGERP (w
->redisplay_end_trigger
))
2637 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2639 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2641 /* Are lines in the display truncated? */
2642 if (base_face_id
!= DEFAULT_FACE_ID
2643 || XINT (it
->w
->hscroll
)
2644 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2645 && ((!NILP (Vtruncate_partial_width_windows
)
2646 && !INTEGERP (Vtruncate_partial_width_windows
))
2647 || (INTEGERP (Vtruncate_partial_width_windows
)
2648 && (WINDOW_TOTAL_COLS (it
->w
)
2649 < XINT (Vtruncate_partial_width_windows
))))))
2650 it
->line_wrap
= TRUNCATE
;
2651 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2652 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2653 ? WINDOW_WRAP
: WORD_WRAP
;
2655 it
->line_wrap
= TRUNCATE
;
2657 /* Get dimensions of truncation and continuation glyphs. These are
2658 displayed as fringe bitmaps under X, so we don't need them for such
2660 if (!FRAME_WINDOW_P (it
->f
))
2662 if (it
->line_wrap
== TRUNCATE
)
2664 /* We will need the truncation glyph. */
2665 xassert (it
->glyph_row
== NULL
);
2666 produce_special_glyphs (it
, IT_TRUNCATION
);
2667 it
->truncation_pixel_width
= it
->pixel_width
;
2671 /* We will need the continuation glyph. */
2672 xassert (it
->glyph_row
== NULL
);
2673 produce_special_glyphs (it
, IT_CONTINUATION
);
2674 it
->continuation_pixel_width
= it
->pixel_width
;
2677 /* Reset these values to zero because the produce_special_glyphs
2678 above has changed them. */
2679 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2680 it
->phys_ascent
= it
->phys_descent
= 0;
2683 /* Set this after getting the dimensions of truncation and
2684 continuation glyphs, so that we don't produce glyphs when calling
2685 produce_special_glyphs, above. */
2686 it
->glyph_row
= row
;
2687 it
->area
= TEXT_AREA
;
2689 /* Forget any previous info about this row being reversed. */
2691 it
->glyph_row
->reversed_p
= 0;
2693 /* Get the dimensions of the display area. The display area
2694 consists of the visible window area plus a horizontally scrolled
2695 part to the left of the window. All x-values are relative to the
2696 start of this total display area. */
2697 if (base_face_id
!= DEFAULT_FACE_ID
)
2699 /* Mode lines, menu bar in terminal frames. */
2700 it
->first_visible_x
= 0;
2701 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2706 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2707 it
->last_visible_x
= (it
->first_visible_x
2708 + window_box_width (w
, TEXT_AREA
));
2710 /* If we truncate lines, leave room for the truncator glyph(s) at
2711 the right margin. Otherwise, leave room for the continuation
2712 glyph(s). Truncation and continuation glyphs are not inserted
2713 for window-based redisplay. */
2714 if (!FRAME_WINDOW_P (it
->f
))
2716 if (it
->line_wrap
== TRUNCATE
)
2717 it
->last_visible_x
-= it
->truncation_pixel_width
;
2719 it
->last_visible_x
-= it
->continuation_pixel_width
;
2722 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2723 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2726 /* Leave room for a border glyph. */
2727 if (!FRAME_WINDOW_P (it
->f
)
2728 && !WINDOW_RIGHTMOST_P (it
->w
))
2729 it
->last_visible_x
-= 1;
2731 it
->last_visible_y
= window_text_bottom_y (w
);
2733 /* For mode lines and alike, arrange for the first glyph having a
2734 left box line if the face specifies a box. */
2735 if (base_face_id
!= DEFAULT_FACE_ID
)
2739 it
->face_id
= remapped_base_face_id
;
2741 /* If we have a boxed mode line, make the first character appear
2742 with a left box line. */
2743 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2744 if (face
->box
!= FACE_NO_BOX
)
2745 it
->start_of_box_run_p
= 1;
2748 /* If a buffer position was specified, set the iterator there,
2749 getting overlays and face properties from that position. */
2750 if (charpos
>= BUF_BEG (current_buffer
))
2752 it
->end_charpos
= ZV
;
2753 IT_CHARPOS (*it
) = charpos
;
2755 /* We will rely on `reseat' to set this up properly, via
2756 handle_face_prop. */
2757 it
->face_id
= it
->base_face_id
;
2759 /* Compute byte position if not specified. */
2760 if (bytepos
< charpos
)
2761 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2763 IT_BYTEPOS (*it
) = bytepos
;
2765 it
->start
= it
->current
;
2766 /* Do we need to reorder bidirectional text? Not if this is a
2767 unibyte buffer: by definition, none of the single-byte
2768 characters are strong R2L, so no reordering is needed. And
2769 bidi.c doesn't support unibyte buffers anyway. Also, don't
2770 reorder while we are loading loadup.el, since the tables of
2771 character properties needed for reordering are not yet
2775 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2778 /* If we are to reorder bidirectional text, init the bidi
2782 /* Note the paragraph direction that this buffer wants to
2784 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2786 it
->paragraph_embedding
= L2R
;
2787 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2789 it
->paragraph_embedding
= R2L
;
2791 it
->paragraph_embedding
= NEUTRAL_DIR
;
2792 bidi_unshelve_cache (NULL
, 0);
2793 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2797 /* Compute faces etc. */
2798 reseat (it
, it
->current
.pos
, 1);
2805 /* Initialize IT for the display of window W with window start POS. */
2808 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2810 struct glyph_row
*row
;
2811 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2813 row
= w
->desired_matrix
->rows
+ first_vpos
;
2814 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2815 it
->first_vpos
= first_vpos
;
2817 /* Don't reseat to previous visible line start if current start
2818 position is in a string or image. */
2819 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2821 int start_at_line_beg_p
;
2822 int first_y
= it
->current_y
;
2824 /* If window start is not at a line start, skip forward to POS to
2825 get the correct continuation lines width. */
2826 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2827 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2828 if (!start_at_line_beg_p
)
2832 reseat_at_previous_visible_line_start (it
);
2833 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2835 new_x
= it
->current_x
+ it
->pixel_width
;
2837 /* If lines are continued, this line may end in the middle
2838 of a multi-glyph character (e.g. a control character
2839 displayed as \003, or in the middle of an overlay
2840 string). In this case move_it_to above will not have
2841 taken us to the start of the continuation line but to the
2842 end of the continued line. */
2843 if (it
->current_x
> 0
2844 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2845 && (/* And glyph doesn't fit on the line. */
2846 new_x
> it
->last_visible_x
2847 /* Or it fits exactly and we're on a window
2849 || (new_x
== it
->last_visible_x
2850 && FRAME_WINDOW_P (it
->f
))))
2852 if ((it
->current
.dpvec_index
>= 0
2853 || it
->current
.overlay_string_index
>= 0)
2854 /* If we are on a newline from a display vector or
2855 overlay string, then we are already at the end of
2856 a screen line; no need to go to the next line in
2857 that case, as this line is not really continued.
2858 (If we do go to the next line, C-e will not DTRT.) */
2861 set_iterator_to_next (it
, 1);
2862 move_it_in_display_line_to (it
, -1, -1, 0);
2865 it
->continuation_lines_width
+= it
->current_x
;
2867 /* If the character at POS is displayed via a display
2868 vector, move_it_to above stops at the final glyph of
2869 IT->dpvec. To make the caller redisplay that character
2870 again (a.k.a. start at POS), we need to reset the
2871 dpvec_index to the beginning of IT->dpvec. */
2872 else if (it
->current
.dpvec_index
>= 0)
2873 it
->current
.dpvec_index
= 0;
2875 /* We're starting a new display line, not affected by the
2876 height of the continued line, so clear the appropriate
2877 fields in the iterator structure. */
2878 it
->max_ascent
= it
->max_descent
= 0;
2879 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2881 it
->current_y
= first_y
;
2883 it
->current_x
= it
->hpos
= 0;
2889 /* Return 1 if POS is a position in ellipses displayed for invisible
2890 text. W is the window we display, for text property lookup. */
2893 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2895 Lisp_Object prop
, window
;
2897 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2899 /* If POS specifies a position in a display vector, this might
2900 be for an ellipsis displayed for invisible text. We won't
2901 get the iterator set up for delivering that ellipsis unless
2902 we make sure that it gets aware of the invisible text. */
2903 if (pos
->dpvec_index
>= 0
2904 && pos
->overlay_string_index
< 0
2905 && CHARPOS (pos
->string_pos
) < 0
2907 && (XSETWINDOW (window
, w
),
2908 prop
= Fget_char_property (make_number (charpos
),
2909 Qinvisible
, window
),
2910 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2912 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2914 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2921 /* Initialize IT for stepping through current_buffer in window W,
2922 starting at position POS that includes overlay string and display
2923 vector/ control character translation position information. Value
2924 is zero if there are overlay strings with newlines at POS. */
2927 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2929 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2930 int i
, overlay_strings_with_newlines
= 0;
2932 /* If POS specifies a position in a display vector, this might
2933 be for an ellipsis displayed for invisible text. We won't
2934 get the iterator set up for delivering that ellipsis unless
2935 we make sure that it gets aware of the invisible text. */
2936 if (in_ellipses_for_invisible_text_p (pos
, w
))
2942 /* Keep in mind: the call to reseat in init_iterator skips invisible
2943 text, so we might end up at a position different from POS. This
2944 is only a problem when POS is a row start after a newline and an
2945 overlay starts there with an after-string, and the overlay has an
2946 invisible property. Since we don't skip invisible text in
2947 display_line and elsewhere immediately after consuming the
2948 newline before the row start, such a POS will not be in a string,
2949 but the call to init_iterator below will move us to the
2951 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2953 /* This only scans the current chunk -- it should scan all chunks.
2954 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2955 to 16 in 22.1 to make this a lesser problem. */
2956 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2958 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2959 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2961 while (s
< e
&& *s
!= '\n')
2966 overlay_strings_with_newlines
= 1;
2971 /* If position is within an overlay string, set up IT to the right
2973 if (pos
->overlay_string_index
>= 0)
2977 /* If the first overlay string happens to have a `display'
2978 property for an image, the iterator will be set up for that
2979 image, and we have to undo that setup first before we can
2980 correct the overlay string index. */
2981 if (it
->method
== GET_FROM_IMAGE
)
2984 /* We already have the first chunk of overlay strings in
2985 IT->overlay_strings. Load more until the one for
2986 pos->overlay_string_index is in IT->overlay_strings. */
2987 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2989 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2990 it
->current
.overlay_string_index
= 0;
2993 load_overlay_strings (it
, 0);
2994 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2998 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2999 relative_index
= (it
->current
.overlay_string_index
3000 % OVERLAY_STRING_CHUNK_SIZE
);
3001 it
->string
= it
->overlay_strings
[relative_index
];
3002 xassert (STRINGP (it
->string
));
3003 it
->current
.string_pos
= pos
->string_pos
;
3004 it
->method
= GET_FROM_STRING
;
3007 if (CHARPOS (pos
->string_pos
) >= 0)
3009 /* Recorded position is not in an overlay string, but in another
3010 string. This can only be a string from a `display' property.
3011 IT should already be filled with that string. */
3012 it
->current
.string_pos
= pos
->string_pos
;
3013 xassert (STRINGP (it
->string
));
3016 /* Restore position in display vector translations, control
3017 character translations or ellipses. */
3018 if (pos
->dpvec_index
>= 0)
3020 if (it
->dpvec
== NULL
)
3021 get_next_display_element (it
);
3022 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3023 it
->current
.dpvec_index
= pos
->dpvec_index
;
3027 return !overlay_strings_with_newlines
;
3031 /* Initialize IT for stepping through current_buffer in window W
3032 starting at ROW->start. */
3035 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3037 init_from_display_pos (it
, w
, &row
->start
);
3038 it
->start
= row
->start
;
3039 it
->continuation_lines_width
= row
->continuation_lines_width
;
3044 /* Initialize IT for stepping through current_buffer in window W
3045 starting in the line following ROW, i.e. starting at ROW->end.
3046 Value is zero if there are overlay strings with newlines at ROW's
3050 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3054 if (init_from_display_pos (it
, w
, &row
->end
))
3056 if (row
->continued_p
)
3057 it
->continuation_lines_width
3058 = row
->continuation_lines_width
+ row
->pixel_width
;
3069 /***********************************************************************
3071 ***********************************************************************/
3073 /* Called when IT reaches IT->stop_charpos. Handle text property and
3074 overlay changes. Set IT->stop_charpos to the next position where
3078 handle_stop (struct it
*it
)
3080 enum prop_handled handled
;
3081 int handle_overlay_change_p
;
3085 it
->current
.dpvec_index
= -1;
3086 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3087 it
->ignore_overlay_strings_at_pos_p
= 0;
3090 /* Use face of preceding text for ellipsis (if invisible) */
3091 if (it
->selective_display_ellipsis_p
)
3092 it
->saved_face_id
= it
->face_id
;
3096 handled
= HANDLED_NORMALLY
;
3098 /* Call text property handlers. */
3099 for (p
= it_props
; p
->handler
; ++p
)
3101 handled
= p
->handler (it
);
3103 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3105 else if (handled
== HANDLED_RETURN
)
3107 /* We still want to show before and after strings from
3108 overlays even if the actual buffer text is replaced. */
3109 if (!handle_overlay_change_p
3111 || !get_overlay_strings_1 (it
, 0, 0))
3114 setup_for_ellipsis (it
, 0);
3115 /* When handling a display spec, we might load an
3116 empty string. In that case, discard it here. We
3117 used to discard it in handle_single_display_spec,
3118 but that causes get_overlay_strings_1, above, to
3119 ignore overlay strings that we must check. */
3120 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3124 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3128 it
->ignore_overlay_strings_at_pos_p
= 1;
3129 it
->string_from_display_prop_p
= 0;
3130 it
->from_disp_prop_p
= 0;
3131 handle_overlay_change_p
= 0;
3133 handled
= HANDLED_RECOMPUTE_PROPS
;
3136 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3137 handle_overlay_change_p
= 0;
3140 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3142 /* Don't check for overlay strings below when set to deliver
3143 characters from a display vector. */
3144 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3145 handle_overlay_change_p
= 0;
3147 /* Handle overlay changes.
3148 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3149 if it finds overlays. */
3150 if (handle_overlay_change_p
)
3151 handled
= handle_overlay_change (it
);
3156 setup_for_ellipsis (it
, 0);
3160 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3162 /* Determine where to stop next. */
3163 if (handled
== HANDLED_NORMALLY
)
3164 compute_stop_pos (it
);
3168 /* Compute IT->stop_charpos from text property and overlay change
3169 information for IT's current position. */
3172 compute_stop_pos (struct it
*it
)
3174 register INTERVAL iv
, next_iv
;
3175 Lisp_Object object
, limit
, position
;
3176 EMACS_INT charpos
, bytepos
;
3178 if (STRINGP (it
->string
))
3180 /* Strings are usually short, so don't limit the search for
3182 it
->stop_charpos
= it
->end_charpos
;
3183 object
= it
->string
;
3185 charpos
= IT_STRING_CHARPOS (*it
);
3186 bytepos
= IT_STRING_BYTEPOS (*it
);
3192 /* If end_charpos is out of range for some reason, such as a
3193 misbehaving display function, rationalize it (Bug#5984). */
3194 if (it
->end_charpos
> ZV
)
3195 it
->end_charpos
= ZV
;
3196 it
->stop_charpos
= it
->end_charpos
;
3198 /* If next overlay change is in front of the current stop pos
3199 (which is IT->end_charpos), stop there. Note: value of
3200 next_overlay_change is point-max if no overlay change
3202 charpos
= IT_CHARPOS (*it
);
3203 bytepos
= IT_BYTEPOS (*it
);
3204 pos
= next_overlay_change (charpos
);
3205 if (pos
< it
->stop_charpos
)
3206 it
->stop_charpos
= pos
;
3208 /* If showing the region, we have to stop at the region
3209 start or end because the face might change there. */
3210 if (it
->region_beg_charpos
> 0)
3212 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3213 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3214 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3215 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3218 /* Set up variables for computing the stop position from text
3219 property changes. */
3220 XSETBUFFER (object
, current_buffer
);
3221 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3224 /* Get the interval containing IT's position. Value is a null
3225 interval if there isn't such an interval. */
3226 position
= make_number (charpos
);
3227 iv
= validate_interval_range (object
, &position
, &position
, 0);
3228 if (!NULL_INTERVAL_P (iv
))
3230 Lisp_Object values_here
[LAST_PROP_IDX
];
3233 /* Get properties here. */
3234 for (p
= it_props
; p
->handler
; ++p
)
3235 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3237 /* Look for an interval following iv that has different
3239 for (next_iv
= next_interval (iv
);
3240 (!NULL_INTERVAL_P (next_iv
)
3242 || XFASTINT (limit
) > next_iv
->position
));
3243 next_iv
= next_interval (next_iv
))
3245 for (p
= it_props
; p
->handler
; ++p
)
3247 Lisp_Object new_value
;
3249 new_value
= textget (next_iv
->plist
, *p
->name
);
3250 if (!EQ (values_here
[p
->idx
], new_value
))
3258 if (!NULL_INTERVAL_P (next_iv
))
3260 if (INTEGERP (limit
)
3261 && next_iv
->position
>= XFASTINT (limit
))
3262 /* No text property change up to limit. */
3263 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3265 /* Text properties change in next_iv. */
3266 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3270 if (it
->cmp_it
.id
< 0)
3272 EMACS_INT stoppos
= it
->end_charpos
;
3274 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3276 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3277 stoppos
, it
->string
);
3280 xassert (STRINGP (it
->string
)
3281 || (it
->stop_charpos
>= BEGV
3282 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3286 /* Return the position of the next overlay change after POS in
3287 current_buffer. Value is point-max if no overlay change
3288 follows. This is like `next-overlay-change' but doesn't use
3292 next_overlay_change (EMACS_INT pos
)
3294 ptrdiff_t i
, noverlays
;
3296 Lisp_Object
*overlays
;
3298 /* Get all overlays at the given position. */
3299 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3301 /* If any of these overlays ends before endpos,
3302 use its ending point instead. */
3303 for (i
= 0; i
< noverlays
; ++i
)
3308 oend
= OVERLAY_END (overlays
[i
]);
3309 oendpos
= OVERLAY_POSITION (oend
);
3310 endpos
= min (endpos
, oendpos
);
3316 /* How many characters forward to search for a display property or
3317 display string. Searching too far forward makes the bidi display
3318 sluggish, especially in small windows. */
3319 #define MAX_DISP_SCAN 250
3321 /* Return the character position of a display string at or after
3322 position specified by POSITION. If no display string exists at or
3323 after POSITION, return ZV. A display string is either an overlay
3324 with `display' property whose value is a string, or a `display'
3325 text property whose value is a string. STRING is data about the
3326 string to iterate; if STRING->lstring is nil, we are iterating a
3327 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3328 on a GUI frame. DISP_PROP is set to zero if we searched
3329 MAX_DISP_SCAN characters forward without finding any display
3330 strings, non-zero otherwise. It is set to 2 if the display string
3331 uses any kind of `(space ...)' spec that will produce a stretch of
3332 white space in the text area. */
3334 compute_display_string_pos (struct text_pos
*position
,
3335 struct bidi_string_data
*string
,
3336 int frame_window_p
, int *disp_prop
)
3338 /* OBJECT = nil means current buffer. */
3339 Lisp_Object object
=
3340 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3341 Lisp_Object pos
, spec
, limpos
;
3342 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3343 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3344 EMACS_INT begb
= string_p
? 0 : BEGV
;
3345 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3347 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3348 struct text_pos tpos
;
3354 /* We don't support display properties whose values are strings
3355 that have display string properties. */
3356 || string
->from_disp_str
3357 /* C strings cannot have display properties. */
3358 || (string
->s
&& !STRINGP (object
)))
3364 /* If the character at CHARPOS is where the display string begins,
3366 pos
= make_number (charpos
);
3367 if (STRINGP (object
))
3368 bufpos
= string
->bufpos
;
3372 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3374 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3377 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3385 /* Look forward for the first character with a `display' property
3386 that will replace the underlying text when displayed. */
3387 limpos
= make_number (lim
);
3389 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3390 CHARPOS (tpos
) = XFASTINT (pos
);
3391 if (CHARPOS (tpos
) >= lim
)
3396 if (STRINGP (object
))
3397 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3399 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3400 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3401 if (!STRINGP (object
))
3402 bufpos
= CHARPOS (tpos
);
3403 } while (NILP (spec
)
3404 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3405 bufpos
, frame_window_p
)));
3409 return CHARPOS (tpos
);
3412 /* Return the character position of the end of the display string that
3413 started at CHARPOS. If there's no display string at CHARPOS,
3414 return -1. A display string is either an overlay with `display'
3415 property whose value is a string or a `display' text property whose
3416 value is a string. */
3418 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3420 /* OBJECT = nil means current buffer. */
3421 Lisp_Object object
=
3422 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3423 Lisp_Object pos
= make_number (charpos
);
3425 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3427 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3430 /* It could happen that the display property or overlay was removed
3431 since we found it in compute_display_string_pos above. One way
3432 this can happen is if JIT font-lock was called (through
3433 handle_fontified_prop), and jit-lock-functions remove text
3434 properties or overlays from the portion of buffer that includes
3435 CHARPOS. Muse mode is known to do that, for example. In this
3436 case, we return -1 to the caller, to signal that no display
3437 string is actually present at CHARPOS. See bidi_fetch_char for
3438 how this is handled.
3440 An alternative would be to never look for display properties past
3441 it->stop_charpos. But neither compute_display_string_pos nor
3442 bidi_fetch_char that calls it know or care where the next
3444 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3447 /* Look forward for the first character where the `display' property
3449 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3451 return XFASTINT (pos
);
3456 /***********************************************************************
3458 ***********************************************************************/
3460 /* Handle changes in the `fontified' property of the current buffer by
3461 calling hook functions from Qfontification_functions to fontify
3464 static enum prop_handled
3465 handle_fontified_prop (struct it
*it
)
3467 Lisp_Object prop
, pos
;
3468 enum prop_handled handled
= HANDLED_NORMALLY
;
3470 if (!NILP (Vmemory_full
))
3473 /* Get the value of the `fontified' property at IT's current buffer
3474 position. (The `fontified' property doesn't have a special
3475 meaning in strings.) If the value is nil, call functions from
3476 Qfontification_functions. */
3477 if (!STRINGP (it
->string
)
3479 && !NILP (Vfontification_functions
)
3480 && !NILP (Vrun_hooks
)
3481 && (pos
= make_number (IT_CHARPOS (*it
)),
3482 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3483 /* Ignore the special cased nil value always present at EOB since
3484 no amount of fontifying will be able to change it. */
3485 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3487 int count
= SPECPDL_INDEX ();
3489 struct buffer
*obuf
= current_buffer
;
3490 int begv
= BEGV
, zv
= ZV
;
3491 int old_clip_changed
= current_buffer
->clip_changed
;
3493 val
= Vfontification_functions
;
3494 specbind (Qfontification_functions
, Qnil
);
3496 xassert (it
->end_charpos
== ZV
);
3498 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3499 safe_call1 (val
, pos
);
3502 Lisp_Object fns
, fn
;
3503 struct gcpro gcpro1
, gcpro2
;
3508 for (; CONSP (val
); val
= XCDR (val
))
3514 /* A value of t indicates this hook has a local
3515 binding; it means to run the global binding too.
3516 In a global value, t should not occur. If it
3517 does, we must ignore it to avoid an endless
3519 for (fns
= Fdefault_value (Qfontification_functions
);
3525 safe_call1 (fn
, pos
);
3529 safe_call1 (fn
, pos
);
3535 unbind_to (count
, Qnil
);
3537 /* Fontification functions routinely call `save-restriction'.
3538 Normally, this tags clip_changed, which can confuse redisplay
3539 (see discussion in Bug#6671). Since we don't perform any
3540 special handling of fontification changes in the case where
3541 `save-restriction' isn't called, there's no point doing so in
3542 this case either. So, if the buffer's restrictions are
3543 actually left unchanged, reset clip_changed. */
3544 if (obuf
== current_buffer
)
3546 if (begv
== BEGV
&& zv
== ZV
)
3547 current_buffer
->clip_changed
= old_clip_changed
;
3549 /* There isn't much we can reasonably do to protect against
3550 misbehaving fontification, but here's a fig leaf. */
3551 else if (!NILP (BVAR (obuf
, name
)))
3552 set_buffer_internal_1 (obuf
);
3554 /* The fontification code may have added/removed text.
3555 It could do even a lot worse, but let's at least protect against
3556 the most obvious case where only the text past `pos' gets changed',
3557 as is/was done in grep.el where some escapes sequences are turned
3558 into face properties (bug#7876). */
3559 it
->end_charpos
= ZV
;
3561 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3562 something. This avoids an endless loop if they failed to
3563 fontify the text for which reason ever. */
3564 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3565 handled
= HANDLED_RECOMPUTE_PROPS
;
3573 /***********************************************************************
3575 ***********************************************************************/
3577 /* Set up iterator IT from face properties at its current position.
3578 Called from handle_stop. */
3580 static enum prop_handled
3581 handle_face_prop (struct it
*it
)
3584 EMACS_INT next_stop
;
3586 if (!STRINGP (it
->string
))
3589 = face_at_buffer_position (it
->w
,
3591 it
->region_beg_charpos
,
3592 it
->region_end_charpos
,
3595 + TEXT_PROP_DISTANCE_LIMIT
),
3596 0, it
->base_face_id
);
3598 /* Is this a start of a run of characters with box face?
3599 Caveat: this can be called for a freshly initialized
3600 iterator; face_id is -1 in this case. We know that the new
3601 face will not change until limit, i.e. if the new face has a
3602 box, all characters up to limit will have one. But, as
3603 usual, we don't know whether limit is really the end. */
3604 if (new_face_id
!= it
->face_id
)
3606 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3608 /* If new face has a box but old face has not, this is
3609 the start of a run of characters with box, i.e. it has
3610 a shadow on the left side. The value of face_id of the
3611 iterator will be -1 if this is the initial call that gets
3612 the face. In this case, we have to look in front of IT's
3613 position and see whether there is a face != new_face_id. */
3614 it
->start_of_box_run_p
3615 = (new_face
->box
!= FACE_NO_BOX
3616 && (it
->face_id
>= 0
3617 || IT_CHARPOS (*it
) == BEG
3618 || new_face_id
!= face_before_it_pos (it
)));
3619 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3627 Lisp_Object from_overlay
3628 = (it
->current
.overlay_string_index
>= 0
3629 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3632 /* See if we got to this string directly or indirectly from
3633 an overlay property. That includes the before-string or
3634 after-string of an overlay, strings in display properties
3635 provided by an overlay, their text properties, etc.
3637 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3638 if (! NILP (from_overlay
))
3639 for (i
= it
->sp
- 1; i
>= 0; i
--)
3641 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3643 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3644 else if (! NILP (it
->stack
[i
].from_overlay
))
3645 from_overlay
= it
->stack
[i
].from_overlay
;
3647 if (!NILP (from_overlay
))
3651 if (! NILP (from_overlay
))
3653 bufpos
= IT_CHARPOS (*it
);
3654 /* For a string from an overlay, the base face depends
3655 only on text properties and ignores overlays. */
3657 = face_for_overlay_string (it
->w
,
3659 it
->region_beg_charpos
,
3660 it
->region_end_charpos
,
3663 + TEXT_PROP_DISTANCE_LIMIT
),
3671 /* For strings from a `display' property, use the face at
3672 IT's current buffer position as the base face to merge
3673 with, so that overlay strings appear in the same face as
3674 surrounding text, unless they specify their own
3676 base_face_id
= it
->string_from_prefix_prop_p
3678 : underlying_face_id (it
);
3681 new_face_id
= face_at_string_position (it
->w
,
3683 IT_STRING_CHARPOS (*it
),
3685 it
->region_beg_charpos
,
3686 it
->region_end_charpos
,
3690 /* Is this a start of a run of characters with box? Caveat:
3691 this can be called for a freshly allocated iterator; face_id
3692 is -1 is this case. We know that the new face will not
3693 change until the next check pos, i.e. if the new face has a
3694 box, all characters up to that position will have a
3695 box. But, as usual, we don't know whether that position
3696 is really the end. */
3697 if (new_face_id
!= it
->face_id
)
3699 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3700 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3702 /* If new face has a box but old face hasn't, this is the
3703 start of a run of characters with box, i.e. it has a
3704 shadow on the left side. */
3705 it
->start_of_box_run_p
3706 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3707 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3711 it
->face_id
= new_face_id
;
3712 return HANDLED_NORMALLY
;
3716 /* Return the ID of the face ``underlying'' IT's current position,
3717 which is in a string. If the iterator is associated with a
3718 buffer, return the face at IT's current buffer position.
3719 Otherwise, use the iterator's base_face_id. */
3722 underlying_face_id (struct it
*it
)
3724 int face_id
= it
->base_face_id
, i
;
3726 xassert (STRINGP (it
->string
));
3728 for (i
= it
->sp
- 1; i
>= 0; --i
)
3729 if (NILP (it
->stack
[i
].string
))
3730 face_id
= it
->stack
[i
].face_id
;
3736 /* Compute the face one character before or after the current position
3737 of IT, in the visual order. BEFORE_P non-zero means get the face
3738 in front (to the left in L2R paragraphs, to the right in R2L
3739 paragraphs) of IT's screen position. Value is the ID of the face. */
3742 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3745 EMACS_INT next_check_charpos
;
3747 void *it_copy_data
= NULL
;
3749 xassert (it
->s
== NULL
);
3751 if (STRINGP (it
->string
))
3753 EMACS_INT bufpos
, charpos
;
3756 /* No face change past the end of the string (for the case
3757 we are padding with spaces). No face change before the
3759 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3760 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3765 /* Set charpos to the position before or after IT's current
3766 position, in the logical order, which in the non-bidi
3767 case is the same as the visual order. */
3769 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3770 else if (it
->what
== IT_COMPOSITION
)
3771 /* For composition, we must check the character after the
3773 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3775 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3781 /* With bidi iteration, the character before the current
3782 in the visual order cannot be found by simple
3783 iteration, because "reverse" reordering is not
3784 supported. Instead, we need to use the move_it_*
3785 family of functions. */
3786 /* Ignore face changes before the first visible
3787 character on this display line. */
3788 if (it
->current_x
<= it
->first_visible_x
)
3790 SAVE_IT (it_copy
, *it
, it_copy_data
);
3791 /* Implementation note: Since move_it_in_display_line
3792 works in the iterator geometry, and thinks the first
3793 character is always the leftmost, even in R2L lines,
3794 we don't need to distinguish between the R2L and L2R
3796 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3797 it_copy
.current_x
- 1, MOVE_TO_X
);
3798 charpos
= IT_STRING_CHARPOS (it_copy
);
3799 RESTORE_IT (it
, it
, it_copy_data
);
3803 /* Set charpos to the string position of the character
3804 that comes after IT's current position in the visual
3806 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3810 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3812 charpos
= it_copy
.bidi_it
.charpos
;
3815 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3817 if (it
->current
.overlay_string_index
>= 0)
3818 bufpos
= IT_CHARPOS (*it
);
3822 base_face_id
= underlying_face_id (it
);
3824 /* Get the face for ASCII, or unibyte. */
3825 face_id
= face_at_string_position (it
->w
,
3829 it
->region_beg_charpos
,
3830 it
->region_end_charpos
,
3831 &next_check_charpos
,
3834 /* Correct the face for charsets different from ASCII. Do it
3835 for the multibyte case only. The face returned above is
3836 suitable for unibyte text if IT->string is unibyte. */
3837 if (STRING_MULTIBYTE (it
->string
))
3839 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3840 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3842 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3844 c
= string_char_and_length (p
, &len
);
3845 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3850 struct text_pos pos
;
3852 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3853 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3856 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3857 pos
= it
->current
.pos
;
3862 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3865 if (it
->what
== IT_COMPOSITION
)
3867 /* For composition, we must check the position after
3869 pos
.charpos
+= it
->cmp_it
.nchars
;
3870 pos
.bytepos
+= it
->len
;
3873 INC_TEXT_POS (pos
, it
->multibyte_p
);
3880 /* With bidi iteration, the character before the current
3881 in the visual order cannot be found by simple
3882 iteration, because "reverse" reordering is not
3883 supported. Instead, we need to use the move_it_*
3884 family of functions. */
3885 /* Ignore face changes before the first visible
3886 character on this display line. */
3887 if (it
->current_x
<= it
->first_visible_x
)
3889 SAVE_IT (it_copy
, *it
, it_copy_data
);
3890 /* Implementation note: Since move_it_in_display_line
3891 works in the iterator geometry, and thinks the first
3892 character is always the leftmost, even in R2L lines,
3893 we don't need to distinguish between the R2L and L2R
3895 move_it_in_display_line (&it_copy
, ZV
,
3896 it_copy
.current_x
- 1, MOVE_TO_X
);
3897 pos
= it_copy
.current
.pos
;
3898 RESTORE_IT (it
, it
, it_copy_data
);
3902 /* Set charpos to the buffer position of the character
3903 that comes after IT's current position in the visual
3905 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3909 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3912 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3915 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3917 /* Determine face for CHARSET_ASCII, or unibyte. */
3918 face_id
= face_at_buffer_position (it
->w
,
3920 it
->region_beg_charpos
,
3921 it
->region_end_charpos
,
3922 &next_check_charpos
,
3925 /* Correct the face for charsets different from ASCII. Do it
3926 for the multibyte case only. The face returned above is
3927 suitable for unibyte text if current_buffer is unibyte. */
3928 if (it
->multibyte_p
)
3930 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3931 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3932 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3941 /***********************************************************************
3943 ***********************************************************************/
3945 /* Set up iterator IT from invisible properties at its current
3946 position. Called from handle_stop. */
3948 static enum prop_handled
3949 handle_invisible_prop (struct it
*it
)
3951 enum prop_handled handled
= HANDLED_NORMALLY
;
3953 if (STRINGP (it
->string
))
3955 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3957 /* Get the value of the invisible text property at the
3958 current position. Value will be nil if there is no such
3960 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3961 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3964 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3968 handled
= HANDLED_RECOMPUTE_PROPS
;
3970 /* Get the position at which the next change of the
3971 invisible text property can be found in IT->string.
3972 Value will be nil if the property value is the same for
3973 all the rest of IT->string. */
3974 XSETINT (limit
, SCHARS (it
->string
));
3975 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3978 /* Text at current position is invisible. The next
3979 change in the property is at position end_charpos.
3980 Move IT's current position to that position. */
3981 if (INTEGERP (end_charpos
)
3982 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3984 struct text_pos old
;
3987 old
= it
->current
.string_pos
;
3988 oldpos
= CHARPOS (old
);
3991 if (it
->bidi_it
.first_elt
3992 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3993 bidi_paragraph_init (it
->paragraph_embedding
,
3995 /* Bidi-iterate out of the invisible text. */
3998 bidi_move_to_visually_next (&it
->bidi_it
);
4000 while (oldpos
<= it
->bidi_it
.charpos
4001 && it
->bidi_it
.charpos
< endpos
);
4003 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4004 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4005 if (IT_CHARPOS (*it
) >= endpos
)
4006 it
->prev_stop
= endpos
;
4010 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4011 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4016 /* The rest of the string is invisible. If this is an
4017 overlay string, proceed with the next overlay string
4018 or whatever comes and return a character from there. */
4019 if (it
->current
.overlay_string_index
>= 0)
4021 next_overlay_string (it
);
4022 /* Don't check for overlay strings when we just
4023 finished processing them. */
4024 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4028 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4029 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4037 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4038 Lisp_Object pos
, prop
, overlay
;
4040 /* First of all, is there invisible text at this position? */
4041 tem
= start_charpos
= IT_CHARPOS (*it
);
4042 pos
= make_number (tem
);
4043 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4045 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4047 /* If we are on invisible text, skip over it. */
4048 if (invis_p
&& start_charpos
< it
->end_charpos
)
4050 /* Record whether we have to display an ellipsis for the
4052 int display_ellipsis_p
= invis_p
== 2;
4054 handled
= HANDLED_RECOMPUTE_PROPS
;
4056 /* Loop skipping over invisible text. The loop is left at
4057 ZV or with IT on the first char being visible again. */
4060 /* Try to skip some invisible text. Return value is the
4061 position reached which can be equal to where we start
4062 if there is nothing invisible there. This skips both
4063 over invisible text properties and overlays with
4064 invisible property. */
4065 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4067 /* If we skipped nothing at all we weren't at invisible
4068 text in the first place. If everything to the end of
4069 the buffer was skipped, end the loop. */
4070 if (newpos
== tem
|| newpos
>= ZV
)
4074 /* We skipped some characters but not necessarily
4075 all there are. Check if we ended up on visible
4076 text. Fget_char_property returns the property of
4077 the char before the given position, i.e. if we
4078 get invis_p = 0, this means that the char at
4079 newpos is visible. */
4080 pos
= make_number (newpos
);
4081 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4082 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4085 /* If we ended up on invisible text, proceed to
4086 skip starting with next_stop. */
4090 /* If there are adjacent invisible texts, don't lose the
4091 second one's ellipsis. */
4093 display_ellipsis_p
= 1;
4097 /* The position newpos is now either ZV or on visible text. */
4100 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4102 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4104 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4106 /* If the invisible text ends on a newline or on a
4107 character after a newline, we can avoid the costly,
4108 character by character, bidi iteration to NEWPOS, and
4109 instead simply reseat the iterator there. That's
4110 because all bidi reordering information is tossed at
4111 the newline. This is a big win for modes that hide
4112 complete lines, like Outline, Org, etc. */
4113 if (on_newline
|| after_newline
)
4115 struct text_pos tpos
;
4116 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4118 SET_TEXT_POS (tpos
, newpos
, bpos
);
4119 reseat_1 (it
, tpos
, 0);
4120 /* If we reseat on a newline/ZV, we need to prep the
4121 bidi iterator for advancing to the next character
4122 after the newline/EOB, keeping the current paragraph
4123 direction (so that PRODUCE_GLYPHS does TRT wrt
4124 prepending/appending glyphs to a glyph row). */
4127 it
->bidi_it
.first_elt
= 0;
4128 it
->bidi_it
.paragraph_dir
= pdir
;
4129 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4130 it
->bidi_it
.nchars
= 1;
4131 it
->bidi_it
.ch_len
= 1;
4134 else /* Must use the slow method. */
4136 /* With bidi iteration, the region of invisible text
4137 could start and/or end in the middle of a
4138 non-base embedding level. Therefore, we need to
4139 skip invisible text using the bidi iterator,
4140 starting at IT's current position, until we find
4141 ourselves outside of the invisible text.
4142 Skipping invisible text _after_ bidi iteration
4143 avoids affecting the visual order of the
4144 displayed text when invisible properties are
4145 added or removed. */
4146 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4148 /* If we were `reseat'ed to a new paragraph,
4149 determine the paragraph base direction. We
4150 need to do it now because
4151 next_element_from_buffer may not have a
4152 chance to do it, if we are going to skip any
4153 text at the beginning, which resets the
4155 bidi_paragraph_init (it
->paragraph_embedding
,
4160 bidi_move_to_visually_next (&it
->bidi_it
);
4162 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4163 && it
->bidi_it
.charpos
< newpos
);
4164 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4165 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4166 /* If we overstepped NEWPOS, record its position in
4167 the iterator, so that we skip invisible text if
4168 later the bidi iteration lands us in the
4169 invisible region again. */
4170 if (IT_CHARPOS (*it
) >= newpos
)
4171 it
->prev_stop
= newpos
;
4176 IT_CHARPOS (*it
) = newpos
;
4177 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4180 /* If there are before-strings at the start of invisible
4181 text, and the text is invisible because of a text
4182 property, arrange to show before-strings because 20.x did
4183 it that way. (If the text is invisible because of an
4184 overlay property instead of a text property, this is
4185 already handled in the overlay code.) */
4187 && get_overlay_strings (it
, it
->stop_charpos
))
4189 handled
= HANDLED_RECOMPUTE_PROPS
;
4190 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4192 else if (display_ellipsis_p
)
4194 /* Make sure that the glyphs of the ellipsis will get
4195 correct `charpos' values. If we would not update
4196 it->position here, the glyphs would belong to the
4197 last visible character _before_ the invisible
4198 text, which confuses `set_cursor_from_row'.
4200 We use the last invisible position instead of the
4201 first because this way the cursor is always drawn on
4202 the first "." of the ellipsis, whenever PT is inside
4203 the invisible text. Otherwise the cursor would be
4204 placed _after_ the ellipsis when the point is after the
4205 first invisible character. */
4206 if (!STRINGP (it
->object
))
4208 it
->position
.charpos
= newpos
- 1;
4209 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4212 /* Let the ellipsis display before
4213 considering any properties of the following char.
4214 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4215 handled
= HANDLED_RETURN
;
4224 /* Make iterator IT return `...' next.
4225 Replaces LEN characters from buffer. */
4228 setup_for_ellipsis (struct it
*it
, int len
)
4230 /* Use the display table definition for `...'. Invalid glyphs
4231 will be handled by the method returning elements from dpvec. */
4232 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4234 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4235 it
->dpvec
= v
->contents
;
4236 it
->dpend
= v
->contents
+ v
->header
.size
;
4240 /* Default `...'. */
4241 it
->dpvec
= default_invis_vector
;
4242 it
->dpend
= default_invis_vector
+ 3;
4245 it
->dpvec_char_len
= len
;
4246 it
->current
.dpvec_index
= 0;
4247 it
->dpvec_face_id
= -1;
4249 /* Remember the current face id in case glyphs specify faces.
4250 IT's face is restored in set_iterator_to_next.
4251 saved_face_id was set to preceding char's face in handle_stop. */
4252 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4253 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4255 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4261 /***********************************************************************
4263 ***********************************************************************/
4265 /* Set up iterator IT from `display' property at its current position.
4266 Called from handle_stop.
4267 We return HANDLED_RETURN if some part of the display property
4268 overrides the display of the buffer text itself.
4269 Otherwise we return HANDLED_NORMALLY. */
4271 static enum prop_handled
4272 handle_display_prop (struct it
*it
)
4274 Lisp_Object propval
, object
, overlay
;
4275 struct text_pos
*position
;
4277 /* Nonzero if some property replaces the display of the text itself. */
4278 int display_replaced_p
= 0;
4280 if (STRINGP (it
->string
))
4282 object
= it
->string
;
4283 position
= &it
->current
.string_pos
;
4284 bufpos
= CHARPOS (it
->current
.pos
);
4288 XSETWINDOW (object
, it
->w
);
4289 position
= &it
->current
.pos
;
4290 bufpos
= CHARPOS (*position
);
4293 /* Reset those iterator values set from display property values. */
4294 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4295 it
->space_width
= Qnil
;
4296 it
->font_height
= Qnil
;
4299 /* We don't support recursive `display' properties, i.e. string
4300 values that have a string `display' property, that have a string
4301 `display' property etc. */
4302 if (!it
->string_from_display_prop_p
)
4303 it
->area
= TEXT_AREA
;
4305 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4306 Qdisplay
, object
, &overlay
);
4308 return HANDLED_NORMALLY
;
4309 /* Now OVERLAY is the overlay that gave us this property, or nil
4310 if it was a text property. */
4312 if (!STRINGP (it
->string
))
4313 object
= it
->w
->buffer
;
4315 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4317 FRAME_WINDOW_P (it
->f
));
4319 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4322 /* Subroutine of handle_display_prop. Returns non-zero if the display
4323 specification in SPEC is a replacing specification, i.e. it would
4324 replace the text covered by `display' property with something else,
4325 such as an image or a display string. If SPEC includes any kind or
4326 `(space ...) specification, the value is 2; this is used by
4327 compute_display_string_pos, which see.
4329 See handle_single_display_spec for documentation of arguments.
4330 frame_window_p is non-zero if the window being redisplayed is on a
4331 GUI frame; this argument is used only if IT is NULL, see below.
4333 IT can be NULL, if this is called by the bidi reordering code
4334 through compute_display_string_pos, which see. In that case, this
4335 function only examines SPEC, but does not otherwise "handle" it, in
4336 the sense that it doesn't set up members of IT from the display
4339 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4340 Lisp_Object overlay
, struct text_pos
*position
,
4341 EMACS_INT bufpos
, int frame_window_p
)
4343 int replacing_p
= 0;
4347 /* Simple specifications. */
4348 && !EQ (XCAR (spec
), Qimage
)
4349 && !EQ (XCAR (spec
), Qspace
)
4350 && !EQ (XCAR (spec
), Qwhen
)
4351 && !EQ (XCAR (spec
), Qslice
)
4352 && !EQ (XCAR (spec
), Qspace_width
)
4353 && !EQ (XCAR (spec
), Qheight
)
4354 && !EQ (XCAR (spec
), Qraise
)
4355 /* Marginal area specifications. */
4356 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4357 && !EQ (XCAR (spec
), Qleft_fringe
)
4358 && !EQ (XCAR (spec
), Qright_fringe
)
4359 && !NILP (XCAR (spec
)))
4361 for (; CONSP (spec
); spec
= XCDR (spec
))
4363 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4364 overlay
, position
, bufpos
,
4365 replacing_p
, frame_window_p
)))
4368 /* If some text in a string is replaced, `position' no
4369 longer points to the position of `object'. */
4370 if (!it
|| STRINGP (object
))
4375 else if (VECTORP (spec
))
4378 for (i
= 0; i
< ASIZE (spec
); ++i
)
4379 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4380 overlay
, position
, bufpos
,
4381 replacing_p
, frame_window_p
)))
4384 /* If some text in a string is replaced, `position' no
4385 longer points to the position of `object'. */
4386 if (!it
|| STRINGP (object
))
4392 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4393 position
, bufpos
, 0,
4401 /* Value is the position of the end of the `display' property starting
4402 at START_POS in OBJECT. */
4404 static struct text_pos
4405 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4408 struct text_pos end_pos
;
4410 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4411 Qdisplay
, object
, Qnil
);
4412 CHARPOS (end_pos
) = XFASTINT (end
);
4413 if (STRINGP (object
))
4414 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4416 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4422 /* Set up IT from a single `display' property specification SPEC. OBJECT
4423 is the object in which the `display' property was found. *POSITION
4424 is the position in OBJECT at which the `display' property was found.
4425 BUFPOS is the buffer position of OBJECT (different from POSITION if
4426 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4427 previously saw a display specification which already replaced text
4428 display with something else, for example an image; we ignore such
4429 properties after the first one has been processed.
4431 OVERLAY is the overlay this `display' property came from,
4432 or nil if it was a text property.
4434 If SPEC is a `space' or `image' specification, and in some other
4435 cases too, set *POSITION to the position where the `display'
4438 If IT is NULL, only examine the property specification in SPEC, but
4439 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4440 is intended to be displayed in a window on a GUI frame.
4442 Value is non-zero if something was found which replaces the display
4443 of buffer or string text. */
4446 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4447 Lisp_Object overlay
, struct text_pos
*position
,
4448 EMACS_INT bufpos
, int display_replaced_p
,
4452 Lisp_Object location
, value
;
4453 struct text_pos start_pos
= *position
;
4456 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4457 If the result is non-nil, use VALUE instead of SPEC. */
4459 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4468 if (!NILP (form
) && !EQ (form
, Qt
))
4470 int count
= SPECPDL_INDEX ();
4471 struct gcpro gcpro1
;
4473 /* Bind `object' to the object having the `display' property, a
4474 buffer or string. Bind `position' to the position in the
4475 object where the property was found, and `buffer-position'
4476 to the current position in the buffer. */
4479 XSETBUFFER (object
, current_buffer
);
4480 specbind (Qobject
, object
);
4481 specbind (Qposition
, make_number (CHARPOS (*position
)));
4482 specbind (Qbuffer_position
, make_number (bufpos
));
4484 form
= safe_eval (form
);
4486 unbind_to (count
, Qnil
);
4492 /* Handle `(height HEIGHT)' specifications. */
4494 && EQ (XCAR (spec
), Qheight
)
4495 && CONSP (XCDR (spec
)))
4499 if (!FRAME_WINDOW_P (it
->f
))
4502 it
->font_height
= XCAR (XCDR (spec
));
4503 if (!NILP (it
->font_height
))
4505 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4506 int new_height
= -1;
4508 if (CONSP (it
->font_height
)
4509 && (EQ (XCAR (it
->font_height
), Qplus
)
4510 || EQ (XCAR (it
->font_height
), Qminus
))
4511 && CONSP (XCDR (it
->font_height
))
4512 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4514 /* `(+ N)' or `(- N)' where N is an integer. */
4515 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4516 if (EQ (XCAR (it
->font_height
), Qplus
))
4518 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4520 else if (FUNCTIONP (it
->font_height
))
4522 /* Call function with current height as argument.
4523 Value is the new height. */
4525 height
= safe_call1 (it
->font_height
,
4526 face
->lface
[LFACE_HEIGHT_INDEX
]);
4527 if (NUMBERP (height
))
4528 new_height
= XFLOATINT (height
);
4530 else if (NUMBERP (it
->font_height
))
4532 /* Value is a multiple of the canonical char height. */
4535 f
= FACE_FROM_ID (it
->f
,
4536 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4537 new_height
= (XFLOATINT (it
->font_height
)
4538 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4542 /* Evaluate IT->font_height with `height' bound to the
4543 current specified height to get the new height. */
4544 int count
= SPECPDL_INDEX ();
4546 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4547 value
= safe_eval (it
->font_height
);
4548 unbind_to (count
, Qnil
);
4550 if (NUMBERP (value
))
4551 new_height
= XFLOATINT (value
);
4555 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4562 /* Handle `(space-width WIDTH)'. */
4564 && EQ (XCAR (spec
), Qspace_width
)
4565 && CONSP (XCDR (spec
)))
4569 if (!FRAME_WINDOW_P (it
->f
))
4572 value
= XCAR (XCDR (spec
));
4573 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4574 it
->space_width
= value
;
4580 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4582 && EQ (XCAR (spec
), Qslice
))
4588 if (!FRAME_WINDOW_P (it
->f
))
4591 if (tem
= XCDR (spec
), CONSP (tem
))
4593 it
->slice
.x
= XCAR (tem
);
4594 if (tem
= XCDR (tem
), CONSP (tem
))
4596 it
->slice
.y
= XCAR (tem
);
4597 if (tem
= XCDR (tem
), CONSP (tem
))
4599 it
->slice
.width
= XCAR (tem
);
4600 if (tem
= XCDR (tem
), CONSP (tem
))
4601 it
->slice
.height
= XCAR (tem
);
4610 /* Handle `(raise FACTOR)'. */
4612 && EQ (XCAR (spec
), Qraise
)
4613 && CONSP (XCDR (spec
)))
4617 if (!FRAME_WINDOW_P (it
->f
))
4620 #ifdef HAVE_WINDOW_SYSTEM
4621 value
= XCAR (XCDR (spec
));
4622 if (NUMBERP (value
))
4624 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4625 it
->voffset
= - (XFLOATINT (value
)
4626 * (FONT_HEIGHT (face
->font
)));
4628 #endif /* HAVE_WINDOW_SYSTEM */
4634 /* Don't handle the other kinds of display specifications
4635 inside a string that we got from a `display' property. */
4636 if (it
&& it
->string_from_display_prop_p
)
4639 /* Characters having this form of property are not displayed, so
4640 we have to find the end of the property. */
4643 start_pos
= *position
;
4644 *position
= display_prop_end (it
, object
, start_pos
);
4648 /* Stop the scan at that end position--we assume that all
4649 text properties change there. */
4651 it
->stop_charpos
= position
->charpos
;
4653 /* Handle `(left-fringe BITMAP [FACE])'
4654 and `(right-fringe BITMAP [FACE])'. */
4656 && (EQ (XCAR (spec
), Qleft_fringe
)
4657 || EQ (XCAR (spec
), Qright_fringe
))
4658 && CONSP (XCDR (spec
)))
4664 if (!FRAME_WINDOW_P (it
->f
))
4665 /* If we return here, POSITION has been advanced
4666 across the text with this property. */
4669 else if (!frame_window_p
)
4672 #ifdef HAVE_WINDOW_SYSTEM
4673 value
= XCAR (XCDR (spec
));
4674 if (!SYMBOLP (value
)
4675 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4676 /* If we return here, POSITION has been advanced
4677 across the text with this property. */
4682 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4684 if (CONSP (XCDR (XCDR (spec
))))
4686 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4687 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4693 /* Save current settings of IT so that we can restore them
4694 when we are finished with the glyph property value. */
4695 push_it (it
, position
);
4697 it
->area
= TEXT_AREA
;
4698 it
->what
= IT_IMAGE
;
4699 it
->image_id
= -1; /* no image */
4700 it
->position
= start_pos
;
4701 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4702 it
->method
= GET_FROM_IMAGE
;
4703 it
->from_overlay
= Qnil
;
4704 it
->face_id
= face_id
;
4705 it
->from_disp_prop_p
= 1;
4707 /* Say that we haven't consumed the characters with
4708 `display' property yet. The call to pop_it in
4709 set_iterator_to_next will clean this up. */
4710 *position
= start_pos
;
4712 if (EQ (XCAR (spec
), Qleft_fringe
))
4714 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4715 it
->left_user_fringe_face_id
= face_id
;
4719 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4720 it
->right_user_fringe_face_id
= face_id
;
4723 #endif /* HAVE_WINDOW_SYSTEM */
4727 /* Prepare to handle `((margin left-margin) ...)',
4728 `((margin right-margin) ...)' and `((margin nil) ...)'
4729 prefixes for display specifications. */
4730 location
= Qunbound
;
4731 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4735 value
= XCDR (spec
);
4737 value
= XCAR (value
);
4740 if (EQ (XCAR (tem
), Qmargin
)
4741 && (tem
= XCDR (tem
),
4742 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4744 || EQ (tem
, Qleft_margin
)
4745 || EQ (tem
, Qright_margin
))))
4749 if (EQ (location
, Qunbound
))
4755 /* After this point, VALUE is the property after any
4756 margin prefix has been stripped. It must be a string,
4757 an image specification, or `(space ...)'.
4759 LOCATION specifies where to display: `left-margin',
4760 `right-margin' or nil. */
4762 valid_p
= (STRINGP (value
)
4763 #ifdef HAVE_WINDOW_SYSTEM
4764 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4765 && valid_image_p (value
))
4766 #endif /* not HAVE_WINDOW_SYSTEM */
4767 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4769 if (valid_p
&& !display_replaced_p
)
4775 /* Callers need to know whether the display spec is any kind
4776 of `(space ...)' spec that is about to affect text-area
4778 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4783 /* Save current settings of IT so that we can restore them
4784 when we are finished with the glyph property value. */
4785 push_it (it
, position
);
4786 it
->from_overlay
= overlay
;
4787 it
->from_disp_prop_p
= 1;
4789 if (NILP (location
))
4790 it
->area
= TEXT_AREA
;
4791 else if (EQ (location
, Qleft_margin
))
4792 it
->area
= LEFT_MARGIN_AREA
;
4794 it
->area
= RIGHT_MARGIN_AREA
;
4796 if (STRINGP (value
))
4799 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4800 it
->current
.overlay_string_index
= -1;
4801 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4802 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4803 it
->method
= GET_FROM_STRING
;
4804 it
->stop_charpos
= 0;
4806 it
->base_level_stop
= 0;
4807 it
->string_from_display_prop_p
= 1;
4808 /* Say that we haven't consumed the characters with
4809 `display' property yet. The call to pop_it in
4810 set_iterator_to_next will clean this up. */
4811 if (BUFFERP (object
))
4812 *position
= start_pos
;
4814 /* Force paragraph direction to be that of the parent
4815 object. If the parent object's paragraph direction is
4816 not yet determined, default to L2R. */
4817 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4818 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4820 it
->paragraph_embedding
= L2R
;
4822 /* Set up the bidi iterator for this display string. */
4825 it
->bidi_it
.string
.lstring
= it
->string
;
4826 it
->bidi_it
.string
.s
= NULL
;
4827 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4828 it
->bidi_it
.string
.bufpos
= bufpos
;
4829 it
->bidi_it
.string
.from_disp_str
= 1;
4830 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4831 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4834 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4836 it
->method
= GET_FROM_STRETCH
;
4838 *position
= it
->position
= start_pos
;
4839 retval
= 1 + (it
->area
== TEXT_AREA
);
4841 #ifdef HAVE_WINDOW_SYSTEM
4844 it
->what
= IT_IMAGE
;
4845 it
->image_id
= lookup_image (it
->f
, value
);
4846 it
->position
= start_pos
;
4847 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4848 it
->method
= GET_FROM_IMAGE
;
4850 /* Say that we haven't consumed the characters with
4851 `display' property yet. The call to pop_it in
4852 set_iterator_to_next will clean this up. */
4853 *position
= start_pos
;
4855 #endif /* HAVE_WINDOW_SYSTEM */
4860 /* Invalid property or property not supported. Restore
4861 POSITION to what it was before. */
4862 *position
= start_pos
;
4866 /* Check if PROP is a display property value whose text should be
4867 treated as intangible. OVERLAY is the overlay from which PROP
4868 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4869 specify the buffer position covered by PROP. */
4872 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4873 EMACS_INT charpos
, EMACS_INT bytepos
)
4875 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4876 struct text_pos position
;
4878 SET_TEXT_POS (position
, charpos
, bytepos
);
4879 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4880 &position
, charpos
, frame_window_p
);
4884 /* Return 1 if PROP is a display sub-property value containing STRING.
4886 Implementation note: this and the following function are really
4887 special cases of handle_display_spec and
4888 handle_single_display_spec, and should ideally use the same code.
4889 Until they do, these two pairs must be consistent and must be
4890 modified in sync. */
4893 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4895 if (EQ (string
, prop
))
4898 /* Skip over `when FORM'. */
4899 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4904 /* Actually, the condition following `when' should be eval'ed,
4905 like handle_single_display_spec does, and we should return
4906 zero if it evaluates to nil. However, this function is
4907 called only when the buffer was already displayed and some
4908 glyph in the glyph matrix was found to come from a display
4909 string. Therefore, the condition was already evaluated, and
4910 the result was non-nil, otherwise the display string wouldn't
4911 have been displayed and we would have never been called for
4912 this property. Thus, we can skip the evaluation and assume
4913 its result is non-nil. */
4918 /* Skip over `margin LOCATION'. */
4919 if (EQ (XCAR (prop
), Qmargin
))
4930 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4934 /* Return 1 if STRING appears in the `display' property PROP. */
4937 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4940 && !EQ (XCAR (prop
), Qwhen
)
4941 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4943 /* A list of sub-properties. */
4944 while (CONSP (prop
))
4946 if (single_display_spec_string_p (XCAR (prop
), string
))
4951 else if (VECTORP (prop
))
4953 /* A vector of sub-properties. */
4955 for (i
= 0; i
< ASIZE (prop
); ++i
)
4956 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4960 return single_display_spec_string_p (prop
, string
);
4965 /* Look for STRING in overlays and text properties in the current
4966 buffer, between character positions FROM and TO (excluding TO).
4967 BACK_P non-zero means look back (in this case, TO is supposed to be
4969 Value is the first character position where STRING was found, or
4970 zero if it wasn't found before hitting TO.
4972 This function may only use code that doesn't eval because it is
4973 called asynchronously from note_mouse_highlight. */
4976 string_buffer_position_lim (Lisp_Object string
,
4977 EMACS_INT from
, EMACS_INT to
, int back_p
)
4979 Lisp_Object limit
, prop
, pos
;
4982 pos
= make_number (from
);
4984 if (!back_p
) /* looking forward */
4986 limit
= make_number (min (to
, ZV
));
4987 while (!found
&& !EQ (pos
, limit
))
4989 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4990 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4993 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4997 else /* looking back */
4999 limit
= make_number (max (to
, BEGV
));
5000 while (!found
&& !EQ (pos
, limit
))
5002 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5003 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5006 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5011 return found
? XINT (pos
) : 0;
5014 /* Determine which buffer position in current buffer STRING comes from.
5015 AROUND_CHARPOS is an approximate position where it could come from.
5016 Value is the buffer position or 0 if it couldn't be determined.
5018 This function is necessary because we don't record buffer positions
5019 in glyphs generated from strings (to keep struct glyph small).
5020 This function may only use code that doesn't eval because it is
5021 called asynchronously from note_mouse_highlight. */
5024 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
5026 const int MAX_DISTANCE
= 1000;
5027 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
5028 around_charpos
+ MAX_DISTANCE
,
5032 found
= string_buffer_position_lim (string
, around_charpos
,
5033 around_charpos
- MAX_DISTANCE
, 1);
5039 /***********************************************************************
5040 `composition' property
5041 ***********************************************************************/
5043 /* Set up iterator IT from `composition' property at its current
5044 position. Called from handle_stop. */
5046 static enum prop_handled
5047 handle_composition_prop (struct it
*it
)
5049 Lisp_Object prop
, string
;
5050 EMACS_INT pos
, pos_byte
, start
, end
;
5052 if (STRINGP (it
->string
))
5056 pos
= IT_STRING_CHARPOS (*it
);
5057 pos_byte
= IT_STRING_BYTEPOS (*it
);
5058 string
= it
->string
;
5059 s
= SDATA (string
) + pos_byte
;
5060 it
->c
= STRING_CHAR (s
);
5064 pos
= IT_CHARPOS (*it
);
5065 pos_byte
= IT_BYTEPOS (*it
);
5067 it
->c
= FETCH_CHAR (pos_byte
);
5070 /* If there's a valid composition and point is not inside of the
5071 composition (in the case that the composition is from the current
5072 buffer), draw a glyph composed from the composition components. */
5073 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5074 && COMPOSITION_VALID_P (start
, end
, prop
)
5075 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5078 /* As we can't handle this situation (perhaps font-lock added
5079 a new composition), we just return here hoping that next
5080 redisplay will detect this composition much earlier. */
5081 return HANDLED_NORMALLY
;
5084 if (STRINGP (it
->string
))
5085 pos_byte
= string_char_to_byte (it
->string
, start
);
5087 pos_byte
= CHAR_TO_BYTE (start
);
5089 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5092 if (it
->cmp_it
.id
>= 0)
5095 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5096 it
->cmp_it
.nglyphs
= -1;
5100 return HANDLED_NORMALLY
;
5105 /***********************************************************************
5107 ***********************************************************************/
5109 /* The following structure is used to record overlay strings for
5110 later sorting in load_overlay_strings. */
5112 struct overlay_entry
5114 Lisp_Object overlay
;
5121 /* Set up iterator IT from overlay strings at its current position.
5122 Called from handle_stop. */
5124 static enum prop_handled
5125 handle_overlay_change (struct it
*it
)
5127 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5128 return HANDLED_RECOMPUTE_PROPS
;
5130 return HANDLED_NORMALLY
;
5134 /* Set up the next overlay string for delivery by IT, if there is an
5135 overlay string to deliver. Called by set_iterator_to_next when the
5136 end of the current overlay string is reached. If there are more
5137 overlay strings to display, IT->string and
5138 IT->current.overlay_string_index are set appropriately here.
5139 Otherwise IT->string is set to nil. */
5142 next_overlay_string (struct it
*it
)
5144 ++it
->current
.overlay_string_index
;
5145 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5147 /* No more overlay strings. Restore IT's settings to what
5148 they were before overlay strings were processed, and
5149 continue to deliver from current_buffer. */
5151 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5154 || (NILP (it
->string
)
5155 && it
->method
== GET_FROM_BUFFER
5156 && it
->stop_charpos
>= BEGV
5157 && it
->stop_charpos
<= it
->end_charpos
));
5158 it
->current
.overlay_string_index
= -1;
5159 it
->n_overlay_strings
= 0;
5160 it
->overlay_strings_charpos
= -1;
5161 /* If there's an empty display string on the stack, pop the
5162 stack, to resync the bidi iterator with IT's position. Such
5163 empty strings are pushed onto the stack in
5164 get_overlay_strings_1. */
5165 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5168 /* If we're at the end of the buffer, record that we have
5169 processed the overlay strings there already, so that
5170 next_element_from_buffer doesn't try it again. */
5171 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5172 it
->overlay_strings_at_end_processed_p
= 1;
5176 /* There are more overlay strings to process. If
5177 IT->current.overlay_string_index has advanced to a position
5178 where we must load IT->overlay_strings with more strings, do
5179 it. We must load at the IT->overlay_strings_charpos where
5180 IT->n_overlay_strings was originally computed; when invisible
5181 text is present, this might not be IT_CHARPOS (Bug#7016). */
5182 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5184 if (it
->current
.overlay_string_index
&& i
== 0)
5185 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5187 /* Initialize IT to deliver display elements from the overlay
5189 it
->string
= it
->overlay_strings
[i
];
5190 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5191 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5192 it
->method
= GET_FROM_STRING
;
5193 it
->stop_charpos
= 0;
5194 if (it
->cmp_it
.stop_pos
>= 0)
5195 it
->cmp_it
.stop_pos
= 0;
5197 it
->base_level_stop
= 0;
5199 /* Set up the bidi iterator for this overlay string. */
5202 it
->bidi_it
.string
.lstring
= it
->string
;
5203 it
->bidi_it
.string
.s
= NULL
;
5204 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5205 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5206 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5207 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5208 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5216 /* Compare two overlay_entry structures E1 and E2. Used as a
5217 comparison function for qsort in load_overlay_strings. Overlay
5218 strings for the same position are sorted so that
5220 1. All after-strings come in front of before-strings, except
5221 when they come from the same overlay.
5223 2. Within after-strings, strings are sorted so that overlay strings
5224 from overlays with higher priorities come first.
5226 2. Within before-strings, strings are sorted so that overlay
5227 strings from overlays with higher priorities come last.
5229 Value is analogous to strcmp. */
5233 compare_overlay_entries (const void *e1
, const void *e2
)
5235 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5236 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5239 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5241 /* Let after-strings appear in front of before-strings if
5242 they come from different overlays. */
5243 if (EQ (entry1
->overlay
, entry2
->overlay
))
5244 result
= entry1
->after_string_p
? 1 : -1;
5246 result
= entry1
->after_string_p
? -1 : 1;
5248 else if (entry1
->after_string_p
)
5249 /* After-strings sorted in order of decreasing priority. */
5250 result
= entry2
->priority
- entry1
->priority
;
5252 /* Before-strings sorted in order of increasing priority. */
5253 result
= entry1
->priority
- entry2
->priority
;
5259 /* Load the vector IT->overlay_strings with overlay strings from IT's
5260 current buffer position, or from CHARPOS if that is > 0. Set
5261 IT->n_overlays to the total number of overlay strings found.
5263 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5264 a time. On entry into load_overlay_strings,
5265 IT->current.overlay_string_index gives the number of overlay
5266 strings that have already been loaded by previous calls to this
5269 IT->add_overlay_start contains an additional overlay start
5270 position to consider for taking overlay strings from, if non-zero.
5271 This position comes into play when the overlay has an `invisible'
5272 property, and both before and after-strings. When we've skipped to
5273 the end of the overlay, because of its `invisible' property, we
5274 nevertheless want its before-string to appear.
5275 IT->add_overlay_start will contain the overlay start position
5278 Overlay strings are sorted so that after-string strings come in
5279 front of before-string strings. Within before and after-strings,
5280 strings are sorted by overlay priority. See also function
5281 compare_overlay_entries. */
5284 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5286 Lisp_Object overlay
, window
, str
, invisible
;
5287 struct Lisp_Overlay
*ov
;
5288 EMACS_INT start
, end
;
5290 int n
= 0, i
, j
, invis_p
;
5291 struct overlay_entry
*entries
5292 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5295 charpos
= IT_CHARPOS (*it
);
5297 /* Append the overlay string STRING of overlay OVERLAY to vector
5298 `entries' which has size `size' and currently contains `n'
5299 elements. AFTER_P non-zero means STRING is an after-string of
5301 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5304 Lisp_Object priority; \
5308 int new_size = 2 * size; \
5309 struct overlay_entry *old = entries; \
5311 (struct overlay_entry *) alloca (new_size \
5312 * sizeof *entries); \
5313 memcpy (entries, old, size * sizeof *entries); \
5317 entries[n].string = (STRING); \
5318 entries[n].overlay = (OVERLAY); \
5319 priority = Foverlay_get ((OVERLAY), Qpriority); \
5320 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5321 entries[n].after_string_p = (AFTER_P); \
5326 /* Process overlay before the overlay center. */
5327 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5329 XSETMISC (overlay
, ov
);
5330 xassert (OVERLAYP (overlay
));
5331 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5332 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5337 /* Skip this overlay if it doesn't start or end at IT's current
5339 if (end
!= charpos
&& start
!= charpos
)
5342 /* Skip this overlay if it doesn't apply to IT->w. */
5343 window
= Foverlay_get (overlay
, Qwindow
);
5344 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5347 /* If the text ``under'' the overlay is invisible, both before-
5348 and after-strings from this overlay are visible; start and
5349 end position are indistinguishable. */
5350 invisible
= Foverlay_get (overlay
, Qinvisible
);
5351 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5353 /* If overlay has a non-empty before-string, record it. */
5354 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5355 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5357 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5359 /* If overlay has a non-empty after-string, record it. */
5360 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5361 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5363 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5366 /* Process overlays after the overlay center. */
5367 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5369 XSETMISC (overlay
, ov
);
5370 xassert (OVERLAYP (overlay
));
5371 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5372 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5374 if (start
> charpos
)
5377 /* Skip this overlay if it doesn't start or end at IT's current
5379 if (end
!= charpos
&& start
!= charpos
)
5382 /* Skip this overlay if it doesn't apply to IT->w. */
5383 window
= Foverlay_get (overlay
, Qwindow
);
5384 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5387 /* If the text ``under'' the overlay is invisible, it has a zero
5388 dimension, and both before- and after-strings apply. */
5389 invisible
= Foverlay_get (overlay
, Qinvisible
);
5390 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5392 /* If overlay has a non-empty before-string, record it. */
5393 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5394 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5396 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5398 /* If overlay has a non-empty after-string, record it. */
5399 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5400 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5402 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5405 #undef RECORD_OVERLAY_STRING
5409 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5411 /* Record number of overlay strings, and where we computed it. */
5412 it
->n_overlay_strings
= n
;
5413 it
->overlay_strings_charpos
= charpos
;
5415 /* IT->current.overlay_string_index is the number of overlay strings
5416 that have already been consumed by IT. Copy some of the
5417 remaining overlay strings to IT->overlay_strings. */
5419 j
= it
->current
.overlay_string_index
;
5420 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5422 it
->overlay_strings
[i
] = entries
[j
].string
;
5423 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5430 /* Get the first chunk of overlay strings at IT's current buffer
5431 position, or at CHARPOS if that is > 0. Value is non-zero if at
5432 least one overlay string was found. */
5435 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5437 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5438 process. This fills IT->overlay_strings with strings, and sets
5439 IT->n_overlay_strings to the total number of strings to process.
5440 IT->pos.overlay_string_index has to be set temporarily to zero
5441 because load_overlay_strings needs this; it must be set to -1
5442 when no overlay strings are found because a zero value would
5443 indicate a position in the first overlay string. */
5444 it
->current
.overlay_string_index
= 0;
5445 load_overlay_strings (it
, charpos
);
5447 /* If we found overlay strings, set up IT to deliver display
5448 elements from the first one. Otherwise set up IT to deliver
5449 from current_buffer. */
5450 if (it
->n_overlay_strings
)
5452 /* Make sure we know settings in current_buffer, so that we can
5453 restore meaningful values when we're done with the overlay
5456 compute_stop_pos (it
);
5457 xassert (it
->face_id
>= 0);
5459 /* Save IT's settings. They are restored after all overlay
5460 strings have been processed. */
5461 xassert (!compute_stop_p
|| it
->sp
== 0);
5463 /* When called from handle_stop, there might be an empty display
5464 string loaded. In that case, don't bother saving it. But
5465 don't use this optimization with the bidi iterator, since we
5466 need the corresponding pop_it call to resync the bidi
5467 iterator's position with IT's position, after we are done
5468 with the overlay strings. (The corresponding call to pop_it
5469 in case of an empty display string is in
5470 next_overlay_string.) */
5472 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5475 /* Set up IT to deliver display elements from the first overlay
5477 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5478 it
->string
= it
->overlay_strings
[0];
5479 it
->from_overlay
= Qnil
;
5480 it
->stop_charpos
= 0;
5481 xassert (STRINGP (it
->string
));
5482 it
->end_charpos
= SCHARS (it
->string
);
5484 it
->base_level_stop
= 0;
5485 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5486 it
->method
= GET_FROM_STRING
;
5487 it
->from_disp_prop_p
= 0;
5489 /* Force paragraph direction to be that of the parent
5491 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5492 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5494 it
->paragraph_embedding
= L2R
;
5496 /* Set up the bidi iterator for this overlay string. */
5499 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5501 it
->bidi_it
.string
.lstring
= it
->string
;
5502 it
->bidi_it
.string
.s
= NULL
;
5503 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5504 it
->bidi_it
.string
.bufpos
= pos
;
5505 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5506 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5507 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5512 it
->current
.overlay_string_index
= -1;
5517 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5520 it
->method
= GET_FROM_BUFFER
;
5522 (void) get_overlay_strings_1 (it
, charpos
, 1);
5526 /* Value is non-zero if we found at least one overlay string. */
5527 return STRINGP (it
->string
);
5532 /***********************************************************************
5533 Saving and restoring state
5534 ***********************************************************************/
5536 /* Save current settings of IT on IT->stack. Called, for example,
5537 before setting up IT for an overlay string, to be able to restore
5538 IT's settings to what they were after the overlay string has been
5539 processed. If POSITION is non-NULL, it is the position to save on
5540 the stack instead of IT->position. */
5543 push_it (struct it
*it
, struct text_pos
*position
)
5545 struct iterator_stack_entry
*p
;
5547 xassert (it
->sp
< IT_STACK_SIZE
);
5548 p
= it
->stack
+ it
->sp
;
5550 p
->stop_charpos
= it
->stop_charpos
;
5551 p
->prev_stop
= it
->prev_stop
;
5552 p
->base_level_stop
= it
->base_level_stop
;
5553 p
->cmp_it
= it
->cmp_it
;
5554 xassert (it
->face_id
>= 0);
5555 p
->face_id
= it
->face_id
;
5556 p
->string
= it
->string
;
5557 p
->method
= it
->method
;
5558 p
->from_overlay
= it
->from_overlay
;
5561 case GET_FROM_IMAGE
:
5562 p
->u
.image
.object
= it
->object
;
5563 p
->u
.image
.image_id
= it
->image_id
;
5564 p
->u
.image
.slice
= it
->slice
;
5566 case GET_FROM_STRETCH
:
5567 p
->u
.stretch
.object
= it
->object
;
5570 p
->position
= position
? *position
: it
->position
;
5571 p
->current
= it
->current
;
5572 p
->end_charpos
= it
->end_charpos
;
5573 p
->string_nchars
= it
->string_nchars
;
5575 p
->multibyte_p
= it
->multibyte_p
;
5576 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5577 p
->space_width
= it
->space_width
;
5578 p
->font_height
= it
->font_height
;
5579 p
->voffset
= it
->voffset
;
5580 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5581 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5582 p
->display_ellipsis_p
= 0;
5583 p
->line_wrap
= it
->line_wrap
;
5584 p
->bidi_p
= it
->bidi_p
;
5585 p
->paragraph_embedding
= it
->paragraph_embedding
;
5586 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5589 /* Save the state of the bidi iterator as well. */
5591 bidi_push_it (&it
->bidi_it
);
5595 iterate_out_of_display_property (struct it
*it
)
5597 int buffer_p
= BUFFERP (it
->object
);
5598 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5599 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5601 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5603 /* Maybe initialize paragraph direction. If we are at the beginning
5604 of a new paragraph, next_element_from_buffer may not have a
5605 chance to do that. */
5606 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5607 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5608 /* prev_stop can be zero, so check against BEGV as well. */
5609 while (it
->bidi_it
.charpos
>= bob
5610 && it
->prev_stop
<= it
->bidi_it
.charpos
5611 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5612 && it
->bidi_it
.charpos
< eob
)
5613 bidi_move_to_visually_next (&it
->bidi_it
);
5614 /* Record the stop_pos we just crossed, for when we cross it
5616 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5617 it
->prev_stop
= CHARPOS (it
->position
);
5618 /* If we ended up not where pop_it put us, resync IT's
5619 positional members with the bidi iterator. */
5620 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5621 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5623 it
->current
.pos
= it
->position
;
5625 it
->current
.string_pos
= it
->position
;
5628 /* Restore IT's settings from IT->stack. Called, for example, when no
5629 more overlay strings must be processed, and we return to delivering
5630 display elements from a buffer, or when the end of a string from a
5631 `display' property is reached and we return to delivering display
5632 elements from an overlay string, or from a buffer. */
5635 pop_it (struct it
*it
)
5637 struct iterator_stack_entry
*p
;
5638 int from_display_prop
= it
->from_disp_prop_p
;
5640 xassert (it
->sp
> 0);
5642 p
= it
->stack
+ it
->sp
;
5643 it
->stop_charpos
= p
->stop_charpos
;
5644 it
->prev_stop
= p
->prev_stop
;
5645 it
->base_level_stop
= p
->base_level_stop
;
5646 it
->cmp_it
= p
->cmp_it
;
5647 it
->face_id
= p
->face_id
;
5648 it
->current
= p
->current
;
5649 it
->position
= p
->position
;
5650 it
->string
= p
->string
;
5651 it
->from_overlay
= p
->from_overlay
;
5652 if (NILP (it
->string
))
5653 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5654 it
->method
= p
->method
;
5657 case GET_FROM_IMAGE
:
5658 it
->image_id
= p
->u
.image
.image_id
;
5659 it
->object
= p
->u
.image
.object
;
5660 it
->slice
= p
->u
.image
.slice
;
5662 case GET_FROM_STRETCH
:
5663 it
->object
= p
->u
.stretch
.object
;
5665 case GET_FROM_BUFFER
:
5666 it
->object
= it
->w
->buffer
;
5668 case GET_FROM_STRING
:
5669 it
->object
= it
->string
;
5671 case GET_FROM_DISPLAY_VECTOR
:
5673 it
->method
= GET_FROM_C_STRING
;
5674 else if (STRINGP (it
->string
))
5675 it
->method
= GET_FROM_STRING
;
5678 it
->method
= GET_FROM_BUFFER
;
5679 it
->object
= it
->w
->buffer
;
5682 it
->end_charpos
= p
->end_charpos
;
5683 it
->string_nchars
= p
->string_nchars
;
5685 it
->multibyte_p
= p
->multibyte_p
;
5686 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5687 it
->space_width
= p
->space_width
;
5688 it
->font_height
= p
->font_height
;
5689 it
->voffset
= p
->voffset
;
5690 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5691 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5692 it
->line_wrap
= p
->line_wrap
;
5693 it
->bidi_p
= p
->bidi_p
;
5694 it
->paragraph_embedding
= p
->paragraph_embedding
;
5695 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5698 bidi_pop_it (&it
->bidi_it
);
5699 /* Bidi-iterate until we get out of the portion of text, if any,
5700 covered by a `display' text property or by an overlay with
5701 `display' property. (We cannot just jump there, because the
5702 internal coherency of the bidi iterator state can not be
5703 preserved across such jumps.) We also must determine the
5704 paragraph base direction if the overlay we just processed is
5705 at the beginning of a new paragraph. */
5706 if (from_display_prop
5707 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5708 iterate_out_of_display_property (it
);
5710 xassert ((BUFFERP (it
->object
)
5711 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5712 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5713 || (STRINGP (it
->object
)
5714 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5715 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5716 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5722 /***********************************************************************
5724 ***********************************************************************/
5726 /* Set IT's current position to the previous line start. */
5729 back_to_previous_line_start (struct it
*it
)
5731 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5732 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5736 /* Move IT to the next line start.
5738 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5739 we skipped over part of the text (as opposed to moving the iterator
5740 continuously over the text). Otherwise, don't change the value
5743 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5744 iterator on the newline, if it was found.
5746 Newlines may come from buffer text, overlay strings, or strings
5747 displayed via the `display' property. That's the reason we can't
5748 simply use find_next_newline_no_quit.
5750 Note that this function may not skip over invisible text that is so
5751 because of text properties and immediately follows a newline. If
5752 it would, function reseat_at_next_visible_line_start, when called
5753 from set_iterator_to_next, would effectively make invisible
5754 characters following a newline part of the wrong glyph row, which
5755 leads to wrong cursor motion. */
5758 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5759 struct bidi_it
*bidi_it_prev
)
5761 EMACS_INT old_selective
;
5762 int newline_found_p
, n
;
5763 const int MAX_NEWLINE_DISTANCE
= 500;
5765 /* If already on a newline, just consume it to avoid unintended
5766 skipping over invisible text below. */
5767 if (it
->what
== IT_CHARACTER
5769 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5771 if (it
->bidi_p
&& bidi_it_prev
)
5772 *bidi_it_prev
= it
->bidi_it
;
5773 set_iterator_to_next (it
, 0);
5778 /* Don't handle selective display in the following. It's (a)
5779 unnecessary because it's done by the caller, and (b) leads to an
5780 infinite recursion because next_element_from_ellipsis indirectly
5781 calls this function. */
5782 old_selective
= it
->selective
;
5785 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5786 from buffer text. */
5787 for (n
= newline_found_p
= 0;
5788 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5789 n
+= STRINGP (it
->string
) ? 0 : 1)
5791 if (!get_next_display_element (it
))
5793 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5794 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5795 *bidi_it_prev
= it
->bidi_it
;
5796 set_iterator_to_next (it
, 0);
5799 /* If we didn't find a newline near enough, see if we can use a
5801 if (!newline_found_p
)
5803 EMACS_INT start
= IT_CHARPOS (*it
);
5804 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5807 xassert (!STRINGP (it
->string
));
5809 /* If there isn't any `display' property in sight, and no
5810 overlays, we can just use the position of the newline in
5812 if (it
->stop_charpos
>= limit
5813 || ((pos
= Fnext_single_property_change (make_number (start
),
5815 make_number (limit
)),
5817 && next_overlay_change (start
) == ZV
))
5821 IT_CHARPOS (*it
) = limit
;
5822 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5826 struct bidi_it bprev
;
5828 /* Help bidi.c avoid expensive searches for display
5829 properties and overlays, by telling it that there are
5830 none up to `limit'. */
5831 if (it
->bidi_it
.disp_pos
< limit
)
5833 it
->bidi_it
.disp_pos
= limit
;
5834 it
->bidi_it
.disp_prop
= 0;
5837 bprev
= it
->bidi_it
;
5838 bidi_move_to_visually_next (&it
->bidi_it
);
5839 } while (it
->bidi_it
.charpos
!= limit
);
5840 IT_CHARPOS (*it
) = limit
;
5841 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5843 *bidi_it_prev
= bprev
;
5845 *skipped_p
= newline_found_p
= 1;
5849 while (get_next_display_element (it
)
5850 && !newline_found_p
)
5852 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5853 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5854 *bidi_it_prev
= it
->bidi_it
;
5855 set_iterator_to_next (it
, 0);
5860 it
->selective
= old_selective
;
5861 return newline_found_p
;
5865 /* Set IT's current position to the previous visible line start. Skip
5866 invisible text that is so either due to text properties or due to
5867 selective display. Caution: this does not change IT->current_x and
5871 back_to_previous_visible_line_start (struct it
*it
)
5873 while (IT_CHARPOS (*it
) > BEGV
)
5875 back_to_previous_line_start (it
);
5877 if (IT_CHARPOS (*it
) <= BEGV
)
5880 /* If selective > 0, then lines indented more than its value are
5882 if (it
->selective
> 0
5883 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5887 /* Check the newline before point for invisibility. */
5890 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5891 Qinvisible
, it
->window
);
5892 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5896 if (IT_CHARPOS (*it
) <= BEGV
)
5901 void *it2data
= NULL
;
5904 Lisp_Object val
, overlay
;
5906 SAVE_IT (it2
, *it
, it2data
);
5908 /* If newline is part of a composition, continue from start of composition */
5909 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5910 && beg
< IT_CHARPOS (*it
))
5913 /* If newline is replaced by a display property, find start of overlay
5914 or interval and continue search from that point. */
5915 pos
= --IT_CHARPOS (it2
);
5918 bidi_unshelve_cache (NULL
, 0);
5919 it2
.string_from_display_prop_p
= 0;
5920 it2
.from_disp_prop_p
= 0;
5921 if (handle_display_prop (&it2
) == HANDLED_RETURN
5922 && !NILP (val
= get_char_property_and_overlay
5923 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5924 && (OVERLAYP (overlay
)
5925 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5926 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5928 RESTORE_IT (it
, it
, it2data
);
5932 /* Newline is not replaced by anything -- so we are done. */
5933 RESTORE_IT (it
, it
, it2data
);
5939 IT_CHARPOS (*it
) = beg
;
5940 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5944 it
->continuation_lines_width
= 0;
5946 xassert (IT_CHARPOS (*it
) >= BEGV
);
5947 xassert (IT_CHARPOS (*it
) == BEGV
5948 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5953 /* Reseat iterator IT at the previous visible line start. Skip
5954 invisible text that is so either due to text properties or due to
5955 selective display. At the end, update IT's overlay information,
5956 face information etc. */
5959 reseat_at_previous_visible_line_start (struct it
*it
)
5961 back_to_previous_visible_line_start (it
);
5962 reseat (it
, it
->current
.pos
, 1);
5967 /* Reseat iterator IT on the next visible line start in the current
5968 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5969 preceding the line start. Skip over invisible text that is so
5970 because of selective display. Compute faces, overlays etc at the
5971 new position. Note that this function does not skip over text that
5972 is invisible because of text properties. */
5975 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5977 int newline_found_p
, skipped_p
= 0;
5978 struct bidi_it bidi_it_prev
;
5980 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5982 /* Skip over lines that are invisible because they are indented
5983 more than the value of IT->selective. */
5984 if (it
->selective
> 0)
5985 while (IT_CHARPOS (*it
) < ZV
5986 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5989 xassert (IT_BYTEPOS (*it
) == BEGV
5990 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5992 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5995 /* Position on the newline if that's what's requested. */
5996 if (on_newline_p
&& newline_found_p
)
5998 if (STRINGP (it
->string
))
6000 if (IT_STRING_CHARPOS (*it
) > 0)
6004 --IT_STRING_CHARPOS (*it
);
6005 --IT_STRING_BYTEPOS (*it
);
6009 /* We need to restore the bidi iterator to the state
6010 it had on the newline, and resync the IT's
6011 position with that. */
6012 it
->bidi_it
= bidi_it_prev
;
6013 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6014 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6018 else if (IT_CHARPOS (*it
) > BEGV
)
6027 /* We need to restore the bidi iterator to the state it
6028 had on the newline and resync IT with that. */
6029 it
->bidi_it
= bidi_it_prev
;
6030 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6031 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6033 reseat (it
, it
->current
.pos
, 0);
6037 reseat (it
, it
->current
.pos
, 0);
6044 /***********************************************************************
6045 Changing an iterator's position
6046 ***********************************************************************/
6048 /* Change IT's current position to POS in current_buffer. If FORCE_P
6049 is non-zero, always check for text properties at the new position.
6050 Otherwise, text properties are only looked up if POS >=
6051 IT->check_charpos of a property. */
6054 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6056 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6058 reseat_1 (it
, pos
, 0);
6060 /* Determine where to check text properties. Avoid doing it
6061 where possible because text property lookup is very expensive. */
6063 || CHARPOS (pos
) > it
->stop_charpos
6064 || CHARPOS (pos
) < original_pos
)
6068 /* For bidi iteration, we need to prime prev_stop and
6069 base_level_stop with our best estimations. */
6070 /* Implementation note: Of course, POS is not necessarily a
6071 stop position, so assigning prev_pos to it is a lie; we
6072 should have called compute_stop_backwards. However, if
6073 the current buffer does not include any R2L characters,
6074 that call would be a waste of cycles, because the
6075 iterator will never move back, and thus never cross this
6076 "fake" stop position. So we delay that backward search
6077 until the time we really need it, in next_element_from_buffer. */
6078 if (CHARPOS (pos
) != it
->prev_stop
)
6079 it
->prev_stop
= CHARPOS (pos
);
6080 if (CHARPOS (pos
) < it
->base_level_stop
)
6081 it
->base_level_stop
= 0; /* meaning it's unknown */
6087 it
->prev_stop
= it
->base_level_stop
= 0;
6096 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6097 IT->stop_pos to POS, also. */
6100 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6102 /* Don't call this function when scanning a C string. */
6103 xassert (it
->s
== NULL
);
6105 /* POS must be a reasonable value. */
6106 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6108 it
->current
.pos
= it
->position
= pos
;
6109 it
->end_charpos
= ZV
;
6111 it
->current
.dpvec_index
= -1;
6112 it
->current
.overlay_string_index
= -1;
6113 IT_STRING_CHARPOS (*it
) = -1;
6114 IT_STRING_BYTEPOS (*it
) = -1;
6116 it
->method
= GET_FROM_BUFFER
;
6117 it
->object
= it
->w
->buffer
;
6118 it
->area
= TEXT_AREA
;
6119 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6121 it
->string_from_display_prop_p
= 0;
6122 it
->string_from_prefix_prop_p
= 0;
6124 it
->from_disp_prop_p
= 0;
6125 it
->face_before_selective_p
= 0;
6128 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6130 bidi_unshelve_cache (NULL
, 0);
6131 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6132 it
->bidi_it
.string
.s
= NULL
;
6133 it
->bidi_it
.string
.lstring
= Qnil
;
6134 it
->bidi_it
.string
.bufpos
= 0;
6135 it
->bidi_it
.string
.unibyte
= 0;
6140 it
->stop_charpos
= CHARPOS (pos
);
6141 it
->base_level_stop
= CHARPOS (pos
);
6146 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6147 If S is non-null, it is a C string to iterate over. Otherwise,
6148 STRING gives a Lisp string to iterate over.
6150 If PRECISION > 0, don't return more then PRECISION number of
6151 characters from the string.
6153 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6154 characters have been returned. FIELD_WIDTH < 0 means an infinite
6157 MULTIBYTE = 0 means disable processing of multibyte characters,
6158 MULTIBYTE > 0 means enable it,
6159 MULTIBYTE < 0 means use IT->multibyte_p.
6161 IT must be initialized via a prior call to init_iterator before
6162 calling this function. */
6165 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6166 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6169 /* No region in strings. */
6170 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6172 /* No text property checks performed by default, but see below. */
6173 it
->stop_charpos
= -1;
6175 /* Set iterator position and end position. */
6176 memset (&it
->current
, 0, sizeof it
->current
);
6177 it
->current
.overlay_string_index
= -1;
6178 it
->current
.dpvec_index
= -1;
6179 xassert (charpos
>= 0);
6181 /* If STRING is specified, use its multibyteness, otherwise use the
6182 setting of MULTIBYTE, if specified. */
6184 it
->multibyte_p
= multibyte
> 0;
6186 /* Bidirectional reordering of strings is controlled by the default
6187 value of bidi-display-reordering. Don't try to reorder while
6188 loading loadup.el, as the necessary character property tables are
6189 not yet available. */
6192 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6196 xassert (STRINGP (string
));
6197 it
->string
= string
;
6199 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6200 it
->method
= GET_FROM_STRING
;
6201 it
->current
.string_pos
= string_pos (charpos
, string
);
6205 it
->bidi_it
.string
.lstring
= string
;
6206 it
->bidi_it
.string
.s
= NULL
;
6207 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6208 it
->bidi_it
.string
.bufpos
= 0;
6209 it
->bidi_it
.string
.from_disp_str
= 0;
6210 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6211 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6212 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6217 it
->s
= (const unsigned char *) s
;
6220 /* Note that we use IT->current.pos, not it->current.string_pos,
6221 for displaying C strings. */
6222 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6223 if (it
->multibyte_p
)
6225 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6226 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6230 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6231 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6236 it
->bidi_it
.string
.lstring
= Qnil
;
6237 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6238 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6239 it
->bidi_it
.string
.bufpos
= 0;
6240 it
->bidi_it
.string
.from_disp_str
= 0;
6241 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6242 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6245 it
->method
= GET_FROM_C_STRING
;
6248 /* PRECISION > 0 means don't return more than PRECISION characters
6250 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6252 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6254 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6257 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6258 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6259 FIELD_WIDTH < 0 means infinite field width. This is useful for
6260 padding with `-' at the end of a mode line. */
6261 if (field_width
< 0)
6262 field_width
= INFINITY
;
6263 /* Implementation note: We deliberately don't enlarge
6264 it->bidi_it.string.schars here to fit it->end_charpos, because
6265 the bidi iterator cannot produce characters out of thin air. */
6266 if (field_width
> it
->end_charpos
- charpos
)
6267 it
->end_charpos
= charpos
+ field_width
;
6269 /* Use the standard display table for displaying strings. */
6270 if (DISP_TABLE_P (Vstandard_display_table
))
6271 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6273 it
->stop_charpos
= charpos
;
6274 it
->prev_stop
= charpos
;
6275 it
->base_level_stop
= 0;
6278 it
->bidi_it
.first_elt
= 1;
6279 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6280 it
->bidi_it
.disp_pos
= -1;
6282 if (s
== NULL
&& it
->multibyte_p
)
6284 EMACS_INT endpos
= SCHARS (it
->string
);
6285 if (endpos
> it
->end_charpos
)
6286 endpos
= it
->end_charpos
;
6287 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6295 /***********************************************************************
6297 ***********************************************************************/
6299 /* Map enum it_method value to corresponding next_element_from_* function. */
6301 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6303 next_element_from_buffer
,
6304 next_element_from_display_vector
,
6305 next_element_from_string
,
6306 next_element_from_c_string
,
6307 next_element_from_image
,
6308 next_element_from_stretch
6311 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6314 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6315 (possibly with the following characters). */
6317 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6318 ((IT)->cmp_it.id >= 0 \
6319 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6320 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6321 END_CHARPOS, (IT)->w, \
6322 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6326 /* Lookup the char-table Vglyphless_char_display for character C (-1
6327 if we want information for no-font case), and return the display
6328 method symbol. By side-effect, update it->what and
6329 it->glyphless_method. This function is called from
6330 get_next_display_element for each character element, and from
6331 x_produce_glyphs when no suitable font was found. */
6334 lookup_glyphless_char_display (int c
, struct it
*it
)
6336 Lisp_Object glyphless_method
= Qnil
;
6338 if (CHAR_TABLE_P (Vglyphless_char_display
)
6339 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6343 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6344 if (CONSP (glyphless_method
))
6345 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6346 ? XCAR (glyphless_method
)
6347 : XCDR (glyphless_method
);
6350 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6354 if (NILP (glyphless_method
))
6357 /* The default is to display the character by a proper font. */
6359 /* The default for the no-font case is to display an empty box. */
6360 glyphless_method
= Qempty_box
;
6362 if (EQ (glyphless_method
, Qzero_width
))
6365 return glyphless_method
;
6366 /* This method can't be used for the no-font case. */
6367 glyphless_method
= Qempty_box
;
6369 if (EQ (glyphless_method
, Qthin_space
))
6370 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6371 else if (EQ (glyphless_method
, Qempty_box
))
6372 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6373 else if (EQ (glyphless_method
, Qhex_code
))
6374 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6375 else if (STRINGP (glyphless_method
))
6376 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6379 /* Invalid value. We use the default method. */
6380 glyphless_method
= Qnil
;
6383 it
->what
= IT_GLYPHLESS
;
6384 return glyphless_method
;
6387 /* Load IT's display element fields with information about the next
6388 display element from the current position of IT. Value is zero if
6389 end of buffer (or C string) is reached. */
6391 static struct frame
*last_escape_glyph_frame
= NULL
;
6392 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6393 static int last_escape_glyph_merged_face_id
= 0;
6395 struct frame
*last_glyphless_glyph_frame
= NULL
;
6396 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6397 int last_glyphless_glyph_merged_face_id
= 0;
6400 get_next_display_element (struct it
*it
)
6402 /* Non-zero means that we found a display element. Zero means that
6403 we hit the end of what we iterate over. Performance note: the
6404 function pointer `method' used here turns out to be faster than
6405 using a sequence of if-statements. */
6409 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6411 if (it
->what
== IT_CHARACTER
)
6413 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6414 and only if (a) the resolved directionality of that character
6416 /* FIXME: Do we need an exception for characters from display
6418 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6419 it
->c
= bidi_mirror_char (it
->c
);
6420 /* Map via display table or translate control characters.
6421 IT->c, IT->len etc. have been set to the next character by
6422 the function call above. If we have a display table, and it
6423 contains an entry for IT->c, translate it. Don't do this if
6424 IT->c itself comes from a display table, otherwise we could
6425 end up in an infinite recursion. (An alternative could be to
6426 count the recursion depth of this function and signal an
6427 error when a certain maximum depth is reached.) Is it worth
6429 if (success_p
&& it
->dpvec
== NULL
)
6432 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6433 int nonascii_space_p
= 0;
6434 int nonascii_hyphen_p
= 0;
6435 int c
= it
->c
; /* This is the character to display. */
6437 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6439 xassert (SINGLE_BYTE_CHAR_P (c
));
6440 if (unibyte_display_via_language_environment
)
6442 c
= DECODE_CHAR (unibyte
, c
);
6444 c
= BYTE8_TO_CHAR (it
->c
);
6447 c
= BYTE8_TO_CHAR (it
->c
);
6451 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6454 struct Lisp_Vector
*v
= XVECTOR (dv
);
6456 /* Return the first character from the display table
6457 entry, if not empty. If empty, don't display the
6458 current character. */
6461 it
->dpvec_char_len
= it
->len
;
6462 it
->dpvec
= v
->contents
;
6463 it
->dpend
= v
->contents
+ v
->header
.size
;
6464 it
->current
.dpvec_index
= 0;
6465 it
->dpvec_face_id
= -1;
6466 it
->saved_face_id
= it
->face_id
;
6467 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6472 set_iterator_to_next (it
, 0);
6477 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6479 if (it
->what
== IT_GLYPHLESS
)
6481 /* Don't display this character. */
6482 set_iterator_to_next (it
, 0);
6486 /* If `nobreak-char-display' is non-nil, we display
6487 non-ASCII spaces and hyphens specially. */
6488 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6491 nonascii_space_p
= 1;
6492 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6493 nonascii_hyphen_p
= 1;
6496 /* Translate control characters into `\003' or `^C' form.
6497 Control characters coming from a display table entry are
6498 currently not translated because we use IT->dpvec to hold
6499 the translation. This could easily be changed but I
6500 don't believe that it is worth doing.
6502 The characters handled by `nobreak-char-display' must be
6505 Non-printable characters and raw-byte characters are also
6506 translated to octal form. */
6507 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6508 ? (it
->area
!= TEXT_AREA
6509 /* In mode line, treat \n, \t like other crl chars. */
6512 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6513 || (c
!= '\n' && c
!= '\t'))
6515 || nonascii_hyphen_p
6517 || ! CHAR_PRINTABLE_P (c
))))
6519 /* C is a control character, non-ASCII space/hyphen,
6520 raw-byte, or a non-printable character which must be
6521 displayed either as '\003' or as `^C' where the '\\'
6522 and '^' can be defined in the display table. Fill
6523 IT->ctl_chars with glyphs for what we have to
6524 display. Then, set IT->dpvec to these glyphs. */
6528 EMACS_INT lface_id
= 0;
6531 /* Handle control characters with ^. */
6533 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6537 g
= '^'; /* default glyph for Control */
6538 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6540 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6541 && GLYPH_CODE_CHAR_VALID_P (gc
))
6543 g
= GLYPH_CODE_CHAR (gc
);
6544 lface_id
= GLYPH_CODE_FACE (gc
);
6548 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6550 else if (it
->f
== last_escape_glyph_frame
6551 && it
->face_id
== last_escape_glyph_face_id
)
6553 face_id
= last_escape_glyph_merged_face_id
;
6557 /* Merge the escape-glyph face into the current face. */
6558 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6560 last_escape_glyph_frame
= it
->f
;
6561 last_escape_glyph_face_id
= it
->face_id
;
6562 last_escape_glyph_merged_face_id
= face_id
;
6565 XSETINT (it
->ctl_chars
[0], g
);
6566 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6568 goto display_control
;
6571 /* Handle non-ascii space in the mode where it only gets
6574 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6576 /* Merge `nobreak-space' into the current face. */
6577 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6579 XSETINT (it
->ctl_chars
[0], ' ');
6581 goto display_control
;
6584 /* Handle sequences that start with the "escape glyph". */
6586 /* the default escape glyph is \. */
6587 escape_glyph
= '\\';
6590 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6591 && GLYPH_CODE_CHAR_VALID_P (gc
))
6593 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6594 lface_id
= GLYPH_CODE_FACE (gc
);
6598 /* The display table specified a face.
6599 Merge it into face_id and also into escape_glyph. */
6600 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6603 else if (it
->f
== last_escape_glyph_frame
6604 && it
->face_id
== last_escape_glyph_face_id
)
6606 face_id
= last_escape_glyph_merged_face_id
;
6610 /* Merge the escape-glyph face into the current face. */
6611 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6613 last_escape_glyph_frame
= it
->f
;
6614 last_escape_glyph_face_id
= it
->face_id
;
6615 last_escape_glyph_merged_face_id
= face_id
;
6618 /* Draw non-ASCII hyphen with just highlighting: */
6620 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6622 XSETINT (it
->ctl_chars
[0], '-');
6624 goto display_control
;
6627 /* Draw non-ASCII space/hyphen with escape glyph: */
6629 if (nonascii_space_p
|| nonascii_hyphen_p
)
6631 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6632 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6634 goto display_control
;
6641 if (CHAR_BYTE8_P (c
))
6642 /* Display \200 instead of \17777600. */
6643 c
= CHAR_TO_BYTE8 (c
);
6644 len
= sprintf (str
, "%03o", c
);
6646 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6647 for (i
= 0; i
< len
; i
++)
6648 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6653 /* Set up IT->dpvec and return first character from it. */
6654 it
->dpvec_char_len
= it
->len
;
6655 it
->dpvec
= it
->ctl_chars
;
6656 it
->dpend
= it
->dpvec
+ ctl_len
;
6657 it
->current
.dpvec_index
= 0;
6658 it
->dpvec_face_id
= face_id
;
6659 it
->saved_face_id
= it
->face_id
;
6660 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6664 it
->char_to_display
= c
;
6668 it
->char_to_display
= it
->c
;
6672 /* Adjust face id for a multibyte character. There are no multibyte
6673 character in unibyte text. */
6674 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6677 && FRAME_WINDOW_P (it
->f
))
6679 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6681 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6683 /* Automatic composition with glyph-string. */
6684 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6686 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6690 EMACS_INT pos
= (it
->s
? -1
6691 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6692 : IT_CHARPOS (*it
));
6695 if (it
->what
== IT_CHARACTER
)
6696 c
= it
->char_to_display
;
6699 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6703 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6704 /* TAB in a composition means display glyphs with
6705 padding space on the left or right. */
6706 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6709 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6714 /* Is this character the last one of a run of characters with
6715 box? If yes, set IT->end_of_box_run_p to 1. */
6719 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6721 int face_id
= underlying_face_id (it
);
6722 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6726 if (face
->box
== FACE_NO_BOX
)
6728 /* If the box comes from face properties in a
6729 display string, check faces in that string. */
6730 int string_face_id
= face_after_it_pos (it
);
6731 it
->end_of_box_run_p
6732 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6735 /* Otherwise, the box comes from the underlying face.
6736 If this is the last string character displayed, check
6737 the next buffer location. */
6738 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6739 && (it
->current
.overlay_string_index
6740 == it
->n_overlay_strings
- 1))
6744 struct text_pos pos
= it
->current
.pos
;
6745 INC_TEXT_POS (pos
, it
->multibyte_p
);
6747 next_face_id
= face_at_buffer_position
6748 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6749 it
->region_end_charpos
, &ignore
,
6750 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6752 it
->end_of_box_run_p
6753 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6760 int face_id
= face_after_it_pos (it
);
6761 it
->end_of_box_run_p
6762 = (face_id
!= it
->face_id
6763 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6767 /* Value is 0 if end of buffer or string reached. */
6772 /* Move IT to the next display element.
6774 RESEAT_P non-zero means if called on a newline in buffer text,
6775 skip to the next visible line start.
6777 Functions get_next_display_element and set_iterator_to_next are
6778 separate because I find this arrangement easier to handle than a
6779 get_next_display_element function that also increments IT's
6780 position. The way it is we can first look at an iterator's current
6781 display element, decide whether it fits on a line, and if it does,
6782 increment the iterator position. The other way around we probably
6783 would either need a flag indicating whether the iterator has to be
6784 incremented the next time, or we would have to implement a
6785 decrement position function which would not be easy to write. */
6788 set_iterator_to_next (struct it
*it
, int reseat_p
)
6790 /* Reset flags indicating start and end of a sequence of characters
6791 with box. Reset them at the start of this function because
6792 moving the iterator to a new position might set them. */
6793 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6797 case GET_FROM_BUFFER
:
6798 /* The current display element of IT is a character from
6799 current_buffer. Advance in the buffer, and maybe skip over
6800 invisible lines that are so because of selective display. */
6801 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6802 reseat_at_next_visible_line_start (it
, 0);
6803 else if (it
->cmp_it
.id
>= 0)
6805 /* We are currently getting glyphs from a composition. */
6810 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6811 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6812 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6814 it
->cmp_it
.from
= it
->cmp_it
.to
;
6819 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6821 it
->end_charpos
, Qnil
);
6824 else if (! it
->cmp_it
.reversed_p
)
6826 /* Composition created while scanning forward. */
6827 /* Update IT's char/byte positions to point to the first
6828 character of the next grapheme cluster, or to the
6829 character visually after the current composition. */
6830 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6831 bidi_move_to_visually_next (&it
->bidi_it
);
6832 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6833 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6835 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6837 /* Proceed to the next grapheme cluster. */
6838 it
->cmp_it
.from
= it
->cmp_it
.to
;
6842 /* No more grapheme clusters in this composition.
6843 Find the next stop position. */
6844 EMACS_INT stop
= it
->end_charpos
;
6845 if (it
->bidi_it
.scan_dir
< 0)
6846 /* Now we are scanning backward and don't know
6849 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6850 IT_BYTEPOS (*it
), stop
, Qnil
);
6855 /* Composition created while scanning backward. */
6856 /* Update IT's char/byte positions to point to the last
6857 character of the previous grapheme cluster, or the
6858 character visually after the current composition. */
6859 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6860 bidi_move_to_visually_next (&it
->bidi_it
);
6861 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6862 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6863 if (it
->cmp_it
.from
> 0)
6865 /* Proceed to the previous grapheme cluster. */
6866 it
->cmp_it
.to
= it
->cmp_it
.from
;
6870 /* No more grapheme clusters in this composition.
6871 Find the next stop position. */
6872 EMACS_INT stop
= it
->end_charpos
;
6873 if (it
->bidi_it
.scan_dir
< 0)
6874 /* Now we are scanning backward and don't know
6877 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6878 IT_BYTEPOS (*it
), stop
, Qnil
);
6884 xassert (it
->len
!= 0);
6888 IT_BYTEPOS (*it
) += it
->len
;
6889 IT_CHARPOS (*it
) += 1;
6893 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6894 /* If this is a new paragraph, determine its base
6895 direction (a.k.a. its base embedding level). */
6896 if (it
->bidi_it
.new_paragraph
)
6897 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6898 bidi_move_to_visually_next (&it
->bidi_it
);
6899 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6900 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6901 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6903 /* As the scan direction was changed, we must
6904 re-compute the stop position for composition. */
6905 EMACS_INT stop
= it
->end_charpos
;
6906 if (it
->bidi_it
.scan_dir
< 0)
6908 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6909 IT_BYTEPOS (*it
), stop
, Qnil
);
6912 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6916 case GET_FROM_C_STRING
:
6917 /* Current display element of IT is from a C string. */
6919 /* If the string position is beyond string's end, it means
6920 next_element_from_c_string is padding the string with
6921 blanks, in which case we bypass the bidi iterator,
6922 because it cannot deal with such virtual characters. */
6923 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6925 IT_BYTEPOS (*it
) += it
->len
;
6926 IT_CHARPOS (*it
) += 1;
6930 bidi_move_to_visually_next (&it
->bidi_it
);
6931 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6932 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6936 case GET_FROM_DISPLAY_VECTOR
:
6937 /* Current display element of IT is from a display table entry.
6938 Advance in the display table definition. Reset it to null if
6939 end reached, and continue with characters from buffers/
6941 ++it
->current
.dpvec_index
;
6943 /* Restore face of the iterator to what they were before the
6944 display vector entry (these entries may contain faces). */
6945 it
->face_id
= it
->saved_face_id
;
6947 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6949 int recheck_faces
= it
->ellipsis_p
;
6952 it
->method
= GET_FROM_C_STRING
;
6953 else if (STRINGP (it
->string
))
6954 it
->method
= GET_FROM_STRING
;
6957 it
->method
= GET_FROM_BUFFER
;
6958 it
->object
= it
->w
->buffer
;
6962 it
->current
.dpvec_index
= -1;
6964 /* Skip over characters which were displayed via IT->dpvec. */
6965 if (it
->dpvec_char_len
< 0)
6966 reseat_at_next_visible_line_start (it
, 1);
6967 else if (it
->dpvec_char_len
> 0)
6969 if (it
->method
== GET_FROM_STRING
6970 && it
->n_overlay_strings
> 0)
6971 it
->ignore_overlay_strings_at_pos_p
= 1;
6972 it
->len
= it
->dpvec_char_len
;
6973 set_iterator_to_next (it
, reseat_p
);
6976 /* Maybe recheck faces after display vector */
6978 it
->stop_charpos
= IT_CHARPOS (*it
);
6982 case GET_FROM_STRING
:
6983 /* Current display element is a character from a Lisp string. */
6984 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6985 if (it
->cmp_it
.id
>= 0)
6991 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6992 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6993 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6994 it
->cmp_it
.from
= it
->cmp_it
.to
;
6998 composition_compute_stop_pos (&it
->cmp_it
,
6999 IT_STRING_CHARPOS (*it
),
7000 IT_STRING_BYTEPOS (*it
),
7001 it
->end_charpos
, it
->string
);
7004 else if (! it
->cmp_it
.reversed_p
)
7006 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7007 bidi_move_to_visually_next (&it
->bidi_it
);
7008 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7009 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7011 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7012 it
->cmp_it
.from
= it
->cmp_it
.to
;
7015 EMACS_INT stop
= it
->end_charpos
;
7016 if (it
->bidi_it
.scan_dir
< 0)
7018 composition_compute_stop_pos (&it
->cmp_it
,
7019 IT_STRING_CHARPOS (*it
),
7020 IT_STRING_BYTEPOS (*it
), stop
,
7026 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7027 bidi_move_to_visually_next (&it
->bidi_it
);
7028 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7029 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7030 if (it
->cmp_it
.from
> 0)
7031 it
->cmp_it
.to
= it
->cmp_it
.from
;
7034 EMACS_INT stop
= it
->end_charpos
;
7035 if (it
->bidi_it
.scan_dir
< 0)
7037 composition_compute_stop_pos (&it
->cmp_it
,
7038 IT_STRING_CHARPOS (*it
),
7039 IT_STRING_BYTEPOS (*it
), stop
,
7047 /* If the string position is beyond string's end, it
7048 means next_element_from_string is padding the string
7049 with blanks, in which case we bypass the bidi
7050 iterator, because it cannot deal with such virtual
7052 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7054 IT_STRING_BYTEPOS (*it
) += it
->len
;
7055 IT_STRING_CHARPOS (*it
) += 1;
7059 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7061 bidi_move_to_visually_next (&it
->bidi_it
);
7062 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7063 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7064 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7066 EMACS_INT stop
= it
->end_charpos
;
7068 if (it
->bidi_it
.scan_dir
< 0)
7070 composition_compute_stop_pos (&it
->cmp_it
,
7071 IT_STRING_CHARPOS (*it
),
7072 IT_STRING_BYTEPOS (*it
), stop
,
7078 consider_string_end
:
7080 if (it
->current
.overlay_string_index
>= 0)
7082 /* IT->string is an overlay string. Advance to the
7083 next, if there is one. */
7084 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7087 next_overlay_string (it
);
7089 setup_for_ellipsis (it
, 0);
7094 /* IT->string is not an overlay string. If we reached
7095 its end, and there is something on IT->stack, proceed
7096 with what is on the stack. This can be either another
7097 string, this time an overlay string, or a buffer. */
7098 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7102 if (it
->method
== GET_FROM_STRING
)
7103 goto consider_string_end
;
7108 case GET_FROM_IMAGE
:
7109 case GET_FROM_STRETCH
:
7110 /* The position etc with which we have to proceed are on
7111 the stack. The position may be at the end of a string,
7112 if the `display' property takes up the whole string. */
7113 xassert (it
->sp
> 0);
7115 if (it
->method
== GET_FROM_STRING
)
7116 goto consider_string_end
;
7120 /* There are no other methods defined, so this should be a bug. */
7124 xassert (it
->method
!= GET_FROM_STRING
7125 || (STRINGP (it
->string
)
7126 && IT_STRING_CHARPOS (*it
) >= 0));
7129 /* Load IT's display element fields with information about the next
7130 display element which comes from a display table entry or from the
7131 result of translating a control character to one of the forms `^C'
7134 IT->dpvec holds the glyphs to return as characters.
7135 IT->saved_face_id holds the face id before the display vector--it
7136 is restored into IT->face_id in set_iterator_to_next. */
7139 next_element_from_display_vector (struct it
*it
)
7144 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7146 it
->face_id
= it
->saved_face_id
;
7148 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7149 That seemed totally bogus - so I changed it... */
7150 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7152 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7154 it
->c
= GLYPH_CODE_CHAR (gc
);
7155 it
->len
= CHAR_BYTES (it
->c
);
7157 /* The entry may contain a face id to use. Such a face id is
7158 the id of a Lisp face, not a realized face. A face id of
7159 zero means no face is specified. */
7160 if (it
->dpvec_face_id
>= 0)
7161 it
->face_id
= it
->dpvec_face_id
;
7164 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7166 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7171 /* Display table entry is invalid. Return a space. */
7172 it
->c
= ' ', it
->len
= 1;
7174 /* Don't change position and object of the iterator here. They are
7175 still the values of the character that had this display table
7176 entry or was translated, and that's what we want. */
7177 it
->what
= IT_CHARACTER
;
7181 /* Get the first element of string/buffer in the visual order, after
7182 being reseated to a new position in a string or a buffer. */
7184 get_visually_first_element (struct it
*it
)
7186 int string_p
= STRINGP (it
->string
) || it
->s
;
7187 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7188 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7190 if (STRINGP (it
->string
))
7192 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7193 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7197 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7198 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7201 if (it
->bidi_it
.charpos
== eob
)
7203 /* Nothing to do, but reset the FIRST_ELT flag, like
7204 bidi_paragraph_init does, because we are not going to
7206 it
->bidi_it
.first_elt
= 0;
7208 else if (it
->bidi_it
.charpos
== bob
7210 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7211 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7213 /* If we are at the beginning of a line/string, we can produce
7214 the next element right away. */
7215 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7216 bidi_move_to_visually_next (&it
->bidi_it
);
7220 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7222 /* We need to prime the bidi iterator starting at the line's or
7223 string's beginning, before we will be able to produce the
7226 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7229 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7231 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7233 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7236 /* Now return to buffer/string position where we were asked
7237 to get the next display element, and produce that. */
7238 bidi_move_to_visually_next (&it
->bidi_it
);
7240 while (it
->bidi_it
.bytepos
!= orig_bytepos
7241 && it
->bidi_it
.charpos
< eob
);
7244 /* Adjust IT's position information to where we ended up. */
7245 if (STRINGP (it
->string
))
7247 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7248 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7252 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7253 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7256 if (STRINGP (it
->string
) || !it
->s
)
7258 EMACS_INT stop
, charpos
, bytepos
;
7260 if (STRINGP (it
->string
))
7263 stop
= SCHARS (it
->string
);
7264 if (stop
> it
->end_charpos
)
7265 stop
= it
->end_charpos
;
7266 charpos
= IT_STRING_CHARPOS (*it
);
7267 bytepos
= IT_STRING_BYTEPOS (*it
);
7271 stop
= it
->end_charpos
;
7272 charpos
= IT_CHARPOS (*it
);
7273 bytepos
= IT_BYTEPOS (*it
);
7275 if (it
->bidi_it
.scan_dir
< 0)
7277 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7282 /* Load IT with the next display element from Lisp string IT->string.
7283 IT->current.string_pos is the current position within the string.
7284 If IT->current.overlay_string_index >= 0, the Lisp string is an
7288 next_element_from_string (struct it
*it
)
7290 struct text_pos position
;
7292 xassert (STRINGP (it
->string
));
7293 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7294 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7295 position
= it
->current
.string_pos
;
7297 /* With bidi reordering, the character to display might not be the
7298 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7299 that we were reseat()ed to a new string, whose paragraph
7300 direction is not known. */
7301 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7303 get_visually_first_element (it
);
7304 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7307 /* Time to check for invisible text? */
7308 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7310 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7313 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7314 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7316 /* With bidi non-linear iteration, we could find
7317 ourselves far beyond the last computed stop_charpos,
7318 with several other stop positions in between that we
7319 missed. Scan them all now, in buffer's logical
7320 order, until we find and handle the last stop_charpos
7321 that precedes our current position. */
7322 handle_stop_backwards (it
, it
->stop_charpos
);
7323 return GET_NEXT_DISPLAY_ELEMENT (it
);
7329 /* Take note of the stop position we just moved
7330 across, for when we will move back across it. */
7331 it
->prev_stop
= it
->stop_charpos
;
7332 /* If we are at base paragraph embedding level, take
7333 note of the last stop position seen at this
7335 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7336 it
->base_level_stop
= it
->stop_charpos
;
7340 /* Since a handler may have changed IT->method, we must
7342 return GET_NEXT_DISPLAY_ELEMENT (it
);
7346 /* If we are before prev_stop, we may have overstepped
7347 on our way backwards a stop_pos, and if so, we need
7348 to handle that stop_pos. */
7349 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7350 /* We can sometimes back up for reasons that have nothing
7351 to do with bidi reordering. E.g., compositions. The
7352 code below is only needed when we are above the base
7353 embedding level, so test for that explicitly. */
7354 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7356 /* If we lost track of base_level_stop, we have no better
7357 place for handle_stop_backwards to start from than string
7358 beginning. This happens, e.g., when we were reseated to
7359 the previous screenful of text by vertical-motion. */
7360 if (it
->base_level_stop
<= 0
7361 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7362 it
->base_level_stop
= 0;
7363 handle_stop_backwards (it
, it
->base_level_stop
);
7364 return GET_NEXT_DISPLAY_ELEMENT (it
);
7368 if (it
->current
.overlay_string_index
>= 0)
7370 /* Get the next character from an overlay string. In overlay
7371 strings, there is no field width or padding with spaces to
7373 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7378 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7379 IT_STRING_BYTEPOS (*it
),
7380 it
->bidi_it
.scan_dir
< 0
7382 : SCHARS (it
->string
))
7383 && next_element_from_composition (it
))
7387 else if (STRING_MULTIBYTE (it
->string
))
7389 const unsigned char *s
= (SDATA (it
->string
)
7390 + IT_STRING_BYTEPOS (*it
));
7391 it
->c
= string_char_and_length (s
, &it
->len
);
7395 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7401 /* Get the next character from a Lisp string that is not an
7402 overlay string. Such strings come from the mode line, for
7403 example. We may have to pad with spaces, or truncate the
7404 string. See also next_element_from_c_string. */
7405 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7410 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7412 /* Pad with spaces. */
7413 it
->c
= ' ', it
->len
= 1;
7414 CHARPOS (position
) = BYTEPOS (position
) = -1;
7416 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7417 IT_STRING_BYTEPOS (*it
),
7418 it
->bidi_it
.scan_dir
< 0
7420 : it
->string_nchars
)
7421 && next_element_from_composition (it
))
7425 else if (STRING_MULTIBYTE (it
->string
))
7427 const unsigned char *s
= (SDATA (it
->string
)
7428 + IT_STRING_BYTEPOS (*it
));
7429 it
->c
= string_char_and_length (s
, &it
->len
);
7433 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7438 /* Record what we have and where it came from. */
7439 it
->what
= IT_CHARACTER
;
7440 it
->object
= it
->string
;
7441 it
->position
= position
;
7446 /* Load IT with next display element from C string IT->s.
7447 IT->string_nchars is the maximum number of characters to return
7448 from the string. IT->end_charpos may be greater than
7449 IT->string_nchars when this function is called, in which case we
7450 may have to return padding spaces. Value is zero if end of string
7451 reached, including padding spaces. */
7454 next_element_from_c_string (struct it
*it
)
7459 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7460 it
->what
= IT_CHARACTER
;
7461 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7464 /* With bidi reordering, the character to display might not be the
7465 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7466 we were reseated to a new string, whose paragraph direction is
7468 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7469 get_visually_first_element (it
);
7471 /* IT's position can be greater than IT->string_nchars in case a
7472 field width or precision has been specified when the iterator was
7474 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7476 /* End of the game. */
7480 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7482 /* Pad with spaces. */
7483 it
->c
= ' ', it
->len
= 1;
7484 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7486 else if (it
->multibyte_p
)
7487 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7489 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7495 /* Set up IT to return characters from an ellipsis, if appropriate.
7496 The definition of the ellipsis glyphs may come from a display table
7497 entry. This function fills IT with the first glyph from the
7498 ellipsis if an ellipsis is to be displayed. */
7501 next_element_from_ellipsis (struct it
*it
)
7503 if (it
->selective_display_ellipsis_p
)
7504 setup_for_ellipsis (it
, it
->len
);
7507 /* The face at the current position may be different from the
7508 face we find after the invisible text. Remember what it
7509 was in IT->saved_face_id, and signal that it's there by
7510 setting face_before_selective_p. */
7511 it
->saved_face_id
= it
->face_id
;
7512 it
->method
= GET_FROM_BUFFER
;
7513 it
->object
= it
->w
->buffer
;
7514 reseat_at_next_visible_line_start (it
, 1);
7515 it
->face_before_selective_p
= 1;
7518 return GET_NEXT_DISPLAY_ELEMENT (it
);
7522 /* Deliver an image display element. The iterator IT is already
7523 filled with image information (done in handle_display_prop). Value
7528 next_element_from_image (struct it
*it
)
7530 it
->what
= IT_IMAGE
;
7531 it
->ignore_overlay_strings_at_pos_p
= 0;
7536 /* Fill iterator IT with next display element from a stretch glyph
7537 property. IT->object is the value of the text property. Value is
7541 next_element_from_stretch (struct it
*it
)
7543 it
->what
= IT_STRETCH
;
7547 /* Scan backwards from IT's current position until we find a stop
7548 position, or until BEGV. This is called when we find ourself
7549 before both the last known prev_stop and base_level_stop while
7550 reordering bidirectional text. */
7553 compute_stop_pos_backwards (struct it
*it
)
7555 const int SCAN_BACK_LIMIT
= 1000;
7556 struct text_pos pos
;
7557 struct display_pos save_current
= it
->current
;
7558 struct text_pos save_position
= it
->position
;
7559 EMACS_INT charpos
= IT_CHARPOS (*it
);
7560 EMACS_INT where_we_are
= charpos
;
7561 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7562 EMACS_INT save_end_pos
= it
->end_charpos
;
7564 xassert (NILP (it
->string
) && !it
->s
);
7565 xassert (it
->bidi_p
);
7569 it
->end_charpos
= min (charpos
+ 1, ZV
);
7570 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7571 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7572 reseat_1 (it
, pos
, 0);
7573 compute_stop_pos (it
);
7574 /* We must advance forward, right? */
7575 if (it
->stop_charpos
<= charpos
)
7578 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7580 if (it
->stop_charpos
<= where_we_are
)
7581 it
->prev_stop
= it
->stop_charpos
;
7583 it
->prev_stop
= BEGV
;
7585 it
->current
= save_current
;
7586 it
->position
= save_position
;
7587 it
->stop_charpos
= save_stop_pos
;
7588 it
->end_charpos
= save_end_pos
;
7591 /* Scan forward from CHARPOS in the current buffer/string, until we
7592 find a stop position > current IT's position. Then handle the stop
7593 position before that. This is called when we bump into a stop
7594 position while reordering bidirectional text. CHARPOS should be
7595 the last previously processed stop_pos (or BEGV/0, if none were
7596 processed yet) whose position is less that IT's current
7600 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7602 int bufp
= !STRINGP (it
->string
);
7603 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7604 struct display_pos save_current
= it
->current
;
7605 struct text_pos save_position
= it
->position
;
7606 struct text_pos pos1
;
7607 EMACS_INT next_stop
;
7609 /* Scan in strict logical order. */
7610 xassert (it
->bidi_p
);
7614 it
->prev_stop
= charpos
;
7617 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7618 reseat_1 (it
, pos1
, 0);
7621 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7622 compute_stop_pos (it
);
7623 /* We must advance forward, right? */
7624 if (it
->stop_charpos
<= it
->prev_stop
)
7626 charpos
= it
->stop_charpos
;
7628 while (charpos
<= where_we_are
);
7631 it
->current
= save_current
;
7632 it
->position
= save_position
;
7633 next_stop
= it
->stop_charpos
;
7634 it
->stop_charpos
= it
->prev_stop
;
7636 it
->stop_charpos
= next_stop
;
7639 /* Load IT with the next display element from current_buffer. Value
7640 is zero if end of buffer reached. IT->stop_charpos is the next
7641 position at which to stop and check for text properties or buffer
7645 next_element_from_buffer (struct it
*it
)
7649 xassert (IT_CHARPOS (*it
) >= BEGV
);
7650 xassert (NILP (it
->string
) && !it
->s
);
7651 xassert (!it
->bidi_p
7652 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7653 && it
->bidi_it
.string
.s
== NULL
));
7655 /* With bidi reordering, the character to display might not be the
7656 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7657 we were reseat()ed to a new buffer position, which is potentially
7658 a different paragraph. */
7659 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7661 get_visually_first_element (it
);
7662 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7665 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7667 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7669 int overlay_strings_follow_p
;
7671 /* End of the game, except when overlay strings follow that
7672 haven't been returned yet. */
7673 if (it
->overlay_strings_at_end_processed_p
)
7674 overlay_strings_follow_p
= 0;
7677 it
->overlay_strings_at_end_processed_p
= 1;
7678 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7681 if (overlay_strings_follow_p
)
7682 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7686 it
->position
= it
->current
.pos
;
7690 else if (!(!it
->bidi_p
7691 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7692 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7694 /* With bidi non-linear iteration, we could find ourselves
7695 far beyond the last computed stop_charpos, with several
7696 other stop positions in between that we missed. Scan
7697 them all now, in buffer's logical order, until we find
7698 and handle the last stop_charpos that precedes our
7699 current position. */
7700 handle_stop_backwards (it
, it
->stop_charpos
);
7701 return GET_NEXT_DISPLAY_ELEMENT (it
);
7707 /* Take note of the stop position we just moved across,
7708 for when we will move back across it. */
7709 it
->prev_stop
= it
->stop_charpos
;
7710 /* If we are at base paragraph embedding level, take
7711 note of the last stop position seen at this
7713 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7714 it
->base_level_stop
= it
->stop_charpos
;
7717 return GET_NEXT_DISPLAY_ELEMENT (it
);
7721 /* If we are before prev_stop, we may have overstepped on
7722 our way backwards a stop_pos, and if so, we need to
7723 handle that stop_pos. */
7724 && IT_CHARPOS (*it
) < it
->prev_stop
7725 /* We can sometimes back up for reasons that have nothing
7726 to do with bidi reordering. E.g., compositions. The
7727 code below is only needed when we are above the base
7728 embedding level, so test for that explicitly. */
7729 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7731 if (it
->base_level_stop
<= 0
7732 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7734 /* If we lost track of base_level_stop, we need to find
7735 prev_stop by looking backwards. This happens, e.g., when
7736 we were reseated to the previous screenful of text by
7738 it
->base_level_stop
= BEGV
;
7739 compute_stop_pos_backwards (it
);
7740 handle_stop_backwards (it
, it
->prev_stop
);
7743 handle_stop_backwards (it
, it
->base_level_stop
);
7744 return GET_NEXT_DISPLAY_ELEMENT (it
);
7748 /* No face changes, overlays etc. in sight, so just return a
7749 character from current_buffer. */
7753 /* Maybe run the redisplay end trigger hook. Performance note:
7754 This doesn't seem to cost measurable time. */
7755 if (it
->redisplay_end_trigger_charpos
7757 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7758 run_redisplay_end_trigger_hook (it
);
7760 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7761 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7763 && next_element_from_composition (it
))
7768 /* Get the next character, maybe multibyte. */
7769 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7770 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7771 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7773 it
->c
= *p
, it
->len
= 1;
7775 /* Record what we have and where it came from. */
7776 it
->what
= IT_CHARACTER
;
7777 it
->object
= it
->w
->buffer
;
7778 it
->position
= it
->current
.pos
;
7780 /* Normally we return the character found above, except when we
7781 really want to return an ellipsis for selective display. */
7786 /* A value of selective > 0 means hide lines indented more
7787 than that number of columns. */
7788 if (it
->selective
> 0
7789 && IT_CHARPOS (*it
) + 1 < ZV
7790 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7791 IT_BYTEPOS (*it
) + 1,
7794 success_p
= next_element_from_ellipsis (it
);
7795 it
->dpvec_char_len
= -1;
7798 else if (it
->c
== '\r' && it
->selective
== -1)
7800 /* A value of selective == -1 means that everything from the
7801 CR to the end of the line is invisible, with maybe an
7802 ellipsis displayed for it. */
7803 success_p
= next_element_from_ellipsis (it
);
7804 it
->dpvec_char_len
= -1;
7809 /* Value is zero if end of buffer reached. */
7810 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7815 /* Run the redisplay end trigger hook for IT. */
7818 run_redisplay_end_trigger_hook (struct it
*it
)
7820 Lisp_Object args
[3];
7822 /* IT->glyph_row should be non-null, i.e. we should be actually
7823 displaying something, or otherwise we should not run the hook. */
7824 xassert (it
->glyph_row
);
7826 /* Set up hook arguments. */
7827 args
[0] = Qredisplay_end_trigger_functions
;
7828 args
[1] = it
->window
;
7829 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7830 it
->redisplay_end_trigger_charpos
= 0;
7832 /* Since we are *trying* to run these functions, don't try to run
7833 them again, even if they get an error. */
7834 it
->w
->redisplay_end_trigger
= Qnil
;
7835 Frun_hook_with_args (3, args
);
7837 /* Notice if it changed the face of the character we are on. */
7838 handle_face_prop (it
);
7842 /* Deliver a composition display element. Unlike the other
7843 next_element_from_XXX, this function is not registered in the array
7844 get_next_element[]. It is called from next_element_from_buffer and
7845 next_element_from_string when necessary. */
7848 next_element_from_composition (struct it
*it
)
7850 it
->what
= IT_COMPOSITION
;
7851 it
->len
= it
->cmp_it
.nbytes
;
7852 if (STRINGP (it
->string
))
7856 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7857 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7860 it
->position
= it
->current
.string_pos
;
7861 it
->object
= it
->string
;
7862 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7863 IT_STRING_BYTEPOS (*it
), it
->string
);
7869 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7870 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7873 if (it
->bidi_it
.new_paragraph
)
7874 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7875 /* Resync the bidi iterator with IT's new position.
7876 FIXME: this doesn't support bidirectional text. */
7877 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7878 bidi_move_to_visually_next (&it
->bidi_it
);
7882 it
->position
= it
->current
.pos
;
7883 it
->object
= it
->w
->buffer
;
7884 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7885 IT_BYTEPOS (*it
), Qnil
);
7892 /***********************************************************************
7893 Moving an iterator without producing glyphs
7894 ***********************************************************************/
7896 /* Check if iterator is at a position corresponding to a valid buffer
7897 position after some move_it_ call. */
7899 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7900 ((it)->method == GET_FROM_STRING \
7901 ? IT_STRING_CHARPOS (*it) == 0 \
7905 /* Move iterator IT to a specified buffer or X position within one
7906 line on the display without producing glyphs.
7908 OP should be a bit mask including some or all of these bits:
7909 MOVE_TO_X: Stop upon reaching x-position TO_X.
7910 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7911 Regardless of OP's value, stop upon reaching the end of the display line.
7913 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7914 This means, in particular, that TO_X includes window's horizontal
7917 The return value has several possible values that
7918 say what condition caused the scan to stop:
7920 MOVE_POS_MATCH_OR_ZV
7921 - when TO_POS or ZV was reached.
7924 -when TO_X was reached before TO_POS or ZV were reached.
7927 - when we reached the end of the display area and the line must
7931 - when we reached the end of the display area and the line is
7935 - when we stopped at a line end, i.e. a newline or a CR and selective
7938 static enum move_it_result
7939 move_it_in_display_line_to (struct it
*it
,
7940 EMACS_INT to_charpos
, int to_x
,
7941 enum move_operation_enum op
)
7943 enum move_it_result result
= MOVE_UNDEFINED
;
7944 struct glyph_row
*saved_glyph_row
;
7945 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7946 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7947 void *ppos_data
= NULL
;
7949 enum it_method prev_method
= it
->method
;
7950 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7951 int saw_smaller_pos
= prev_pos
< to_charpos
;
7953 /* Don't produce glyphs in produce_glyphs. */
7954 saved_glyph_row
= it
->glyph_row
;
7955 it
->glyph_row
= NULL
;
7957 /* Use wrap_it to save a copy of IT wherever a word wrap could
7958 occur. Use atpos_it to save a copy of IT at the desired buffer
7959 position, if found, so that we can scan ahead and check if the
7960 word later overshoots the window edge. Use atx_it similarly, for
7966 /* Use ppos_it under bidi reordering to save a copy of IT for the
7967 position > CHARPOS that is the closest to CHARPOS. We restore
7968 that position in IT when we have scanned the entire display line
7969 without finding a match for CHARPOS and all the character
7970 positions are greater than CHARPOS. */
7973 SAVE_IT (ppos_it
, *it
, ppos_data
);
7974 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7975 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7976 SAVE_IT (ppos_it
, *it
, ppos_data
);
7979 #define BUFFER_POS_REACHED_P() \
7980 ((op & MOVE_TO_POS) != 0 \
7981 && BUFFERP (it->object) \
7982 && (IT_CHARPOS (*it) == to_charpos \
7984 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7985 && IT_CHARPOS (*it) > to_charpos) \
7986 || (it->what == IT_COMPOSITION \
7987 && ((IT_CHARPOS (*it) > to_charpos \
7988 && to_charpos >= it->cmp_it.charpos) \
7989 || (IT_CHARPOS (*it) < to_charpos \
7990 && to_charpos <= it->cmp_it.charpos)))) \
7991 && (it->method == GET_FROM_BUFFER \
7992 || (it->method == GET_FROM_DISPLAY_VECTOR \
7993 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7995 /* If there's a line-/wrap-prefix, handle it. */
7996 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7997 && it
->current_y
< it
->last_visible_y
)
7998 handle_line_prefix (it
);
8000 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8001 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8005 int x
, i
, ascent
= 0, descent
= 0;
8007 /* Utility macro to reset an iterator with x, ascent, and descent. */
8008 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8009 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8010 (IT)->max_descent = descent)
8012 /* Stop if we move beyond TO_CHARPOS (after an image or a
8013 display string or stretch glyph). */
8014 if ((op
& MOVE_TO_POS
) != 0
8015 && BUFFERP (it
->object
)
8016 && it
->method
== GET_FROM_BUFFER
8018 /* When the iterator is at base embedding level, we
8019 are guaranteed that characters are delivered for
8020 display in strictly increasing order of their
8021 buffer positions. */
8022 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8023 && IT_CHARPOS (*it
) > to_charpos
)
8025 && (prev_method
== GET_FROM_IMAGE
8026 || prev_method
== GET_FROM_STRETCH
8027 || prev_method
== GET_FROM_STRING
)
8028 /* Passed TO_CHARPOS from left to right. */
8029 && ((prev_pos
< to_charpos
8030 && IT_CHARPOS (*it
) > to_charpos
)
8031 /* Passed TO_CHARPOS from right to left. */
8032 || (prev_pos
> to_charpos
8033 && IT_CHARPOS (*it
) < to_charpos
)))))
8035 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8037 result
= MOVE_POS_MATCH_OR_ZV
;
8040 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8041 /* If wrap_it is valid, the current position might be in a
8042 word that is wrapped. So, save the iterator in
8043 atpos_it and continue to see if wrapping happens. */
8044 SAVE_IT (atpos_it
, *it
, atpos_data
);
8047 /* Stop when ZV reached.
8048 We used to stop here when TO_CHARPOS reached as well, but that is
8049 too soon if this glyph does not fit on this line. So we handle it
8050 explicitly below. */
8051 if (!get_next_display_element (it
))
8053 result
= MOVE_POS_MATCH_OR_ZV
;
8057 if (it
->line_wrap
== TRUNCATE
)
8059 if (BUFFER_POS_REACHED_P ())
8061 result
= MOVE_POS_MATCH_OR_ZV
;
8067 if (it
->line_wrap
== WORD_WRAP
)
8069 if (IT_DISPLAYING_WHITESPACE (it
))
8073 /* We have reached a glyph that follows one or more
8074 whitespace characters. If the position is
8075 already found, we are done. */
8076 if (atpos_it
.sp
>= 0)
8078 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8079 result
= MOVE_POS_MATCH_OR_ZV
;
8084 RESTORE_IT (it
, &atx_it
, atx_data
);
8085 result
= MOVE_X_REACHED
;
8088 /* Otherwise, we can wrap here. */
8089 SAVE_IT (wrap_it
, *it
, wrap_data
);
8095 /* Remember the line height for the current line, in case
8096 the next element doesn't fit on the line. */
8097 ascent
= it
->max_ascent
;
8098 descent
= it
->max_descent
;
8100 /* The call to produce_glyphs will get the metrics of the
8101 display element IT is loaded with. Record the x-position
8102 before this display element, in case it doesn't fit on the
8106 PRODUCE_GLYPHS (it
);
8108 if (it
->area
!= TEXT_AREA
)
8110 prev_method
= it
->method
;
8111 if (it
->method
== GET_FROM_BUFFER
)
8112 prev_pos
= IT_CHARPOS (*it
);
8113 set_iterator_to_next (it
, 1);
8114 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8115 SET_TEXT_POS (this_line_min_pos
,
8116 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8118 && (op
& MOVE_TO_POS
)
8119 && IT_CHARPOS (*it
) > to_charpos
8120 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8121 SAVE_IT (ppos_it
, *it
, ppos_data
);
8125 /* The number of glyphs we get back in IT->nglyphs will normally
8126 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8127 character on a terminal frame, or (iii) a line end. For the
8128 second case, IT->nglyphs - 1 padding glyphs will be present.
8129 (On X frames, there is only one glyph produced for a
8130 composite character.)
8132 The behavior implemented below means, for continuation lines,
8133 that as many spaces of a TAB as fit on the current line are
8134 displayed there. For terminal frames, as many glyphs of a
8135 multi-glyph character are displayed in the current line, too.
8136 This is what the old redisplay code did, and we keep it that
8137 way. Under X, the whole shape of a complex character must
8138 fit on the line or it will be completely displayed in the
8141 Note that both for tabs and padding glyphs, all glyphs have
8145 /* More than one glyph or glyph doesn't fit on line. All
8146 glyphs have the same width. */
8147 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8149 int x_before_this_char
= x
;
8150 int hpos_before_this_char
= it
->hpos
;
8152 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8154 new_x
= x
+ single_glyph_width
;
8156 /* We want to leave anything reaching TO_X to the caller. */
8157 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8159 if (BUFFER_POS_REACHED_P ())
8161 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8162 goto buffer_pos_reached
;
8163 if (atpos_it
.sp
< 0)
8165 SAVE_IT (atpos_it
, *it
, atpos_data
);
8166 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8171 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8174 result
= MOVE_X_REACHED
;
8179 SAVE_IT (atx_it
, *it
, atx_data
);
8180 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8185 if (/* Lines are continued. */
8186 it
->line_wrap
!= TRUNCATE
8187 && (/* And glyph doesn't fit on the line. */
8188 new_x
> it
->last_visible_x
8189 /* Or it fits exactly and we're on a window
8191 || (new_x
== it
->last_visible_x
8192 && FRAME_WINDOW_P (it
->f
))))
8194 if (/* IT->hpos == 0 means the very first glyph
8195 doesn't fit on the line, e.g. a wide image. */
8197 || (new_x
== it
->last_visible_x
8198 && FRAME_WINDOW_P (it
->f
)))
8201 it
->current_x
= new_x
;
8203 /* The character's last glyph just barely fits
8205 if (i
== it
->nglyphs
- 1)
8207 /* If this is the destination position,
8208 return a position *before* it in this row,
8209 now that we know it fits in this row. */
8210 if (BUFFER_POS_REACHED_P ())
8212 if (it
->line_wrap
!= WORD_WRAP
8215 it
->hpos
= hpos_before_this_char
;
8216 it
->current_x
= x_before_this_char
;
8217 result
= MOVE_POS_MATCH_OR_ZV
;
8220 if (it
->line_wrap
== WORD_WRAP
8223 SAVE_IT (atpos_it
, *it
, atpos_data
);
8224 atpos_it
.current_x
= x_before_this_char
;
8225 atpos_it
.hpos
= hpos_before_this_char
;
8229 prev_method
= it
->method
;
8230 if (it
->method
== GET_FROM_BUFFER
)
8231 prev_pos
= IT_CHARPOS (*it
);
8232 set_iterator_to_next (it
, 1);
8233 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8234 SET_TEXT_POS (this_line_min_pos
,
8235 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8236 /* On graphical terminals, newlines may
8237 "overflow" into the fringe if
8238 overflow-newline-into-fringe is non-nil.
8239 On text-only terminals, newlines may
8240 overflow into the last glyph on the
8242 if (!FRAME_WINDOW_P (it
->f
)
8243 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8245 if (!get_next_display_element (it
))
8247 result
= MOVE_POS_MATCH_OR_ZV
;
8250 if (BUFFER_POS_REACHED_P ())
8252 if (ITERATOR_AT_END_OF_LINE_P (it
))
8253 result
= MOVE_POS_MATCH_OR_ZV
;
8255 result
= MOVE_LINE_CONTINUED
;
8258 if (ITERATOR_AT_END_OF_LINE_P (it
))
8260 result
= MOVE_NEWLINE_OR_CR
;
8267 IT_RESET_X_ASCENT_DESCENT (it
);
8269 if (wrap_it
.sp
>= 0)
8271 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8276 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8278 result
= MOVE_LINE_CONTINUED
;
8282 if (BUFFER_POS_REACHED_P ())
8284 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8285 goto buffer_pos_reached
;
8286 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8288 SAVE_IT (atpos_it
, *it
, atpos_data
);
8289 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8293 if (new_x
> it
->first_visible_x
)
8295 /* Glyph is visible. Increment number of glyphs that
8296 would be displayed. */
8301 if (result
!= MOVE_UNDEFINED
)
8304 else if (BUFFER_POS_REACHED_P ())
8307 IT_RESET_X_ASCENT_DESCENT (it
);
8308 result
= MOVE_POS_MATCH_OR_ZV
;
8311 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8313 /* Stop when TO_X specified and reached. This check is
8314 necessary here because of lines consisting of a line end,
8315 only. The line end will not produce any glyphs and we
8316 would never get MOVE_X_REACHED. */
8317 xassert (it
->nglyphs
== 0);
8318 result
= MOVE_X_REACHED
;
8322 /* Is this a line end? If yes, we're done. */
8323 if (ITERATOR_AT_END_OF_LINE_P (it
))
8325 /* If we are past TO_CHARPOS, but never saw any character
8326 positions smaller than TO_CHARPOS, return
8327 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8329 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8331 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8333 if (IT_CHARPOS (ppos_it
) < ZV
)
8335 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8336 result
= MOVE_POS_MATCH_OR_ZV
;
8339 goto buffer_pos_reached
;
8341 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8342 && IT_CHARPOS (*it
) > to_charpos
)
8343 goto buffer_pos_reached
;
8345 result
= MOVE_NEWLINE_OR_CR
;
8348 result
= MOVE_NEWLINE_OR_CR
;
8352 prev_method
= it
->method
;
8353 if (it
->method
== GET_FROM_BUFFER
)
8354 prev_pos
= IT_CHARPOS (*it
);
8355 /* The current display element has been consumed. Advance
8357 set_iterator_to_next (it
, 1);
8358 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8359 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8360 if (IT_CHARPOS (*it
) < to_charpos
)
8361 saw_smaller_pos
= 1;
8363 && (op
& MOVE_TO_POS
)
8364 && IT_CHARPOS (*it
) >= to_charpos
8365 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8366 SAVE_IT (ppos_it
, *it
, ppos_data
);
8368 /* Stop if lines are truncated and IT's current x-position is
8369 past the right edge of the window now. */
8370 if (it
->line_wrap
== TRUNCATE
8371 && it
->current_x
>= it
->last_visible_x
)
8373 if (!FRAME_WINDOW_P (it
->f
)
8374 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8378 if ((at_eob_p
= !get_next_display_element (it
))
8379 || BUFFER_POS_REACHED_P ()
8380 /* If we are past TO_CHARPOS, but never saw any
8381 character positions smaller than TO_CHARPOS,
8382 return MOVE_POS_MATCH_OR_ZV, like the
8383 unidirectional display did. */
8384 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8386 && IT_CHARPOS (*it
) > to_charpos
))
8389 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8390 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8391 result
= MOVE_POS_MATCH_OR_ZV
;
8394 if (ITERATOR_AT_END_OF_LINE_P (it
))
8396 result
= MOVE_NEWLINE_OR_CR
;
8400 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8402 && IT_CHARPOS (*it
) > to_charpos
)
8404 if (IT_CHARPOS (ppos_it
) < ZV
)
8405 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8406 result
= MOVE_POS_MATCH_OR_ZV
;
8409 result
= MOVE_LINE_TRUNCATED
;
8412 #undef IT_RESET_X_ASCENT_DESCENT
8415 #undef BUFFER_POS_REACHED_P
8417 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8418 restore the saved iterator. */
8419 if (atpos_it
.sp
>= 0)
8420 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8421 else if (atx_it
.sp
>= 0)
8422 RESTORE_IT (it
, &atx_it
, atx_data
);
8427 bidi_unshelve_cache (atpos_data
, 1);
8429 bidi_unshelve_cache (atx_data
, 1);
8431 bidi_unshelve_cache (wrap_data
, 1);
8433 bidi_unshelve_cache (ppos_data
, 1);
8435 /* Restore the iterator settings altered at the beginning of this
8437 it
->glyph_row
= saved_glyph_row
;
8441 /* For external use. */
8443 move_it_in_display_line (struct it
*it
,
8444 EMACS_INT to_charpos
, int to_x
,
8445 enum move_operation_enum op
)
8447 if (it
->line_wrap
== WORD_WRAP
8448 && (op
& MOVE_TO_X
))
8451 void *save_data
= NULL
;
8454 SAVE_IT (save_it
, *it
, save_data
);
8455 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8456 /* When word-wrap is on, TO_X may lie past the end
8457 of a wrapped line. Then it->current is the
8458 character on the next line, so backtrack to the
8459 space before the wrap point. */
8460 if (skip
== MOVE_LINE_CONTINUED
)
8462 int prev_x
= max (it
->current_x
- 1, 0);
8463 RESTORE_IT (it
, &save_it
, save_data
);
8464 move_it_in_display_line_to
8465 (it
, -1, prev_x
, MOVE_TO_X
);
8468 bidi_unshelve_cache (save_data
, 1);
8471 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8475 /* Move IT forward until it satisfies one or more of the criteria in
8476 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8478 OP is a bit-mask that specifies where to stop, and in particular,
8479 which of those four position arguments makes a difference. See the
8480 description of enum move_operation_enum.
8482 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8483 screen line, this function will set IT to the next position that is
8484 displayed to the right of TO_CHARPOS on the screen. */
8487 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8489 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8490 int line_height
, line_start_x
= 0, reached
= 0;
8491 void *backup_data
= NULL
;
8495 if (op
& MOVE_TO_VPOS
)
8497 /* If no TO_CHARPOS and no TO_X specified, stop at the
8498 start of the line TO_VPOS. */
8499 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8501 if (it
->vpos
== to_vpos
)
8507 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8511 /* TO_VPOS >= 0 means stop at TO_X in the line at
8512 TO_VPOS, or at TO_POS, whichever comes first. */
8513 if (it
->vpos
== to_vpos
)
8519 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8521 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8526 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8528 /* We have reached TO_X but not in the line we want. */
8529 skip
= move_it_in_display_line_to (it
, to_charpos
,
8531 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8539 else if (op
& MOVE_TO_Y
)
8541 struct it it_backup
;
8543 if (it
->line_wrap
== WORD_WRAP
)
8544 SAVE_IT (it_backup
, *it
, backup_data
);
8546 /* TO_Y specified means stop at TO_X in the line containing
8547 TO_Y---or at TO_CHARPOS if this is reached first. The
8548 problem is that we can't really tell whether the line
8549 contains TO_Y before we have completely scanned it, and
8550 this may skip past TO_X. What we do is to first scan to
8553 If TO_X is not specified, use a TO_X of zero. The reason
8554 is to make the outcome of this function more predictable.
8555 If we didn't use TO_X == 0, we would stop at the end of
8556 the line which is probably not what a caller would expect
8558 skip
= move_it_in_display_line_to
8559 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8560 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8562 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8563 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8565 else if (skip
== MOVE_X_REACHED
)
8567 /* If TO_X was reached, we want to know whether TO_Y is
8568 in the line. We know this is the case if the already
8569 scanned glyphs make the line tall enough. Otherwise,
8570 we must check by scanning the rest of the line. */
8571 line_height
= it
->max_ascent
+ it
->max_descent
;
8572 if (to_y
>= it
->current_y
8573 && to_y
< it
->current_y
+ line_height
)
8578 SAVE_IT (it_backup
, *it
, backup_data
);
8579 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8580 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8582 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8583 line_height
= it
->max_ascent
+ it
->max_descent
;
8584 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8586 if (to_y
>= it
->current_y
8587 && to_y
< it
->current_y
+ line_height
)
8589 /* If TO_Y is in this line and TO_X was reached
8590 above, we scanned too far. We have to restore
8591 IT's settings to the ones before skipping. */
8592 RESTORE_IT (it
, &it_backup
, backup_data
);
8598 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8604 /* Check whether TO_Y is in this line. */
8605 line_height
= it
->max_ascent
+ it
->max_descent
;
8606 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8608 if (to_y
>= it
->current_y
8609 && to_y
< it
->current_y
+ line_height
)
8611 /* When word-wrap is on, TO_X may lie past the end
8612 of a wrapped line. Then it->current is the
8613 character on the next line, so backtrack to the
8614 space before the wrap point. */
8615 if (skip
== MOVE_LINE_CONTINUED
8616 && it
->line_wrap
== WORD_WRAP
)
8618 int prev_x
= max (it
->current_x
- 1, 0);
8619 RESTORE_IT (it
, &it_backup
, backup_data
);
8620 skip
= move_it_in_display_line_to
8621 (it
, -1, prev_x
, MOVE_TO_X
);
8630 else if (BUFFERP (it
->object
)
8631 && (it
->method
== GET_FROM_BUFFER
8632 || it
->method
== GET_FROM_STRETCH
)
8633 && IT_CHARPOS (*it
) >= to_charpos
8634 /* Under bidi iteration, a call to set_iterator_to_next
8635 can scan far beyond to_charpos if the initial
8636 portion of the next line needs to be reordered. In
8637 that case, give move_it_in_display_line_to another
8640 && it
->bidi_it
.scan_dir
== -1))
8641 skip
= MOVE_POS_MATCH_OR_ZV
;
8643 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8647 case MOVE_POS_MATCH_OR_ZV
:
8651 case MOVE_NEWLINE_OR_CR
:
8652 set_iterator_to_next (it
, 1);
8653 it
->continuation_lines_width
= 0;
8656 case MOVE_LINE_TRUNCATED
:
8657 it
->continuation_lines_width
= 0;
8658 reseat_at_next_visible_line_start (it
, 0);
8659 if ((op
& MOVE_TO_POS
) != 0
8660 && IT_CHARPOS (*it
) > to_charpos
)
8667 case MOVE_LINE_CONTINUED
:
8668 /* For continued lines ending in a tab, some of the glyphs
8669 associated with the tab are displayed on the current
8670 line. Since it->current_x does not include these glyphs,
8671 we use it->last_visible_x instead. */
8674 it
->continuation_lines_width
+= it
->last_visible_x
;
8675 /* When moving by vpos, ensure that the iterator really
8676 advances to the next line (bug#847, bug#969). Fixme:
8677 do we need to do this in other circumstances? */
8678 if (it
->current_x
!= it
->last_visible_x
8679 && (op
& MOVE_TO_VPOS
)
8680 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8682 line_start_x
= it
->current_x
+ it
->pixel_width
8683 - it
->last_visible_x
;
8684 set_iterator_to_next (it
, 0);
8688 it
->continuation_lines_width
+= it
->current_x
;
8695 /* Reset/increment for the next run. */
8696 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8697 it
->current_x
= line_start_x
;
8700 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8702 last_height
= it
->max_ascent
+ it
->max_descent
;
8703 last_max_ascent
= it
->max_ascent
;
8704 it
->max_ascent
= it
->max_descent
= 0;
8709 /* On text terminals, we may stop at the end of a line in the middle
8710 of a multi-character glyph. If the glyph itself is continued,
8711 i.e. it is actually displayed on the next line, don't treat this
8712 stopping point as valid; move to the next line instead (unless
8713 that brings us offscreen). */
8714 if (!FRAME_WINDOW_P (it
->f
)
8716 && IT_CHARPOS (*it
) == to_charpos
8717 && it
->what
== IT_CHARACTER
8719 && it
->line_wrap
== WINDOW_WRAP
8720 && it
->current_x
== it
->last_visible_x
- 1
8723 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8725 it
->continuation_lines_width
+= it
->current_x
;
8726 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8727 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8729 last_height
= it
->max_ascent
+ it
->max_descent
;
8730 last_max_ascent
= it
->max_ascent
;
8734 bidi_unshelve_cache (backup_data
, 1);
8736 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8740 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8742 If DY > 0, move IT backward at least that many pixels. DY = 0
8743 means move IT backward to the preceding line start or BEGV. This
8744 function may move over more than DY pixels if IT->current_y - DY
8745 ends up in the middle of a line; in this case IT->current_y will be
8746 set to the top of the line moved to. */
8749 move_it_vertically_backward (struct it
*it
, int dy
)
8753 void *it2data
= NULL
, *it3data
= NULL
;
8754 EMACS_INT start_pos
;
8759 start_pos
= IT_CHARPOS (*it
);
8761 /* Estimate how many newlines we must move back. */
8762 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8764 /* Set the iterator's position that many lines back. */
8765 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8766 back_to_previous_visible_line_start (it
);
8768 /* Reseat the iterator here. When moving backward, we don't want
8769 reseat to skip forward over invisible text, set up the iterator
8770 to deliver from overlay strings at the new position etc. So,
8771 use reseat_1 here. */
8772 reseat_1 (it
, it
->current
.pos
, 1);
8774 /* We are now surely at a line start. */
8775 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8776 reordering is in effect. */
8777 it
->continuation_lines_width
= 0;
8779 /* Move forward and see what y-distance we moved. First move to the
8780 start of the next line so that we get its height. We need this
8781 height to be able to tell whether we reached the specified
8783 SAVE_IT (it2
, *it
, it2data
);
8784 it2
.max_ascent
= it2
.max_descent
= 0;
8787 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8788 MOVE_TO_POS
| MOVE_TO_VPOS
);
8790 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8791 /* If we are in a display string which starts at START_POS,
8792 and that display string includes a newline, and we are
8793 right after that newline (i.e. at the beginning of a
8794 display line), exit the loop, because otherwise we will
8795 infloop, since move_it_to will see that it is already at
8796 START_POS and will not move. */
8797 || (it2
.method
== GET_FROM_STRING
8798 && IT_CHARPOS (it2
) == start_pos
8799 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8800 xassert (IT_CHARPOS (*it
) >= BEGV
);
8801 SAVE_IT (it3
, it2
, it3data
);
8803 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8804 xassert (IT_CHARPOS (*it
) >= BEGV
);
8805 /* H is the actual vertical distance from the position in *IT
8806 and the starting position. */
8807 h
= it2
.current_y
- it
->current_y
;
8808 /* NLINES is the distance in number of lines. */
8809 nlines
= it2
.vpos
- it
->vpos
;
8811 /* Correct IT's y and vpos position
8812 so that they are relative to the starting point. */
8818 /* DY == 0 means move to the start of the screen line. The
8819 value of nlines is > 0 if continuation lines were involved,
8820 or if the original IT position was at start of a line. */
8821 RESTORE_IT (it
, it
, it2data
);
8823 move_it_by_lines (it
, nlines
);
8824 /* The above code moves us to some position NLINES down,
8825 usually to its first glyph (leftmost in an L2R line), but
8826 that's not necessarily the start of the line, under bidi
8827 reordering. We want to get to the character position
8828 that is immediately after the newline of the previous
8831 && !it
->continuation_lines_width
8832 && !STRINGP (it
->string
)
8833 && IT_CHARPOS (*it
) > BEGV
8834 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8837 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8839 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8841 bidi_unshelve_cache (it3data
, 1);
8845 /* The y-position we try to reach, relative to *IT.
8846 Note that H has been subtracted in front of the if-statement. */
8847 int target_y
= it
->current_y
+ h
- dy
;
8848 int y0
= it3
.current_y
;
8852 RESTORE_IT (&it3
, &it3
, it3data
);
8853 y1
= line_bottom_y (&it3
);
8854 line_height
= y1
- y0
;
8855 RESTORE_IT (it
, it
, it2data
);
8856 /* If we did not reach target_y, try to move further backward if
8857 we can. If we moved too far backward, try to move forward. */
8858 if (target_y
< it
->current_y
8859 /* This is heuristic. In a window that's 3 lines high, with
8860 a line height of 13 pixels each, recentering with point
8861 on the bottom line will try to move -39/2 = 19 pixels
8862 backward. Try to avoid moving into the first line. */
8863 && (it
->current_y
- target_y
8864 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8865 && IT_CHARPOS (*it
) > BEGV
)
8867 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8868 target_y
- it
->current_y
));
8869 dy
= it
->current_y
- target_y
;
8870 goto move_further_back
;
8872 else if (target_y
>= it
->current_y
+ line_height
8873 && IT_CHARPOS (*it
) < ZV
)
8875 /* Should move forward by at least one line, maybe more.
8877 Note: Calling move_it_by_lines can be expensive on
8878 terminal frames, where compute_motion is used (via
8879 vmotion) to do the job, when there are very long lines
8880 and truncate-lines is nil. That's the reason for
8881 treating terminal frames specially here. */
8883 if (!FRAME_WINDOW_P (it
->f
))
8884 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8889 move_it_by_lines (it
, 1);
8891 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8898 /* Move IT by a specified amount of pixel lines DY. DY negative means
8899 move backwards. DY = 0 means move to start of screen line. At the
8900 end, IT will be on the start of a screen line. */
8903 move_it_vertically (struct it
*it
, int dy
)
8906 move_it_vertically_backward (it
, -dy
);
8909 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8910 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8911 MOVE_TO_POS
| MOVE_TO_Y
);
8912 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8914 /* If buffer ends in ZV without a newline, move to the start of
8915 the line to satisfy the post-condition. */
8916 if (IT_CHARPOS (*it
) == ZV
8918 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8919 move_it_by_lines (it
, 0);
8924 /* Move iterator IT past the end of the text line it is in. */
8927 move_it_past_eol (struct it
*it
)
8929 enum move_it_result rc
;
8931 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8932 if (rc
== MOVE_NEWLINE_OR_CR
)
8933 set_iterator_to_next (it
, 0);
8937 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8938 negative means move up. DVPOS == 0 means move to the start of the
8941 Optimization idea: If we would know that IT->f doesn't use
8942 a face with proportional font, we could be faster for
8943 truncate-lines nil. */
8946 move_it_by_lines (struct it
*it
, int dvpos
)
8949 /* The commented-out optimization uses vmotion on terminals. This
8950 gives bad results, because elements like it->what, on which
8951 callers such as pos_visible_p rely, aren't updated. */
8952 /* struct position pos;
8953 if (!FRAME_WINDOW_P (it->f))
8955 struct text_pos textpos;
8957 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8958 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8959 reseat (it, textpos, 1);
8960 it->vpos += pos.vpos;
8961 it->current_y += pos.vpos;
8967 /* DVPOS == 0 means move to the start of the screen line. */
8968 move_it_vertically_backward (it
, 0);
8969 /* Let next call to line_bottom_y calculate real line height */
8974 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8975 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8976 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8981 void *it2data
= NULL
;
8982 EMACS_INT start_charpos
, i
;
8984 /* Start at the beginning of the screen line containing IT's
8985 position. This may actually move vertically backwards,
8986 in case of overlays, so adjust dvpos accordingly. */
8988 move_it_vertically_backward (it
, 0);
8991 /* Go back -DVPOS visible lines and reseat the iterator there. */
8992 start_charpos
= IT_CHARPOS (*it
);
8993 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8994 back_to_previous_visible_line_start (it
);
8995 reseat (it
, it
->current
.pos
, 1);
8997 /* Move further back if we end up in a string or an image. */
8998 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9000 /* First try to move to start of display line. */
9002 move_it_vertically_backward (it
, 0);
9004 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9006 /* If start of line is still in string or image,
9007 move further back. */
9008 back_to_previous_visible_line_start (it
);
9009 reseat (it
, it
->current
.pos
, 1);
9013 it
->current_x
= it
->hpos
= 0;
9015 /* Above call may have moved too far if continuation lines
9016 are involved. Scan forward and see if it did. */
9017 SAVE_IT (it2
, *it
, it2data
);
9018 it2
.vpos
= it2
.current_y
= 0;
9019 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9020 it
->vpos
-= it2
.vpos
;
9021 it
->current_y
-= it2
.current_y
;
9022 it
->current_x
= it
->hpos
= 0;
9024 /* If we moved too far back, move IT some lines forward. */
9025 if (it2
.vpos
> -dvpos
)
9027 int delta
= it2
.vpos
+ dvpos
;
9029 RESTORE_IT (&it2
, &it2
, it2data
);
9030 SAVE_IT (it2
, *it
, it2data
);
9031 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9032 /* Move back again if we got too far ahead. */
9033 if (IT_CHARPOS (*it
) >= start_charpos
)
9034 RESTORE_IT (it
, &it2
, it2data
);
9036 bidi_unshelve_cache (it2data
, 1);
9039 RESTORE_IT (it
, it
, it2data
);
9043 /* Return 1 if IT points into the middle of a display vector. */
9046 in_display_vector_p (struct it
*it
)
9048 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9049 && it
->current
.dpvec_index
> 0
9050 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9054 /***********************************************************************
9056 ***********************************************************************/
9059 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9063 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9065 Lisp_Object args
[3];
9066 Lisp_Object msg
, fmt
;
9069 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9072 /* Do nothing if called asynchronously. Inserting text into
9073 a buffer may call after-change-functions and alike and
9074 that would means running Lisp asynchronously. */
9075 if (handling_signal
)
9079 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9081 args
[0] = fmt
= build_string (format
);
9084 msg
= Fformat (3, args
);
9086 len
= SBYTES (msg
) + 1;
9087 SAFE_ALLOCA (buffer
, char *, len
);
9088 memcpy (buffer
, SDATA (msg
), len
);
9090 message_dolog (buffer
, len
- 1, 1, 0);
9097 /* Output a newline in the *Messages* buffer if "needs" one. */
9100 message_log_maybe_newline (void)
9102 if (message_log_need_newline
)
9103 message_dolog ("", 0, 1, 0);
9107 /* Add a string M of length NBYTES to the message log, optionally
9108 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9109 nonzero, means interpret the contents of M as multibyte. This
9110 function calls low-level routines in order to bypass text property
9111 hooks, etc. which might not be safe to run.
9113 This may GC (insert may run before/after change hooks),
9114 so the buffer M must NOT point to a Lisp string. */
9117 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9119 const unsigned char *msg
= (const unsigned char *) m
;
9121 if (!NILP (Vmemory_full
))
9124 if (!NILP (Vmessage_log_max
))
9126 struct buffer
*oldbuf
;
9127 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9128 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9129 EMACS_INT point_at_end
= 0;
9130 EMACS_INT zv_at_end
= 0;
9131 Lisp_Object old_deactivate_mark
, tem
;
9132 struct gcpro gcpro1
;
9134 old_deactivate_mark
= Vdeactivate_mark
;
9135 oldbuf
= current_buffer
;
9136 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9137 BVAR (current_buffer
, undo_list
) = Qt
;
9139 oldpoint
= message_dolog_marker1
;
9140 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9141 oldbegv
= message_dolog_marker2
;
9142 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9143 oldzv
= message_dolog_marker3
;
9144 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9145 GCPRO1 (old_deactivate_mark
);
9153 BEGV_BYTE
= BEG_BYTE
;
9156 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9158 /* Insert the string--maybe converting multibyte to single byte
9159 or vice versa, so that all the text fits the buffer. */
9161 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9167 /* Convert a multibyte string to single-byte
9168 for the *Message* buffer. */
9169 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9171 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9172 work
[0] = (ASCII_CHAR_P (c
)
9174 : multibyte_char_to_unibyte (c
));
9175 insert_1_both (work
, 1, 1, 1, 0, 0);
9178 else if (! multibyte
9179 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9183 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9184 /* Convert a single-byte string to multibyte
9185 for the *Message* buffer. */
9186 for (i
= 0; i
< nbytes
; i
++)
9189 MAKE_CHAR_MULTIBYTE (c
);
9190 char_bytes
= CHAR_STRING (c
, str
);
9191 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9195 insert_1 (m
, nbytes
, 1, 0, 0);
9199 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9201 insert_1 ("\n", 1, 1, 0, 0);
9203 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9205 this_bol_byte
= PT_BYTE
;
9207 /* See if this line duplicates the previous one.
9208 If so, combine duplicates. */
9211 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9213 prev_bol_byte
= PT_BYTE
;
9215 dups
= message_log_check_duplicate (prev_bol_byte
,
9219 del_range_both (prev_bol
, prev_bol_byte
,
9220 this_bol
, this_bol_byte
, 0);
9223 char dupstr
[sizeof " [ times]"
9224 + INT_STRLEN_BOUND (printmax_t
)];
9227 /* If you change this format, don't forget to also
9228 change message_log_check_duplicate. */
9229 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9230 duplen
= strlen (dupstr
);
9231 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9232 insert_1 (dupstr
, duplen
, 1, 0, 1);
9237 /* If we have more than the desired maximum number of lines
9238 in the *Messages* buffer now, delete the oldest ones.
9239 This is safe because we don't have undo in this buffer. */
9241 if (NATNUMP (Vmessage_log_max
))
9243 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9244 -XFASTINT (Vmessage_log_max
) - 1, 0);
9245 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9248 BEGV
= XMARKER (oldbegv
)->charpos
;
9249 BEGV_BYTE
= marker_byte_position (oldbegv
);
9258 ZV
= XMARKER (oldzv
)->charpos
;
9259 ZV_BYTE
= marker_byte_position (oldzv
);
9263 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9265 /* We can't do Fgoto_char (oldpoint) because it will run some
9267 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9268 XMARKER (oldpoint
)->bytepos
);
9271 unchain_marker (XMARKER (oldpoint
));
9272 unchain_marker (XMARKER (oldbegv
));
9273 unchain_marker (XMARKER (oldzv
));
9275 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9276 set_buffer_internal (oldbuf
);
9278 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9279 message_log_need_newline
= !nlflag
;
9280 Vdeactivate_mark
= old_deactivate_mark
;
9285 /* We are at the end of the buffer after just having inserted a newline.
9286 (Note: We depend on the fact we won't be crossing the gap.)
9287 Check to see if the most recent message looks a lot like the previous one.
9288 Return 0 if different, 1 if the new one should just replace it, or a
9289 value N > 1 if we should also append " [N times]". */
9292 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9295 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9297 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9298 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9300 for (i
= 0; i
< len
; i
++)
9302 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9310 if (*p1
++ == ' ' && *p1
++ == '[')
9313 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9314 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9321 /* Display an echo area message M with a specified length of NBYTES
9322 bytes. The string may include null characters. If M is 0, clear
9323 out any existing message, and let the mini-buffer text show
9326 This may GC, so the buffer M must NOT point to a Lisp string. */
9329 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9331 /* First flush out any partial line written with print. */
9332 message_log_maybe_newline ();
9334 message_dolog (m
, nbytes
, 1, multibyte
);
9335 message2_nolog (m
, nbytes
, multibyte
);
9339 /* The non-logging counterpart of message2. */
9342 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9344 struct frame
*sf
= SELECTED_FRAME ();
9345 message_enable_multibyte
= multibyte
;
9347 if (FRAME_INITIAL_P (sf
))
9349 if (noninteractive_need_newline
)
9350 putc ('\n', stderr
);
9351 noninteractive_need_newline
= 0;
9353 fwrite (m
, nbytes
, 1, stderr
);
9354 if (cursor_in_echo_area
== 0)
9355 fprintf (stderr
, "\n");
9358 /* A null message buffer means that the frame hasn't really been
9359 initialized yet. Error messages get reported properly by
9360 cmd_error, so this must be just an informative message; toss it. */
9361 else if (INTERACTIVE
9362 && sf
->glyphs_initialized_p
9363 && FRAME_MESSAGE_BUF (sf
))
9365 Lisp_Object mini_window
;
9368 /* Get the frame containing the mini-buffer
9369 that the selected frame is using. */
9370 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9371 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9373 FRAME_SAMPLE_VISIBILITY (f
);
9374 if (FRAME_VISIBLE_P (sf
)
9375 && ! FRAME_VISIBLE_P (f
))
9376 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9380 set_message (m
, Qnil
, nbytes
, multibyte
);
9381 if (minibuffer_auto_raise
)
9382 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9385 clear_message (1, 1);
9387 do_pending_window_change (0);
9388 echo_area_display (1);
9389 do_pending_window_change (0);
9390 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9391 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9396 /* Display an echo area message M with a specified length of NBYTES
9397 bytes. The string may include null characters. If M is not a
9398 string, clear out any existing message, and let the mini-buffer
9401 This function cancels echoing. */
9404 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9406 struct gcpro gcpro1
;
9409 clear_message (1,1);
9412 /* First flush out any partial line written with print. */
9413 message_log_maybe_newline ();
9419 SAFE_ALLOCA (buffer
, char *, nbytes
);
9420 memcpy (buffer
, SDATA (m
), nbytes
);
9421 message_dolog (buffer
, nbytes
, 1, multibyte
);
9424 message3_nolog (m
, nbytes
, multibyte
);
9430 /* The non-logging version of message3.
9431 This does not cancel echoing, because it is used for echoing.
9432 Perhaps we need to make a separate function for echoing
9433 and make this cancel echoing. */
9436 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9438 struct frame
*sf
= SELECTED_FRAME ();
9439 message_enable_multibyte
= multibyte
;
9441 if (FRAME_INITIAL_P (sf
))
9443 if (noninteractive_need_newline
)
9444 putc ('\n', stderr
);
9445 noninteractive_need_newline
= 0;
9447 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9448 if (cursor_in_echo_area
== 0)
9449 fprintf (stderr
, "\n");
9452 /* A null message buffer means that the frame hasn't really been
9453 initialized yet. Error messages get reported properly by
9454 cmd_error, so this must be just an informative message; toss it. */
9455 else if (INTERACTIVE
9456 && sf
->glyphs_initialized_p
9457 && FRAME_MESSAGE_BUF (sf
))
9459 Lisp_Object mini_window
;
9463 /* Get the frame containing the mini-buffer
9464 that the selected frame is using. */
9465 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9466 frame
= XWINDOW (mini_window
)->frame
;
9469 FRAME_SAMPLE_VISIBILITY (f
);
9470 if (FRAME_VISIBLE_P (sf
)
9471 && !FRAME_VISIBLE_P (f
))
9472 Fmake_frame_visible (frame
);
9474 if (STRINGP (m
) && SCHARS (m
) > 0)
9476 set_message (NULL
, m
, nbytes
, multibyte
);
9477 if (minibuffer_auto_raise
)
9478 Fraise_frame (frame
);
9479 /* Assume we are not echoing.
9480 (If we are, echo_now will override this.) */
9481 echo_message_buffer
= Qnil
;
9484 clear_message (1, 1);
9486 do_pending_window_change (0);
9487 echo_area_display (1);
9488 do_pending_window_change (0);
9489 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9490 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9495 /* Display a null-terminated echo area message M. If M is 0, clear
9496 out any existing message, and let the mini-buffer text show through.
9498 The buffer M must continue to exist until after the echo area gets
9499 cleared or some other message gets displayed there. Do not pass
9500 text that is stored in a Lisp string. Do not pass text in a buffer
9501 that was alloca'd. */
9504 message1 (const char *m
)
9506 message2 (m
, (m
? strlen (m
) : 0), 0);
9510 /* The non-logging counterpart of message1. */
9513 message1_nolog (const char *m
)
9515 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9518 /* Display a message M which contains a single %s
9519 which gets replaced with STRING. */
9522 message_with_string (const char *m
, Lisp_Object string
, int log
)
9524 CHECK_STRING (string
);
9530 if (noninteractive_need_newline
)
9531 putc ('\n', stderr
);
9532 noninteractive_need_newline
= 0;
9533 fprintf (stderr
, m
, SDATA (string
));
9534 if (!cursor_in_echo_area
)
9535 fprintf (stderr
, "\n");
9539 else if (INTERACTIVE
)
9541 /* The frame whose minibuffer we're going to display the message on.
9542 It may be larger than the selected frame, so we need
9543 to use its buffer, not the selected frame's buffer. */
9544 Lisp_Object mini_window
;
9545 struct frame
*f
, *sf
= SELECTED_FRAME ();
9547 /* Get the frame containing the minibuffer
9548 that the selected frame is using. */
9549 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9550 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9552 /* A null message buffer means that the frame hasn't really been
9553 initialized yet. Error messages get reported properly by
9554 cmd_error, so this must be just an informative message; toss it. */
9555 if (FRAME_MESSAGE_BUF (f
))
9557 Lisp_Object args
[2], msg
;
9558 struct gcpro gcpro1
, gcpro2
;
9560 args
[0] = build_string (m
);
9561 args
[1] = msg
= string
;
9562 GCPRO2 (args
[0], msg
);
9565 msg
= Fformat (2, args
);
9568 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9570 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9574 /* Print should start at the beginning of the message
9575 buffer next time. */
9576 message_buf_print
= 0;
9582 /* Dump an informative message to the minibuf. If M is 0, clear out
9583 any existing message, and let the mini-buffer text show through. */
9586 vmessage (const char *m
, va_list ap
)
9592 if (noninteractive_need_newline
)
9593 putc ('\n', stderr
);
9594 noninteractive_need_newline
= 0;
9595 vfprintf (stderr
, m
, ap
);
9596 if (cursor_in_echo_area
== 0)
9597 fprintf (stderr
, "\n");
9601 else if (INTERACTIVE
)
9603 /* The frame whose mini-buffer we're going to display the message
9604 on. It may be larger than the selected frame, so we need to
9605 use its buffer, not the selected frame's buffer. */
9606 Lisp_Object mini_window
;
9607 struct frame
*f
, *sf
= SELECTED_FRAME ();
9609 /* Get the frame containing the mini-buffer
9610 that the selected frame is using. */
9611 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9612 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9614 /* A null message buffer means that the frame hasn't really been
9615 initialized yet. Error messages get reported properly by
9616 cmd_error, so this must be just an informative message; toss
9618 if (FRAME_MESSAGE_BUF (f
))
9624 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9625 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9627 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9632 /* Print should start at the beginning of the message
9633 buffer next time. */
9634 message_buf_print
= 0;
9640 message (const char *m
, ...)
9650 /* The non-logging version of message. */
9653 message_nolog (const char *m
, ...)
9655 Lisp_Object old_log_max
;
9658 old_log_max
= Vmessage_log_max
;
9659 Vmessage_log_max
= Qnil
;
9661 Vmessage_log_max
= old_log_max
;
9667 /* Display the current message in the current mini-buffer. This is
9668 only called from error handlers in process.c, and is not time
9672 update_echo_area (void)
9674 if (!NILP (echo_area_buffer
[0]))
9677 string
= Fcurrent_message ();
9678 message3 (string
, SBYTES (string
),
9679 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9684 /* Make sure echo area buffers in `echo_buffers' are live.
9685 If they aren't, make new ones. */
9688 ensure_echo_area_buffers (void)
9692 for (i
= 0; i
< 2; ++i
)
9693 if (!BUFFERP (echo_buffer
[i
])
9694 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9697 Lisp_Object old_buffer
;
9700 old_buffer
= echo_buffer
[i
];
9701 sprintf (name
, " *Echo Area %d*", i
);
9702 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9703 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9704 /* to force word wrap in echo area -
9705 it was decided to postpone this*/
9706 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9708 for (j
= 0; j
< 2; ++j
)
9709 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9710 echo_area_buffer
[j
] = echo_buffer
[i
];
9715 /* Call FN with args A1..A4 with either the current or last displayed
9716 echo_area_buffer as current buffer.
9718 WHICH zero means use the current message buffer
9719 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9720 from echo_buffer[] and clear it.
9722 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9723 suitable buffer from echo_buffer[] and clear it.
9725 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9726 that the current message becomes the last displayed one, make
9727 choose a suitable buffer for echo_area_buffer[0], and clear it.
9729 Value is what FN returns. */
9732 with_echo_area_buffer (struct window
*w
, int which
,
9733 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9734 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9737 int this_one
, the_other
, clear_buffer_p
, rc
;
9738 int count
= SPECPDL_INDEX ();
9740 /* If buffers aren't live, make new ones. */
9741 ensure_echo_area_buffers ();
9746 this_one
= 0, the_other
= 1;
9748 this_one
= 1, the_other
= 0;
9751 this_one
= 0, the_other
= 1;
9754 /* We need a fresh one in case the current echo buffer equals
9755 the one containing the last displayed echo area message. */
9756 if (!NILP (echo_area_buffer
[this_one
])
9757 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9758 echo_area_buffer
[this_one
] = Qnil
;
9761 /* Choose a suitable buffer from echo_buffer[] is we don't
9763 if (NILP (echo_area_buffer
[this_one
]))
9765 echo_area_buffer
[this_one
]
9766 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9767 ? echo_buffer
[the_other
]
9768 : echo_buffer
[this_one
]);
9772 buffer
= echo_area_buffer
[this_one
];
9774 /* Don't get confused by reusing the buffer used for echoing
9775 for a different purpose. */
9776 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9779 record_unwind_protect (unwind_with_echo_area_buffer
,
9780 with_echo_area_buffer_unwind_data (w
));
9782 /* Make the echo area buffer current. Note that for display
9783 purposes, it is not necessary that the displayed window's buffer
9784 == current_buffer, except for text property lookup. So, let's
9785 only set that buffer temporarily here without doing a full
9786 Fset_window_buffer. We must also change w->pointm, though,
9787 because otherwise an assertions in unshow_buffer fails, and Emacs
9789 set_buffer_internal_1 (XBUFFER (buffer
));
9793 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9796 BVAR (current_buffer
, undo_list
) = Qt
;
9797 BVAR (current_buffer
, read_only
) = Qnil
;
9798 specbind (Qinhibit_read_only
, Qt
);
9799 specbind (Qinhibit_modification_hooks
, Qt
);
9801 if (clear_buffer_p
&& Z
> BEG
)
9804 xassert (BEGV
>= BEG
);
9805 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9807 rc
= fn (a1
, a2
, a3
, a4
);
9809 xassert (BEGV
>= BEG
);
9810 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9812 unbind_to (count
, Qnil
);
9817 /* Save state that should be preserved around the call to the function
9818 FN called in with_echo_area_buffer. */
9821 with_echo_area_buffer_unwind_data (struct window
*w
)
9824 Lisp_Object vector
, tmp
;
9826 /* Reduce consing by keeping one vector in
9827 Vwith_echo_area_save_vector. */
9828 vector
= Vwith_echo_area_save_vector
;
9829 Vwith_echo_area_save_vector
= Qnil
;
9832 vector
= Fmake_vector (make_number (7), Qnil
);
9834 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9835 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9836 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9840 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9841 ASET (vector
, i
, w
->buffer
); ++i
;
9842 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9843 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9848 for (; i
< end
; ++i
)
9849 ASET (vector
, i
, Qnil
);
9852 xassert (i
== ASIZE (vector
));
9857 /* Restore global state from VECTOR which was created by
9858 with_echo_area_buffer_unwind_data. */
9861 unwind_with_echo_area_buffer (Lisp_Object vector
)
9863 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9864 Vdeactivate_mark
= AREF (vector
, 1);
9865 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9867 if (WINDOWP (AREF (vector
, 3)))
9870 Lisp_Object buffer
, charpos
, bytepos
;
9872 w
= XWINDOW (AREF (vector
, 3));
9873 buffer
= AREF (vector
, 4);
9874 charpos
= AREF (vector
, 5);
9875 bytepos
= AREF (vector
, 6);
9878 set_marker_both (w
->pointm
, buffer
,
9879 XFASTINT (charpos
), XFASTINT (bytepos
));
9882 Vwith_echo_area_save_vector
= vector
;
9887 /* Set up the echo area for use by print functions. MULTIBYTE_P
9888 non-zero means we will print multibyte. */
9891 setup_echo_area_for_printing (int multibyte_p
)
9893 /* If we can't find an echo area any more, exit. */
9894 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9897 ensure_echo_area_buffers ();
9899 if (!message_buf_print
)
9901 /* A message has been output since the last time we printed.
9902 Choose a fresh echo area buffer. */
9903 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9904 echo_area_buffer
[0] = echo_buffer
[1];
9906 echo_area_buffer
[0] = echo_buffer
[0];
9908 /* Switch to that buffer and clear it. */
9909 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9910 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9914 int count
= SPECPDL_INDEX ();
9915 specbind (Qinhibit_read_only
, Qt
);
9916 /* Note that undo recording is always disabled. */
9918 unbind_to (count
, Qnil
);
9920 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9922 /* Set up the buffer for the multibyteness we need. */
9924 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9925 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9927 /* Raise the frame containing the echo area. */
9928 if (minibuffer_auto_raise
)
9930 struct frame
*sf
= SELECTED_FRAME ();
9931 Lisp_Object mini_window
;
9932 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9933 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9936 message_log_maybe_newline ();
9937 message_buf_print
= 1;
9941 if (NILP (echo_area_buffer
[0]))
9943 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9944 echo_area_buffer
[0] = echo_buffer
[1];
9946 echo_area_buffer
[0] = echo_buffer
[0];
9949 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9951 /* Someone switched buffers between print requests. */
9952 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9953 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9959 /* Display an echo area message in window W. Value is non-zero if W's
9960 height is changed. If display_last_displayed_message_p is
9961 non-zero, display the message that was last displayed, otherwise
9962 display the current message. */
9965 display_echo_area (struct window
*w
)
9967 int i
, no_message_p
, window_height_changed_p
, count
;
9969 /* Temporarily disable garbage collections while displaying the echo
9970 area. This is done because a GC can print a message itself.
9971 That message would modify the echo area buffer's contents while a
9972 redisplay of the buffer is going on, and seriously confuse
9974 count
= inhibit_garbage_collection ();
9976 /* If there is no message, we must call display_echo_area_1
9977 nevertheless because it resizes the window. But we will have to
9978 reset the echo_area_buffer in question to nil at the end because
9979 with_echo_area_buffer will sets it to an empty buffer. */
9980 i
= display_last_displayed_message_p
? 1 : 0;
9981 no_message_p
= NILP (echo_area_buffer
[i
]);
9983 window_height_changed_p
9984 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9985 display_echo_area_1
,
9986 (intptr_t) w
, Qnil
, 0, 0);
9989 echo_area_buffer
[i
] = Qnil
;
9991 unbind_to (count
, Qnil
);
9992 return window_height_changed_p
;
9996 /* Helper for display_echo_area. Display the current buffer which
9997 contains the current echo area message in window W, a mini-window,
9998 a pointer to which is passed in A1. A2..A4 are currently not used.
9999 Change the height of W so that all of the message is displayed.
10000 Value is non-zero if height of W was changed. */
10003 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10006 struct window
*w
= (struct window
*) i1
;
10007 Lisp_Object window
;
10008 struct text_pos start
;
10009 int window_height_changed_p
= 0;
10011 /* Do this before displaying, so that we have a large enough glyph
10012 matrix for the display. If we can't get enough space for the
10013 whole text, display the last N lines. That works by setting w->start. */
10014 window_height_changed_p
= resize_mini_window (w
, 0);
10016 /* Use the starting position chosen by resize_mini_window. */
10017 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10020 clear_glyph_matrix (w
->desired_matrix
);
10021 XSETWINDOW (window
, w
);
10022 try_window (window
, start
, 0);
10024 return window_height_changed_p
;
10028 /* Resize the echo area window to exactly the size needed for the
10029 currently displayed message, if there is one. If a mini-buffer
10030 is active, don't shrink it. */
10033 resize_echo_area_exactly (void)
10035 if (BUFFERP (echo_area_buffer
[0])
10036 && WINDOWP (echo_area_window
))
10038 struct window
*w
= XWINDOW (echo_area_window
);
10040 Lisp_Object resize_exactly
;
10042 if (minibuf_level
== 0)
10043 resize_exactly
= Qt
;
10045 resize_exactly
= Qnil
;
10047 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10048 (intptr_t) w
, resize_exactly
,
10052 ++windows_or_buffers_changed
;
10053 ++update_mode_lines
;
10054 redisplay_internal ();
10060 /* Callback function for with_echo_area_buffer, when used from
10061 resize_echo_area_exactly. A1 contains a pointer to the window to
10062 resize, EXACTLY non-nil means resize the mini-window exactly to the
10063 size of the text displayed. A3 and A4 are not used. Value is what
10064 resize_mini_window returns. */
10067 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10070 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10074 /* Resize mini-window W to fit the size of its contents. EXACT_P
10075 means size the window exactly to the size needed. Otherwise, it's
10076 only enlarged until W's buffer is empty.
10078 Set W->start to the right place to begin display. If the whole
10079 contents fit, start at the beginning. Otherwise, start so as
10080 to make the end of the contents appear. This is particularly
10081 important for y-or-n-p, but seems desirable generally.
10083 Value is non-zero if the window height has been changed. */
10086 resize_mini_window (struct window
*w
, int exact_p
)
10088 struct frame
*f
= XFRAME (w
->frame
);
10089 int window_height_changed_p
= 0;
10091 xassert (MINI_WINDOW_P (w
));
10093 /* By default, start display at the beginning. */
10094 set_marker_both (w
->start
, w
->buffer
,
10095 BUF_BEGV (XBUFFER (w
->buffer
)),
10096 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10098 /* Don't resize windows while redisplaying a window; it would
10099 confuse redisplay functions when the size of the window they are
10100 displaying changes from under them. Such a resizing can happen,
10101 for instance, when which-func prints a long message while
10102 we are running fontification-functions. We're running these
10103 functions with safe_call which binds inhibit-redisplay to t. */
10104 if (!NILP (Vinhibit_redisplay
))
10107 /* Nil means don't try to resize. */
10108 if (NILP (Vresize_mini_windows
)
10109 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10112 if (!FRAME_MINIBUF_ONLY_P (f
))
10115 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10116 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10117 int height
, max_height
;
10118 int unit
= FRAME_LINE_HEIGHT (f
);
10119 struct text_pos start
;
10120 struct buffer
*old_current_buffer
= NULL
;
10122 if (current_buffer
!= XBUFFER (w
->buffer
))
10124 old_current_buffer
= current_buffer
;
10125 set_buffer_internal (XBUFFER (w
->buffer
));
10128 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10130 /* Compute the max. number of lines specified by the user. */
10131 if (FLOATP (Vmax_mini_window_height
))
10132 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10133 else if (INTEGERP (Vmax_mini_window_height
))
10134 max_height
= XINT (Vmax_mini_window_height
);
10136 max_height
= total_height
/ 4;
10138 /* Correct that max. height if it's bogus. */
10139 max_height
= max (1, max_height
);
10140 max_height
= min (total_height
, max_height
);
10142 /* Find out the height of the text in the window. */
10143 if (it
.line_wrap
== TRUNCATE
)
10148 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10149 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10150 height
= it
.current_y
+ last_height
;
10152 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10153 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10154 height
= (height
+ unit
- 1) / unit
;
10157 /* Compute a suitable window start. */
10158 if (height
> max_height
)
10160 height
= max_height
;
10161 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10162 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10163 start
= it
.current
.pos
;
10166 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10167 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10169 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10171 /* Let it grow only, until we display an empty message, in which
10172 case the window shrinks again. */
10173 if (height
> WINDOW_TOTAL_LINES (w
))
10175 int old_height
= WINDOW_TOTAL_LINES (w
);
10176 freeze_window_starts (f
, 1);
10177 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10178 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10180 else if (height
< WINDOW_TOTAL_LINES (w
)
10181 && (exact_p
|| BEGV
== ZV
))
10183 int old_height
= WINDOW_TOTAL_LINES (w
);
10184 freeze_window_starts (f
, 0);
10185 shrink_mini_window (w
);
10186 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10191 /* Always resize to exact size needed. */
10192 if (height
> WINDOW_TOTAL_LINES (w
))
10194 int old_height
= WINDOW_TOTAL_LINES (w
);
10195 freeze_window_starts (f
, 1);
10196 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10197 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10199 else if (height
< WINDOW_TOTAL_LINES (w
))
10201 int old_height
= WINDOW_TOTAL_LINES (w
);
10202 freeze_window_starts (f
, 0);
10203 shrink_mini_window (w
);
10207 freeze_window_starts (f
, 1);
10208 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10211 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10215 if (old_current_buffer
)
10216 set_buffer_internal (old_current_buffer
);
10219 return window_height_changed_p
;
10223 /* Value is the current message, a string, or nil if there is no
10224 current message. */
10227 current_message (void)
10231 if (!BUFFERP (echo_area_buffer
[0]))
10235 with_echo_area_buffer (0, 0, current_message_1
,
10236 (intptr_t) &msg
, Qnil
, 0, 0);
10238 echo_area_buffer
[0] = Qnil
;
10246 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10249 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10252 *msg
= make_buffer_string (BEG
, Z
, 1);
10259 /* Push the current message on Vmessage_stack for later restoration
10260 by restore_message. Value is non-zero if the current message isn't
10261 empty. This is a relatively infrequent operation, so it's not
10262 worth optimizing. */
10265 push_message (void)
10268 msg
= current_message ();
10269 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10270 return STRINGP (msg
);
10274 /* Restore message display from the top of Vmessage_stack. */
10277 restore_message (void)
10281 xassert (CONSP (Vmessage_stack
));
10282 msg
= XCAR (Vmessage_stack
);
10284 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10286 message3_nolog (msg
, 0, 0);
10290 /* Handler for record_unwind_protect calling pop_message. */
10293 pop_message_unwind (Lisp_Object dummy
)
10299 /* Pop the top-most entry off Vmessage_stack. */
10304 xassert (CONSP (Vmessage_stack
));
10305 Vmessage_stack
= XCDR (Vmessage_stack
);
10309 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10310 exits. If the stack is not empty, we have a missing pop_message
10314 check_message_stack (void)
10316 if (!NILP (Vmessage_stack
))
10321 /* Truncate to NCHARS what will be displayed in the echo area the next
10322 time we display it---but don't redisplay it now. */
10325 truncate_echo_area (EMACS_INT nchars
)
10328 echo_area_buffer
[0] = Qnil
;
10329 /* A null message buffer means that the frame hasn't really been
10330 initialized yet. Error messages get reported properly by
10331 cmd_error, so this must be just an informative message; toss it. */
10332 else if (!noninteractive
10334 && !NILP (echo_area_buffer
[0]))
10336 struct frame
*sf
= SELECTED_FRAME ();
10337 if (FRAME_MESSAGE_BUF (sf
))
10338 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10343 /* Helper function for truncate_echo_area. Truncate the current
10344 message to at most NCHARS characters. */
10347 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10349 if (BEG
+ nchars
< Z
)
10350 del_range (BEG
+ nchars
, Z
);
10352 echo_area_buffer
[0] = Qnil
;
10357 /* Set the current message to a substring of S or STRING.
10359 If STRING is a Lisp string, set the message to the first NBYTES
10360 bytes from STRING. NBYTES zero means use the whole string. If
10361 STRING is multibyte, the message will be displayed multibyte.
10363 If S is not null, set the message to the first LEN bytes of S. LEN
10364 zero means use the whole string. MULTIBYTE_P non-zero means S is
10365 multibyte. Display the message multibyte in that case.
10367 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10368 to t before calling set_message_1 (which calls insert).
10372 set_message (const char *s
, Lisp_Object string
,
10373 EMACS_INT nbytes
, int multibyte_p
)
10375 message_enable_multibyte
10376 = ((s
&& multibyte_p
)
10377 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10379 with_echo_area_buffer (0, -1, set_message_1
,
10380 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10381 message_buf_print
= 0;
10382 help_echo_showing_p
= 0;
10386 /* Helper function for set_message. Arguments have the same meaning
10387 as there, with A1 corresponding to S and A2 corresponding to STRING
10388 This function is called with the echo area buffer being
10392 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10395 const char *s
= (const char *) i1
;
10396 const unsigned char *msg
= (const unsigned char *) s
;
10397 Lisp_Object string
= a2
;
10399 /* Change multibyteness of the echo buffer appropriately. */
10400 if (message_enable_multibyte
10401 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10402 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10404 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10405 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10406 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10408 /* Insert new message at BEG. */
10409 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10411 if (STRINGP (string
))
10416 nbytes
= SBYTES (string
);
10417 nchars
= string_byte_to_char (string
, nbytes
);
10419 /* This function takes care of single/multibyte conversion. We
10420 just have to ensure that the echo area buffer has the right
10421 setting of enable_multibyte_characters. */
10422 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10427 nbytes
= strlen (s
);
10429 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10431 /* Convert from multi-byte to single-byte. */
10436 /* Convert a multibyte string to single-byte. */
10437 for (i
= 0; i
< nbytes
; i
+= n
)
10439 c
= string_char_and_length (msg
+ i
, &n
);
10440 work
[0] = (ASCII_CHAR_P (c
)
10442 : multibyte_char_to_unibyte (c
));
10443 insert_1_both (work
, 1, 1, 1, 0, 0);
10446 else if (!multibyte_p
10447 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10449 /* Convert from single-byte to multi-byte. */
10452 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10454 /* Convert a single-byte string to multibyte. */
10455 for (i
= 0; i
< nbytes
; i
++)
10458 MAKE_CHAR_MULTIBYTE (c
);
10459 n
= CHAR_STRING (c
, str
);
10460 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10464 insert_1 (s
, nbytes
, 1, 0, 0);
10471 /* Clear messages. CURRENT_P non-zero means clear the current
10472 message. LAST_DISPLAYED_P non-zero means clear the message
10476 clear_message (int current_p
, int last_displayed_p
)
10480 echo_area_buffer
[0] = Qnil
;
10481 message_cleared_p
= 1;
10484 if (last_displayed_p
)
10485 echo_area_buffer
[1] = Qnil
;
10487 message_buf_print
= 0;
10490 /* Clear garbaged frames.
10492 This function is used where the old redisplay called
10493 redraw_garbaged_frames which in turn called redraw_frame which in
10494 turn called clear_frame. The call to clear_frame was a source of
10495 flickering. I believe a clear_frame is not necessary. It should
10496 suffice in the new redisplay to invalidate all current matrices,
10497 and ensure a complete redisplay of all windows. */
10500 clear_garbaged_frames (void)
10502 if (frame_garbaged
)
10504 Lisp_Object tail
, frame
;
10505 int changed_count
= 0;
10507 FOR_EACH_FRAME (tail
, frame
)
10509 struct frame
*f
= XFRAME (frame
);
10511 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10515 Fredraw_frame (frame
);
10516 f
->force_flush_display_p
= 1;
10518 clear_current_matrices (f
);
10525 frame_garbaged
= 0;
10527 ++windows_or_buffers_changed
;
10532 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10533 is non-zero update selected_frame. Value is non-zero if the
10534 mini-windows height has been changed. */
10537 echo_area_display (int update_frame_p
)
10539 Lisp_Object mini_window
;
10542 int window_height_changed_p
= 0;
10543 struct frame
*sf
= SELECTED_FRAME ();
10545 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10546 w
= XWINDOW (mini_window
);
10547 f
= XFRAME (WINDOW_FRAME (w
));
10549 /* Don't display if frame is invisible or not yet initialized. */
10550 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10553 #ifdef HAVE_WINDOW_SYSTEM
10554 /* When Emacs starts, selected_frame may be the initial terminal
10555 frame. If we let this through, a message would be displayed on
10557 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10559 #endif /* HAVE_WINDOW_SYSTEM */
10561 /* Redraw garbaged frames. */
10562 if (frame_garbaged
)
10563 clear_garbaged_frames ();
10565 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10567 echo_area_window
= mini_window
;
10568 window_height_changed_p
= display_echo_area (w
);
10569 w
->must_be_updated_p
= 1;
10571 /* Update the display, unless called from redisplay_internal.
10572 Also don't update the screen during redisplay itself. The
10573 update will happen at the end of redisplay, and an update
10574 here could cause confusion. */
10575 if (update_frame_p
&& !redisplaying_p
)
10579 /* If the display update has been interrupted by pending
10580 input, update mode lines in the frame. Due to the
10581 pending input, it might have been that redisplay hasn't
10582 been called, so that mode lines above the echo area are
10583 garbaged. This looks odd, so we prevent it here. */
10584 if (!display_completed
)
10585 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10587 if (window_height_changed_p
10588 /* Don't do this if Emacs is shutting down. Redisplay
10589 needs to run hooks. */
10590 && !NILP (Vrun_hooks
))
10592 /* Must update other windows. Likewise as in other
10593 cases, don't let this update be interrupted by
10595 int count
= SPECPDL_INDEX ();
10596 specbind (Qredisplay_dont_pause
, Qt
);
10597 windows_or_buffers_changed
= 1;
10598 redisplay_internal ();
10599 unbind_to (count
, Qnil
);
10601 else if (FRAME_WINDOW_P (f
) && n
== 0)
10603 /* Window configuration is the same as before.
10604 Can do with a display update of the echo area,
10605 unless we displayed some mode lines. */
10606 update_single_window (w
, 1);
10607 FRAME_RIF (f
)->flush_display (f
);
10610 update_frame (f
, 1, 1);
10612 /* If cursor is in the echo area, make sure that the next
10613 redisplay displays the minibuffer, so that the cursor will
10614 be replaced with what the minibuffer wants. */
10615 if (cursor_in_echo_area
)
10616 ++windows_or_buffers_changed
;
10619 else if (!EQ (mini_window
, selected_window
))
10620 windows_or_buffers_changed
++;
10622 /* Last displayed message is now the current message. */
10623 echo_area_buffer
[1] = echo_area_buffer
[0];
10624 /* Inform read_char that we're not echoing. */
10625 echo_message_buffer
= Qnil
;
10627 /* Prevent redisplay optimization in redisplay_internal by resetting
10628 this_line_start_pos. This is done because the mini-buffer now
10629 displays the message instead of its buffer text. */
10630 if (EQ (mini_window
, selected_window
))
10631 CHARPOS (this_line_start_pos
) = 0;
10633 return window_height_changed_p
;
10638 /***********************************************************************
10639 Mode Lines and Frame Titles
10640 ***********************************************************************/
10642 /* A buffer for constructing non-propertized mode-line strings and
10643 frame titles in it; allocated from the heap in init_xdisp and
10644 resized as needed in store_mode_line_noprop_char. */
10646 static char *mode_line_noprop_buf
;
10648 /* The buffer's end, and a current output position in it. */
10650 static char *mode_line_noprop_buf_end
;
10651 static char *mode_line_noprop_ptr
;
10653 #define MODE_LINE_NOPROP_LEN(start) \
10654 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10657 MODE_LINE_DISPLAY
= 0,
10661 } mode_line_target
;
10663 /* Alist that caches the results of :propertize.
10664 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10665 static Lisp_Object mode_line_proptrans_alist
;
10667 /* List of strings making up the mode-line. */
10668 static Lisp_Object mode_line_string_list
;
10670 /* Base face property when building propertized mode line string. */
10671 static Lisp_Object mode_line_string_face
;
10672 static Lisp_Object mode_line_string_face_prop
;
10675 /* Unwind data for mode line strings */
10677 static Lisp_Object Vmode_line_unwind_vector
;
10680 format_mode_line_unwind_data (struct buffer
*obuf
,
10682 int save_proptrans
)
10684 Lisp_Object vector
, tmp
;
10686 /* Reduce consing by keeping one vector in
10687 Vwith_echo_area_save_vector. */
10688 vector
= Vmode_line_unwind_vector
;
10689 Vmode_line_unwind_vector
= Qnil
;
10692 vector
= Fmake_vector (make_number (8), Qnil
);
10694 ASET (vector
, 0, make_number (mode_line_target
));
10695 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10696 ASET (vector
, 2, mode_line_string_list
);
10697 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10698 ASET (vector
, 4, mode_line_string_face
);
10699 ASET (vector
, 5, mode_line_string_face_prop
);
10702 XSETBUFFER (tmp
, obuf
);
10705 ASET (vector
, 6, tmp
);
10706 ASET (vector
, 7, owin
);
10712 unwind_format_mode_line (Lisp_Object vector
)
10714 mode_line_target
= XINT (AREF (vector
, 0));
10715 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10716 mode_line_string_list
= AREF (vector
, 2);
10717 if (! EQ (AREF (vector
, 3), Qt
))
10718 mode_line_proptrans_alist
= AREF (vector
, 3);
10719 mode_line_string_face
= AREF (vector
, 4);
10720 mode_line_string_face_prop
= AREF (vector
, 5);
10722 if (!NILP (AREF (vector
, 7)))
10723 /* Select window before buffer, since it may change the buffer. */
10724 Fselect_window (AREF (vector
, 7), Qt
);
10726 if (!NILP (AREF (vector
, 6)))
10728 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10729 ASET (vector
, 6, Qnil
);
10732 Vmode_line_unwind_vector
= vector
;
10737 /* Store a single character C for the frame title in mode_line_noprop_buf.
10738 Re-allocate mode_line_noprop_buf if necessary. */
10741 store_mode_line_noprop_char (char c
)
10743 /* If output position has reached the end of the allocated buffer,
10744 increase the buffer's size. */
10745 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10747 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10748 ptrdiff_t size
= len
;
10749 mode_line_noprop_buf
=
10750 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10751 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10752 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10755 *mode_line_noprop_ptr
++ = c
;
10759 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10760 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10761 characters that yield more columns than PRECISION; PRECISION <= 0
10762 means copy the whole string. Pad with spaces until FIELD_WIDTH
10763 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10764 pad. Called from display_mode_element when it is used to build a
10768 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10770 const unsigned char *str
= (const unsigned char *) string
;
10772 EMACS_INT dummy
, nbytes
;
10774 /* Copy at most PRECISION chars from STR. */
10775 nbytes
= strlen (string
);
10776 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10778 store_mode_line_noprop_char (*str
++);
10780 /* Fill up with spaces until FIELD_WIDTH reached. */
10781 while (field_width
> 0
10782 && n
< field_width
)
10784 store_mode_line_noprop_char (' ');
10791 /***********************************************************************
10793 ***********************************************************************/
10795 #ifdef HAVE_WINDOW_SYSTEM
10797 /* Set the title of FRAME, if it has changed. The title format is
10798 Vicon_title_format if FRAME is iconified, otherwise it is
10799 frame_title_format. */
10802 x_consider_frame_title (Lisp_Object frame
)
10804 struct frame
*f
= XFRAME (frame
);
10806 if (FRAME_WINDOW_P (f
)
10807 || FRAME_MINIBUF_ONLY_P (f
)
10808 || f
->explicit_name
)
10810 /* Do we have more than one visible frame on this X display? */
10813 ptrdiff_t title_start
;
10817 int count
= SPECPDL_INDEX ();
10819 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10821 Lisp_Object other_frame
= XCAR (tail
);
10822 struct frame
*tf
= XFRAME (other_frame
);
10825 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10826 && !FRAME_MINIBUF_ONLY_P (tf
)
10827 && !EQ (other_frame
, tip_frame
)
10828 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10832 /* Set global variable indicating that multiple frames exist. */
10833 multiple_frames
= CONSP (tail
);
10835 /* Switch to the buffer of selected window of the frame. Set up
10836 mode_line_target so that display_mode_element will output into
10837 mode_line_noprop_buf; then display the title. */
10838 record_unwind_protect (unwind_format_mode_line
,
10839 format_mode_line_unwind_data
10840 (current_buffer
, selected_window
, 0));
10842 Fselect_window (f
->selected_window
, Qt
);
10843 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10844 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10846 mode_line_target
= MODE_LINE_TITLE
;
10847 title_start
= MODE_LINE_NOPROP_LEN (0);
10848 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10849 NULL
, DEFAULT_FACE_ID
);
10850 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10851 len
= MODE_LINE_NOPROP_LEN (title_start
);
10852 title
= mode_line_noprop_buf
+ title_start
;
10853 unbind_to (count
, Qnil
);
10855 /* Set the title only if it's changed. This avoids consing in
10856 the common case where it hasn't. (If it turns out that we've
10857 already wasted too much time by walking through the list with
10858 display_mode_element, then we might need to optimize at a
10859 higher level than this.) */
10860 if (! STRINGP (f
->name
)
10861 || SBYTES (f
->name
) != len
10862 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10863 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10867 #endif /* not HAVE_WINDOW_SYSTEM */
10872 /***********************************************************************
10874 ***********************************************************************/
10877 /* Prepare for redisplay by updating menu-bar item lists when
10878 appropriate. This can call eval. */
10881 prepare_menu_bars (void)
10884 struct gcpro gcpro1
, gcpro2
;
10886 Lisp_Object tooltip_frame
;
10888 #ifdef HAVE_WINDOW_SYSTEM
10889 tooltip_frame
= tip_frame
;
10891 tooltip_frame
= Qnil
;
10894 /* Update all frame titles based on their buffer names, etc. We do
10895 this before the menu bars so that the buffer-menu will show the
10896 up-to-date frame titles. */
10897 #ifdef HAVE_WINDOW_SYSTEM
10898 if (windows_or_buffers_changed
|| update_mode_lines
)
10900 Lisp_Object tail
, frame
;
10902 FOR_EACH_FRAME (tail
, frame
)
10904 f
= XFRAME (frame
);
10905 if (!EQ (frame
, tooltip_frame
)
10906 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10907 x_consider_frame_title (frame
);
10910 #endif /* HAVE_WINDOW_SYSTEM */
10912 /* Update the menu bar item lists, if appropriate. This has to be
10913 done before any actual redisplay or generation of display lines. */
10914 all_windows
= (update_mode_lines
10915 || buffer_shared
> 1
10916 || windows_or_buffers_changed
);
10919 Lisp_Object tail
, frame
;
10920 int count
= SPECPDL_INDEX ();
10921 /* 1 means that update_menu_bar has run its hooks
10922 so any further calls to update_menu_bar shouldn't do so again. */
10923 int menu_bar_hooks_run
= 0;
10925 record_unwind_save_match_data ();
10927 FOR_EACH_FRAME (tail
, frame
)
10929 f
= XFRAME (frame
);
10931 /* Ignore tooltip frame. */
10932 if (EQ (frame
, tooltip_frame
))
10935 /* If a window on this frame changed size, report that to
10936 the user and clear the size-change flag. */
10937 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10939 Lisp_Object functions
;
10941 /* Clear flag first in case we get an error below. */
10942 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10943 functions
= Vwindow_size_change_functions
;
10944 GCPRO2 (tail
, functions
);
10946 while (CONSP (functions
))
10948 if (!EQ (XCAR (functions
), Qt
))
10949 call1 (XCAR (functions
), frame
);
10950 functions
= XCDR (functions
);
10956 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10957 #ifdef HAVE_WINDOW_SYSTEM
10958 update_tool_bar (f
, 0);
10961 if (windows_or_buffers_changed
10963 ns_set_doc_edited (f
, Fbuffer_modified_p
10964 (XWINDOW (f
->selected_window
)->buffer
));
10969 unbind_to (count
, Qnil
);
10973 struct frame
*sf
= SELECTED_FRAME ();
10974 update_menu_bar (sf
, 1, 0);
10975 #ifdef HAVE_WINDOW_SYSTEM
10976 update_tool_bar (sf
, 1);
10982 /* Update the menu bar item list for frame F. This has to be done
10983 before we start to fill in any display lines, because it can call
10986 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10988 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10989 already ran the menu bar hooks for this redisplay, so there
10990 is no need to run them again. The return value is the
10991 updated value of this flag, to pass to the next call. */
10994 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10996 Lisp_Object window
;
10997 register struct window
*w
;
10999 /* If called recursively during a menu update, do nothing. This can
11000 happen when, for instance, an activate-menubar-hook causes a
11002 if (inhibit_menubar_update
)
11005 window
= FRAME_SELECTED_WINDOW (f
);
11006 w
= XWINDOW (window
);
11008 if (FRAME_WINDOW_P (f
)
11010 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11011 || defined (HAVE_NS) || defined (USE_GTK)
11012 FRAME_EXTERNAL_MENU_BAR (f
)
11014 FRAME_MENU_BAR_LINES (f
) > 0
11016 : FRAME_MENU_BAR_LINES (f
) > 0)
11018 /* If the user has switched buffers or windows, we need to
11019 recompute to reflect the new bindings. But we'll
11020 recompute when update_mode_lines is set too; that means
11021 that people can use force-mode-line-update to request
11022 that the menu bar be recomputed. The adverse effect on
11023 the rest of the redisplay algorithm is about the same as
11024 windows_or_buffers_changed anyway. */
11025 if (windows_or_buffers_changed
11026 /* This used to test w->update_mode_line, but we believe
11027 there is no need to recompute the menu in that case. */
11028 || update_mode_lines
11029 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11030 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11031 != !NILP (w
->last_had_star
))
11032 || ((!NILP (Vtransient_mark_mode
)
11033 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11034 != !NILP (w
->region_showing
)))
11036 struct buffer
*prev
= current_buffer
;
11037 int count
= SPECPDL_INDEX ();
11039 specbind (Qinhibit_menubar_update
, Qt
);
11041 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11042 if (save_match_data
)
11043 record_unwind_save_match_data ();
11044 if (NILP (Voverriding_local_map_menu_flag
))
11046 specbind (Qoverriding_terminal_local_map
, Qnil
);
11047 specbind (Qoverriding_local_map
, Qnil
);
11052 /* Run the Lucid hook. */
11053 safe_run_hooks (Qactivate_menubar_hook
);
11055 /* If it has changed current-menubar from previous value,
11056 really recompute the menu-bar from the value. */
11057 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11058 call0 (Qrecompute_lucid_menubar
);
11060 safe_run_hooks (Qmenu_bar_update_hook
);
11065 XSETFRAME (Vmenu_updating_frame
, f
);
11066 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11068 /* Redisplay the menu bar in case we changed it. */
11069 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11070 || defined (HAVE_NS) || defined (USE_GTK)
11071 if (FRAME_WINDOW_P (f
))
11073 #if defined (HAVE_NS)
11074 /* All frames on Mac OS share the same menubar. So only
11075 the selected frame should be allowed to set it. */
11076 if (f
== SELECTED_FRAME ())
11078 set_frame_menubar (f
, 0, 0);
11081 /* On a terminal screen, the menu bar is an ordinary screen
11082 line, and this makes it get updated. */
11083 w
->update_mode_line
= Qt
;
11084 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11085 /* In the non-toolkit version, the menu bar is an ordinary screen
11086 line, and this makes it get updated. */
11087 w
->update_mode_line
= Qt
;
11088 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11090 unbind_to (count
, Qnil
);
11091 set_buffer_internal_1 (prev
);
11100 /***********************************************************************
11102 ***********************************************************************/
11104 #ifdef HAVE_WINDOW_SYSTEM
11107 Nominal cursor position -- where to draw output.
11108 HPOS and VPOS are window relative glyph matrix coordinates.
11109 X and Y are window relative pixel coordinates. */
11111 struct cursor_pos output_cursor
;
11115 Set the global variable output_cursor to CURSOR. All cursor
11116 positions are relative to updated_window. */
11119 set_output_cursor (struct cursor_pos
*cursor
)
11121 output_cursor
.hpos
= cursor
->hpos
;
11122 output_cursor
.vpos
= cursor
->vpos
;
11123 output_cursor
.x
= cursor
->x
;
11124 output_cursor
.y
= cursor
->y
;
11129 Set a nominal cursor position.
11131 HPOS and VPOS are column/row positions in a window glyph matrix. X
11132 and Y are window text area relative pixel positions.
11134 If this is done during an update, updated_window will contain the
11135 window that is being updated and the position is the future output
11136 cursor position for that window. If updated_window is null, use
11137 selected_window and display the cursor at the given position. */
11140 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11144 /* If updated_window is not set, work on selected_window. */
11145 if (updated_window
)
11146 w
= updated_window
;
11148 w
= XWINDOW (selected_window
);
11150 /* Set the output cursor. */
11151 output_cursor
.hpos
= hpos
;
11152 output_cursor
.vpos
= vpos
;
11153 output_cursor
.x
= x
;
11154 output_cursor
.y
= y
;
11156 /* If not called as part of an update, really display the cursor.
11157 This will also set the cursor position of W. */
11158 if (updated_window
== NULL
)
11161 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11162 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11163 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11168 #endif /* HAVE_WINDOW_SYSTEM */
11171 /***********************************************************************
11173 ***********************************************************************/
11175 #ifdef HAVE_WINDOW_SYSTEM
11177 /* Where the mouse was last time we reported a mouse event. */
11179 FRAME_PTR last_mouse_frame
;
11181 /* Tool-bar item index of the item on which a mouse button was pressed
11184 int last_tool_bar_item
;
11188 update_tool_bar_unwind (Lisp_Object frame
)
11190 selected_frame
= frame
;
11194 /* Update the tool-bar item list for frame F. This has to be done
11195 before we start to fill in any display lines. Called from
11196 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11197 and restore it here. */
11200 update_tool_bar (struct frame
*f
, int save_match_data
)
11202 #if defined (USE_GTK) || defined (HAVE_NS)
11203 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11205 int do_update
= WINDOWP (f
->tool_bar_window
)
11206 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11211 Lisp_Object window
;
11214 window
= FRAME_SELECTED_WINDOW (f
);
11215 w
= XWINDOW (window
);
11217 /* If the user has switched buffers or windows, we need to
11218 recompute to reflect the new bindings. But we'll
11219 recompute when update_mode_lines is set too; that means
11220 that people can use force-mode-line-update to request
11221 that the menu bar be recomputed. The adverse effect on
11222 the rest of the redisplay algorithm is about the same as
11223 windows_or_buffers_changed anyway. */
11224 if (windows_or_buffers_changed
11225 || !NILP (w
->update_mode_line
)
11226 || update_mode_lines
11227 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11228 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11229 != !NILP (w
->last_had_star
))
11230 || ((!NILP (Vtransient_mark_mode
)
11231 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11232 != !NILP (w
->region_showing
)))
11234 struct buffer
*prev
= current_buffer
;
11235 int count
= SPECPDL_INDEX ();
11236 Lisp_Object frame
, new_tool_bar
;
11237 int new_n_tool_bar
;
11238 struct gcpro gcpro1
;
11240 /* Set current_buffer to the buffer of the selected
11241 window of the frame, so that we get the right local
11243 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11245 /* Save match data, if we must. */
11246 if (save_match_data
)
11247 record_unwind_save_match_data ();
11249 /* Make sure that we don't accidentally use bogus keymaps. */
11250 if (NILP (Voverriding_local_map_menu_flag
))
11252 specbind (Qoverriding_terminal_local_map
, Qnil
);
11253 specbind (Qoverriding_local_map
, Qnil
);
11256 GCPRO1 (new_tool_bar
);
11258 /* We must temporarily set the selected frame to this frame
11259 before calling tool_bar_items, because the calculation of
11260 the tool-bar keymap uses the selected frame (see
11261 `tool-bar-make-keymap' in tool-bar.el). */
11262 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11263 XSETFRAME (frame
, f
);
11264 selected_frame
= frame
;
11266 /* Build desired tool-bar items from keymaps. */
11267 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11270 /* Redisplay the tool-bar if we changed it. */
11271 if (new_n_tool_bar
!= f
->n_tool_bar_items
11272 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11274 /* Redisplay that happens asynchronously due to an expose event
11275 may access f->tool_bar_items. Make sure we update both
11276 variables within BLOCK_INPUT so no such event interrupts. */
11278 f
->tool_bar_items
= new_tool_bar
;
11279 f
->n_tool_bar_items
= new_n_tool_bar
;
11280 w
->update_mode_line
= Qt
;
11286 unbind_to (count
, Qnil
);
11287 set_buffer_internal_1 (prev
);
11293 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11294 F's desired tool-bar contents. F->tool_bar_items must have
11295 been set up previously by calling prepare_menu_bars. */
11298 build_desired_tool_bar_string (struct frame
*f
)
11300 int i
, size
, size_needed
;
11301 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11302 Lisp_Object image
, plist
, props
;
11304 image
= plist
= props
= Qnil
;
11305 GCPRO3 (image
, plist
, props
);
11307 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11308 Otherwise, make a new string. */
11310 /* The size of the string we might be able to reuse. */
11311 size
= (STRINGP (f
->desired_tool_bar_string
)
11312 ? SCHARS (f
->desired_tool_bar_string
)
11315 /* We need one space in the string for each image. */
11316 size_needed
= f
->n_tool_bar_items
;
11318 /* Reuse f->desired_tool_bar_string, if possible. */
11319 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11320 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11321 make_number (' '));
11324 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11325 Fremove_text_properties (make_number (0), make_number (size
),
11326 props
, f
->desired_tool_bar_string
);
11329 /* Put a `display' property on the string for the images to display,
11330 put a `menu_item' property on tool-bar items with a value that
11331 is the index of the item in F's tool-bar item vector. */
11332 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11334 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11336 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11337 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11338 int hmargin
, vmargin
, relief
, idx
, end
;
11340 /* If image is a vector, choose the image according to the
11342 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11343 if (VECTORP (image
))
11347 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11348 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11351 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11352 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11354 xassert (ASIZE (image
) >= idx
);
11355 image
= AREF (image
, idx
);
11360 /* Ignore invalid image specifications. */
11361 if (!valid_image_p (image
))
11364 /* Display the tool-bar button pressed, or depressed. */
11365 plist
= Fcopy_sequence (XCDR (image
));
11367 /* Compute margin and relief to draw. */
11368 relief
= (tool_bar_button_relief
>= 0
11369 ? tool_bar_button_relief
11370 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11371 hmargin
= vmargin
= relief
;
11373 if (INTEGERP (Vtool_bar_button_margin
)
11374 && XINT (Vtool_bar_button_margin
) > 0)
11376 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11377 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11379 else if (CONSP (Vtool_bar_button_margin
))
11381 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11382 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11383 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11385 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11386 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11387 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11390 if (auto_raise_tool_bar_buttons_p
)
11392 /* Add a `:relief' property to the image spec if the item is
11396 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11403 /* If image is selected, display it pressed, i.e. with a
11404 negative relief. If it's not selected, display it with a
11406 plist
= Fplist_put (plist
, QCrelief
,
11408 ? make_number (-relief
)
11409 : make_number (relief
)));
11414 /* Put a margin around the image. */
11415 if (hmargin
|| vmargin
)
11417 if (hmargin
== vmargin
)
11418 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11420 plist
= Fplist_put (plist
, QCmargin
,
11421 Fcons (make_number (hmargin
),
11422 make_number (vmargin
)));
11425 /* If button is not enabled, and we don't have special images
11426 for the disabled state, make the image appear disabled by
11427 applying an appropriate algorithm to it. */
11428 if (!enabled_p
&& idx
< 0)
11429 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11431 /* Put a `display' text property on the string for the image to
11432 display. Put a `menu-item' property on the string that gives
11433 the start of this item's properties in the tool-bar items
11435 image
= Fcons (Qimage
, plist
);
11436 props
= list4 (Qdisplay
, image
,
11437 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11439 /* Let the last image hide all remaining spaces in the tool bar
11440 string. The string can be longer than needed when we reuse a
11441 previous string. */
11442 if (i
+ 1 == f
->n_tool_bar_items
)
11443 end
= SCHARS (f
->desired_tool_bar_string
);
11446 Fadd_text_properties (make_number (i
), make_number (end
),
11447 props
, f
->desired_tool_bar_string
);
11455 /* Display one line of the tool-bar of frame IT->f.
11457 HEIGHT specifies the desired height of the tool-bar line.
11458 If the actual height of the glyph row is less than HEIGHT, the
11459 row's height is increased to HEIGHT, and the icons are centered
11460 vertically in the new height.
11462 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11463 count a final empty row in case the tool-bar width exactly matches
11468 display_tool_bar_line (struct it
*it
, int height
)
11470 struct glyph_row
*row
= it
->glyph_row
;
11471 int max_x
= it
->last_visible_x
;
11472 struct glyph
*last
;
11474 prepare_desired_row (row
);
11475 row
->y
= it
->current_y
;
11477 /* Note that this isn't made use of if the face hasn't a box,
11478 so there's no need to check the face here. */
11479 it
->start_of_box_run_p
= 1;
11481 while (it
->current_x
< max_x
)
11483 int x
, n_glyphs_before
, i
, nglyphs
;
11484 struct it it_before
;
11486 /* Get the next display element. */
11487 if (!get_next_display_element (it
))
11489 /* Don't count empty row if we are counting needed tool-bar lines. */
11490 if (height
< 0 && !it
->hpos
)
11495 /* Produce glyphs. */
11496 n_glyphs_before
= row
->used
[TEXT_AREA
];
11499 PRODUCE_GLYPHS (it
);
11501 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11503 x
= it_before
.current_x
;
11504 while (i
< nglyphs
)
11506 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11508 if (x
+ glyph
->pixel_width
> max_x
)
11510 /* Glyph doesn't fit on line. Backtrack. */
11511 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11513 /* If this is the only glyph on this line, it will never fit on the
11514 tool-bar, so skip it. But ensure there is at least one glyph,
11515 so we don't accidentally disable the tool-bar. */
11516 if (n_glyphs_before
== 0
11517 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11523 x
+= glyph
->pixel_width
;
11527 /* Stop at line end. */
11528 if (ITERATOR_AT_END_OF_LINE_P (it
))
11531 set_iterator_to_next (it
, 1);
11536 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11538 /* Use default face for the border below the tool bar.
11540 FIXME: When auto-resize-tool-bars is grow-only, there is
11541 no additional border below the possibly empty tool-bar lines.
11542 So to make the extra empty lines look "normal", we have to
11543 use the tool-bar face for the border too. */
11544 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11545 it
->face_id
= DEFAULT_FACE_ID
;
11547 extend_face_to_end_of_line (it
);
11548 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11549 last
->right_box_line_p
= 1;
11550 if (last
== row
->glyphs
[TEXT_AREA
])
11551 last
->left_box_line_p
= 1;
11553 /* Make line the desired height and center it vertically. */
11554 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11556 /* Don't add more than one line height. */
11557 height
%= FRAME_LINE_HEIGHT (it
->f
);
11558 it
->max_ascent
+= height
/ 2;
11559 it
->max_descent
+= (height
+ 1) / 2;
11562 compute_line_metrics (it
);
11564 /* If line is empty, make it occupy the rest of the tool-bar. */
11565 if (!row
->displays_text_p
)
11567 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11568 row
->visible_height
= row
->height
;
11569 row
->ascent
= row
->phys_ascent
= 0;
11570 row
->extra_line_spacing
= 0;
11573 row
->full_width_p
= 1;
11574 row
->continued_p
= 0;
11575 row
->truncated_on_left_p
= 0;
11576 row
->truncated_on_right_p
= 0;
11578 it
->current_x
= it
->hpos
= 0;
11579 it
->current_y
+= row
->height
;
11585 /* Max tool-bar height. */
11587 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11588 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11590 /* Value is the number of screen lines needed to make all tool-bar
11591 items of frame F visible. The number of actual rows needed is
11592 returned in *N_ROWS if non-NULL. */
11595 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11597 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11599 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11600 the desired matrix, so use (unused) mode-line row as temporary row to
11601 avoid destroying the first tool-bar row. */
11602 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11604 /* Initialize an iterator for iteration over
11605 F->desired_tool_bar_string in the tool-bar window of frame F. */
11606 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11607 it
.first_visible_x
= 0;
11608 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11609 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11610 it
.paragraph_embedding
= L2R
;
11612 while (!ITERATOR_AT_END_P (&it
))
11614 clear_glyph_row (temp_row
);
11615 it
.glyph_row
= temp_row
;
11616 display_tool_bar_line (&it
, -1);
11618 clear_glyph_row (temp_row
);
11620 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11622 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11624 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11628 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11630 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11631 (Lisp_Object frame
)
11638 frame
= selected_frame
;
11640 CHECK_FRAME (frame
);
11641 f
= XFRAME (frame
);
11643 if (WINDOWP (f
->tool_bar_window
)
11644 && (w
= XWINDOW (f
->tool_bar_window
),
11645 WINDOW_TOTAL_LINES (w
) > 0))
11647 update_tool_bar (f
, 1);
11648 if (f
->n_tool_bar_items
)
11650 build_desired_tool_bar_string (f
);
11651 nlines
= tool_bar_lines_needed (f
, NULL
);
11655 return make_number (nlines
);
11659 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11660 height should be changed. */
11663 redisplay_tool_bar (struct frame
*f
)
11667 struct glyph_row
*row
;
11669 #if defined (USE_GTK) || defined (HAVE_NS)
11670 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11671 update_frame_tool_bar (f
);
11675 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11676 do anything. This means you must start with tool-bar-lines
11677 non-zero to get the auto-sizing effect. Or in other words, you
11678 can turn off tool-bars by specifying tool-bar-lines zero. */
11679 if (!WINDOWP (f
->tool_bar_window
)
11680 || (w
= XWINDOW (f
->tool_bar_window
),
11681 WINDOW_TOTAL_LINES (w
) == 0))
11684 /* Set up an iterator for the tool-bar window. */
11685 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11686 it
.first_visible_x
= 0;
11687 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11688 row
= it
.glyph_row
;
11690 /* Build a string that represents the contents of the tool-bar. */
11691 build_desired_tool_bar_string (f
);
11692 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11693 /* FIXME: This should be controlled by a user option. But it
11694 doesn't make sense to have an R2L tool bar if the menu bar cannot
11695 be drawn also R2L, and making the menu bar R2L is tricky due
11696 toolkit-specific code that implements it. If an R2L tool bar is
11697 ever supported, display_tool_bar_line should also be augmented to
11698 call unproduce_glyphs like display_line and display_string
11700 it
.paragraph_embedding
= L2R
;
11702 if (f
->n_tool_bar_rows
== 0)
11706 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11707 nlines
!= WINDOW_TOTAL_LINES (w
)))
11710 int old_height
= WINDOW_TOTAL_LINES (w
);
11712 XSETFRAME (frame
, f
);
11713 Fmodify_frame_parameters (frame
,
11714 Fcons (Fcons (Qtool_bar_lines
,
11715 make_number (nlines
)),
11717 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11719 clear_glyph_matrix (w
->desired_matrix
);
11720 fonts_changed_p
= 1;
11726 /* Display as many lines as needed to display all tool-bar items. */
11728 if (f
->n_tool_bar_rows
> 0)
11730 int border
, rows
, height
, extra
;
11732 if (INTEGERP (Vtool_bar_border
))
11733 border
= XINT (Vtool_bar_border
);
11734 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11735 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11736 else if (EQ (Vtool_bar_border
, Qborder_width
))
11737 border
= f
->border_width
;
11743 rows
= f
->n_tool_bar_rows
;
11744 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11745 extra
= it
.last_visible_y
- border
- height
* rows
;
11747 while (it
.current_y
< it
.last_visible_y
)
11750 if (extra
> 0 && rows
-- > 0)
11752 h
= (extra
+ rows
- 1) / rows
;
11755 display_tool_bar_line (&it
, height
+ h
);
11760 while (it
.current_y
< it
.last_visible_y
)
11761 display_tool_bar_line (&it
, 0);
11764 /* It doesn't make much sense to try scrolling in the tool-bar
11765 window, so don't do it. */
11766 w
->desired_matrix
->no_scrolling_p
= 1;
11767 w
->must_be_updated_p
= 1;
11769 if (!NILP (Vauto_resize_tool_bars
))
11771 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11772 int change_height_p
= 0;
11774 /* If we couldn't display everything, change the tool-bar's
11775 height if there is room for more. */
11776 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11777 && it
.current_y
< max_tool_bar_height
)
11778 change_height_p
= 1;
11780 row
= it
.glyph_row
- 1;
11782 /* If there are blank lines at the end, except for a partially
11783 visible blank line at the end that is smaller than
11784 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11785 if (!row
->displays_text_p
11786 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11787 change_height_p
= 1;
11789 /* If row displays tool-bar items, but is partially visible,
11790 change the tool-bar's height. */
11791 if (row
->displays_text_p
11792 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11793 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11794 change_height_p
= 1;
11796 /* Resize windows as needed by changing the `tool-bar-lines'
11797 frame parameter. */
11798 if (change_height_p
)
11801 int old_height
= WINDOW_TOTAL_LINES (w
);
11803 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11805 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11806 && !f
->minimize_tool_bar_window_p
)
11807 ? (nlines
> old_height
)
11808 : (nlines
!= old_height
));
11809 f
->minimize_tool_bar_window_p
= 0;
11811 if (change_height_p
)
11813 XSETFRAME (frame
, f
);
11814 Fmodify_frame_parameters (frame
,
11815 Fcons (Fcons (Qtool_bar_lines
,
11816 make_number (nlines
)),
11818 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11820 clear_glyph_matrix (w
->desired_matrix
);
11821 f
->n_tool_bar_rows
= nrows
;
11822 fonts_changed_p
= 1;
11829 f
->minimize_tool_bar_window_p
= 0;
11834 /* Get information about the tool-bar item which is displayed in GLYPH
11835 on frame F. Return in *PROP_IDX the index where tool-bar item
11836 properties start in F->tool_bar_items. Value is zero if
11837 GLYPH doesn't display a tool-bar item. */
11840 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11846 /* This function can be called asynchronously, which means we must
11847 exclude any possibility that Fget_text_property signals an
11849 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11850 charpos
= max (0, charpos
);
11852 /* Get the text property `menu-item' at pos. The value of that
11853 property is the start index of this item's properties in
11854 F->tool_bar_items. */
11855 prop
= Fget_text_property (make_number (charpos
),
11856 Qmenu_item
, f
->current_tool_bar_string
);
11857 if (INTEGERP (prop
))
11859 *prop_idx
= XINT (prop
);
11869 /* Get information about the tool-bar item at position X/Y on frame F.
11870 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11871 the current matrix of the tool-bar window of F, or NULL if not
11872 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11873 item in F->tool_bar_items. Value is
11875 -1 if X/Y is not on a tool-bar item
11876 0 if X/Y is on the same item that was highlighted before.
11880 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11881 int *hpos
, int *vpos
, int *prop_idx
)
11883 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11884 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11887 /* Find the glyph under X/Y. */
11888 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11889 if (*glyph
== NULL
)
11892 /* Get the start of this tool-bar item's properties in
11893 f->tool_bar_items. */
11894 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11897 /* Is mouse on the highlighted item? */
11898 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11899 && *vpos
>= hlinfo
->mouse_face_beg_row
11900 && *vpos
<= hlinfo
->mouse_face_end_row
11901 && (*vpos
> hlinfo
->mouse_face_beg_row
11902 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11903 && (*vpos
< hlinfo
->mouse_face_end_row
11904 || *hpos
< hlinfo
->mouse_face_end_col
11905 || hlinfo
->mouse_face_past_end
))
11913 Handle mouse button event on the tool-bar of frame F, at
11914 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11915 0 for button release. MODIFIERS is event modifiers for button
11919 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11920 unsigned int modifiers
)
11922 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11923 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11924 int hpos
, vpos
, prop_idx
;
11925 struct glyph
*glyph
;
11926 Lisp_Object enabled_p
;
11928 /* If not on the highlighted tool-bar item, return. */
11929 frame_to_window_pixel_xy (w
, &x
, &y
);
11930 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11933 /* If item is disabled, do nothing. */
11934 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11935 if (NILP (enabled_p
))
11940 /* Show item in pressed state. */
11941 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11942 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11943 last_tool_bar_item
= prop_idx
;
11947 Lisp_Object key
, frame
;
11948 struct input_event event
;
11949 EVENT_INIT (event
);
11951 /* Show item in released state. */
11952 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11953 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11955 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11957 XSETFRAME (frame
, f
);
11958 event
.kind
= TOOL_BAR_EVENT
;
11959 event
.frame_or_window
= frame
;
11961 kbd_buffer_store_event (&event
);
11963 event
.kind
= TOOL_BAR_EVENT
;
11964 event
.frame_or_window
= frame
;
11966 event
.modifiers
= modifiers
;
11967 kbd_buffer_store_event (&event
);
11968 last_tool_bar_item
= -1;
11973 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11974 tool-bar window-relative coordinates X/Y. Called from
11975 note_mouse_highlight. */
11978 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11980 Lisp_Object window
= f
->tool_bar_window
;
11981 struct window
*w
= XWINDOW (window
);
11982 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11983 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11985 struct glyph
*glyph
;
11986 struct glyph_row
*row
;
11988 Lisp_Object enabled_p
;
11990 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11991 int mouse_down_p
, rc
;
11993 /* Function note_mouse_highlight is called with negative X/Y
11994 values when mouse moves outside of the frame. */
11995 if (x
<= 0 || y
<= 0)
11997 clear_mouse_face (hlinfo
);
12001 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12004 /* Not on tool-bar item. */
12005 clear_mouse_face (hlinfo
);
12009 /* On same tool-bar item as before. */
12010 goto set_help_echo
;
12012 clear_mouse_face (hlinfo
);
12014 /* Mouse is down, but on different tool-bar item? */
12015 mouse_down_p
= (dpyinfo
->grabbed
12016 && f
== last_mouse_frame
12017 && FRAME_LIVE_P (f
));
12019 && last_tool_bar_item
!= prop_idx
)
12022 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12023 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12025 /* If tool-bar item is not enabled, don't highlight it. */
12026 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12027 if (!NILP (enabled_p
))
12029 /* Compute the x-position of the glyph. In front and past the
12030 image is a space. We include this in the highlighted area. */
12031 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12032 for (i
= x
= 0; i
< hpos
; ++i
)
12033 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12035 /* Record this as the current active region. */
12036 hlinfo
->mouse_face_beg_col
= hpos
;
12037 hlinfo
->mouse_face_beg_row
= vpos
;
12038 hlinfo
->mouse_face_beg_x
= x
;
12039 hlinfo
->mouse_face_beg_y
= row
->y
;
12040 hlinfo
->mouse_face_past_end
= 0;
12042 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12043 hlinfo
->mouse_face_end_row
= vpos
;
12044 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12045 hlinfo
->mouse_face_end_y
= row
->y
;
12046 hlinfo
->mouse_face_window
= window
;
12047 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12049 /* Display it as active. */
12050 show_mouse_face (hlinfo
, draw
);
12051 hlinfo
->mouse_face_image_state
= draw
;
12056 /* Set help_echo_string to a help string to display for this tool-bar item.
12057 XTread_socket does the rest. */
12058 help_echo_object
= help_echo_window
= Qnil
;
12059 help_echo_pos
= -1;
12060 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12061 if (NILP (help_echo_string
))
12062 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12065 #endif /* HAVE_WINDOW_SYSTEM */
12069 /************************************************************************
12070 Horizontal scrolling
12071 ************************************************************************/
12073 static int hscroll_window_tree (Lisp_Object
);
12074 static int hscroll_windows (Lisp_Object
);
12076 /* For all leaf windows in the window tree rooted at WINDOW, set their
12077 hscroll value so that PT is (i) visible in the window, and (ii) so
12078 that it is not within a certain margin at the window's left and
12079 right border. Value is non-zero if any window's hscroll has been
12083 hscroll_window_tree (Lisp_Object window
)
12085 int hscrolled_p
= 0;
12086 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12087 int hscroll_step_abs
= 0;
12088 double hscroll_step_rel
= 0;
12090 if (hscroll_relative_p
)
12092 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12093 if (hscroll_step_rel
< 0)
12095 hscroll_relative_p
= 0;
12096 hscroll_step_abs
= 0;
12099 else if (INTEGERP (Vhscroll_step
))
12101 hscroll_step_abs
= XINT (Vhscroll_step
);
12102 if (hscroll_step_abs
< 0)
12103 hscroll_step_abs
= 0;
12106 hscroll_step_abs
= 0;
12108 while (WINDOWP (window
))
12110 struct window
*w
= XWINDOW (window
);
12112 if (WINDOWP (w
->hchild
))
12113 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12114 else if (WINDOWP (w
->vchild
))
12115 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12116 else if (w
->cursor
.vpos
>= 0)
12119 int text_area_width
;
12120 struct glyph_row
*current_cursor_row
12121 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12122 struct glyph_row
*desired_cursor_row
12123 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12124 struct glyph_row
*cursor_row
12125 = (desired_cursor_row
->enabled_p
12126 ? desired_cursor_row
12127 : current_cursor_row
);
12128 int row_r2l_p
= cursor_row
->reversed_p
;
12130 text_area_width
= window_box_width (w
, TEXT_AREA
);
12132 /* Scroll when cursor is inside this scroll margin. */
12133 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12135 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12136 /* For left-to-right rows, hscroll when cursor is either
12137 (i) inside the right hscroll margin, or (ii) if it is
12138 inside the left margin and the window is already
12141 && ((XFASTINT (w
->hscroll
)
12142 && w
->cursor
.x
<= h_margin
)
12143 || (cursor_row
->enabled_p
12144 && cursor_row
->truncated_on_right_p
12145 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12146 /* For right-to-left rows, the logic is similar,
12147 except that rules for scrolling to left and right
12148 are reversed. E.g., if cursor.x <= h_margin, we
12149 need to hscroll "to the right" unconditionally,
12150 and that will scroll the screen to the left so as
12151 to reveal the next portion of the row. */
12153 && ((cursor_row
->enabled_p
12154 /* FIXME: It is confusing to set the
12155 truncated_on_right_p flag when R2L rows
12156 are actually truncated on the left. */
12157 && cursor_row
->truncated_on_right_p
12158 && w
->cursor
.x
<= h_margin
)
12159 || (XFASTINT (w
->hscroll
)
12160 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12164 struct buffer
*saved_current_buffer
;
12168 /* Find point in a display of infinite width. */
12169 saved_current_buffer
= current_buffer
;
12170 current_buffer
= XBUFFER (w
->buffer
);
12172 if (w
== XWINDOW (selected_window
))
12176 pt
= marker_position (w
->pointm
);
12177 pt
= max (BEGV
, pt
);
12181 /* Move iterator to pt starting at cursor_row->start in
12182 a line with infinite width. */
12183 init_to_row_start (&it
, w
, cursor_row
);
12184 it
.last_visible_x
= INFINITY
;
12185 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12186 current_buffer
= saved_current_buffer
;
12188 /* Position cursor in window. */
12189 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12190 hscroll
= max (0, (it
.current_x
12191 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12192 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12193 : (text_area_width
/ 2))))
12194 / FRAME_COLUMN_WIDTH (it
.f
);
12195 else if ((!row_r2l_p
12196 && w
->cursor
.x
>= text_area_width
- h_margin
)
12197 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12199 if (hscroll_relative_p
)
12200 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12203 wanted_x
= text_area_width
12204 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12207 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12211 if (hscroll_relative_p
)
12212 wanted_x
= text_area_width
* hscroll_step_rel
12215 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12218 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12220 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12222 /* Don't prevent redisplay optimizations if hscroll
12223 hasn't changed, as it will unnecessarily slow down
12225 if (XFASTINT (w
->hscroll
) != hscroll
)
12227 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12228 w
->hscroll
= make_number (hscroll
);
12237 /* Value is non-zero if hscroll of any leaf window has been changed. */
12238 return hscrolled_p
;
12242 /* Set hscroll so that cursor is visible and not inside horizontal
12243 scroll margins for all windows in the tree rooted at WINDOW. See
12244 also hscroll_window_tree above. Value is non-zero if any window's
12245 hscroll has been changed. If it has, desired matrices on the frame
12246 of WINDOW are cleared. */
12249 hscroll_windows (Lisp_Object window
)
12251 int hscrolled_p
= hscroll_window_tree (window
);
12253 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12254 return hscrolled_p
;
12259 /************************************************************************
12261 ************************************************************************/
12263 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12264 to a non-zero value. This is sometimes handy to have in a debugger
12269 /* First and last unchanged row for try_window_id. */
12271 static int debug_first_unchanged_at_end_vpos
;
12272 static int debug_last_unchanged_at_beg_vpos
;
12274 /* Delta vpos and y. */
12276 static int debug_dvpos
, debug_dy
;
12278 /* Delta in characters and bytes for try_window_id. */
12280 static EMACS_INT debug_delta
, debug_delta_bytes
;
12282 /* Values of window_end_pos and window_end_vpos at the end of
12285 static EMACS_INT debug_end_vpos
;
12287 /* Append a string to W->desired_matrix->method. FMT is a printf
12288 format string. If trace_redisplay_p is non-zero also printf the
12289 resulting string to stderr. */
12291 static void debug_method_add (struct window
*, char const *, ...)
12292 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12295 debug_method_add (struct window
*w
, char const *fmt
, ...)
12298 char *method
= w
->desired_matrix
->method
;
12299 int len
= strlen (method
);
12300 int size
= sizeof w
->desired_matrix
->method
;
12301 int remaining
= size
- len
- 1;
12304 va_start (ap
, fmt
);
12305 vsprintf (buffer
, fmt
, ap
);
12307 if (len
&& remaining
)
12310 --remaining
, ++len
;
12313 strncpy (method
+ len
, buffer
, remaining
);
12315 if (trace_redisplay_p
)
12316 fprintf (stderr
, "%p (%s): %s\n",
12318 ((BUFFERP (w
->buffer
)
12319 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12320 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12325 #endif /* GLYPH_DEBUG */
12328 /* Value is non-zero if all changes in window W, which displays
12329 current_buffer, are in the text between START and END. START is a
12330 buffer position, END is given as a distance from Z. Used in
12331 redisplay_internal for display optimization. */
12334 text_outside_line_unchanged_p (struct window
*w
,
12335 EMACS_INT start
, EMACS_INT end
)
12337 int unchanged_p
= 1;
12339 /* If text or overlays have changed, see where. */
12340 if (XFASTINT (w
->last_modified
) < MODIFF
12341 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12343 /* Gap in the line? */
12344 if (GPT
< start
|| Z
- GPT
< end
)
12347 /* Changes start in front of the line, or end after it? */
12349 && (BEG_UNCHANGED
< start
- 1
12350 || END_UNCHANGED
< end
))
12353 /* If selective display, can't optimize if changes start at the
12354 beginning of the line. */
12356 && INTEGERP (BVAR (current_buffer
, selective_display
))
12357 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12358 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12361 /* If there are overlays at the start or end of the line, these
12362 may have overlay strings with newlines in them. A change at
12363 START, for instance, may actually concern the display of such
12364 overlay strings as well, and they are displayed on different
12365 lines. So, quickly rule out this case. (For the future, it
12366 might be desirable to implement something more telling than
12367 just BEG/END_UNCHANGED.) */
12370 if (BEG
+ BEG_UNCHANGED
== start
12371 && overlay_touches_p (start
))
12373 if (END_UNCHANGED
== end
12374 && overlay_touches_p (Z
- end
))
12378 /* Under bidi reordering, adding or deleting a character in the
12379 beginning of a paragraph, before the first strong directional
12380 character, can change the base direction of the paragraph (unless
12381 the buffer specifies a fixed paragraph direction), which will
12382 require to redisplay the whole paragraph. It might be worthwhile
12383 to find the paragraph limits and widen the range of redisplayed
12384 lines to that, but for now just give up this optimization. */
12385 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12386 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12390 return unchanged_p
;
12394 /* Do a frame update, taking possible shortcuts into account. This is
12395 the main external entry point for redisplay.
12397 If the last redisplay displayed an echo area message and that message
12398 is no longer requested, we clear the echo area or bring back the
12399 mini-buffer if that is in use. */
12404 redisplay_internal ();
12409 overlay_arrow_string_or_property (Lisp_Object var
)
12413 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12416 return Voverlay_arrow_string
;
12419 /* Return 1 if there are any overlay-arrows in current_buffer. */
12421 overlay_arrow_in_current_buffer_p (void)
12425 for (vlist
= Voverlay_arrow_variable_list
;
12427 vlist
= XCDR (vlist
))
12429 Lisp_Object var
= XCAR (vlist
);
12432 if (!SYMBOLP (var
))
12434 val
= find_symbol_value (var
);
12436 && current_buffer
== XMARKER (val
)->buffer
)
12443 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12447 overlay_arrows_changed_p (void)
12451 for (vlist
= Voverlay_arrow_variable_list
;
12453 vlist
= XCDR (vlist
))
12455 Lisp_Object var
= XCAR (vlist
);
12456 Lisp_Object val
, pstr
;
12458 if (!SYMBOLP (var
))
12460 val
= find_symbol_value (var
);
12461 if (!MARKERP (val
))
12463 if (! EQ (COERCE_MARKER (val
),
12464 Fget (var
, Qlast_arrow_position
))
12465 || ! (pstr
= overlay_arrow_string_or_property (var
),
12466 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12472 /* Mark overlay arrows to be updated on next redisplay. */
12475 update_overlay_arrows (int up_to_date
)
12479 for (vlist
= Voverlay_arrow_variable_list
;
12481 vlist
= XCDR (vlist
))
12483 Lisp_Object var
= XCAR (vlist
);
12485 if (!SYMBOLP (var
))
12488 if (up_to_date
> 0)
12490 Lisp_Object val
= find_symbol_value (var
);
12491 Fput (var
, Qlast_arrow_position
,
12492 COERCE_MARKER (val
));
12493 Fput (var
, Qlast_arrow_string
,
12494 overlay_arrow_string_or_property (var
));
12496 else if (up_to_date
< 0
12497 || !NILP (Fget (var
, Qlast_arrow_position
)))
12499 Fput (var
, Qlast_arrow_position
, Qt
);
12500 Fput (var
, Qlast_arrow_string
, Qt
);
12506 /* Return overlay arrow string to display at row.
12507 Return integer (bitmap number) for arrow bitmap in left fringe.
12508 Return nil if no overlay arrow. */
12511 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12515 for (vlist
= Voverlay_arrow_variable_list
;
12517 vlist
= XCDR (vlist
))
12519 Lisp_Object var
= XCAR (vlist
);
12522 if (!SYMBOLP (var
))
12525 val
= find_symbol_value (var
);
12528 && current_buffer
== XMARKER (val
)->buffer
12529 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12531 if (FRAME_WINDOW_P (it
->f
)
12532 /* FIXME: if ROW->reversed_p is set, this should test
12533 the right fringe, not the left one. */
12534 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12536 #ifdef HAVE_WINDOW_SYSTEM
12537 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12540 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12541 return make_number (fringe_bitmap
);
12544 return make_number (-1); /* Use default arrow bitmap */
12546 return overlay_arrow_string_or_property (var
);
12553 /* Return 1 if point moved out of or into a composition. Otherwise
12554 return 0. PREV_BUF and PREV_PT are the last point buffer and
12555 position. BUF and PT are the current point buffer and position. */
12558 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12559 struct buffer
*buf
, EMACS_INT pt
)
12561 EMACS_INT start
, end
;
12563 Lisp_Object buffer
;
12565 XSETBUFFER (buffer
, buf
);
12566 /* Check a composition at the last point if point moved within the
12568 if (prev_buf
== buf
)
12571 /* Point didn't move. */
12574 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12575 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12576 && COMPOSITION_VALID_P (start
, end
, prop
)
12577 && start
< prev_pt
&& end
> prev_pt
)
12578 /* The last point was within the composition. Return 1 iff
12579 point moved out of the composition. */
12580 return (pt
<= start
|| pt
>= end
);
12583 /* Check a composition at the current point. */
12584 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12585 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12586 && COMPOSITION_VALID_P (start
, end
, prop
)
12587 && start
< pt
&& end
> pt
);
12591 /* Reconsider the setting of B->clip_changed which is displayed
12595 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12597 if (b
->clip_changed
12598 && !NILP (w
->window_end_valid
)
12599 && w
->current_matrix
->buffer
== b
12600 && w
->current_matrix
->zv
== BUF_ZV (b
)
12601 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12602 b
->clip_changed
= 0;
12604 /* If display wasn't paused, and W is not a tool bar window, see if
12605 point has been moved into or out of a composition. In that case,
12606 we set b->clip_changed to 1 to force updating the screen. If
12607 b->clip_changed has already been set to 1, we can skip this
12609 if (!b
->clip_changed
12610 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12614 if (w
== XWINDOW (selected_window
))
12617 pt
= marker_position (w
->pointm
);
12619 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12620 || pt
!= XINT (w
->last_point
))
12621 && check_point_in_composition (w
->current_matrix
->buffer
,
12622 XINT (w
->last_point
),
12623 XBUFFER (w
->buffer
), pt
))
12624 b
->clip_changed
= 1;
12629 /* Select FRAME to forward the values of frame-local variables into C
12630 variables so that the redisplay routines can access those values
12634 select_frame_for_redisplay (Lisp_Object frame
)
12636 Lisp_Object tail
, tem
;
12637 Lisp_Object old
= selected_frame
;
12638 struct Lisp_Symbol
*sym
;
12640 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12642 selected_frame
= frame
;
12645 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12646 if (CONSP (XCAR (tail
))
12647 && (tem
= XCAR (XCAR (tail
)),
12649 && (sym
= indirect_variable (XSYMBOL (tem
)),
12650 sym
->redirect
== SYMBOL_LOCALIZED
)
12651 && sym
->val
.blv
->frame_local
)
12652 /* Use find_symbol_value rather than Fsymbol_value
12653 to avoid an error if it is void. */
12654 find_symbol_value (tem
);
12655 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12659 #define STOP_POLLING \
12660 do { if (! polling_stopped_here) stop_polling (); \
12661 polling_stopped_here = 1; } while (0)
12663 #define RESUME_POLLING \
12664 do { if (polling_stopped_here) start_polling (); \
12665 polling_stopped_here = 0; } while (0)
12668 /* Perhaps in the future avoid recentering windows if it
12669 is not necessary; currently that causes some problems. */
12672 redisplay_internal (void)
12674 struct window
*w
= XWINDOW (selected_window
);
12678 int must_finish
= 0;
12679 struct text_pos tlbufpos
, tlendpos
;
12680 int number_of_visible_frames
;
12683 int polling_stopped_here
= 0;
12684 Lisp_Object old_frame
= selected_frame
;
12686 /* Non-zero means redisplay has to consider all windows on all
12687 frames. Zero means, only selected_window is considered. */
12688 int consider_all_windows_p
;
12690 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12692 /* No redisplay if running in batch mode or frame is not yet fully
12693 initialized, or redisplay is explicitly turned off by setting
12694 Vinhibit_redisplay. */
12695 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12696 || !NILP (Vinhibit_redisplay
))
12699 /* Don't examine these until after testing Vinhibit_redisplay.
12700 When Emacs is shutting down, perhaps because its connection to
12701 X has dropped, we should not look at them at all. */
12702 fr
= XFRAME (w
->frame
);
12703 sf
= SELECTED_FRAME ();
12705 if (!fr
->glyphs_initialized_p
)
12708 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12709 if (popup_activated ())
12713 /* I don't think this happens but let's be paranoid. */
12714 if (redisplaying_p
)
12717 /* Record a function that resets redisplaying_p to its old value
12718 when we leave this function. */
12719 count
= SPECPDL_INDEX ();
12720 record_unwind_protect (unwind_redisplay
,
12721 Fcons (make_number (redisplaying_p
), selected_frame
));
12723 specbind (Qinhibit_free_realized_faces
, Qnil
);
12726 Lisp_Object tail
, frame
;
12728 FOR_EACH_FRAME (tail
, frame
)
12730 struct frame
*f
= XFRAME (frame
);
12731 f
->already_hscrolled_p
= 0;
12736 /* Remember the currently selected window. */
12739 if (!EQ (old_frame
, selected_frame
)
12740 && FRAME_LIVE_P (XFRAME (old_frame
)))
12741 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12742 selected_frame and selected_window to be temporarily out-of-sync so
12743 when we come back here via `goto retry', we need to resync because we
12744 may need to run Elisp code (via prepare_menu_bars). */
12745 select_frame_for_redisplay (old_frame
);
12748 reconsider_clip_changes (w
, current_buffer
);
12749 last_escape_glyph_frame
= NULL
;
12750 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12751 last_glyphless_glyph_frame
= NULL
;
12752 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12754 /* If new fonts have been loaded that make a glyph matrix adjustment
12755 necessary, do it. */
12756 if (fonts_changed_p
)
12758 adjust_glyphs (NULL
);
12759 ++windows_or_buffers_changed
;
12760 fonts_changed_p
= 0;
12763 /* If face_change_count is non-zero, init_iterator will free all
12764 realized faces, which includes the faces referenced from current
12765 matrices. So, we can't reuse current matrices in this case. */
12766 if (face_change_count
)
12767 ++windows_or_buffers_changed
;
12769 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12770 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12772 /* Since frames on a single ASCII terminal share the same
12773 display area, displaying a different frame means redisplay
12774 the whole thing. */
12775 windows_or_buffers_changed
++;
12776 SET_FRAME_GARBAGED (sf
);
12778 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12780 FRAME_TTY (sf
)->previous_frame
= sf
;
12783 /* Set the visible flags for all frames. Do this before checking
12784 for resized or garbaged frames; they want to know if their frames
12785 are visible. See the comment in frame.h for
12786 FRAME_SAMPLE_VISIBILITY. */
12788 Lisp_Object tail
, frame
;
12790 number_of_visible_frames
= 0;
12792 FOR_EACH_FRAME (tail
, frame
)
12794 struct frame
*f
= XFRAME (frame
);
12796 FRAME_SAMPLE_VISIBILITY (f
);
12797 if (FRAME_VISIBLE_P (f
))
12798 ++number_of_visible_frames
;
12799 clear_desired_matrices (f
);
12803 /* Notice any pending interrupt request to change frame size. */
12804 do_pending_window_change (1);
12806 /* do_pending_window_change could change the selected_window due to
12807 frame resizing which makes the selected window too small. */
12808 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12811 reconsider_clip_changes (w
, current_buffer
);
12814 /* Clear frames marked as garbaged. */
12815 if (frame_garbaged
)
12816 clear_garbaged_frames ();
12818 /* Build menubar and tool-bar items. */
12819 if (NILP (Vmemory_full
))
12820 prepare_menu_bars ();
12822 if (windows_or_buffers_changed
)
12823 update_mode_lines
++;
12825 /* Detect case that we need to write or remove a star in the mode line. */
12826 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12828 w
->update_mode_line
= Qt
;
12829 if (buffer_shared
> 1)
12830 update_mode_lines
++;
12833 /* Avoid invocation of point motion hooks by `current_column' below. */
12834 count1
= SPECPDL_INDEX ();
12835 specbind (Qinhibit_point_motion_hooks
, Qt
);
12837 /* If %c is in the mode line, update it if needed. */
12838 if (!NILP (w
->column_number_displayed
)
12839 /* This alternative quickly identifies a common case
12840 where no change is needed. */
12841 && !(PT
== XFASTINT (w
->last_point
)
12842 && XFASTINT (w
->last_modified
) >= MODIFF
12843 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12844 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12845 w
->update_mode_line
= Qt
;
12847 unbind_to (count1
, Qnil
);
12849 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12851 /* The variable buffer_shared is set in redisplay_window and
12852 indicates that we redisplay a buffer in different windows. See
12854 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12855 || cursor_type_changed
);
12857 /* If specs for an arrow have changed, do thorough redisplay
12858 to ensure we remove any arrow that should no longer exist. */
12859 if (overlay_arrows_changed_p ())
12860 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12862 /* Normally the message* functions will have already displayed and
12863 updated the echo area, but the frame may have been trashed, or
12864 the update may have been preempted, so display the echo area
12865 again here. Checking message_cleared_p captures the case that
12866 the echo area should be cleared. */
12867 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12868 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12869 || (message_cleared_p
12870 && minibuf_level
== 0
12871 /* If the mini-window is currently selected, this means the
12872 echo-area doesn't show through. */
12873 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12875 int window_height_changed_p
= echo_area_display (0);
12878 /* If we don't display the current message, don't clear the
12879 message_cleared_p flag, because, if we did, we wouldn't clear
12880 the echo area in the next redisplay which doesn't preserve
12882 if (!display_last_displayed_message_p
)
12883 message_cleared_p
= 0;
12885 if (fonts_changed_p
)
12887 else if (window_height_changed_p
)
12889 consider_all_windows_p
= 1;
12890 ++update_mode_lines
;
12891 ++windows_or_buffers_changed
;
12893 /* If window configuration was changed, frames may have been
12894 marked garbaged. Clear them or we will experience
12895 surprises wrt scrolling. */
12896 if (frame_garbaged
)
12897 clear_garbaged_frames ();
12900 else if (EQ (selected_window
, minibuf_window
)
12901 && (current_buffer
->clip_changed
12902 || XFASTINT (w
->last_modified
) < MODIFF
12903 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12904 && resize_mini_window (w
, 0))
12906 /* Resized active mini-window to fit the size of what it is
12907 showing if its contents might have changed. */
12909 /* FIXME: this causes all frames to be updated, which seems unnecessary
12910 since only the current frame needs to be considered. This function needs
12911 to be rewritten with two variables, consider_all_windows and
12912 consider_all_frames. */
12913 consider_all_windows_p
= 1;
12914 ++windows_or_buffers_changed
;
12915 ++update_mode_lines
;
12917 /* If window configuration was changed, frames may have been
12918 marked garbaged. Clear them or we will experience
12919 surprises wrt scrolling. */
12920 if (frame_garbaged
)
12921 clear_garbaged_frames ();
12925 /* If showing the region, and mark has changed, we must redisplay
12926 the whole window. The assignment to this_line_start_pos prevents
12927 the optimization directly below this if-statement. */
12928 if (((!NILP (Vtransient_mark_mode
)
12929 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12930 != !NILP (w
->region_showing
))
12931 || (!NILP (w
->region_showing
)
12932 && !EQ (w
->region_showing
,
12933 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12934 CHARPOS (this_line_start_pos
) = 0;
12936 /* Optimize the case that only the line containing the cursor in the
12937 selected window has changed. Variables starting with this_ are
12938 set in display_line and record information about the line
12939 containing the cursor. */
12940 tlbufpos
= this_line_start_pos
;
12941 tlendpos
= this_line_end_pos
;
12942 if (!consider_all_windows_p
12943 && CHARPOS (tlbufpos
) > 0
12944 && NILP (w
->update_mode_line
)
12945 && !current_buffer
->clip_changed
12946 && !current_buffer
->prevent_redisplay_optimizations_p
12947 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12948 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12949 /* Make sure recorded data applies to current buffer, etc. */
12950 && this_line_buffer
== current_buffer
12951 && current_buffer
== XBUFFER (w
->buffer
)
12952 && NILP (w
->force_start
)
12953 && NILP (w
->optional_new_start
)
12954 /* Point must be on the line that we have info recorded about. */
12955 && PT
>= CHARPOS (tlbufpos
)
12956 && PT
<= Z
- CHARPOS (tlendpos
)
12957 /* All text outside that line, including its final newline,
12958 must be unchanged. */
12959 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12960 CHARPOS (tlendpos
)))
12962 if (CHARPOS (tlbufpos
) > BEGV
12963 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12964 && (CHARPOS (tlbufpos
) == ZV
12965 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12966 /* Former continuation line has disappeared by becoming empty. */
12968 else if (XFASTINT (w
->last_modified
) < MODIFF
12969 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12970 || MINI_WINDOW_P (w
))
12972 /* We have to handle the case of continuation around a
12973 wide-column character (see the comment in indent.c around
12976 For instance, in the following case:
12978 -------- Insert --------
12979 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12980 J_I_ ==> J_I_ `^^' are cursors.
12984 As we have to redraw the line above, we cannot use this
12988 int line_height_before
= this_line_pixel_height
;
12990 /* Note that start_display will handle the case that the
12991 line starting at tlbufpos is a continuation line. */
12992 start_display (&it
, w
, tlbufpos
);
12994 /* Implementation note: It this still necessary? */
12995 if (it
.current_x
!= this_line_start_x
)
12998 TRACE ((stderr
, "trying display optimization 1\n"));
12999 w
->cursor
.vpos
= -1;
13000 overlay_arrow_seen
= 0;
13001 it
.vpos
= this_line_vpos
;
13002 it
.current_y
= this_line_y
;
13003 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13004 display_line (&it
);
13006 /* If line contains point, is not continued,
13007 and ends at same distance from eob as before, we win. */
13008 if (w
->cursor
.vpos
>= 0
13009 /* Line is not continued, otherwise this_line_start_pos
13010 would have been set to 0 in display_line. */
13011 && CHARPOS (this_line_start_pos
)
13012 /* Line ends as before. */
13013 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13014 /* Line has same height as before. Otherwise other lines
13015 would have to be shifted up or down. */
13016 && this_line_pixel_height
== line_height_before
)
13018 /* If this is not the window's last line, we must adjust
13019 the charstarts of the lines below. */
13020 if (it
.current_y
< it
.last_visible_y
)
13022 struct glyph_row
*row
13023 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13024 EMACS_INT delta
, delta_bytes
;
13026 /* We used to distinguish between two cases here,
13027 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13028 when the line ends in a newline or the end of the
13029 buffer's accessible portion. But both cases did
13030 the same, so they were collapsed. */
13032 - CHARPOS (tlendpos
)
13033 - MATRIX_ROW_START_CHARPOS (row
));
13034 delta_bytes
= (Z_BYTE
13035 - BYTEPOS (tlendpos
)
13036 - MATRIX_ROW_START_BYTEPOS (row
));
13038 increment_matrix_positions (w
->current_matrix
,
13039 this_line_vpos
+ 1,
13040 w
->current_matrix
->nrows
,
13041 delta
, delta_bytes
);
13044 /* If this row displays text now but previously didn't,
13045 or vice versa, w->window_end_vpos may have to be
13047 if ((it
.glyph_row
- 1)->displays_text_p
)
13049 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13050 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13052 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13053 && this_line_vpos
> 0)
13054 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13055 w
->window_end_valid
= Qnil
;
13057 /* Update hint: No need to try to scroll in update_window. */
13058 w
->desired_matrix
->no_scrolling_p
= 1;
13061 *w
->desired_matrix
->method
= 0;
13062 debug_method_add (w
, "optimization 1");
13064 #ifdef HAVE_WINDOW_SYSTEM
13065 update_window_fringes (w
, 0);
13072 else if (/* Cursor position hasn't changed. */
13073 PT
== XFASTINT (w
->last_point
)
13074 /* Make sure the cursor was last displayed
13075 in this window. Otherwise we have to reposition it. */
13076 && 0 <= w
->cursor
.vpos
13077 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13081 do_pending_window_change (1);
13082 /* If selected_window changed, redisplay again. */
13083 if (WINDOWP (selected_window
)
13084 && (w
= XWINDOW (selected_window
)) != sw
)
13087 /* We used to always goto end_of_redisplay here, but this
13088 isn't enough if we have a blinking cursor. */
13089 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13090 goto end_of_redisplay
;
13094 /* If highlighting the region, or if the cursor is in the echo area,
13095 then we can't just move the cursor. */
13096 else if (! (!NILP (Vtransient_mark_mode
)
13097 && !NILP (BVAR (current_buffer
, mark_active
)))
13098 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13099 || highlight_nonselected_windows
)
13100 && NILP (w
->region_showing
)
13101 && NILP (Vshow_trailing_whitespace
)
13102 && !cursor_in_echo_area
)
13105 struct glyph_row
*row
;
13107 /* Skip from tlbufpos to PT and see where it is. Note that
13108 PT may be in invisible text. If so, we will end at the
13109 next visible position. */
13110 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13111 NULL
, DEFAULT_FACE_ID
);
13112 it
.current_x
= this_line_start_x
;
13113 it
.current_y
= this_line_y
;
13114 it
.vpos
= this_line_vpos
;
13116 /* The call to move_it_to stops in front of PT, but
13117 moves over before-strings. */
13118 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13120 if (it
.vpos
== this_line_vpos
13121 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13124 xassert (this_line_vpos
== it
.vpos
);
13125 xassert (this_line_y
== it
.current_y
);
13126 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13128 *w
->desired_matrix
->method
= 0;
13129 debug_method_add (w
, "optimization 3");
13138 /* Text changed drastically or point moved off of line. */
13139 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13142 CHARPOS (this_line_start_pos
) = 0;
13143 consider_all_windows_p
|= buffer_shared
> 1;
13144 ++clear_face_cache_count
;
13145 #ifdef HAVE_WINDOW_SYSTEM
13146 ++clear_image_cache_count
;
13149 /* Build desired matrices, and update the display. If
13150 consider_all_windows_p is non-zero, do it for all windows on all
13151 frames. Otherwise do it for selected_window, only. */
13153 if (consider_all_windows_p
)
13155 Lisp_Object tail
, frame
;
13157 FOR_EACH_FRAME (tail
, frame
)
13158 XFRAME (frame
)->updated_p
= 0;
13160 /* Recompute # windows showing selected buffer. This will be
13161 incremented each time such a window is displayed. */
13164 FOR_EACH_FRAME (tail
, frame
)
13166 struct frame
*f
= XFRAME (frame
);
13168 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13170 if (! EQ (frame
, selected_frame
))
13171 /* Select the frame, for the sake of frame-local
13173 select_frame_for_redisplay (frame
);
13175 /* Mark all the scroll bars to be removed; we'll redeem
13176 the ones we want when we redisplay their windows. */
13177 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13178 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13180 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13181 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13183 /* The X error handler may have deleted that frame. */
13184 if (!FRAME_LIVE_P (f
))
13187 /* Any scroll bars which redisplay_windows should have
13188 nuked should now go away. */
13189 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13190 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13192 /* If fonts changed, display again. */
13193 /* ??? rms: I suspect it is a mistake to jump all the way
13194 back to retry here. It should just retry this frame. */
13195 if (fonts_changed_p
)
13198 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13200 /* See if we have to hscroll. */
13201 if (!f
->already_hscrolled_p
)
13203 f
->already_hscrolled_p
= 1;
13204 if (hscroll_windows (f
->root_window
))
13208 /* Prevent various kinds of signals during display
13209 update. stdio is not robust about handling
13210 signals, which can cause an apparent I/O
13212 if (interrupt_input
)
13213 unrequest_sigio ();
13216 /* Update the display. */
13217 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13218 pending
|= update_frame (f
, 0, 0);
13224 if (!EQ (old_frame
, selected_frame
)
13225 && FRAME_LIVE_P (XFRAME (old_frame
)))
13226 /* We played a bit fast-and-loose above and allowed selected_frame
13227 and selected_window to be temporarily out-of-sync but let's make
13228 sure this stays contained. */
13229 select_frame_for_redisplay (old_frame
);
13230 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13234 /* Do the mark_window_display_accurate after all windows have
13235 been redisplayed because this call resets flags in buffers
13236 which are needed for proper redisplay. */
13237 FOR_EACH_FRAME (tail
, frame
)
13239 struct frame
*f
= XFRAME (frame
);
13242 mark_window_display_accurate (f
->root_window
, 1);
13243 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13244 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13249 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13251 Lisp_Object mini_window
;
13252 struct frame
*mini_frame
;
13254 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13255 /* Use list_of_error, not Qerror, so that
13256 we catch only errors and don't run the debugger. */
13257 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13259 redisplay_window_error
);
13261 /* Compare desired and current matrices, perform output. */
13264 /* If fonts changed, display again. */
13265 if (fonts_changed_p
)
13268 /* Prevent various kinds of signals during display update.
13269 stdio is not robust about handling signals,
13270 which can cause an apparent I/O error. */
13271 if (interrupt_input
)
13272 unrequest_sigio ();
13275 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13277 if (hscroll_windows (selected_window
))
13280 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13281 pending
= update_frame (sf
, 0, 0);
13284 /* We may have called echo_area_display at the top of this
13285 function. If the echo area is on another frame, that may
13286 have put text on a frame other than the selected one, so the
13287 above call to update_frame would not have caught it. Catch
13289 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13290 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13292 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13294 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13295 pending
|= update_frame (mini_frame
, 0, 0);
13296 if (!pending
&& hscroll_windows (mini_window
))
13301 /* If display was paused because of pending input, make sure we do a
13302 thorough update the next time. */
13305 /* Prevent the optimization at the beginning of
13306 redisplay_internal that tries a single-line update of the
13307 line containing the cursor in the selected window. */
13308 CHARPOS (this_line_start_pos
) = 0;
13310 /* Let the overlay arrow be updated the next time. */
13311 update_overlay_arrows (0);
13313 /* If we pause after scrolling, some rows in the current
13314 matrices of some windows are not valid. */
13315 if (!WINDOW_FULL_WIDTH_P (w
)
13316 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13317 update_mode_lines
= 1;
13321 if (!consider_all_windows_p
)
13323 /* This has already been done above if
13324 consider_all_windows_p is set. */
13325 mark_window_display_accurate_1 (w
, 1);
13327 /* Say overlay arrows are up to date. */
13328 update_overlay_arrows (1);
13330 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13331 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13334 update_mode_lines
= 0;
13335 windows_or_buffers_changed
= 0;
13336 cursor_type_changed
= 0;
13339 /* Start SIGIO interrupts coming again. Having them off during the
13340 code above makes it less likely one will discard output, but not
13341 impossible, since there might be stuff in the system buffer here.
13342 But it is much hairier to try to do anything about that. */
13343 if (interrupt_input
)
13347 /* If a frame has become visible which was not before, redisplay
13348 again, so that we display it. Expose events for such a frame
13349 (which it gets when becoming visible) don't call the parts of
13350 redisplay constructing glyphs, so simply exposing a frame won't
13351 display anything in this case. So, we have to display these
13352 frames here explicitly. */
13355 Lisp_Object tail
, frame
;
13358 FOR_EACH_FRAME (tail
, frame
)
13360 int this_is_visible
= 0;
13362 if (XFRAME (frame
)->visible
)
13363 this_is_visible
= 1;
13364 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13365 if (XFRAME (frame
)->visible
)
13366 this_is_visible
= 1;
13368 if (this_is_visible
)
13372 if (new_count
!= number_of_visible_frames
)
13373 windows_or_buffers_changed
++;
13376 /* Change frame size now if a change is pending. */
13377 do_pending_window_change (1);
13379 /* If we just did a pending size change, or have additional
13380 visible frames, or selected_window changed, redisplay again. */
13381 if ((windows_or_buffers_changed
&& !pending
)
13382 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13385 /* Clear the face and image caches.
13387 We used to do this only if consider_all_windows_p. But the cache
13388 needs to be cleared if a timer creates images in the current
13389 buffer (e.g. the test case in Bug#6230). */
13391 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13393 clear_face_cache (0);
13394 clear_face_cache_count
= 0;
13397 #ifdef HAVE_WINDOW_SYSTEM
13398 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13400 clear_image_caches (Qnil
);
13401 clear_image_cache_count
= 0;
13403 #endif /* HAVE_WINDOW_SYSTEM */
13406 unbind_to (count
, Qnil
);
13411 /* Redisplay, but leave alone any recent echo area message unless
13412 another message has been requested in its place.
13414 This is useful in situations where you need to redisplay but no
13415 user action has occurred, making it inappropriate for the message
13416 area to be cleared. See tracking_off and
13417 wait_reading_process_output for examples of these situations.
13419 FROM_WHERE is an integer saying from where this function was
13420 called. This is useful for debugging. */
13423 redisplay_preserve_echo_area (int from_where
)
13425 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13427 if (!NILP (echo_area_buffer
[1]))
13429 /* We have a previously displayed message, but no current
13430 message. Redisplay the previous message. */
13431 display_last_displayed_message_p
= 1;
13432 redisplay_internal ();
13433 display_last_displayed_message_p
= 0;
13436 redisplay_internal ();
13438 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13439 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13440 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13444 /* Function registered with record_unwind_protect in
13445 redisplay_internal. Reset redisplaying_p to the value it had
13446 before redisplay_internal was called, and clear
13447 prevent_freeing_realized_faces_p. It also selects the previously
13448 selected frame, unless it has been deleted (by an X connection
13449 failure during redisplay, for example). */
13452 unwind_redisplay (Lisp_Object val
)
13454 Lisp_Object old_redisplaying_p
, old_frame
;
13456 old_redisplaying_p
= XCAR (val
);
13457 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13458 old_frame
= XCDR (val
);
13459 if (! EQ (old_frame
, selected_frame
)
13460 && FRAME_LIVE_P (XFRAME (old_frame
)))
13461 select_frame_for_redisplay (old_frame
);
13466 /* Mark the display of window W as accurate or inaccurate. If
13467 ACCURATE_P is non-zero mark display of W as accurate. If
13468 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13469 redisplay_internal is called. */
13472 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13474 if (BUFFERP (w
->buffer
))
13476 struct buffer
*b
= XBUFFER (w
->buffer
);
13479 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13480 w
->last_overlay_modified
13481 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13483 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13487 b
->clip_changed
= 0;
13488 b
->prevent_redisplay_optimizations_p
= 0;
13490 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13491 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13492 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13493 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13495 w
->current_matrix
->buffer
= b
;
13496 w
->current_matrix
->begv
= BUF_BEGV (b
);
13497 w
->current_matrix
->zv
= BUF_ZV (b
);
13499 w
->last_cursor
= w
->cursor
;
13500 w
->last_cursor_off_p
= w
->cursor_off_p
;
13502 if (w
== XWINDOW (selected_window
))
13503 w
->last_point
= make_number (BUF_PT (b
));
13505 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13511 w
->window_end_valid
= w
->buffer
;
13512 w
->update_mode_line
= Qnil
;
13517 /* Mark the display of windows in the window tree rooted at WINDOW as
13518 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13519 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13520 be redisplayed the next time redisplay_internal is called. */
13523 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13527 for (; !NILP (window
); window
= w
->next
)
13529 w
= XWINDOW (window
);
13530 mark_window_display_accurate_1 (w
, accurate_p
);
13532 if (!NILP (w
->vchild
))
13533 mark_window_display_accurate (w
->vchild
, accurate_p
);
13534 if (!NILP (w
->hchild
))
13535 mark_window_display_accurate (w
->hchild
, accurate_p
);
13540 update_overlay_arrows (1);
13544 /* Force a thorough redisplay the next time by setting
13545 last_arrow_position and last_arrow_string to t, which is
13546 unequal to any useful value of Voverlay_arrow_... */
13547 update_overlay_arrows (-1);
13552 /* Return value in display table DP (Lisp_Char_Table *) for character
13553 C. Since a display table doesn't have any parent, we don't have to
13554 follow parent. Do not call this function directly but use the
13555 macro DISP_CHAR_VECTOR. */
13558 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13562 if (ASCII_CHAR_P (c
))
13565 if (SUB_CHAR_TABLE_P (val
))
13566 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13572 XSETCHAR_TABLE (table
, dp
);
13573 val
= char_table_ref (table
, c
);
13582 /***********************************************************************
13584 ***********************************************************************/
13586 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13589 redisplay_windows (Lisp_Object window
)
13591 while (!NILP (window
))
13593 struct window
*w
= XWINDOW (window
);
13595 if (!NILP (w
->hchild
))
13596 redisplay_windows (w
->hchild
);
13597 else if (!NILP (w
->vchild
))
13598 redisplay_windows (w
->vchild
);
13599 else if (!NILP (w
->buffer
))
13601 displayed_buffer
= XBUFFER (w
->buffer
);
13602 /* Use list_of_error, not Qerror, so that
13603 we catch only errors and don't run the debugger. */
13604 internal_condition_case_1 (redisplay_window_0
, window
,
13606 redisplay_window_error
);
13614 redisplay_window_error (Lisp_Object ignore
)
13616 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13621 redisplay_window_0 (Lisp_Object window
)
13623 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13624 redisplay_window (window
, 0);
13629 redisplay_window_1 (Lisp_Object window
)
13631 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13632 redisplay_window (window
, 1);
13637 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13638 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13639 which positions recorded in ROW differ from current buffer
13642 Return 0 if cursor is not on this row, 1 otherwise. */
13645 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13646 struct glyph_matrix
*matrix
,
13647 EMACS_INT delta
, EMACS_INT delta_bytes
,
13650 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13651 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13652 struct glyph
*cursor
= NULL
;
13653 /* The last known character position in row. */
13654 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13656 EMACS_INT pt_old
= PT
- delta
;
13657 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13658 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13659 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13660 /* A glyph beyond the edge of TEXT_AREA which we should never
13662 struct glyph
*glyphs_end
= end
;
13663 /* Non-zero means we've found a match for cursor position, but that
13664 glyph has the avoid_cursor_p flag set. */
13665 int match_with_avoid_cursor
= 0;
13666 /* Non-zero means we've seen at least one glyph that came from a
13668 int string_seen
= 0;
13669 /* Largest and smallest buffer positions seen so far during scan of
13671 EMACS_INT bpos_max
= pos_before
;
13672 EMACS_INT bpos_min
= pos_after
;
13673 /* Last buffer position covered by an overlay string with an integer
13674 `cursor' property. */
13675 EMACS_INT bpos_covered
= 0;
13676 /* Non-zero means the display string on which to display the cursor
13677 comes from a text property, not from an overlay. */
13678 int string_from_text_prop
= 0;
13680 /* Skip over glyphs not having an object at the start and the end of
13681 the row. These are special glyphs like truncation marks on
13682 terminal frames. */
13683 if (row
->displays_text_p
)
13685 if (!row
->reversed_p
)
13688 && INTEGERP (glyph
->object
)
13689 && glyph
->charpos
< 0)
13691 x
+= glyph
->pixel_width
;
13695 && INTEGERP ((end
- 1)->object
)
13696 /* CHARPOS is zero for blanks and stretch glyphs
13697 inserted by extend_face_to_end_of_line. */
13698 && (end
- 1)->charpos
<= 0)
13700 glyph_before
= glyph
- 1;
13707 /* If the glyph row is reversed, we need to process it from back
13708 to front, so swap the edge pointers. */
13709 glyphs_end
= end
= glyph
- 1;
13710 glyph
+= row
->used
[TEXT_AREA
] - 1;
13712 while (glyph
> end
+ 1
13713 && INTEGERP (glyph
->object
)
13714 && glyph
->charpos
< 0)
13717 x
-= glyph
->pixel_width
;
13719 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13721 /* By default, in reversed rows we put the cursor on the
13722 rightmost (first in the reading order) glyph. */
13723 for (g
= end
+ 1; g
< glyph
; g
++)
13724 x
+= g
->pixel_width
;
13726 && INTEGERP ((end
+ 1)->object
)
13727 && (end
+ 1)->charpos
<= 0)
13729 glyph_before
= glyph
+ 1;
13733 else if (row
->reversed_p
)
13735 /* In R2L rows that don't display text, put the cursor on the
13736 rightmost glyph. Case in point: an empty last line that is
13737 part of an R2L paragraph. */
13739 /* Avoid placing the cursor on the last glyph of the row, where
13740 on terminal frames we hold the vertical border between
13741 adjacent windows. */
13742 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13743 && !WINDOW_RIGHTMOST_P (w
)
13744 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13746 x
= -1; /* will be computed below, at label compute_x */
13749 /* Step 1: Try to find the glyph whose character position
13750 corresponds to point. If that's not possible, find 2 glyphs
13751 whose character positions are the closest to point, one before
13752 point, the other after it. */
13753 if (!row
->reversed_p
)
13754 while (/* not marched to end of glyph row */
13756 /* glyph was not inserted by redisplay for internal purposes */
13757 && !INTEGERP (glyph
->object
))
13759 if (BUFFERP (glyph
->object
))
13761 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13763 if (glyph
->charpos
> bpos_max
)
13764 bpos_max
= glyph
->charpos
;
13765 if (glyph
->charpos
< bpos_min
)
13766 bpos_min
= glyph
->charpos
;
13767 if (!glyph
->avoid_cursor_p
)
13769 /* If we hit point, we've found the glyph on which to
13770 display the cursor. */
13773 match_with_avoid_cursor
= 0;
13776 /* See if we've found a better approximation to
13777 POS_BEFORE or to POS_AFTER. Note that we want the
13778 first (leftmost) glyph of all those that are the
13779 closest from below, and the last (rightmost) of all
13780 those from above. */
13781 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13783 pos_before
= glyph
->charpos
;
13784 glyph_before
= glyph
;
13786 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13788 pos_after
= glyph
->charpos
;
13789 glyph_after
= glyph
;
13792 else if (dpos
== 0)
13793 match_with_avoid_cursor
= 1;
13795 else if (STRINGP (glyph
->object
))
13797 Lisp_Object chprop
;
13798 EMACS_INT glyph_pos
= glyph
->charpos
;
13800 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13802 if (!NILP (chprop
))
13804 /* If the string came from a `display' text property,
13805 look up the buffer position of that property and
13806 use that position to update bpos_max, as if we
13807 actually saw such a position in one of the row's
13808 glyphs. This helps with supporting integer values
13809 of `cursor' property on the display string in
13810 situations where most or all of the row's buffer
13811 text is completely covered by display properties,
13812 so that no glyph with valid buffer positions is
13813 ever seen in the row. */
13814 EMACS_INT prop_pos
=
13815 string_buffer_position_lim (glyph
->object
, pos_before
,
13818 if (prop_pos
>= pos_before
)
13819 bpos_max
= prop_pos
- 1;
13821 if (INTEGERP (chprop
))
13823 bpos_covered
= bpos_max
+ XINT (chprop
);
13824 /* If the `cursor' property covers buffer positions up
13825 to and including point, we should display cursor on
13826 this glyph. Note that, if a `cursor' property on one
13827 of the string's characters has an integer value, we
13828 will break out of the loop below _before_ we get to
13829 the position match above. IOW, integer values of
13830 the `cursor' property override the "exact match for
13831 point" strategy of positioning the cursor. */
13832 /* Implementation note: bpos_max == pt_old when, e.g.,
13833 we are in an empty line, where bpos_max is set to
13834 MATRIX_ROW_START_CHARPOS, see above. */
13835 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13844 x
+= glyph
->pixel_width
;
13847 else if (glyph
> end
) /* row is reversed */
13848 while (!INTEGERP (glyph
->object
))
13850 if (BUFFERP (glyph
->object
))
13852 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13854 if (glyph
->charpos
> bpos_max
)
13855 bpos_max
= glyph
->charpos
;
13856 if (glyph
->charpos
< bpos_min
)
13857 bpos_min
= glyph
->charpos
;
13858 if (!glyph
->avoid_cursor_p
)
13862 match_with_avoid_cursor
= 0;
13865 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13867 pos_before
= glyph
->charpos
;
13868 glyph_before
= glyph
;
13870 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13872 pos_after
= glyph
->charpos
;
13873 glyph_after
= glyph
;
13876 else if (dpos
== 0)
13877 match_with_avoid_cursor
= 1;
13879 else if (STRINGP (glyph
->object
))
13881 Lisp_Object chprop
;
13882 EMACS_INT glyph_pos
= glyph
->charpos
;
13884 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13886 if (!NILP (chprop
))
13888 EMACS_INT prop_pos
=
13889 string_buffer_position_lim (glyph
->object
, pos_before
,
13892 if (prop_pos
>= pos_before
)
13893 bpos_max
= prop_pos
- 1;
13895 if (INTEGERP (chprop
))
13897 bpos_covered
= bpos_max
+ XINT (chprop
);
13898 /* If the `cursor' property covers buffer positions up
13899 to and including point, we should display cursor on
13901 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13910 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13912 x
--; /* can't use any pixel_width */
13915 x
-= glyph
->pixel_width
;
13918 /* Step 2: If we didn't find an exact match for point, we need to
13919 look for a proper place to put the cursor among glyphs between
13920 GLYPH_BEFORE and GLYPH_AFTER. */
13921 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13922 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13923 && bpos_covered
< pt_old
)
13925 /* An empty line has a single glyph whose OBJECT is zero and
13926 whose CHARPOS is the position of a newline on that line.
13927 Note that on a TTY, there are more glyphs after that, which
13928 were produced by extend_face_to_end_of_line, but their
13929 CHARPOS is zero or negative. */
13931 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13932 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13934 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13936 EMACS_INT ellipsis_pos
;
13938 /* Scan back over the ellipsis glyphs. */
13939 if (!row
->reversed_p
)
13941 ellipsis_pos
= (glyph
- 1)->charpos
;
13942 while (glyph
> row
->glyphs
[TEXT_AREA
]
13943 && (glyph
- 1)->charpos
== ellipsis_pos
)
13944 glyph
--, x
-= glyph
->pixel_width
;
13945 /* That loop always goes one position too far, including
13946 the glyph before the ellipsis. So scan forward over
13948 x
+= glyph
->pixel_width
;
13951 else /* row is reversed */
13953 ellipsis_pos
= (glyph
+ 1)->charpos
;
13954 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13955 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13956 glyph
++, x
+= glyph
->pixel_width
;
13957 x
-= glyph
->pixel_width
;
13961 else if (match_with_avoid_cursor
)
13963 cursor
= glyph_after
;
13966 else if (string_seen
)
13968 int incr
= row
->reversed_p
? -1 : +1;
13970 /* Need to find the glyph that came out of a string which is
13971 present at point. That glyph is somewhere between
13972 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13973 positioned between POS_BEFORE and POS_AFTER in the
13975 struct glyph
*start
, *stop
;
13976 EMACS_INT pos
= pos_before
;
13980 /* If the row ends in a newline from a display string,
13981 reordering could have moved the glyphs belonging to the
13982 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13983 in this case we extend the search to the last glyph in
13984 the row that was not inserted by redisplay. */
13985 if (row
->ends_in_newline_from_string_p
)
13988 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13991 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13992 correspond to POS_BEFORE and POS_AFTER, respectively. We
13993 need START and STOP in the order that corresponds to the
13994 row's direction as given by its reversed_p flag. If the
13995 directionality of characters between POS_BEFORE and
13996 POS_AFTER is the opposite of the row's base direction,
13997 these characters will have been reordered for display,
13998 and we need to reverse START and STOP. */
13999 if (!row
->reversed_p
)
14001 start
= min (glyph_before
, glyph_after
);
14002 stop
= max (glyph_before
, glyph_after
);
14006 start
= max (glyph_before
, glyph_after
);
14007 stop
= min (glyph_before
, glyph_after
);
14009 for (glyph
= start
+ incr
;
14010 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14013 /* Any glyphs that come from the buffer are here because
14014 of bidi reordering. Skip them, and only pay
14015 attention to glyphs that came from some string. */
14016 if (STRINGP (glyph
->object
))
14020 /* If the display property covers the newline, we
14021 need to search for it one position farther. */
14022 EMACS_INT lim
= pos_after
14023 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14025 string_from_text_prop
= 0;
14026 str
= glyph
->object
;
14027 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14028 if (tem
== 0 /* from overlay */
14031 /* If the string from which this glyph came is
14032 found in the buffer at point, then we've
14033 found the glyph we've been looking for. If
14034 it comes from an overlay (tem == 0), and it
14035 has the `cursor' property on one of its
14036 glyphs, record that glyph as a candidate for
14037 displaying the cursor. (As in the
14038 unidirectional version, we will display the
14039 cursor on the last candidate we find.) */
14040 if (tem
== 0 || tem
== pt_old
)
14042 /* The glyphs from this string could have
14043 been reordered. Find the one with the
14044 smallest string position. Or there could
14045 be a character in the string with the
14046 `cursor' property, which means display
14047 cursor on that character's glyph. */
14048 EMACS_INT strpos
= glyph
->charpos
;
14053 string_from_text_prop
= 1;
14056 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14057 && EQ (glyph
->object
, str
);
14061 EMACS_INT gpos
= glyph
->charpos
;
14063 cprop
= Fget_char_property (make_number (gpos
),
14071 if (tem
&& glyph
->charpos
< strpos
)
14073 strpos
= glyph
->charpos
;
14082 pos
= tem
+ 1; /* don't find previous instances */
14084 /* This string is not what we want; skip all of the
14085 glyphs that came from it. */
14086 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14087 && EQ (glyph
->object
, str
))
14094 /* If we reached the end of the line, and END was from a string,
14095 the cursor is not on this line. */
14097 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14098 && STRINGP (end
->object
)
14099 && row
->continued_p
)
14102 /* A truncated row may not include PT among its character positions.
14103 Setting the cursor inside the scroll margin will trigger
14104 recalculation of hscroll in hscroll_window_tree. But if a
14105 display string covers point, defer to the string-handling
14106 code below to figure this out. */
14107 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14109 cursor
= glyph_before
;
14112 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14113 /* Zero-width characters produce no glyphs. */
14115 && (row
->reversed_p
14116 ? glyph_after
> glyphs_end
14117 : glyph_after
< glyphs_end
)))
14119 cursor
= glyph_after
;
14125 if (cursor
!= NULL
)
14131 /* Need to compute x that corresponds to GLYPH. */
14132 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14134 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14136 x
+= g
->pixel_width
;
14140 /* ROW could be part of a continued line, which, under bidi
14141 reordering, might have other rows whose start and end charpos
14142 occlude point. Only set w->cursor if we found a better
14143 approximation to the cursor position than we have from previously
14144 examined candidate rows belonging to the same continued line. */
14145 if (/* we already have a candidate row */
14146 w
->cursor
.vpos
>= 0
14147 /* that candidate is not the row we are processing */
14148 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14149 /* Make sure cursor.vpos specifies a row whose start and end
14150 charpos occlude point, and it is valid candidate for being a
14151 cursor-row. This is because some callers of this function
14152 leave cursor.vpos at the row where the cursor was displayed
14153 during the last redisplay cycle. */
14154 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14155 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14156 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14159 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14161 /* Don't consider glyphs that are outside TEXT_AREA. */
14162 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14164 /* Keep the candidate whose buffer position is the closest to
14165 point or has the `cursor' property. */
14166 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14167 w
->cursor
.hpos
>= 0
14168 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14169 && ((BUFFERP (g1
->object
)
14170 && (g1
->charpos
== pt_old
/* an exact match always wins */
14171 || (BUFFERP (glyph
->object
)
14172 && eabs (g1
->charpos
- pt_old
)
14173 < eabs (glyph
->charpos
- pt_old
))))
14174 /* previous candidate is a glyph from a string that has
14175 a non-nil `cursor' property */
14176 || (STRINGP (g1
->object
)
14177 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14178 Qcursor
, g1
->object
))
14179 /* previous candidate is from the same display
14180 string as this one, and the display string
14181 came from a text property */
14182 || (EQ (g1
->object
, glyph
->object
)
14183 && string_from_text_prop
)
14184 /* this candidate is from newline and its
14185 position is not an exact match */
14186 || (INTEGERP (glyph
->object
)
14187 && glyph
->charpos
!= pt_old
)))))
14189 /* If this candidate gives an exact match, use that. */
14190 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14191 /* If this candidate is a glyph created for the
14192 terminating newline of a line, and point is on that
14193 newline, it wins because it's an exact match. */
14194 || (!row
->continued_p
14195 && INTEGERP (glyph
->object
)
14196 && glyph
->charpos
== 0
14197 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14198 /* Otherwise, keep the candidate that comes from a row
14199 spanning less buffer positions. This may win when one or
14200 both candidate positions are on glyphs that came from
14201 display strings, for which we cannot compare buffer
14203 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14204 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14205 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14208 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14210 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14211 w
->cursor
.y
= row
->y
+ dy
;
14213 if (w
== XWINDOW (selected_window
))
14215 if (!row
->continued_p
14216 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14219 this_line_buffer
= XBUFFER (w
->buffer
);
14221 CHARPOS (this_line_start_pos
)
14222 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14223 BYTEPOS (this_line_start_pos
)
14224 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14226 CHARPOS (this_line_end_pos
)
14227 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14228 BYTEPOS (this_line_end_pos
)
14229 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14231 this_line_y
= w
->cursor
.y
;
14232 this_line_pixel_height
= row
->height
;
14233 this_line_vpos
= w
->cursor
.vpos
;
14234 this_line_start_x
= row
->x
;
14237 CHARPOS (this_line_start_pos
) = 0;
14244 /* Run window scroll functions, if any, for WINDOW with new window
14245 start STARTP. Sets the window start of WINDOW to that position.
14247 We assume that the window's buffer is really current. */
14249 static inline struct text_pos
14250 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14252 struct window
*w
= XWINDOW (window
);
14253 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14255 if (current_buffer
!= XBUFFER (w
->buffer
))
14258 if (!NILP (Vwindow_scroll_functions
))
14260 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14261 make_number (CHARPOS (startp
)));
14262 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14263 /* In case the hook functions switch buffers. */
14264 if (current_buffer
!= XBUFFER (w
->buffer
))
14265 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14272 /* Make sure the line containing the cursor is fully visible.
14273 A value of 1 means there is nothing to be done.
14274 (Either the line is fully visible, or it cannot be made so,
14275 or we cannot tell.)
14277 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14278 is higher than window.
14280 A value of 0 means the caller should do scrolling
14281 as if point had gone off the screen. */
14284 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14286 struct glyph_matrix
*matrix
;
14287 struct glyph_row
*row
;
14290 if (!make_cursor_line_fully_visible_p
)
14293 /* It's not always possible to find the cursor, e.g, when a window
14294 is full of overlay strings. Don't do anything in that case. */
14295 if (w
->cursor
.vpos
< 0)
14298 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14299 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14301 /* If the cursor row is not partially visible, there's nothing to do. */
14302 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14305 /* If the row the cursor is in is taller than the window's height,
14306 it's not clear what to do, so do nothing. */
14307 window_height
= window_box_height (w
);
14308 if (row
->height
>= window_height
)
14310 if (!force_p
|| MINI_WINDOW_P (w
)
14311 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14318 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14319 non-zero means only WINDOW is redisplayed in redisplay_internal.
14320 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14321 in redisplay_window to bring a partially visible line into view in
14322 the case that only the cursor has moved.
14324 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14325 last screen line's vertical height extends past the end of the screen.
14329 1 if scrolling succeeded
14331 0 if scrolling didn't find point.
14333 -1 if new fonts have been loaded so that we must interrupt
14334 redisplay, adjust glyph matrices, and try again. */
14340 SCROLLING_NEED_LARGER_MATRICES
14343 /* If scroll-conservatively is more than this, never recenter.
14345 If you change this, don't forget to update the doc string of
14346 `scroll-conservatively' and the Emacs manual. */
14347 #define SCROLL_LIMIT 100
14350 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14351 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14352 int temp_scroll_step
, int last_line_misfit
)
14354 struct window
*w
= XWINDOW (window
);
14355 struct frame
*f
= XFRAME (w
->frame
);
14356 struct text_pos pos
, startp
;
14358 int this_scroll_margin
, scroll_max
, rc
, height
;
14359 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14360 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14361 Lisp_Object aggressive
;
14362 /* We will never try scrolling more than this number of lines. */
14363 int scroll_limit
= SCROLL_LIMIT
;
14366 debug_method_add (w
, "try_scrolling");
14369 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14371 /* Compute scroll margin height in pixels. We scroll when point is
14372 within this distance from the top or bottom of the window. */
14373 if (scroll_margin
> 0)
14374 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14375 * FRAME_LINE_HEIGHT (f
);
14377 this_scroll_margin
= 0;
14379 /* Force arg_scroll_conservatively to have a reasonable value, to
14380 avoid scrolling too far away with slow move_it_* functions. Note
14381 that the user can supply scroll-conservatively equal to
14382 `most-positive-fixnum', which can be larger than INT_MAX. */
14383 if (arg_scroll_conservatively
> scroll_limit
)
14385 arg_scroll_conservatively
= scroll_limit
+ 1;
14386 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14388 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14389 /* Compute how much we should try to scroll maximally to bring
14390 point into view. */
14391 scroll_max
= (max (scroll_step
,
14392 max (arg_scroll_conservatively
, temp_scroll_step
))
14393 * FRAME_LINE_HEIGHT (f
));
14394 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14395 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14396 /* We're trying to scroll because of aggressive scrolling but no
14397 scroll_step is set. Choose an arbitrary one. */
14398 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14404 /* Decide whether to scroll down. */
14405 if (PT
> CHARPOS (startp
))
14407 int scroll_margin_y
;
14409 /* Compute the pixel ypos of the scroll margin, then move IT to
14410 either that ypos or PT, whichever comes first. */
14411 start_display (&it
, w
, startp
);
14412 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14413 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14414 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14415 (MOVE_TO_POS
| MOVE_TO_Y
));
14417 if (PT
> CHARPOS (it
.current
.pos
))
14419 int y0
= line_bottom_y (&it
);
14420 /* Compute how many pixels below window bottom to stop searching
14421 for PT. This avoids costly search for PT that is far away if
14422 the user limited scrolling by a small number of lines, but
14423 always finds PT if scroll_conservatively is set to a large
14424 number, such as most-positive-fixnum. */
14425 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14426 int y_to_move
= it
.last_visible_y
+ slack
;
14428 /* Compute the distance from the scroll margin to PT or to
14429 the scroll limit, whichever comes first. This should
14430 include the height of the cursor line, to make that line
14432 move_it_to (&it
, PT
, -1, y_to_move
,
14433 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14434 dy
= line_bottom_y (&it
) - y0
;
14436 if (dy
> scroll_max
)
14437 return SCROLLING_FAILED
;
14446 /* Point is in or below the bottom scroll margin, so move the
14447 window start down. If scrolling conservatively, move it just
14448 enough down to make point visible. If scroll_step is set,
14449 move it down by scroll_step. */
14450 if (arg_scroll_conservatively
)
14452 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14453 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14454 else if (scroll_step
|| temp_scroll_step
)
14455 amount_to_scroll
= scroll_max
;
14458 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14459 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14460 if (NUMBERP (aggressive
))
14462 double float_amount
= XFLOATINT (aggressive
) * height
;
14463 amount_to_scroll
= float_amount
;
14464 if (amount_to_scroll
== 0 && float_amount
> 0)
14465 amount_to_scroll
= 1;
14466 /* Don't let point enter the scroll margin near top of
14468 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14469 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14473 if (amount_to_scroll
<= 0)
14474 return SCROLLING_FAILED
;
14476 start_display (&it
, w
, startp
);
14477 if (arg_scroll_conservatively
<= scroll_limit
)
14478 move_it_vertically (&it
, amount_to_scroll
);
14481 /* Extra precision for users who set scroll-conservatively
14482 to a large number: make sure the amount we scroll
14483 the window start is never less than amount_to_scroll,
14484 which was computed as distance from window bottom to
14485 point. This matters when lines at window top and lines
14486 below window bottom have different height. */
14488 void *it1data
= NULL
;
14489 /* We use a temporary it1 because line_bottom_y can modify
14490 its argument, if it moves one line down; see there. */
14493 SAVE_IT (it1
, it
, it1data
);
14494 start_y
= line_bottom_y (&it1
);
14496 RESTORE_IT (&it
, &it
, it1data
);
14497 move_it_by_lines (&it
, 1);
14498 SAVE_IT (it1
, it
, it1data
);
14499 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14502 /* If STARTP is unchanged, move it down another screen line. */
14503 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14504 move_it_by_lines (&it
, 1);
14505 startp
= it
.current
.pos
;
14509 struct text_pos scroll_margin_pos
= startp
;
14511 /* See if point is inside the scroll margin at the top of the
14513 if (this_scroll_margin
)
14515 start_display (&it
, w
, startp
);
14516 move_it_vertically (&it
, this_scroll_margin
);
14517 scroll_margin_pos
= it
.current
.pos
;
14520 if (PT
< CHARPOS (scroll_margin_pos
))
14522 /* Point is in the scroll margin at the top of the window or
14523 above what is displayed in the window. */
14526 /* Compute the vertical distance from PT to the scroll
14527 margin position. Move as far as scroll_max allows, or
14528 one screenful, or 10 screen lines, whichever is largest.
14529 Give up if distance is greater than scroll_max. */
14530 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14531 start_display (&it
, w
, pos
);
14533 y_to_move
= max (it
.last_visible_y
,
14534 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14535 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14537 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14538 dy
= it
.current_y
- y0
;
14539 if (dy
> scroll_max
)
14540 return SCROLLING_FAILED
;
14542 /* Compute new window start. */
14543 start_display (&it
, w
, startp
);
14545 if (arg_scroll_conservatively
)
14546 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14547 max (scroll_step
, temp_scroll_step
));
14548 else if (scroll_step
|| temp_scroll_step
)
14549 amount_to_scroll
= scroll_max
;
14552 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14553 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14554 if (NUMBERP (aggressive
))
14556 double float_amount
= XFLOATINT (aggressive
) * height
;
14557 amount_to_scroll
= float_amount
;
14558 if (amount_to_scroll
== 0 && float_amount
> 0)
14559 amount_to_scroll
= 1;
14560 amount_to_scroll
-=
14561 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14562 /* Don't let point enter the scroll margin near
14563 bottom of the window. */
14564 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14565 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14569 if (amount_to_scroll
<= 0)
14570 return SCROLLING_FAILED
;
14572 move_it_vertically_backward (&it
, amount_to_scroll
);
14573 startp
= it
.current
.pos
;
14577 /* Run window scroll functions. */
14578 startp
= run_window_scroll_functions (window
, startp
);
14580 /* Display the window. Give up if new fonts are loaded, or if point
14582 if (!try_window (window
, startp
, 0))
14583 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14584 else if (w
->cursor
.vpos
< 0)
14586 clear_glyph_matrix (w
->desired_matrix
);
14587 rc
= SCROLLING_FAILED
;
14591 /* Maybe forget recorded base line for line number display. */
14592 if (!just_this_one_p
14593 || current_buffer
->clip_changed
14594 || BEG_UNCHANGED
< CHARPOS (startp
))
14595 w
->base_line_number
= Qnil
;
14597 /* If cursor ends up on a partially visible line,
14598 treat that as being off the bottom of the screen. */
14599 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14600 /* It's possible that the cursor is on the first line of the
14601 buffer, which is partially obscured due to a vscroll
14602 (Bug#7537). In that case, avoid looping forever . */
14603 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14605 clear_glyph_matrix (w
->desired_matrix
);
14606 ++extra_scroll_margin_lines
;
14609 rc
= SCROLLING_SUCCESS
;
14616 /* Compute a suitable window start for window W if display of W starts
14617 on a continuation line. Value is non-zero if a new window start
14620 The new window start will be computed, based on W's width, starting
14621 from the start of the continued line. It is the start of the
14622 screen line with the minimum distance from the old start W->start. */
14625 compute_window_start_on_continuation_line (struct window
*w
)
14627 struct text_pos pos
, start_pos
;
14628 int window_start_changed_p
= 0;
14630 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14632 /* If window start is on a continuation line... Window start may be
14633 < BEGV in case there's invisible text at the start of the
14634 buffer (M-x rmail, for example). */
14635 if (CHARPOS (start_pos
) > BEGV
14636 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14639 struct glyph_row
*row
;
14641 /* Handle the case that the window start is out of range. */
14642 if (CHARPOS (start_pos
) < BEGV
)
14643 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14644 else if (CHARPOS (start_pos
) > ZV
)
14645 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14647 /* Find the start of the continued line. This should be fast
14648 because scan_buffer is fast (newline cache). */
14649 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14650 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14651 row
, DEFAULT_FACE_ID
);
14652 reseat_at_previous_visible_line_start (&it
);
14654 /* If the line start is "too far" away from the window start,
14655 say it takes too much time to compute a new window start. */
14656 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14657 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14659 int min_distance
, distance
;
14661 /* Move forward by display lines to find the new window
14662 start. If window width was enlarged, the new start can
14663 be expected to be > the old start. If window width was
14664 decreased, the new window start will be < the old start.
14665 So, we're looking for the display line start with the
14666 minimum distance from the old window start. */
14667 pos
= it
.current
.pos
;
14668 min_distance
= INFINITY
;
14669 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14670 distance
< min_distance
)
14672 min_distance
= distance
;
14673 pos
= it
.current
.pos
;
14674 move_it_by_lines (&it
, 1);
14677 /* Set the window start there. */
14678 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14679 window_start_changed_p
= 1;
14683 return window_start_changed_p
;
14687 /* Try cursor movement in case text has not changed in window WINDOW,
14688 with window start STARTP. Value is
14690 CURSOR_MOVEMENT_SUCCESS if successful
14692 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14694 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14695 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14696 we want to scroll as if scroll-step were set to 1. See the code.
14698 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14699 which case we have to abort this redisplay, and adjust matrices
14704 CURSOR_MOVEMENT_SUCCESS
,
14705 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14706 CURSOR_MOVEMENT_MUST_SCROLL
,
14707 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14711 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14713 struct window
*w
= XWINDOW (window
);
14714 struct frame
*f
= XFRAME (w
->frame
);
14715 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14718 if (inhibit_try_cursor_movement
)
14722 /* Handle case where text has not changed, only point, and it has
14723 not moved off the frame. */
14724 if (/* Point may be in this window. */
14725 PT
>= CHARPOS (startp
)
14726 /* Selective display hasn't changed. */
14727 && !current_buffer
->clip_changed
14728 /* Function force-mode-line-update is used to force a thorough
14729 redisplay. It sets either windows_or_buffers_changed or
14730 update_mode_lines. So don't take a shortcut here for these
14732 && !update_mode_lines
14733 && !windows_or_buffers_changed
14734 && !cursor_type_changed
14735 /* Can't use this case if highlighting a region. When a
14736 region exists, cursor movement has to do more than just
14738 && !(!NILP (Vtransient_mark_mode
)
14739 && !NILP (BVAR (current_buffer
, mark_active
)))
14740 && NILP (w
->region_showing
)
14741 && NILP (Vshow_trailing_whitespace
)
14742 /* Right after splitting windows, last_point may be nil. */
14743 && INTEGERP (w
->last_point
)
14744 /* This code is not used for mini-buffer for the sake of the case
14745 of redisplaying to replace an echo area message; since in
14746 that case the mini-buffer contents per se are usually
14747 unchanged. This code is of no real use in the mini-buffer
14748 since the handling of this_line_start_pos, etc., in redisplay
14749 handles the same cases. */
14750 && !EQ (window
, minibuf_window
)
14751 /* When splitting windows or for new windows, it happens that
14752 redisplay is called with a nil window_end_vpos or one being
14753 larger than the window. This should really be fixed in
14754 window.c. I don't have this on my list, now, so we do
14755 approximately the same as the old redisplay code. --gerd. */
14756 && INTEGERP (w
->window_end_vpos
)
14757 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14758 && (FRAME_WINDOW_P (f
)
14759 || !overlay_arrow_in_current_buffer_p ()))
14761 int this_scroll_margin
, top_scroll_margin
;
14762 struct glyph_row
*row
= NULL
;
14765 debug_method_add (w
, "cursor movement");
14768 /* Scroll if point within this distance from the top or bottom
14769 of the window. This is a pixel value. */
14770 if (scroll_margin
> 0)
14772 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14773 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14776 this_scroll_margin
= 0;
14778 top_scroll_margin
= this_scroll_margin
;
14779 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14780 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14782 /* Start with the row the cursor was displayed during the last
14783 not paused redisplay. Give up if that row is not valid. */
14784 if (w
->last_cursor
.vpos
< 0
14785 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14786 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14789 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14790 if (row
->mode_line_p
)
14792 if (!row
->enabled_p
)
14793 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14796 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14798 int scroll_p
= 0, must_scroll
= 0;
14799 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14801 if (PT
> XFASTINT (w
->last_point
))
14803 /* Point has moved forward. */
14804 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14805 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14807 xassert (row
->enabled_p
);
14811 /* If the end position of a row equals the start
14812 position of the next row, and PT is at that position,
14813 we would rather display cursor in the next line. */
14814 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14815 && MATRIX_ROW_END_CHARPOS (row
) == PT
14816 && row
< w
->current_matrix
->rows
14817 + w
->current_matrix
->nrows
- 1
14818 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14819 && !cursor_row_p (row
))
14822 /* If within the scroll margin, scroll. Note that
14823 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14824 the next line would be drawn, and that
14825 this_scroll_margin can be zero. */
14826 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14827 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14828 /* Line is completely visible last line in window
14829 and PT is to be set in the next line. */
14830 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14831 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14832 && !row
->ends_at_zv_p
14833 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14836 else if (PT
< XFASTINT (w
->last_point
))
14838 /* Cursor has to be moved backward. Note that PT >=
14839 CHARPOS (startp) because of the outer if-statement. */
14840 while (!row
->mode_line_p
14841 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14842 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14843 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14844 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14845 row
> w
->current_matrix
->rows
14846 && (row
-1)->ends_in_newline_from_string_p
))))
14847 && (row
->y
> top_scroll_margin
14848 || CHARPOS (startp
) == BEGV
))
14850 xassert (row
->enabled_p
);
14854 /* Consider the following case: Window starts at BEGV,
14855 there is invisible, intangible text at BEGV, so that
14856 display starts at some point START > BEGV. It can
14857 happen that we are called with PT somewhere between
14858 BEGV and START. Try to handle that case. */
14859 if (row
< w
->current_matrix
->rows
14860 || row
->mode_line_p
)
14862 row
= w
->current_matrix
->rows
;
14863 if (row
->mode_line_p
)
14867 /* Due to newlines in overlay strings, we may have to
14868 skip forward over overlay strings. */
14869 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14870 && MATRIX_ROW_END_CHARPOS (row
) == PT
14871 && !cursor_row_p (row
))
14874 /* If within the scroll margin, scroll. */
14875 if (row
->y
< top_scroll_margin
14876 && CHARPOS (startp
) != BEGV
)
14881 /* Cursor did not move. So don't scroll even if cursor line
14882 is partially visible, as it was so before. */
14883 rc
= CURSOR_MOVEMENT_SUCCESS
;
14886 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14887 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14889 /* if PT is not in the glyph row, give up. */
14890 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14893 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14894 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14896 /* If rows are bidi-reordered and point moved, back up
14897 until we find a row that does not belong to a
14898 continuation line. This is because we must consider
14899 all rows of a continued line as candidates for the
14900 new cursor positioning, since row start and end
14901 positions change non-linearly with vertical position
14903 /* FIXME: Revisit this when glyph ``spilling'' in
14904 continuation lines' rows is implemented for
14905 bidi-reordered rows. */
14906 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14908 /* If we hit the beginning of the displayed portion
14909 without finding the first row of a continued
14911 if (row
<= w
->current_matrix
->rows
)
14913 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14916 xassert (row
->enabled_p
);
14922 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14923 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14924 && make_cursor_line_fully_visible_p
)
14926 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14927 && !row
->ends_at_zv_p
14928 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14929 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14930 else if (row
->height
> window_box_height (w
))
14932 /* If we end up in a partially visible line, let's
14933 make it fully visible, except when it's taller
14934 than the window, in which case we can't do much
14937 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14941 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14942 if (!cursor_row_fully_visible_p (w
, 0, 1))
14943 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14945 rc
= CURSOR_MOVEMENT_SUCCESS
;
14949 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14950 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14951 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14953 /* With bidi-reordered rows, there could be more than
14954 one candidate row whose start and end positions
14955 occlude point. We need to let set_cursor_from_row
14956 find the best candidate. */
14957 /* FIXME: Revisit this when glyph ``spilling'' in
14958 continuation lines' rows is implemented for
14959 bidi-reordered rows. */
14964 int at_zv_p
= 0, exact_match_p
= 0;
14966 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14967 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14968 && cursor_row_p (row
))
14969 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14971 /* As soon as we've found the exact match for point,
14972 or the first suitable row whose ends_at_zv_p flag
14973 is set, we are done. */
14975 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14977 && w
->cursor
.hpos
>= 0
14978 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14981 struct glyph_row
*candidate
=
14982 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14984 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14985 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14988 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14989 || (INTEGERP (g
->object
)
14990 && (g
->charpos
== PT
14991 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14993 if (rv
&& (at_zv_p
|| exact_match_p
))
14995 rc
= CURSOR_MOVEMENT_SUCCESS
;
14998 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15002 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15003 || row
->continued_p
)
15004 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15005 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15006 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15007 /* If we didn't find any candidate rows, or exited the
15008 loop before all the candidates were examined, signal
15009 to the caller that this method failed. */
15010 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15012 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15013 && !row
->continued_p
))
15014 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15016 rc
= CURSOR_MOVEMENT_SUCCESS
;
15022 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15024 rc
= CURSOR_MOVEMENT_SUCCESS
;
15029 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15030 && MATRIX_ROW_START_CHARPOS (row
) == PT
15031 && cursor_row_p (row
));
15039 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15043 set_vertical_scroll_bar (struct window
*w
)
15045 EMACS_INT start
, end
, whole
;
15047 /* Calculate the start and end positions for the current window.
15048 At some point, it would be nice to choose between scrollbars
15049 which reflect the whole buffer size, with special markers
15050 indicating narrowing, and scrollbars which reflect only the
15053 Note that mini-buffers sometimes aren't displaying any text. */
15054 if (!MINI_WINDOW_P (w
)
15055 || (w
== XWINDOW (minibuf_window
)
15056 && NILP (echo_area_buffer
[0])))
15058 struct buffer
*buf
= XBUFFER (w
->buffer
);
15059 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15060 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15061 /* I don't think this is guaranteed to be right. For the
15062 moment, we'll pretend it is. */
15063 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15067 if (whole
< (end
- start
))
15068 whole
= end
- start
;
15071 start
= end
= whole
= 0;
15073 /* Indicate what this scroll bar ought to be displaying now. */
15074 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15075 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15076 (w
, end
- start
, whole
, start
);
15080 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15081 selected_window is redisplayed.
15083 We can return without actually redisplaying the window if
15084 fonts_changed_p is nonzero. In that case, redisplay_internal will
15088 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15090 struct window
*w
= XWINDOW (window
);
15091 struct frame
*f
= XFRAME (w
->frame
);
15092 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15093 struct buffer
*old
= current_buffer
;
15094 struct text_pos lpoint
, opoint
, startp
;
15095 int update_mode_line
;
15098 /* Record it now because it's overwritten. */
15099 int current_matrix_up_to_date_p
= 0;
15100 int used_current_matrix_p
= 0;
15101 /* This is less strict than current_matrix_up_to_date_p.
15102 It indicates that the buffer contents and narrowing are unchanged. */
15103 int buffer_unchanged_p
= 0;
15104 int temp_scroll_step
= 0;
15105 int count
= SPECPDL_INDEX ();
15107 int centering_position
= -1;
15108 int last_line_misfit
= 0;
15109 EMACS_INT beg_unchanged
, end_unchanged
;
15111 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15114 /* W must be a leaf window here. */
15115 xassert (!NILP (w
->buffer
));
15117 *w
->desired_matrix
->method
= 0;
15121 reconsider_clip_changes (w
, buffer
);
15123 /* Has the mode line to be updated? */
15124 update_mode_line
= (!NILP (w
->update_mode_line
)
15125 || update_mode_lines
15126 || buffer
->clip_changed
15127 || buffer
->prevent_redisplay_optimizations_p
);
15129 if (MINI_WINDOW_P (w
))
15131 if (w
== XWINDOW (echo_area_window
)
15132 && !NILP (echo_area_buffer
[0]))
15134 if (update_mode_line
)
15135 /* We may have to update a tty frame's menu bar or a
15136 tool-bar. Example `M-x C-h C-h C-g'. */
15137 goto finish_menu_bars
;
15139 /* We've already displayed the echo area glyphs in this window. */
15140 goto finish_scroll_bars
;
15142 else if ((w
!= XWINDOW (minibuf_window
)
15143 || minibuf_level
== 0)
15144 /* When buffer is nonempty, redisplay window normally. */
15145 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15146 /* Quail displays non-mini buffers in minibuffer window.
15147 In that case, redisplay the window normally. */
15148 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15150 /* W is a mini-buffer window, but it's not active, so clear
15152 int yb
= window_text_bottom_y (w
);
15153 struct glyph_row
*row
;
15156 for (y
= 0, row
= w
->desired_matrix
->rows
;
15158 y
+= row
->height
, ++row
)
15159 blank_row (w
, row
, y
);
15160 goto finish_scroll_bars
;
15163 clear_glyph_matrix (w
->desired_matrix
);
15166 /* Otherwise set up data on this window; select its buffer and point
15168 /* Really select the buffer, for the sake of buffer-local
15170 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15172 current_matrix_up_to_date_p
15173 = (!NILP (w
->window_end_valid
)
15174 && !current_buffer
->clip_changed
15175 && !current_buffer
->prevent_redisplay_optimizations_p
15176 && XFASTINT (w
->last_modified
) >= MODIFF
15177 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15179 /* Run the window-bottom-change-functions
15180 if it is possible that the text on the screen has changed
15181 (either due to modification of the text, or any other reason). */
15182 if (!current_matrix_up_to_date_p
15183 && !NILP (Vwindow_text_change_functions
))
15185 safe_run_hooks (Qwindow_text_change_functions
);
15189 beg_unchanged
= BEG_UNCHANGED
;
15190 end_unchanged
= END_UNCHANGED
;
15192 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15194 specbind (Qinhibit_point_motion_hooks
, Qt
);
15197 = (!NILP (w
->window_end_valid
)
15198 && !current_buffer
->clip_changed
15199 && XFASTINT (w
->last_modified
) >= MODIFF
15200 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15202 /* When windows_or_buffers_changed is non-zero, we can't rely on
15203 the window end being valid, so set it to nil there. */
15204 if (windows_or_buffers_changed
)
15206 /* If window starts on a continuation line, maybe adjust the
15207 window start in case the window's width changed. */
15208 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15209 compute_window_start_on_continuation_line (w
);
15211 w
->window_end_valid
= Qnil
;
15214 /* Some sanity checks. */
15215 CHECK_WINDOW_END (w
);
15216 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15218 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15221 /* If %c is in mode line, update it if needed. */
15222 if (!NILP (w
->column_number_displayed
)
15223 /* This alternative quickly identifies a common case
15224 where no change is needed. */
15225 && !(PT
== XFASTINT (w
->last_point
)
15226 && XFASTINT (w
->last_modified
) >= MODIFF
15227 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15228 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15229 update_mode_line
= 1;
15231 /* Count number of windows showing the selected buffer. An indirect
15232 buffer counts as its base buffer. */
15233 if (!just_this_one_p
)
15235 struct buffer
*current_base
, *window_base
;
15236 current_base
= current_buffer
;
15237 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15238 if (current_base
->base_buffer
)
15239 current_base
= current_base
->base_buffer
;
15240 if (window_base
->base_buffer
)
15241 window_base
= window_base
->base_buffer
;
15242 if (current_base
== window_base
)
15246 /* Point refers normally to the selected window. For any other
15247 window, set up appropriate value. */
15248 if (!EQ (window
, selected_window
))
15250 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15251 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15255 new_pt_byte
= BEGV_BYTE
;
15256 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15258 else if (new_pt
> (ZV
- 1))
15261 new_pt_byte
= ZV_BYTE
;
15262 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15265 /* We don't use SET_PT so that the point-motion hooks don't run. */
15266 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15269 /* If any of the character widths specified in the display table
15270 have changed, invalidate the width run cache. It's true that
15271 this may be a bit late to catch such changes, but the rest of
15272 redisplay goes (non-fatally) haywire when the display table is
15273 changed, so why should we worry about doing any better? */
15274 if (current_buffer
->width_run_cache
)
15276 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15278 if (! disptab_matches_widthtab (disptab
,
15279 XVECTOR (BVAR (current_buffer
, width_table
))))
15281 invalidate_region_cache (current_buffer
,
15282 current_buffer
->width_run_cache
,
15284 recompute_width_table (current_buffer
, disptab
);
15288 /* If window-start is screwed up, choose a new one. */
15289 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15292 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15294 /* If someone specified a new starting point but did not insist,
15295 check whether it can be used. */
15296 if (!NILP (w
->optional_new_start
)
15297 && CHARPOS (startp
) >= BEGV
15298 && CHARPOS (startp
) <= ZV
)
15300 w
->optional_new_start
= Qnil
;
15301 start_display (&it
, w
, startp
);
15302 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15303 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15304 if (IT_CHARPOS (it
) == PT
)
15305 w
->force_start
= Qt
;
15306 /* IT may overshoot PT if text at PT is invisible. */
15307 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15308 w
->force_start
= Qt
;
15313 /* Handle case where place to start displaying has been specified,
15314 unless the specified location is outside the accessible range. */
15315 if (!NILP (w
->force_start
)
15316 || w
->frozen_window_start_p
)
15318 /* We set this later on if we have to adjust point. */
15321 w
->force_start
= Qnil
;
15323 w
->window_end_valid
= Qnil
;
15325 /* Forget any recorded base line for line number display. */
15326 if (!buffer_unchanged_p
)
15327 w
->base_line_number
= Qnil
;
15329 /* Redisplay the mode line. Select the buffer properly for that.
15330 Also, run the hook window-scroll-functions
15331 because we have scrolled. */
15332 /* Note, we do this after clearing force_start because
15333 if there's an error, it is better to forget about force_start
15334 than to get into an infinite loop calling the hook functions
15335 and having them get more errors. */
15336 if (!update_mode_line
15337 || ! NILP (Vwindow_scroll_functions
))
15339 update_mode_line
= 1;
15340 w
->update_mode_line
= Qt
;
15341 startp
= run_window_scroll_functions (window
, startp
);
15344 w
->last_modified
= make_number (0);
15345 w
->last_overlay_modified
= make_number (0);
15346 if (CHARPOS (startp
) < BEGV
)
15347 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15348 else if (CHARPOS (startp
) > ZV
)
15349 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15351 /* Redisplay, then check if cursor has been set during the
15352 redisplay. Give up if new fonts were loaded. */
15353 /* We used to issue a CHECK_MARGINS argument to try_window here,
15354 but this causes scrolling to fail when point begins inside
15355 the scroll margin (bug#148) -- cyd */
15356 if (!try_window (window
, startp
, 0))
15358 w
->force_start
= Qt
;
15359 clear_glyph_matrix (w
->desired_matrix
);
15360 goto need_larger_matrices
;
15363 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15365 /* If point does not appear, try to move point so it does
15366 appear. The desired matrix has been built above, so we
15367 can use it here. */
15368 new_vpos
= window_box_height (w
) / 2;
15371 if (!cursor_row_fully_visible_p (w
, 0, 0))
15373 /* Point does appear, but on a line partly visible at end of window.
15374 Move it back to a fully-visible line. */
15375 new_vpos
= window_box_height (w
);
15378 /* If we need to move point for either of the above reasons,
15379 now actually do it. */
15382 struct glyph_row
*row
;
15384 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15385 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15388 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15389 MATRIX_ROW_START_BYTEPOS (row
));
15391 if (w
!= XWINDOW (selected_window
))
15392 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15393 else if (current_buffer
== old
)
15394 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15396 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15398 /* If we are highlighting the region, then we just changed
15399 the region, so redisplay to show it. */
15400 if (!NILP (Vtransient_mark_mode
)
15401 && !NILP (BVAR (current_buffer
, mark_active
)))
15403 clear_glyph_matrix (w
->desired_matrix
);
15404 if (!try_window (window
, startp
, 0))
15405 goto need_larger_matrices
;
15410 debug_method_add (w
, "forced window start");
15415 /* Handle case where text has not changed, only point, and it has
15416 not moved off the frame, and we are not retrying after hscroll.
15417 (current_matrix_up_to_date_p is nonzero when retrying.) */
15418 if (current_matrix_up_to_date_p
15419 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15420 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15424 case CURSOR_MOVEMENT_SUCCESS
:
15425 used_current_matrix_p
= 1;
15428 case CURSOR_MOVEMENT_MUST_SCROLL
:
15429 goto try_to_scroll
;
15435 /* If current starting point was originally the beginning of a line
15436 but no longer is, find a new starting point. */
15437 else if (!NILP (w
->start_at_line_beg
)
15438 && !(CHARPOS (startp
) <= BEGV
15439 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15442 debug_method_add (w
, "recenter 1");
15447 /* Try scrolling with try_window_id. Value is > 0 if update has
15448 been done, it is -1 if we know that the same window start will
15449 not work. It is 0 if unsuccessful for some other reason. */
15450 else if ((tem
= try_window_id (w
)) != 0)
15453 debug_method_add (w
, "try_window_id %d", tem
);
15456 if (fonts_changed_p
)
15457 goto need_larger_matrices
;
15461 /* Otherwise try_window_id has returned -1 which means that we
15462 don't want the alternative below this comment to execute. */
15464 else if (CHARPOS (startp
) >= BEGV
15465 && CHARPOS (startp
) <= ZV
15466 && PT
>= CHARPOS (startp
)
15467 && (CHARPOS (startp
) < ZV
15468 /* Avoid starting at end of buffer. */
15469 || CHARPOS (startp
) == BEGV
15470 || (XFASTINT (w
->last_modified
) >= MODIFF
15471 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15473 int d1
, d2
, d3
, d4
, d5
, d6
;
15475 /* If first window line is a continuation line, and window start
15476 is inside the modified region, but the first change is before
15477 current window start, we must select a new window start.
15479 However, if this is the result of a down-mouse event (e.g. by
15480 extending the mouse-drag-overlay), we don't want to select a
15481 new window start, since that would change the position under
15482 the mouse, resulting in an unwanted mouse-movement rather
15483 than a simple mouse-click. */
15484 if (NILP (w
->start_at_line_beg
)
15485 && NILP (do_mouse_tracking
)
15486 && CHARPOS (startp
) > BEGV
15487 && CHARPOS (startp
) > BEG
+ beg_unchanged
15488 && CHARPOS (startp
) <= Z
- end_unchanged
15489 /* Even if w->start_at_line_beg is nil, a new window may
15490 start at a line_beg, since that's how set_buffer_window
15491 sets it. So, we need to check the return value of
15492 compute_window_start_on_continuation_line. (See also
15494 && XMARKER (w
->start
)->buffer
== current_buffer
15495 && compute_window_start_on_continuation_line (w
)
15496 /* It doesn't make sense to force the window start like we
15497 do at label force_start if it is already known that point
15498 will not be visible in the resulting window, because
15499 doing so will move point from its correct position
15500 instead of scrolling the window to bring point into view.
15502 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15504 w
->force_start
= Qt
;
15505 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15510 debug_method_add (w
, "same window start");
15513 /* Try to redisplay starting at same place as before.
15514 If point has not moved off frame, accept the results. */
15515 if (!current_matrix_up_to_date_p
15516 /* Don't use try_window_reusing_current_matrix in this case
15517 because a window scroll function can have changed the
15519 || !NILP (Vwindow_scroll_functions
)
15520 || MINI_WINDOW_P (w
)
15521 || !(used_current_matrix_p
15522 = try_window_reusing_current_matrix (w
)))
15524 IF_DEBUG (debug_method_add (w
, "1"));
15525 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15526 /* -1 means we need to scroll.
15527 0 means we need new matrices, but fonts_changed_p
15528 is set in that case, so we will detect it below. */
15529 goto try_to_scroll
;
15532 if (fonts_changed_p
)
15533 goto need_larger_matrices
;
15535 if (w
->cursor
.vpos
>= 0)
15537 if (!just_this_one_p
15538 || current_buffer
->clip_changed
15539 || BEG_UNCHANGED
< CHARPOS (startp
))
15540 /* Forget any recorded base line for line number display. */
15541 w
->base_line_number
= Qnil
;
15543 if (!cursor_row_fully_visible_p (w
, 1, 0))
15545 clear_glyph_matrix (w
->desired_matrix
);
15546 last_line_misfit
= 1;
15548 /* Drop through and scroll. */
15553 clear_glyph_matrix (w
->desired_matrix
);
15558 w
->last_modified
= make_number (0);
15559 w
->last_overlay_modified
= make_number (0);
15561 /* Redisplay the mode line. Select the buffer properly for that. */
15562 if (!update_mode_line
)
15564 update_mode_line
= 1;
15565 w
->update_mode_line
= Qt
;
15568 /* Try to scroll by specified few lines. */
15569 if ((scroll_conservatively
15570 || emacs_scroll_step
15571 || temp_scroll_step
15572 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15573 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15574 && CHARPOS (startp
) >= BEGV
15575 && CHARPOS (startp
) <= ZV
)
15577 /* The function returns -1 if new fonts were loaded, 1 if
15578 successful, 0 if not successful. */
15579 int ss
= try_scrolling (window
, just_this_one_p
,
15580 scroll_conservatively
,
15582 temp_scroll_step
, last_line_misfit
);
15585 case SCROLLING_SUCCESS
:
15588 case SCROLLING_NEED_LARGER_MATRICES
:
15589 goto need_larger_matrices
;
15591 case SCROLLING_FAILED
:
15599 /* Finally, just choose a place to start which positions point
15600 according to user preferences. */
15605 debug_method_add (w
, "recenter");
15608 /* w->vscroll = 0; */
15610 /* Forget any previously recorded base line for line number display. */
15611 if (!buffer_unchanged_p
)
15612 w
->base_line_number
= Qnil
;
15614 /* Determine the window start relative to point. */
15615 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15616 it
.current_y
= it
.last_visible_y
;
15617 if (centering_position
< 0)
15621 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15623 EMACS_INT margin_pos
= CHARPOS (startp
);
15624 Lisp_Object aggressive
;
15627 /* If there is a scroll margin at the top of the window, find
15628 its character position. */
15630 /* Cannot call start_display if startp is not in the
15631 accessible region of the buffer. This can happen when we
15632 have just switched to a different buffer and/or changed
15633 its restriction. In that case, startp is initialized to
15634 the character position 1 (BEGV) because we did not yet
15635 have chance to display the buffer even once. */
15636 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15639 void *it1data
= NULL
;
15641 SAVE_IT (it1
, it
, it1data
);
15642 start_display (&it1
, w
, startp
);
15643 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15644 margin_pos
= IT_CHARPOS (it1
);
15645 RESTORE_IT (&it
, &it
, it1data
);
15647 scrolling_up
= PT
> margin_pos
;
15650 ? BVAR (current_buffer
, scroll_up_aggressively
)
15651 : BVAR (current_buffer
, scroll_down_aggressively
);
15653 if (!MINI_WINDOW_P (w
)
15654 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15658 /* Setting scroll-conservatively overrides
15659 scroll-*-aggressively. */
15660 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15662 double float_amount
= XFLOATINT (aggressive
);
15664 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15665 if (pt_offset
== 0 && float_amount
> 0)
15667 if (pt_offset
&& margin
> 0)
15670 /* Compute how much to move the window start backward from
15671 point so that point will be displayed where the user
15675 centering_position
= it
.last_visible_y
;
15677 centering_position
-= pt_offset
;
15678 centering_position
-=
15679 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15680 + WINDOW_HEADER_LINE_HEIGHT (w
);
15681 /* Don't let point enter the scroll margin near top of
15683 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15684 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15687 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15690 /* Set the window start half the height of the window backward
15692 centering_position
= window_box_height (w
) / 2;
15694 move_it_vertically_backward (&it
, centering_position
);
15696 xassert (IT_CHARPOS (it
) >= BEGV
);
15698 /* The function move_it_vertically_backward may move over more
15699 than the specified y-distance. If it->w is small, e.g. a
15700 mini-buffer window, we may end up in front of the window's
15701 display area. Start displaying at the start of the line
15702 containing PT in this case. */
15703 if (it
.current_y
<= 0)
15705 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15706 move_it_vertically_backward (&it
, 0);
15710 it
.current_x
= it
.hpos
= 0;
15712 /* Set the window start position here explicitly, to avoid an
15713 infinite loop in case the functions in window-scroll-functions
15715 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15717 /* Run scroll hooks. */
15718 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15720 /* Redisplay the window. */
15721 if (!current_matrix_up_to_date_p
15722 || windows_or_buffers_changed
15723 || cursor_type_changed
15724 /* Don't use try_window_reusing_current_matrix in this case
15725 because it can have changed the buffer. */
15726 || !NILP (Vwindow_scroll_functions
)
15727 || !just_this_one_p
15728 || MINI_WINDOW_P (w
)
15729 || !(used_current_matrix_p
15730 = try_window_reusing_current_matrix (w
)))
15731 try_window (window
, startp
, 0);
15733 /* If new fonts have been loaded (due to fontsets), give up. We
15734 have to start a new redisplay since we need to re-adjust glyph
15736 if (fonts_changed_p
)
15737 goto need_larger_matrices
;
15739 /* If cursor did not appear assume that the middle of the window is
15740 in the first line of the window. Do it again with the next line.
15741 (Imagine a window of height 100, displaying two lines of height
15742 60. Moving back 50 from it->last_visible_y will end in the first
15744 if (w
->cursor
.vpos
< 0)
15746 if (!NILP (w
->window_end_valid
)
15747 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15749 clear_glyph_matrix (w
->desired_matrix
);
15750 move_it_by_lines (&it
, 1);
15751 try_window (window
, it
.current
.pos
, 0);
15753 else if (PT
< IT_CHARPOS (it
))
15755 clear_glyph_matrix (w
->desired_matrix
);
15756 move_it_by_lines (&it
, -1);
15757 try_window (window
, it
.current
.pos
, 0);
15761 /* Not much we can do about it. */
15765 /* Consider the following case: Window starts at BEGV, there is
15766 invisible, intangible text at BEGV, so that display starts at
15767 some point START > BEGV. It can happen that we are called with
15768 PT somewhere between BEGV and START. Try to handle that case. */
15769 if (w
->cursor
.vpos
< 0)
15771 struct glyph_row
*row
= w
->current_matrix
->rows
;
15772 if (row
->mode_line_p
)
15774 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15777 if (!cursor_row_fully_visible_p (w
, 0, 0))
15779 /* If vscroll is enabled, disable it and try again. */
15783 clear_glyph_matrix (w
->desired_matrix
);
15787 /* Users who set scroll-conservatively to a large number want
15788 point just above/below the scroll margin. If we ended up
15789 with point's row partially visible, move the window start to
15790 make that row fully visible and out of the margin. */
15791 if (scroll_conservatively
> SCROLL_LIMIT
)
15795 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15797 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15799 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15800 clear_glyph_matrix (w
->desired_matrix
);
15801 if (1 == try_window (window
, it
.current
.pos
,
15802 TRY_WINDOW_CHECK_MARGINS
))
15806 /* If centering point failed to make the whole line visible,
15807 put point at the top instead. That has to make the whole line
15808 visible, if it can be done. */
15809 if (centering_position
== 0)
15812 clear_glyph_matrix (w
->desired_matrix
);
15813 centering_position
= 0;
15819 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15820 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15821 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15824 /* Display the mode line, if we must. */
15825 if ((update_mode_line
15826 /* If window not full width, must redo its mode line
15827 if (a) the window to its side is being redone and
15828 (b) we do a frame-based redisplay. This is a consequence
15829 of how inverted lines are drawn in frame-based redisplay. */
15830 || (!just_this_one_p
15831 && !FRAME_WINDOW_P (f
)
15832 && !WINDOW_FULL_WIDTH_P (w
))
15833 /* Line number to display. */
15834 || INTEGERP (w
->base_line_pos
)
15835 /* Column number is displayed and different from the one displayed. */
15836 || (!NILP (w
->column_number_displayed
)
15837 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15838 /* This means that the window has a mode line. */
15839 && (WINDOW_WANTS_MODELINE_P (w
)
15840 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15842 display_mode_lines (w
);
15844 /* If mode line height has changed, arrange for a thorough
15845 immediate redisplay using the correct mode line height. */
15846 if (WINDOW_WANTS_MODELINE_P (w
)
15847 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15849 fonts_changed_p
= 1;
15850 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15851 = DESIRED_MODE_LINE_HEIGHT (w
);
15854 /* If header line height has changed, arrange for a thorough
15855 immediate redisplay using the correct header line height. */
15856 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15857 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15859 fonts_changed_p
= 1;
15860 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15861 = DESIRED_HEADER_LINE_HEIGHT (w
);
15864 if (fonts_changed_p
)
15865 goto need_larger_matrices
;
15868 if (!line_number_displayed
15869 && !BUFFERP (w
->base_line_pos
))
15871 w
->base_line_pos
= Qnil
;
15872 w
->base_line_number
= Qnil
;
15877 /* When we reach a frame's selected window, redo the frame's menu bar. */
15878 if (update_mode_line
15879 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15881 int redisplay_menu_p
= 0;
15883 if (FRAME_WINDOW_P (f
))
15885 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15886 || defined (HAVE_NS) || defined (USE_GTK)
15887 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15889 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15893 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15895 if (redisplay_menu_p
)
15896 display_menu_bar (w
);
15898 #ifdef HAVE_WINDOW_SYSTEM
15899 if (FRAME_WINDOW_P (f
))
15901 #if defined (USE_GTK) || defined (HAVE_NS)
15902 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15903 redisplay_tool_bar (f
);
15905 if (WINDOWP (f
->tool_bar_window
)
15906 && (FRAME_TOOL_BAR_LINES (f
) > 0
15907 || !NILP (Vauto_resize_tool_bars
))
15908 && redisplay_tool_bar (f
))
15909 ignore_mouse_drag_p
= 1;
15915 #ifdef HAVE_WINDOW_SYSTEM
15916 if (FRAME_WINDOW_P (f
)
15917 && update_window_fringes (w
, (just_this_one_p
15918 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15919 || w
->pseudo_window_p
)))
15923 if (draw_window_fringes (w
, 1))
15924 x_draw_vertical_border (w
);
15928 #endif /* HAVE_WINDOW_SYSTEM */
15930 /* We go to this label, with fonts_changed_p nonzero,
15931 if it is necessary to try again using larger glyph matrices.
15932 We have to redeem the scroll bar even in this case,
15933 because the loop in redisplay_internal expects that. */
15934 need_larger_matrices
:
15936 finish_scroll_bars
:
15938 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15940 /* Set the thumb's position and size. */
15941 set_vertical_scroll_bar (w
);
15943 /* Note that we actually used the scroll bar attached to this
15944 window, so it shouldn't be deleted at the end of redisplay. */
15945 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15946 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15949 /* Restore current_buffer and value of point in it. The window
15950 update may have changed the buffer, so first make sure `opoint'
15951 is still valid (Bug#6177). */
15952 if (CHARPOS (opoint
) < BEGV
)
15953 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15954 else if (CHARPOS (opoint
) > ZV
)
15955 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15957 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15959 set_buffer_internal_1 (old
);
15960 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15961 shorter. This can be caused by log truncation in *Messages*. */
15962 if (CHARPOS (lpoint
) <= ZV
)
15963 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15965 unbind_to (count
, Qnil
);
15969 /* Build the complete desired matrix of WINDOW with a window start
15970 buffer position POS.
15972 Value is 1 if successful. It is zero if fonts were loaded during
15973 redisplay which makes re-adjusting glyph matrices necessary, and -1
15974 if point would appear in the scroll margins.
15975 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15976 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15980 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15982 struct window
*w
= XWINDOW (window
);
15984 struct glyph_row
*last_text_row
= NULL
;
15985 struct frame
*f
= XFRAME (w
->frame
);
15987 /* Make POS the new window start. */
15988 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15990 /* Mark cursor position as unknown. No overlay arrow seen. */
15991 w
->cursor
.vpos
= -1;
15992 overlay_arrow_seen
= 0;
15994 /* Initialize iterator and info to start at POS. */
15995 start_display (&it
, w
, pos
);
15997 /* Display all lines of W. */
15998 while (it
.current_y
< it
.last_visible_y
)
16000 if (display_line (&it
))
16001 last_text_row
= it
.glyph_row
- 1;
16002 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16006 /* Don't let the cursor end in the scroll margins. */
16007 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16008 && !MINI_WINDOW_P (w
))
16010 int this_scroll_margin
;
16012 if (scroll_margin
> 0)
16014 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16015 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16018 this_scroll_margin
= 0;
16020 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16021 && w
->cursor
.y
< this_scroll_margin
16022 && CHARPOS (pos
) > BEGV
16023 && IT_CHARPOS (it
) < ZV
)
16024 /* rms: considering make_cursor_line_fully_visible_p here
16025 seems to give wrong results. We don't want to recenter
16026 when the last line is partly visible, we want to allow
16027 that case to be handled in the usual way. */
16028 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16030 w
->cursor
.vpos
= -1;
16031 clear_glyph_matrix (w
->desired_matrix
);
16036 /* If bottom moved off end of frame, change mode line percentage. */
16037 if (XFASTINT (w
->window_end_pos
) <= 0
16038 && Z
!= IT_CHARPOS (it
))
16039 w
->update_mode_line
= Qt
;
16041 /* Set window_end_pos to the offset of the last character displayed
16042 on the window from the end of current_buffer. Set
16043 window_end_vpos to its row number. */
16046 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16047 w
->window_end_bytepos
16048 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16050 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16052 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16053 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16054 ->displays_text_p
);
16058 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16059 w
->window_end_pos
= make_number (Z
- ZV
);
16060 w
->window_end_vpos
= make_number (0);
16063 /* But that is not valid info until redisplay finishes. */
16064 w
->window_end_valid
= Qnil
;
16070 /************************************************************************
16071 Window redisplay reusing current matrix when buffer has not changed
16072 ************************************************************************/
16074 /* Try redisplay of window W showing an unchanged buffer with a
16075 different window start than the last time it was displayed by
16076 reusing its current matrix. Value is non-zero if successful.
16077 W->start is the new window start. */
16080 try_window_reusing_current_matrix (struct window
*w
)
16082 struct frame
*f
= XFRAME (w
->frame
);
16083 struct glyph_row
*bottom_row
;
16086 struct text_pos start
, new_start
;
16087 int nrows_scrolled
, i
;
16088 struct glyph_row
*last_text_row
;
16089 struct glyph_row
*last_reused_text_row
;
16090 struct glyph_row
*start_row
;
16091 int start_vpos
, min_y
, max_y
;
16094 if (inhibit_try_window_reusing
)
16098 if (/* This function doesn't handle terminal frames. */
16099 !FRAME_WINDOW_P (f
)
16100 /* Don't try to reuse the display if windows have been split
16102 || windows_or_buffers_changed
16103 || cursor_type_changed
)
16106 /* Can't do this if region may have changed. */
16107 if ((!NILP (Vtransient_mark_mode
)
16108 && !NILP (BVAR (current_buffer
, mark_active
)))
16109 || !NILP (w
->region_showing
)
16110 || !NILP (Vshow_trailing_whitespace
))
16113 /* If top-line visibility has changed, give up. */
16114 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16115 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16118 /* Give up if old or new display is scrolled vertically. We could
16119 make this function handle this, but right now it doesn't. */
16120 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16121 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16124 /* The variable new_start now holds the new window start. The old
16125 start `start' can be determined from the current matrix. */
16126 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16127 start
= start_row
->minpos
;
16128 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16130 /* Clear the desired matrix for the display below. */
16131 clear_glyph_matrix (w
->desired_matrix
);
16133 if (CHARPOS (new_start
) <= CHARPOS (start
))
16135 /* Don't use this method if the display starts with an ellipsis
16136 displayed for invisible text. It's not easy to handle that case
16137 below, and it's certainly not worth the effort since this is
16138 not a frequent case. */
16139 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16142 IF_DEBUG (debug_method_add (w
, "twu1"));
16144 /* Display up to a row that can be reused. The variable
16145 last_text_row is set to the last row displayed that displays
16146 text. Note that it.vpos == 0 if or if not there is a
16147 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16148 start_display (&it
, w
, new_start
);
16149 w
->cursor
.vpos
= -1;
16150 last_text_row
= last_reused_text_row
= NULL
;
16152 while (it
.current_y
< it
.last_visible_y
16153 && !fonts_changed_p
)
16155 /* If we have reached into the characters in the START row,
16156 that means the line boundaries have changed. So we
16157 can't start copying with the row START. Maybe it will
16158 work to start copying with the following row. */
16159 while (IT_CHARPOS (it
) > CHARPOS (start
))
16161 /* Advance to the next row as the "start". */
16163 start
= start_row
->minpos
;
16164 /* If there are no more rows to try, or just one, give up. */
16165 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16166 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16167 || CHARPOS (start
) == ZV
)
16169 clear_glyph_matrix (w
->desired_matrix
);
16173 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16175 /* If we have reached alignment, we can copy the rest of the
16177 if (IT_CHARPOS (it
) == CHARPOS (start
)
16178 /* Don't accept "alignment" inside a display vector,
16179 since start_row could have started in the middle of
16180 that same display vector (thus their character
16181 positions match), and we have no way of telling if
16182 that is the case. */
16183 && it
.current
.dpvec_index
< 0)
16186 if (display_line (&it
))
16187 last_text_row
= it
.glyph_row
- 1;
16191 /* A value of current_y < last_visible_y means that we stopped
16192 at the previous window start, which in turn means that we
16193 have at least one reusable row. */
16194 if (it
.current_y
< it
.last_visible_y
)
16196 struct glyph_row
*row
;
16198 /* IT.vpos always starts from 0; it counts text lines. */
16199 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16201 /* Find PT if not already found in the lines displayed. */
16202 if (w
->cursor
.vpos
< 0)
16204 int dy
= it
.current_y
- start_row
->y
;
16206 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16207 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16209 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16210 dy
, nrows_scrolled
);
16213 clear_glyph_matrix (w
->desired_matrix
);
16218 /* Scroll the display. Do it before the current matrix is
16219 changed. The problem here is that update has not yet
16220 run, i.e. part of the current matrix is not up to date.
16221 scroll_run_hook will clear the cursor, and use the
16222 current matrix to get the height of the row the cursor is
16224 run
.current_y
= start_row
->y
;
16225 run
.desired_y
= it
.current_y
;
16226 run
.height
= it
.last_visible_y
- it
.current_y
;
16228 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16231 FRAME_RIF (f
)->update_window_begin_hook (w
);
16232 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16233 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16234 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16238 /* Shift current matrix down by nrows_scrolled lines. */
16239 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16240 rotate_matrix (w
->current_matrix
,
16242 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16245 /* Disable lines that must be updated. */
16246 for (i
= 0; i
< nrows_scrolled
; ++i
)
16247 (start_row
+ i
)->enabled_p
= 0;
16249 /* Re-compute Y positions. */
16250 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16251 max_y
= it
.last_visible_y
;
16252 for (row
= start_row
+ nrows_scrolled
;
16256 row
->y
= it
.current_y
;
16257 row
->visible_height
= row
->height
;
16259 if (row
->y
< min_y
)
16260 row
->visible_height
-= min_y
- row
->y
;
16261 if (row
->y
+ row
->height
> max_y
)
16262 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16263 if (row
->fringe_bitmap_periodic_p
)
16264 row
->redraw_fringe_bitmaps_p
= 1;
16266 it
.current_y
+= row
->height
;
16268 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16269 last_reused_text_row
= row
;
16270 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16274 /* Disable lines in the current matrix which are now
16275 below the window. */
16276 for (++row
; row
< bottom_row
; ++row
)
16277 row
->enabled_p
= row
->mode_line_p
= 0;
16280 /* Update window_end_pos etc.; last_reused_text_row is the last
16281 reused row from the current matrix containing text, if any.
16282 The value of last_text_row is the last displayed line
16283 containing text. */
16284 if (last_reused_text_row
)
16286 w
->window_end_bytepos
16287 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16289 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16291 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16292 w
->current_matrix
));
16294 else if (last_text_row
)
16296 w
->window_end_bytepos
16297 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16299 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16301 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16305 /* This window must be completely empty. */
16306 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16307 w
->window_end_pos
= make_number (Z
- ZV
);
16308 w
->window_end_vpos
= make_number (0);
16310 w
->window_end_valid
= Qnil
;
16312 /* Update hint: don't try scrolling again in update_window. */
16313 w
->desired_matrix
->no_scrolling_p
= 1;
16316 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16320 else if (CHARPOS (new_start
) > CHARPOS (start
))
16322 struct glyph_row
*pt_row
, *row
;
16323 struct glyph_row
*first_reusable_row
;
16324 struct glyph_row
*first_row_to_display
;
16326 int yb
= window_text_bottom_y (w
);
16328 /* Find the row starting at new_start, if there is one. Don't
16329 reuse a partially visible line at the end. */
16330 first_reusable_row
= start_row
;
16331 while (first_reusable_row
->enabled_p
16332 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16333 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16334 < CHARPOS (new_start
)))
16335 ++first_reusable_row
;
16337 /* Give up if there is no row to reuse. */
16338 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16339 || !first_reusable_row
->enabled_p
16340 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16341 != CHARPOS (new_start
)))
16344 /* We can reuse fully visible rows beginning with
16345 first_reusable_row to the end of the window. Set
16346 first_row_to_display to the first row that cannot be reused.
16347 Set pt_row to the row containing point, if there is any. */
16349 for (first_row_to_display
= first_reusable_row
;
16350 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16351 ++first_row_to_display
)
16353 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16354 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16355 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16356 && first_row_to_display
->ends_at_zv_p
16357 && pt_row
== NULL
)))
16358 pt_row
= first_row_to_display
;
16361 /* Start displaying at the start of first_row_to_display. */
16362 xassert (first_row_to_display
->y
< yb
);
16363 init_to_row_start (&it
, w
, first_row_to_display
);
16365 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16367 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16369 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16370 + WINDOW_HEADER_LINE_HEIGHT (w
));
16372 /* Display lines beginning with first_row_to_display in the
16373 desired matrix. Set last_text_row to the last row displayed
16374 that displays text. */
16375 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16376 if (pt_row
== NULL
)
16377 w
->cursor
.vpos
= -1;
16378 last_text_row
= NULL
;
16379 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16380 if (display_line (&it
))
16381 last_text_row
= it
.glyph_row
- 1;
16383 /* If point is in a reused row, adjust y and vpos of the cursor
16387 w
->cursor
.vpos
-= nrows_scrolled
;
16388 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16391 /* Give up if point isn't in a row displayed or reused. (This
16392 also handles the case where w->cursor.vpos < nrows_scrolled
16393 after the calls to display_line, which can happen with scroll
16394 margins. See bug#1295.) */
16395 if (w
->cursor
.vpos
< 0)
16397 clear_glyph_matrix (w
->desired_matrix
);
16401 /* Scroll the display. */
16402 run
.current_y
= first_reusable_row
->y
;
16403 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16404 run
.height
= it
.last_visible_y
- run
.current_y
;
16405 dy
= run
.current_y
- run
.desired_y
;
16410 FRAME_RIF (f
)->update_window_begin_hook (w
);
16411 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16412 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16413 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16417 /* Adjust Y positions of reused rows. */
16418 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16419 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16420 max_y
= it
.last_visible_y
;
16421 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16424 row
->visible_height
= row
->height
;
16425 if (row
->y
< min_y
)
16426 row
->visible_height
-= min_y
- row
->y
;
16427 if (row
->y
+ row
->height
> max_y
)
16428 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16429 if (row
->fringe_bitmap_periodic_p
)
16430 row
->redraw_fringe_bitmaps_p
= 1;
16433 /* Scroll the current matrix. */
16434 xassert (nrows_scrolled
> 0);
16435 rotate_matrix (w
->current_matrix
,
16437 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16440 /* Disable rows not reused. */
16441 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16442 row
->enabled_p
= 0;
16444 /* Point may have moved to a different line, so we cannot assume that
16445 the previous cursor position is valid; locate the correct row. */
16448 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16450 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16451 && !row
->ends_at_zv_p
;
16455 w
->cursor
.y
= row
->y
;
16457 if (row
< bottom_row
)
16459 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16460 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16462 /* Can't use this optimization with bidi-reordered glyph
16463 rows, unless cursor is already at point. */
16464 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16466 if (!(w
->cursor
.hpos
>= 0
16467 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16468 && BUFFERP (glyph
->object
)
16469 && glyph
->charpos
== PT
))
16474 && (!BUFFERP (glyph
->object
)
16475 || glyph
->charpos
< PT
);
16479 w
->cursor
.x
+= glyph
->pixel_width
;
16484 /* Adjust window end. A null value of last_text_row means that
16485 the window end is in reused rows which in turn means that
16486 only its vpos can have changed. */
16489 w
->window_end_bytepos
16490 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16492 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16494 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16499 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16502 w
->window_end_valid
= Qnil
;
16503 w
->desired_matrix
->no_scrolling_p
= 1;
16506 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16516 /************************************************************************
16517 Window redisplay reusing current matrix when buffer has changed
16518 ************************************************************************/
16520 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16521 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16522 EMACS_INT
*, EMACS_INT
*);
16523 static struct glyph_row
*
16524 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16525 struct glyph_row
*);
16528 /* Return the last row in MATRIX displaying text. If row START is
16529 non-null, start searching with that row. IT gives the dimensions
16530 of the display. Value is null if matrix is empty; otherwise it is
16531 a pointer to the row found. */
16533 static struct glyph_row
*
16534 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16535 struct glyph_row
*start
)
16537 struct glyph_row
*row
, *row_found
;
16539 /* Set row_found to the last row in IT->w's current matrix
16540 displaying text. The loop looks funny but think of partially
16543 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16544 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16546 xassert (row
->enabled_p
);
16548 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16557 /* Return the last row in the current matrix of W that is not affected
16558 by changes at the start of current_buffer that occurred since W's
16559 current matrix was built. Value is null if no such row exists.
16561 BEG_UNCHANGED us the number of characters unchanged at the start of
16562 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16563 first changed character in current_buffer. Characters at positions <
16564 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16565 when the current matrix was built. */
16567 static struct glyph_row
*
16568 find_last_unchanged_at_beg_row (struct window
*w
)
16570 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16571 struct glyph_row
*row
;
16572 struct glyph_row
*row_found
= NULL
;
16573 int yb
= window_text_bottom_y (w
);
16575 /* Find the last row displaying unchanged text. */
16576 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16577 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16578 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16581 if (/* If row ends before first_changed_pos, it is unchanged,
16582 except in some case. */
16583 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16584 /* When row ends in ZV and we write at ZV it is not
16586 && !row
->ends_at_zv_p
16587 /* When first_changed_pos is the end of a continued line,
16588 row is not unchanged because it may be no longer
16590 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16591 && (row
->continued_p
16592 || row
->exact_window_width_line_p
)))
16595 /* Stop if last visible row. */
16596 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16604 /* Find the first glyph row in the current matrix of W that is not
16605 affected by changes at the end of current_buffer since the
16606 time W's current matrix was built.
16608 Return in *DELTA the number of chars by which buffer positions in
16609 unchanged text at the end of current_buffer must be adjusted.
16611 Return in *DELTA_BYTES the corresponding number of bytes.
16613 Value is null if no such row exists, i.e. all rows are affected by
16616 static struct glyph_row
*
16617 find_first_unchanged_at_end_row (struct window
*w
,
16618 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16620 struct glyph_row
*row
;
16621 struct glyph_row
*row_found
= NULL
;
16623 *delta
= *delta_bytes
= 0;
16625 /* Display must not have been paused, otherwise the current matrix
16626 is not up to date. */
16627 eassert (!NILP (w
->window_end_valid
));
16629 /* A value of window_end_pos >= END_UNCHANGED means that the window
16630 end is in the range of changed text. If so, there is no
16631 unchanged row at the end of W's current matrix. */
16632 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16635 /* Set row to the last row in W's current matrix displaying text. */
16636 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16638 /* If matrix is entirely empty, no unchanged row exists. */
16639 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16641 /* The value of row is the last glyph row in the matrix having a
16642 meaningful buffer position in it. The end position of row
16643 corresponds to window_end_pos. This allows us to translate
16644 buffer positions in the current matrix to current buffer
16645 positions for characters not in changed text. */
16647 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16648 EMACS_INT Z_BYTE_old
=
16649 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16650 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16651 struct glyph_row
*first_text_row
16652 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16654 *delta
= Z
- Z_old
;
16655 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16657 /* Set last_unchanged_pos to the buffer position of the last
16658 character in the buffer that has not been changed. Z is the
16659 index + 1 of the last character in current_buffer, i.e. by
16660 subtracting END_UNCHANGED we get the index of the last
16661 unchanged character, and we have to add BEG to get its buffer
16663 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16664 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16666 /* Search backward from ROW for a row displaying a line that
16667 starts at a minimum position >= last_unchanged_pos_old. */
16668 for (; row
> first_text_row
; --row
)
16670 /* This used to abort, but it can happen.
16671 It is ok to just stop the search instead here. KFS. */
16672 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16675 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16680 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16686 /* Make sure that glyph rows in the current matrix of window W
16687 reference the same glyph memory as corresponding rows in the
16688 frame's frame matrix. This function is called after scrolling W's
16689 current matrix on a terminal frame in try_window_id and
16690 try_window_reusing_current_matrix. */
16693 sync_frame_with_window_matrix_rows (struct window
*w
)
16695 struct frame
*f
= XFRAME (w
->frame
);
16696 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16698 /* Preconditions: W must be a leaf window and full-width. Its frame
16699 must have a frame matrix. */
16700 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16701 xassert (WINDOW_FULL_WIDTH_P (w
));
16702 xassert (!FRAME_WINDOW_P (f
));
16704 /* If W is a full-width window, glyph pointers in W's current matrix
16705 have, by definition, to be the same as glyph pointers in the
16706 corresponding frame matrix. Note that frame matrices have no
16707 marginal areas (see build_frame_matrix). */
16708 window_row
= w
->current_matrix
->rows
;
16709 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16710 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16711 while (window_row
< window_row_end
)
16713 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16714 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16716 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16717 frame_row
->glyphs
[TEXT_AREA
] = start
;
16718 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16719 frame_row
->glyphs
[LAST_AREA
] = end
;
16721 /* Disable frame rows whose corresponding window rows have
16722 been disabled in try_window_id. */
16723 if (!window_row
->enabled_p
)
16724 frame_row
->enabled_p
= 0;
16726 ++window_row
, ++frame_row
;
16731 /* Find the glyph row in window W containing CHARPOS. Consider all
16732 rows between START and END (not inclusive). END null means search
16733 all rows to the end of the display area of W. Value is the row
16734 containing CHARPOS or null. */
16737 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16738 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16740 struct glyph_row
*row
= start
;
16741 struct glyph_row
*best_row
= NULL
;
16742 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16745 /* If we happen to start on a header-line, skip that. */
16746 if (row
->mode_line_p
)
16749 if ((end
&& row
>= end
) || !row
->enabled_p
)
16752 last_y
= window_text_bottom_y (w
) - dy
;
16756 /* Give up if we have gone too far. */
16757 if (end
&& row
>= end
)
16759 /* This formerly returned if they were equal.
16760 I think that both quantities are of a "last plus one" type;
16761 if so, when they are equal, the row is within the screen. -- rms. */
16762 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16765 /* If it is in this row, return this row. */
16766 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16767 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16768 /* The end position of a row equals the start
16769 position of the next row. If CHARPOS is there, we
16770 would rather display it in the next line, except
16771 when this line ends in ZV. */
16772 && !row
->ends_at_zv_p
16773 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16774 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16778 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16779 || (!best_row
&& !row
->continued_p
))
16781 /* In bidi-reordered rows, there could be several rows
16782 occluding point, all of them belonging to the same
16783 continued line. We need to find the row which fits
16784 CHARPOS the best. */
16785 for (g
= row
->glyphs
[TEXT_AREA
];
16786 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16789 if (!STRINGP (g
->object
))
16791 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16793 mindif
= eabs (g
->charpos
- charpos
);
16795 /* Exact match always wins. */
16802 else if (best_row
&& !row
->continued_p
)
16809 /* Try to redisplay window W by reusing its existing display. W's
16810 current matrix must be up to date when this function is called,
16811 i.e. window_end_valid must not be nil.
16815 1 if display has been updated
16816 0 if otherwise unsuccessful
16817 -1 if redisplay with same window start is known not to succeed
16819 The following steps are performed:
16821 1. Find the last row in the current matrix of W that is not
16822 affected by changes at the start of current_buffer. If no such row
16825 2. Find the first row in W's current matrix that is not affected by
16826 changes at the end of current_buffer. Maybe there is no such row.
16828 3. Display lines beginning with the row + 1 found in step 1 to the
16829 row found in step 2 or, if step 2 didn't find a row, to the end of
16832 4. If cursor is not known to appear on the window, give up.
16834 5. If display stopped at the row found in step 2, scroll the
16835 display and current matrix as needed.
16837 6. Maybe display some lines at the end of W, if we must. This can
16838 happen under various circumstances, like a partially visible line
16839 becoming fully visible, or because newly displayed lines are displayed
16840 in smaller font sizes.
16842 7. Update W's window end information. */
16845 try_window_id (struct window
*w
)
16847 struct frame
*f
= XFRAME (w
->frame
);
16848 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16849 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16850 struct glyph_row
*last_unchanged_at_beg_row
;
16851 struct glyph_row
*first_unchanged_at_end_row
;
16852 struct glyph_row
*row
;
16853 struct glyph_row
*bottom_row
;
16856 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16858 struct text_pos start_pos
;
16860 int first_unchanged_at_end_vpos
= 0;
16861 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16862 struct text_pos start
;
16863 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16866 if (inhibit_try_window_id
)
16870 /* This is handy for debugging. */
16872 #define GIVE_UP(X) \
16874 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16878 #define GIVE_UP(X) return 0
16881 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16883 /* Don't use this for mini-windows because these can show
16884 messages and mini-buffers, and we don't handle that here. */
16885 if (MINI_WINDOW_P (w
))
16888 /* This flag is used to prevent redisplay optimizations. */
16889 if (windows_or_buffers_changed
|| cursor_type_changed
)
16892 /* Verify that narrowing has not changed.
16893 Also verify that we were not told to prevent redisplay optimizations.
16894 It would be nice to further
16895 reduce the number of cases where this prevents try_window_id. */
16896 if (current_buffer
->clip_changed
16897 || current_buffer
->prevent_redisplay_optimizations_p
)
16900 /* Window must either use window-based redisplay or be full width. */
16901 if (!FRAME_WINDOW_P (f
)
16902 && (!FRAME_LINE_INS_DEL_OK (f
)
16903 || !WINDOW_FULL_WIDTH_P (w
)))
16906 /* Give up if point is known NOT to appear in W. */
16907 if (PT
< CHARPOS (start
))
16910 /* Another way to prevent redisplay optimizations. */
16911 if (XFASTINT (w
->last_modified
) == 0)
16914 /* Verify that window is not hscrolled. */
16915 if (XFASTINT (w
->hscroll
) != 0)
16918 /* Verify that display wasn't paused. */
16919 if (NILP (w
->window_end_valid
))
16922 /* Can't use this if highlighting a region because a cursor movement
16923 will do more than just set the cursor. */
16924 if (!NILP (Vtransient_mark_mode
)
16925 && !NILP (BVAR (current_buffer
, mark_active
)))
16928 /* Likewise if highlighting trailing whitespace. */
16929 if (!NILP (Vshow_trailing_whitespace
))
16932 /* Likewise if showing a region. */
16933 if (!NILP (w
->region_showing
))
16936 /* Can't use this if overlay arrow position and/or string have
16938 if (overlay_arrows_changed_p ())
16941 /* When word-wrap is on, adding a space to the first word of a
16942 wrapped line can change the wrap position, altering the line
16943 above it. It might be worthwhile to handle this more
16944 intelligently, but for now just redisplay from scratch. */
16945 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16948 /* Under bidi reordering, adding or deleting a character in the
16949 beginning of a paragraph, before the first strong directional
16950 character, can change the base direction of the paragraph (unless
16951 the buffer specifies a fixed paragraph direction), which will
16952 require to redisplay the whole paragraph. It might be worthwhile
16953 to find the paragraph limits and widen the range of redisplayed
16954 lines to that, but for now just give up this optimization and
16955 redisplay from scratch. */
16956 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16957 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16960 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16961 only if buffer has really changed. The reason is that the gap is
16962 initially at Z for freshly visited files. The code below would
16963 set end_unchanged to 0 in that case. */
16964 if (MODIFF
> SAVE_MODIFF
16965 /* This seems to happen sometimes after saving a buffer. */
16966 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16968 if (GPT
- BEG
< BEG_UNCHANGED
)
16969 BEG_UNCHANGED
= GPT
- BEG
;
16970 if (Z
- GPT
< END_UNCHANGED
)
16971 END_UNCHANGED
= Z
- GPT
;
16974 /* The position of the first and last character that has been changed. */
16975 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16976 last_changed_charpos
= Z
- END_UNCHANGED
;
16978 /* If window starts after a line end, and the last change is in
16979 front of that newline, then changes don't affect the display.
16980 This case happens with stealth-fontification. Note that although
16981 the display is unchanged, glyph positions in the matrix have to
16982 be adjusted, of course. */
16983 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16984 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16985 && ((last_changed_charpos
< CHARPOS (start
)
16986 && CHARPOS (start
) == BEGV
)
16987 || (last_changed_charpos
< CHARPOS (start
) - 1
16988 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16990 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16991 struct glyph_row
*r0
;
16993 /* Compute how many chars/bytes have been added to or removed
16994 from the buffer. */
16995 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16996 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16997 Z_delta
= Z
- Z_old
;
16998 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17000 /* Give up if PT is not in the window. Note that it already has
17001 been checked at the start of try_window_id that PT is not in
17002 front of the window start. */
17003 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17006 /* If window start is unchanged, we can reuse the whole matrix
17007 as is, after adjusting glyph positions. No need to compute
17008 the window end again, since its offset from Z hasn't changed. */
17009 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17010 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17011 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17012 /* PT must not be in a partially visible line. */
17013 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17014 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17016 /* Adjust positions in the glyph matrix. */
17017 if (Z_delta
|| Z_delta_bytes
)
17019 struct glyph_row
*r1
17020 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17021 increment_matrix_positions (w
->current_matrix
,
17022 MATRIX_ROW_VPOS (r0
, current_matrix
),
17023 MATRIX_ROW_VPOS (r1
, current_matrix
),
17024 Z_delta
, Z_delta_bytes
);
17027 /* Set the cursor. */
17028 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17030 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17037 /* Handle the case that changes are all below what is displayed in
17038 the window, and that PT is in the window. This shortcut cannot
17039 be taken if ZV is visible in the window, and text has been added
17040 there that is visible in the window. */
17041 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17042 /* ZV is not visible in the window, or there are no
17043 changes at ZV, actually. */
17044 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17045 || first_changed_charpos
== last_changed_charpos
))
17047 struct glyph_row
*r0
;
17049 /* Give up if PT is not in the window. Note that it already has
17050 been checked at the start of try_window_id that PT is not in
17051 front of the window start. */
17052 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17055 /* If window start is unchanged, we can reuse the whole matrix
17056 as is, without changing glyph positions since no text has
17057 been added/removed in front of the window end. */
17058 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17059 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17060 /* PT must not be in a partially visible line. */
17061 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17062 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17064 /* We have to compute the window end anew since text
17065 could have been added/removed after it. */
17067 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17068 w
->window_end_bytepos
17069 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17071 /* Set the cursor. */
17072 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17074 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17081 /* Give up if window start is in the changed area.
17083 The condition used to read
17085 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17087 but why that was tested escapes me at the moment. */
17088 if (CHARPOS (start
) >= first_changed_charpos
17089 && CHARPOS (start
) <= last_changed_charpos
)
17092 /* Check that window start agrees with the start of the first glyph
17093 row in its current matrix. Check this after we know the window
17094 start is not in changed text, otherwise positions would not be
17096 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17097 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17100 /* Give up if the window ends in strings. Overlay strings
17101 at the end are difficult to handle, so don't try. */
17102 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17103 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17106 /* Compute the position at which we have to start displaying new
17107 lines. Some of the lines at the top of the window might be
17108 reusable because they are not displaying changed text. Find the
17109 last row in W's current matrix not affected by changes at the
17110 start of current_buffer. Value is null if changes start in the
17111 first line of window. */
17112 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17113 if (last_unchanged_at_beg_row
)
17115 /* Avoid starting to display in the middle of a character, a TAB
17116 for instance. This is easier than to set up the iterator
17117 exactly, and it's not a frequent case, so the additional
17118 effort wouldn't really pay off. */
17119 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17120 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17121 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17122 --last_unchanged_at_beg_row
;
17124 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17127 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17129 start_pos
= it
.current
.pos
;
17131 /* Start displaying new lines in the desired matrix at the same
17132 vpos we would use in the current matrix, i.e. below
17133 last_unchanged_at_beg_row. */
17134 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17136 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17137 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17139 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17143 /* There are no reusable lines at the start of the window.
17144 Start displaying in the first text line. */
17145 start_display (&it
, w
, start
);
17146 it
.vpos
= it
.first_vpos
;
17147 start_pos
= it
.current
.pos
;
17150 /* Find the first row that is not affected by changes at the end of
17151 the buffer. Value will be null if there is no unchanged row, in
17152 which case we must redisplay to the end of the window. delta
17153 will be set to the value by which buffer positions beginning with
17154 first_unchanged_at_end_row have to be adjusted due to text
17156 first_unchanged_at_end_row
17157 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17158 IF_DEBUG (debug_delta
= delta
);
17159 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17161 /* Set stop_pos to the buffer position up to which we will have to
17162 display new lines. If first_unchanged_at_end_row != NULL, this
17163 is the buffer position of the start of the line displayed in that
17164 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17165 that we don't stop at a buffer position. */
17167 if (first_unchanged_at_end_row
)
17169 xassert (last_unchanged_at_beg_row
== NULL
17170 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17172 /* If this is a continuation line, move forward to the next one
17173 that isn't. Changes in lines above affect this line.
17174 Caution: this may move first_unchanged_at_end_row to a row
17175 not displaying text. */
17176 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17177 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17178 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17179 < it
.last_visible_y
))
17180 ++first_unchanged_at_end_row
;
17182 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17183 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17184 >= it
.last_visible_y
))
17185 first_unchanged_at_end_row
= NULL
;
17188 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17190 first_unchanged_at_end_vpos
17191 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17192 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17195 else if (last_unchanged_at_beg_row
== NULL
)
17201 /* Either there is no unchanged row at the end, or the one we have
17202 now displays text. This is a necessary condition for the window
17203 end pos calculation at the end of this function. */
17204 xassert (first_unchanged_at_end_row
== NULL
17205 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17207 debug_last_unchanged_at_beg_vpos
17208 = (last_unchanged_at_beg_row
17209 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17211 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17213 #endif /* GLYPH_DEBUG != 0 */
17216 /* Display new lines. Set last_text_row to the last new line
17217 displayed which has text on it, i.e. might end up as being the
17218 line where the window_end_vpos is. */
17219 w
->cursor
.vpos
= -1;
17220 last_text_row
= NULL
;
17221 overlay_arrow_seen
= 0;
17222 while (it
.current_y
< it
.last_visible_y
17223 && !fonts_changed_p
17224 && (first_unchanged_at_end_row
== NULL
17225 || IT_CHARPOS (it
) < stop_pos
))
17227 if (display_line (&it
))
17228 last_text_row
= it
.glyph_row
- 1;
17231 if (fonts_changed_p
)
17235 /* Compute differences in buffer positions, y-positions etc. for
17236 lines reused at the bottom of the window. Compute what we can
17238 if (first_unchanged_at_end_row
17239 /* No lines reused because we displayed everything up to the
17240 bottom of the window. */
17241 && it
.current_y
< it
.last_visible_y
)
17244 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17246 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17247 run
.current_y
= first_unchanged_at_end_row
->y
;
17248 run
.desired_y
= run
.current_y
+ dy
;
17249 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17253 delta
= delta_bytes
= dvpos
= dy
17254 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17255 first_unchanged_at_end_row
= NULL
;
17257 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17260 /* Find the cursor if not already found. We have to decide whether
17261 PT will appear on this window (it sometimes doesn't, but this is
17262 not a very frequent case.) This decision has to be made before
17263 the current matrix is altered. A value of cursor.vpos < 0 means
17264 that PT is either in one of the lines beginning at
17265 first_unchanged_at_end_row or below the window. Don't care for
17266 lines that might be displayed later at the window end; as
17267 mentioned, this is not a frequent case. */
17268 if (w
->cursor
.vpos
< 0)
17270 /* Cursor in unchanged rows at the top? */
17271 if (PT
< CHARPOS (start_pos
)
17272 && last_unchanged_at_beg_row
)
17274 row
= row_containing_pos (w
, PT
,
17275 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17276 last_unchanged_at_beg_row
+ 1, 0);
17278 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17281 /* Start from first_unchanged_at_end_row looking for PT. */
17282 else if (first_unchanged_at_end_row
)
17284 row
= row_containing_pos (w
, PT
- delta
,
17285 first_unchanged_at_end_row
, NULL
, 0);
17287 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17288 delta_bytes
, dy
, dvpos
);
17291 /* Give up if cursor was not found. */
17292 if (w
->cursor
.vpos
< 0)
17294 clear_glyph_matrix (w
->desired_matrix
);
17299 /* Don't let the cursor end in the scroll margins. */
17301 int this_scroll_margin
, cursor_height
;
17303 this_scroll_margin
=
17304 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17305 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17306 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17308 if ((w
->cursor
.y
< this_scroll_margin
17309 && CHARPOS (start
) > BEGV
)
17310 /* Old redisplay didn't take scroll margin into account at the bottom,
17311 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17312 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17313 ? cursor_height
+ this_scroll_margin
17314 : 1)) > it
.last_visible_y
)
17316 w
->cursor
.vpos
= -1;
17317 clear_glyph_matrix (w
->desired_matrix
);
17322 /* Scroll the display. Do it before changing the current matrix so
17323 that xterm.c doesn't get confused about where the cursor glyph is
17325 if (dy
&& run
.height
)
17329 if (FRAME_WINDOW_P (f
))
17331 FRAME_RIF (f
)->update_window_begin_hook (w
);
17332 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17333 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17334 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17338 /* Terminal frame. In this case, dvpos gives the number of
17339 lines to scroll by; dvpos < 0 means scroll up. */
17341 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17342 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17343 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17344 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17345 + window_internal_height (w
));
17347 #if defined (HAVE_GPM) || defined (MSDOS)
17348 x_clear_window_mouse_face (w
);
17350 /* Perform the operation on the screen. */
17353 /* Scroll last_unchanged_at_beg_row to the end of the
17354 window down dvpos lines. */
17355 set_terminal_window (f
, end
);
17357 /* On dumb terminals delete dvpos lines at the end
17358 before inserting dvpos empty lines. */
17359 if (!FRAME_SCROLL_REGION_OK (f
))
17360 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17362 /* Insert dvpos empty lines in front of
17363 last_unchanged_at_beg_row. */
17364 ins_del_lines (f
, from
, dvpos
);
17366 else if (dvpos
< 0)
17368 /* Scroll up last_unchanged_at_beg_vpos to the end of
17369 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17370 set_terminal_window (f
, end
);
17372 /* Delete dvpos lines in front of
17373 last_unchanged_at_beg_vpos. ins_del_lines will set
17374 the cursor to the given vpos and emit |dvpos| delete
17376 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17378 /* On a dumb terminal insert dvpos empty lines at the
17380 if (!FRAME_SCROLL_REGION_OK (f
))
17381 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17384 set_terminal_window (f
, 0);
17390 /* Shift reused rows of the current matrix to the right position.
17391 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17393 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17394 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17397 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17398 bottom_vpos
, dvpos
);
17399 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17402 else if (dvpos
> 0)
17404 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17405 bottom_vpos
, dvpos
);
17406 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17407 first_unchanged_at_end_vpos
+ dvpos
, 0);
17410 /* For frame-based redisplay, make sure that current frame and window
17411 matrix are in sync with respect to glyph memory. */
17412 if (!FRAME_WINDOW_P (f
))
17413 sync_frame_with_window_matrix_rows (w
);
17415 /* Adjust buffer positions in reused rows. */
17416 if (delta
|| delta_bytes
)
17417 increment_matrix_positions (current_matrix
,
17418 first_unchanged_at_end_vpos
+ dvpos
,
17419 bottom_vpos
, delta
, delta_bytes
);
17421 /* Adjust Y positions. */
17423 shift_glyph_matrix (w
, current_matrix
,
17424 first_unchanged_at_end_vpos
+ dvpos
,
17427 if (first_unchanged_at_end_row
)
17429 first_unchanged_at_end_row
+= dvpos
;
17430 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17431 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17432 first_unchanged_at_end_row
= NULL
;
17435 /* If scrolling up, there may be some lines to display at the end of
17437 last_text_row_at_end
= NULL
;
17440 /* Scrolling up can leave for example a partially visible line
17441 at the end of the window to be redisplayed. */
17442 /* Set last_row to the glyph row in the current matrix where the
17443 window end line is found. It has been moved up or down in
17444 the matrix by dvpos. */
17445 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17446 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17448 /* If last_row is the window end line, it should display text. */
17449 xassert (last_row
->displays_text_p
);
17451 /* If window end line was partially visible before, begin
17452 displaying at that line. Otherwise begin displaying with the
17453 line following it. */
17454 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17456 init_to_row_start (&it
, w
, last_row
);
17457 it
.vpos
= last_vpos
;
17458 it
.current_y
= last_row
->y
;
17462 init_to_row_end (&it
, w
, last_row
);
17463 it
.vpos
= 1 + last_vpos
;
17464 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17468 /* We may start in a continuation line. If so, we have to
17469 get the right continuation_lines_width and current_x. */
17470 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17471 it
.hpos
= it
.current_x
= 0;
17473 /* Display the rest of the lines at the window end. */
17474 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17475 while (it
.current_y
< it
.last_visible_y
17476 && !fonts_changed_p
)
17478 /* Is it always sure that the display agrees with lines in
17479 the current matrix? I don't think so, so we mark rows
17480 displayed invalid in the current matrix by setting their
17481 enabled_p flag to zero. */
17482 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17483 if (display_line (&it
))
17484 last_text_row_at_end
= it
.glyph_row
- 1;
17488 /* Update window_end_pos and window_end_vpos. */
17489 if (first_unchanged_at_end_row
17490 && !last_text_row_at_end
)
17492 /* Window end line if one of the preserved rows from the current
17493 matrix. Set row to the last row displaying text in current
17494 matrix starting at first_unchanged_at_end_row, after
17496 xassert (first_unchanged_at_end_row
->displays_text_p
);
17497 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17498 first_unchanged_at_end_row
);
17499 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17501 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17502 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17504 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17505 xassert (w
->window_end_bytepos
>= 0);
17506 IF_DEBUG (debug_method_add (w
, "A"));
17508 else if (last_text_row_at_end
)
17511 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17512 w
->window_end_bytepos
17513 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17515 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17516 xassert (w
->window_end_bytepos
>= 0);
17517 IF_DEBUG (debug_method_add (w
, "B"));
17519 else if (last_text_row
)
17521 /* We have displayed either to the end of the window or at the
17522 end of the window, i.e. the last row with text is to be found
17523 in the desired matrix. */
17525 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17526 w
->window_end_bytepos
17527 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17529 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17530 xassert (w
->window_end_bytepos
>= 0);
17532 else if (first_unchanged_at_end_row
== NULL
17533 && last_text_row
== NULL
17534 && last_text_row_at_end
== NULL
)
17536 /* Displayed to end of window, but no line containing text was
17537 displayed. Lines were deleted at the end of the window. */
17538 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17539 int vpos
= XFASTINT (w
->window_end_vpos
);
17540 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17541 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17544 row
== NULL
&& vpos
>= first_vpos
;
17545 --vpos
, --current_row
, --desired_row
)
17547 if (desired_row
->enabled_p
)
17549 if (desired_row
->displays_text_p
)
17552 else if (current_row
->displays_text_p
)
17556 xassert (row
!= NULL
);
17557 w
->window_end_vpos
= make_number (vpos
+ 1);
17558 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17559 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17560 xassert (w
->window_end_bytepos
>= 0);
17561 IF_DEBUG (debug_method_add (w
, "C"));
17566 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17567 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17569 /* Record that display has not been completed. */
17570 w
->window_end_valid
= Qnil
;
17571 w
->desired_matrix
->no_scrolling_p
= 1;
17579 /***********************************************************************
17580 More debugging support
17581 ***********************************************************************/
17585 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17586 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17587 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17590 /* Dump the contents of glyph matrix MATRIX on stderr.
17592 GLYPHS 0 means don't show glyph contents.
17593 GLYPHS 1 means show glyphs in short form
17594 GLYPHS > 1 means show glyphs in long form. */
17597 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17600 for (i
= 0; i
< matrix
->nrows
; ++i
)
17601 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17605 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17606 the glyph row and area where the glyph comes from. */
17609 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17611 if (glyph
->type
== CHAR_GLYPH
)
17614 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17615 glyph
- row
->glyphs
[TEXT_AREA
],
17618 (BUFFERP (glyph
->object
)
17620 : (STRINGP (glyph
->object
)
17623 glyph
->pixel_width
,
17625 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17629 glyph
->left_box_line_p
,
17630 glyph
->right_box_line_p
);
17632 else if (glyph
->type
== STRETCH_GLYPH
)
17635 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17636 glyph
- row
->glyphs
[TEXT_AREA
],
17639 (BUFFERP (glyph
->object
)
17641 : (STRINGP (glyph
->object
)
17644 glyph
->pixel_width
,
17648 glyph
->left_box_line_p
,
17649 glyph
->right_box_line_p
);
17651 else if (glyph
->type
== IMAGE_GLYPH
)
17654 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17655 glyph
- row
->glyphs
[TEXT_AREA
],
17658 (BUFFERP (glyph
->object
)
17660 : (STRINGP (glyph
->object
)
17663 glyph
->pixel_width
,
17667 glyph
->left_box_line_p
,
17668 glyph
->right_box_line_p
);
17670 else if (glyph
->type
== COMPOSITE_GLYPH
)
17673 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17674 glyph
- row
->glyphs
[TEXT_AREA
],
17677 (BUFFERP (glyph
->object
)
17679 : (STRINGP (glyph
->object
)
17682 glyph
->pixel_width
,
17684 if (glyph
->u
.cmp
.automatic
)
17687 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17688 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17690 glyph
->left_box_line_p
,
17691 glyph
->right_box_line_p
);
17696 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17697 GLYPHS 0 means don't show glyph contents.
17698 GLYPHS 1 means show glyphs in short form
17699 GLYPHS > 1 means show glyphs in long form. */
17702 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17706 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17707 fprintf (stderr
, "======================================================================\n");
17709 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17710 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17712 MATRIX_ROW_START_CHARPOS (row
),
17713 MATRIX_ROW_END_CHARPOS (row
),
17714 row
->used
[TEXT_AREA
],
17715 row
->contains_overlapping_glyphs_p
,
17717 row
->truncated_on_left_p
,
17718 row
->truncated_on_right_p
,
17720 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17721 row
->displays_text_p
,
17724 row
->ends_in_middle_of_char_p
,
17725 row
->starts_in_middle_of_char_p
,
17731 row
->visible_height
,
17734 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17735 row
->end
.overlay_string_index
,
17736 row
->continuation_lines_width
);
17737 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17738 CHARPOS (row
->start
.string_pos
),
17739 CHARPOS (row
->end
.string_pos
));
17740 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17741 row
->end
.dpvec_index
);
17748 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17750 struct glyph
*glyph
= row
->glyphs
[area
];
17751 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17753 /* Glyph for a line end in text. */
17754 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17757 if (glyph
< glyph_end
)
17758 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17760 for (; glyph
< glyph_end
; ++glyph
)
17761 dump_glyph (row
, glyph
, area
);
17764 else if (glyphs
== 1)
17768 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17770 char *s
= (char *) alloca (row
->used
[area
] + 1);
17773 for (i
= 0; i
< row
->used
[area
]; ++i
)
17775 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17776 if (glyph
->type
== CHAR_GLYPH
17777 && glyph
->u
.ch
< 0x80
17778 && glyph
->u
.ch
>= ' ')
17779 s
[i
] = glyph
->u
.ch
;
17785 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17791 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17792 Sdump_glyph_matrix
, 0, 1, "p",
17793 doc
: /* Dump the current matrix of the selected window to stderr.
17794 Shows contents of glyph row structures. With non-nil
17795 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17796 glyphs in short form, otherwise show glyphs in long form. */)
17797 (Lisp_Object glyphs
)
17799 struct window
*w
= XWINDOW (selected_window
);
17800 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17802 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17803 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17804 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17805 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17806 fprintf (stderr
, "=============================================\n");
17807 dump_glyph_matrix (w
->current_matrix
,
17808 NILP (glyphs
) ? 0 : XINT (glyphs
));
17813 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17814 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17817 struct frame
*f
= XFRAME (selected_frame
);
17818 dump_glyph_matrix (f
->current_matrix
, 1);
17823 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17824 doc
: /* Dump glyph row ROW to stderr.
17825 GLYPH 0 means don't dump glyphs.
17826 GLYPH 1 means dump glyphs in short form.
17827 GLYPH > 1 or omitted means dump glyphs in long form. */)
17828 (Lisp_Object row
, Lisp_Object glyphs
)
17830 struct glyph_matrix
*matrix
;
17833 CHECK_NUMBER (row
);
17834 matrix
= XWINDOW (selected_window
)->current_matrix
;
17836 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17837 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17839 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17844 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17845 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17846 GLYPH 0 means don't dump glyphs.
17847 GLYPH 1 means dump glyphs in short form.
17848 GLYPH > 1 or omitted means dump glyphs in long form. */)
17849 (Lisp_Object row
, Lisp_Object glyphs
)
17851 struct frame
*sf
= SELECTED_FRAME ();
17852 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17855 CHECK_NUMBER (row
);
17857 if (vpos
>= 0 && vpos
< m
->nrows
)
17858 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17859 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17864 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17865 doc
: /* Toggle tracing of redisplay.
17866 With ARG, turn tracing on if and only if ARG is positive. */)
17870 trace_redisplay_p
= !trace_redisplay_p
;
17873 arg
= Fprefix_numeric_value (arg
);
17874 trace_redisplay_p
= XINT (arg
) > 0;
17881 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17882 doc
: /* Like `format', but print result to stderr.
17883 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17884 (ptrdiff_t nargs
, Lisp_Object
*args
)
17886 Lisp_Object s
= Fformat (nargs
, args
);
17887 fprintf (stderr
, "%s", SDATA (s
));
17891 #endif /* GLYPH_DEBUG */
17895 /***********************************************************************
17896 Building Desired Matrix Rows
17897 ***********************************************************************/
17899 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17900 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17902 static struct glyph_row
*
17903 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17905 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17906 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17907 struct buffer
*old
= current_buffer
;
17908 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17909 int arrow_len
= SCHARS (overlay_arrow_string
);
17910 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17911 const unsigned char *p
;
17914 int n_glyphs_before
;
17916 set_buffer_temp (buffer
);
17917 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17918 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17919 SET_TEXT_POS (it
.position
, 0, 0);
17921 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17923 while (p
< arrow_end
)
17925 Lisp_Object face
, ilisp
;
17927 /* Get the next character. */
17929 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17932 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17933 if (! ASCII_CHAR_P (it
.c
))
17934 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17938 /* Get its face. */
17939 ilisp
= make_number (p
- arrow_string
);
17940 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17941 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17943 /* Compute its width, get its glyphs. */
17944 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17945 SET_TEXT_POS (it
.position
, -1, -1);
17946 PRODUCE_GLYPHS (&it
);
17948 /* If this character doesn't fit any more in the line, we have
17949 to remove some glyphs. */
17950 if (it
.current_x
> it
.last_visible_x
)
17952 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17957 set_buffer_temp (old
);
17958 return it
.glyph_row
;
17962 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17963 glyphs are only inserted for terminal frames since we can't really
17964 win with truncation glyphs when partially visible glyphs are
17965 involved. Which glyphs to insert is determined by
17966 produce_special_glyphs. */
17969 insert_left_trunc_glyphs (struct it
*it
)
17971 struct it truncate_it
;
17972 struct glyph
*from
, *end
, *to
, *toend
;
17974 xassert (!FRAME_WINDOW_P (it
->f
));
17976 /* Get the truncation glyphs. */
17978 truncate_it
.current_x
= 0;
17979 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17980 truncate_it
.glyph_row
= &scratch_glyph_row
;
17981 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17982 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17983 truncate_it
.object
= make_number (0);
17984 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17986 /* Overwrite glyphs from IT with truncation glyphs. */
17987 if (!it
->glyph_row
->reversed_p
)
17989 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17990 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17991 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17992 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17997 /* There may be padding glyphs left over. Overwrite them too. */
17998 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18000 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18006 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18010 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18011 that back to front. */
18012 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18013 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18014 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18015 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18017 while (from
>= end
&& to
>= toend
)
18019 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18022 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18023 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18024 while (from
>= end
&& to
>= toend
)
18029 /* Need to free some room before prepending additional
18031 int move_by
= from
- end
+ 1;
18032 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18033 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18035 for ( ; g
>= g0
; g
--)
18037 while (from
>= end
)
18039 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18044 /* Compute the hash code for ROW. */
18046 row_hash (struct glyph_row
*row
)
18049 unsigned hashval
= 0;
18051 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18052 for (k
= 0; k
< row
->used
[area
]; ++k
)
18053 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18054 + row
->glyphs
[area
][k
].u
.val
18055 + row
->glyphs
[area
][k
].face_id
18056 + row
->glyphs
[area
][k
].padding_p
18057 + (row
->glyphs
[area
][k
].type
<< 2));
18062 /* Compute the pixel height and width of IT->glyph_row.
18064 Most of the time, ascent and height of a display line will be equal
18065 to the max_ascent and max_height values of the display iterator
18066 structure. This is not the case if
18068 1. We hit ZV without displaying anything. In this case, max_ascent
18069 and max_height will be zero.
18071 2. We have some glyphs that don't contribute to the line height.
18072 (The glyph row flag contributes_to_line_height_p is for future
18073 pixmap extensions).
18075 The first case is easily covered by using default values because in
18076 these cases, the line height does not really matter, except that it
18077 must not be zero. */
18080 compute_line_metrics (struct it
*it
)
18082 struct glyph_row
*row
= it
->glyph_row
;
18084 if (FRAME_WINDOW_P (it
->f
))
18086 int i
, min_y
, max_y
;
18088 /* The line may consist of one space only, that was added to
18089 place the cursor on it. If so, the row's height hasn't been
18091 if (row
->height
== 0)
18093 if (it
->max_ascent
+ it
->max_descent
== 0)
18094 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18095 row
->ascent
= it
->max_ascent
;
18096 row
->height
= it
->max_ascent
+ it
->max_descent
;
18097 row
->phys_ascent
= it
->max_phys_ascent
;
18098 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18099 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18102 /* Compute the width of this line. */
18103 row
->pixel_width
= row
->x
;
18104 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18105 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18107 xassert (row
->pixel_width
>= 0);
18108 xassert (row
->ascent
>= 0 && row
->height
> 0);
18110 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18111 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18113 /* If first line's physical ascent is larger than its logical
18114 ascent, use the physical ascent, and make the row taller.
18115 This makes accented characters fully visible. */
18116 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18117 && row
->phys_ascent
> row
->ascent
)
18119 row
->height
+= row
->phys_ascent
- row
->ascent
;
18120 row
->ascent
= row
->phys_ascent
;
18123 /* Compute how much of the line is visible. */
18124 row
->visible_height
= row
->height
;
18126 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18127 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18129 if (row
->y
< min_y
)
18130 row
->visible_height
-= min_y
- row
->y
;
18131 if (row
->y
+ row
->height
> max_y
)
18132 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18136 row
->pixel_width
= row
->used
[TEXT_AREA
];
18137 if (row
->continued_p
)
18138 row
->pixel_width
-= it
->continuation_pixel_width
;
18139 else if (row
->truncated_on_right_p
)
18140 row
->pixel_width
-= it
->truncation_pixel_width
;
18141 row
->ascent
= row
->phys_ascent
= 0;
18142 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18143 row
->extra_line_spacing
= 0;
18146 /* Compute a hash code for this row. */
18147 row
->hash
= row_hash (row
);
18149 it
->max_ascent
= it
->max_descent
= 0;
18150 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18154 /* Append one space to the glyph row of iterator IT if doing a
18155 window-based redisplay. The space has the same face as
18156 IT->face_id. Value is non-zero if a space was added.
18158 This function is called to make sure that there is always one glyph
18159 at the end of a glyph row that the cursor can be set on under
18160 window-systems. (If there weren't such a glyph we would not know
18161 how wide and tall a box cursor should be displayed).
18163 At the same time this space let's a nicely handle clearing to the
18164 end of the line if the row ends in italic text. */
18167 append_space_for_newline (struct it
*it
, int default_face_p
)
18169 if (FRAME_WINDOW_P (it
->f
))
18171 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18173 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18174 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18176 /* Save some values that must not be changed.
18177 Must save IT->c and IT->len because otherwise
18178 ITERATOR_AT_END_P wouldn't work anymore after
18179 append_space_for_newline has been called. */
18180 enum display_element_type saved_what
= it
->what
;
18181 int saved_c
= it
->c
, saved_len
= it
->len
;
18182 int saved_char_to_display
= it
->char_to_display
;
18183 int saved_x
= it
->current_x
;
18184 int saved_face_id
= it
->face_id
;
18185 struct text_pos saved_pos
;
18186 Lisp_Object saved_object
;
18189 saved_object
= it
->object
;
18190 saved_pos
= it
->position
;
18192 it
->what
= IT_CHARACTER
;
18193 memset (&it
->position
, 0, sizeof it
->position
);
18194 it
->object
= make_number (0);
18195 it
->c
= it
->char_to_display
= ' ';
18198 /* If the default face was remapped, be sure to use the
18199 remapped face for the appended newline. */
18200 if (default_face_p
)
18201 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18202 else if (it
->face_before_selective_p
)
18203 it
->face_id
= it
->saved_face_id
;
18204 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18205 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18207 PRODUCE_GLYPHS (it
);
18209 it
->override_ascent
= -1;
18210 it
->constrain_row_ascent_descent_p
= 0;
18211 it
->current_x
= saved_x
;
18212 it
->object
= saved_object
;
18213 it
->position
= saved_pos
;
18214 it
->what
= saved_what
;
18215 it
->face_id
= saved_face_id
;
18216 it
->len
= saved_len
;
18218 it
->char_to_display
= saved_char_to_display
;
18227 /* Extend the face of the last glyph in the text area of IT->glyph_row
18228 to the end of the display line. Called from display_line. If the
18229 glyph row is empty, add a space glyph to it so that we know the
18230 face to draw. Set the glyph row flag fill_line_p. If the glyph
18231 row is R2L, prepend a stretch glyph to cover the empty space to the
18232 left of the leftmost glyph. */
18235 extend_face_to_end_of_line (struct it
*it
)
18237 struct face
*face
, *default_face
;
18238 struct frame
*f
= it
->f
;
18240 /* If line is already filled, do nothing. Non window-system frames
18241 get a grace of one more ``pixel'' because their characters are
18242 1-``pixel'' wide, so they hit the equality too early. This grace
18243 is needed only for R2L rows that are not continued, to produce
18244 one extra blank where we could display the cursor. */
18245 if (it
->current_x
>= it
->last_visible_x
18246 + (!FRAME_WINDOW_P (f
)
18247 && it
->glyph_row
->reversed_p
18248 && !it
->glyph_row
->continued_p
))
18251 /* The default face, possibly remapped. */
18252 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18254 /* Face extension extends the background and box of IT->face_id
18255 to the end of the line. If the background equals the background
18256 of the frame, we don't have to do anything. */
18257 if (it
->face_before_selective_p
)
18258 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18260 face
= FACE_FROM_ID (f
, it
->face_id
);
18262 if (FRAME_WINDOW_P (f
)
18263 && it
->glyph_row
->displays_text_p
18264 && face
->box
== FACE_NO_BOX
18265 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18267 && !it
->glyph_row
->reversed_p
)
18270 /* Set the glyph row flag indicating that the face of the last glyph
18271 in the text area has to be drawn to the end of the text area. */
18272 it
->glyph_row
->fill_line_p
= 1;
18274 /* If current character of IT is not ASCII, make sure we have the
18275 ASCII face. This will be automatically undone the next time
18276 get_next_display_element returns a multibyte character. Note
18277 that the character will always be single byte in unibyte
18279 if (!ASCII_CHAR_P (it
->c
))
18281 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18284 if (FRAME_WINDOW_P (f
))
18286 /* If the row is empty, add a space with the current face of IT,
18287 so that we know which face to draw. */
18288 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18290 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18291 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18292 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18294 #ifdef HAVE_WINDOW_SYSTEM
18295 if (it
->glyph_row
->reversed_p
)
18297 /* Prepend a stretch glyph to the row, such that the
18298 rightmost glyph will be drawn flushed all the way to the
18299 right margin of the window. The stretch glyph that will
18300 occupy the empty space, if any, to the left of the
18302 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18303 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18304 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18306 int row_width
, stretch_ascent
, stretch_width
;
18307 struct text_pos saved_pos
;
18308 int saved_face_id
, saved_avoid_cursor
;
18310 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18311 row_width
+= g
->pixel_width
;
18312 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18313 if (stretch_width
> 0)
18316 (((it
->ascent
+ it
->descent
)
18317 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18318 saved_pos
= it
->position
;
18319 memset (&it
->position
, 0, sizeof it
->position
);
18320 saved_avoid_cursor
= it
->avoid_cursor_p
;
18321 it
->avoid_cursor_p
= 1;
18322 saved_face_id
= it
->face_id
;
18323 /* The last row's stretch glyph should get the default
18324 face, to avoid painting the rest of the window with
18325 the region face, if the region ends at ZV. */
18326 if (it
->glyph_row
->ends_at_zv_p
)
18327 it
->face_id
= default_face
->id
;
18329 it
->face_id
= face
->id
;
18330 append_stretch_glyph (it
, make_number (0), stretch_width
,
18331 it
->ascent
+ it
->descent
, stretch_ascent
);
18332 it
->position
= saved_pos
;
18333 it
->avoid_cursor_p
= saved_avoid_cursor
;
18334 it
->face_id
= saved_face_id
;
18337 #endif /* HAVE_WINDOW_SYSTEM */
18341 /* Save some values that must not be changed. */
18342 int saved_x
= it
->current_x
;
18343 struct text_pos saved_pos
;
18344 Lisp_Object saved_object
;
18345 enum display_element_type saved_what
= it
->what
;
18346 int saved_face_id
= it
->face_id
;
18348 saved_object
= it
->object
;
18349 saved_pos
= it
->position
;
18351 it
->what
= IT_CHARACTER
;
18352 memset (&it
->position
, 0, sizeof it
->position
);
18353 it
->object
= make_number (0);
18354 it
->c
= it
->char_to_display
= ' ';
18356 /* The last row's blank glyphs should get the default face, to
18357 avoid painting the rest of the window with the region face,
18358 if the region ends at ZV. */
18359 if (it
->glyph_row
->ends_at_zv_p
)
18360 it
->face_id
= default_face
->id
;
18362 it
->face_id
= face
->id
;
18364 PRODUCE_GLYPHS (it
);
18366 while (it
->current_x
<= it
->last_visible_x
)
18367 PRODUCE_GLYPHS (it
);
18369 /* Don't count these blanks really. It would let us insert a left
18370 truncation glyph below and make us set the cursor on them, maybe. */
18371 it
->current_x
= saved_x
;
18372 it
->object
= saved_object
;
18373 it
->position
= saved_pos
;
18374 it
->what
= saved_what
;
18375 it
->face_id
= saved_face_id
;
18380 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18381 trailing whitespace. */
18384 trailing_whitespace_p (EMACS_INT charpos
)
18386 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18389 while (bytepos
< ZV_BYTE
18390 && (c
= FETCH_CHAR (bytepos
),
18391 c
== ' ' || c
== '\t'))
18394 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18396 if (bytepos
!= PT_BYTE
)
18403 /* Highlight trailing whitespace, if any, in ROW. */
18406 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18408 int used
= row
->used
[TEXT_AREA
];
18412 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18413 struct glyph
*glyph
= start
+ used
- 1;
18415 if (row
->reversed_p
)
18417 /* Right-to-left rows need to be processed in the opposite
18418 direction, so swap the edge pointers. */
18420 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18423 /* Skip over glyphs inserted to display the cursor at the
18424 end of a line, for extending the face of the last glyph
18425 to the end of the line on terminals, and for truncation
18426 and continuation glyphs. */
18427 if (!row
->reversed_p
)
18429 while (glyph
>= start
18430 && glyph
->type
== CHAR_GLYPH
18431 && INTEGERP (glyph
->object
))
18436 while (glyph
<= start
18437 && glyph
->type
== CHAR_GLYPH
18438 && INTEGERP (glyph
->object
))
18442 /* If last glyph is a space or stretch, and it's trailing
18443 whitespace, set the face of all trailing whitespace glyphs in
18444 IT->glyph_row to `trailing-whitespace'. */
18445 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18446 && BUFFERP (glyph
->object
)
18447 && (glyph
->type
== STRETCH_GLYPH
18448 || (glyph
->type
== CHAR_GLYPH
18449 && glyph
->u
.ch
== ' '))
18450 && trailing_whitespace_p (glyph
->charpos
))
18452 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18456 if (!row
->reversed_p
)
18458 while (glyph
>= start
18459 && BUFFERP (glyph
->object
)
18460 && (glyph
->type
== STRETCH_GLYPH
18461 || (glyph
->type
== CHAR_GLYPH
18462 && glyph
->u
.ch
== ' ')))
18463 (glyph
--)->face_id
= face_id
;
18467 while (glyph
<= start
18468 && BUFFERP (glyph
->object
)
18469 && (glyph
->type
== STRETCH_GLYPH
18470 || (glyph
->type
== CHAR_GLYPH
18471 && glyph
->u
.ch
== ' ')))
18472 (glyph
++)->face_id
= face_id
;
18479 /* Value is non-zero if glyph row ROW should be
18480 used to hold the cursor. */
18483 cursor_row_p (struct glyph_row
*row
)
18487 if (PT
== CHARPOS (row
->end
.pos
)
18488 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18490 /* Suppose the row ends on a string.
18491 Unless the row is continued, that means it ends on a newline
18492 in the string. If it's anything other than a display string
18493 (e.g., a before-string from an overlay), we don't want the
18494 cursor there. (This heuristic seems to give the optimal
18495 behavior for the various types of multi-line strings.)
18496 One exception: if the string has `cursor' property on one of
18497 its characters, we _do_ want the cursor there. */
18498 if (CHARPOS (row
->end
.string_pos
) >= 0)
18500 if (row
->continued_p
)
18504 /* Check for `display' property. */
18505 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18506 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18507 struct glyph
*glyph
;
18510 for (glyph
= end
; glyph
>= beg
; --glyph
)
18511 if (STRINGP (glyph
->object
))
18514 = Fget_char_property (make_number (PT
),
18518 && display_prop_string_p (prop
, glyph
->object
));
18519 /* If there's a `cursor' property on one of the
18520 string's characters, this row is a cursor row,
18521 even though this is not a display string. */
18524 Lisp_Object s
= glyph
->object
;
18526 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18528 EMACS_INT gpos
= glyph
->charpos
;
18530 if (!NILP (Fget_char_property (make_number (gpos
),
18542 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18544 /* If the row ends in middle of a real character,
18545 and the line is continued, we want the cursor here.
18546 That's because CHARPOS (ROW->end.pos) would equal
18547 PT if PT is before the character. */
18548 if (!row
->ends_in_ellipsis_p
)
18549 result
= row
->continued_p
;
18551 /* If the row ends in an ellipsis, then
18552 CHARPOS (ROW->end.pos) will equal point after the
18553 invisible text. We want that position to be displayed
18554 after the ellipsis. */
18557 /* If the row ends at ZV, display the cursor at the end of that
18558 row instead of at the start of the row below. */
18559 else if (row
->ends_at_zv_p
)
18570 /* Push the property PROP so that it will be rendered at the current
18571 position in IT. Return 1 if PROP was successfully pushed, 0
18572 otherwise. Called from handle_line_prefix to handle the
18573 `line-prefix' and `wrap-prefix' properties. */
18576 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18578 struct text_pos pos
=
18579 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18581 xassert (it
->method
== GET_FROM_BUFFER
18582 || it
->method
== GET_FROM_DISPLAY_VECTOR
18583 || it
->method
== GET_FROM_STRING
);
18585 /* We need to save the current buffer/string position, so it will be
18586 restored by pop_it, because iterate_out_of_display_property
18587 depends on that being set correctly, but some situations leave
18588 it->position not yet set when this function is called. */
18589 push_it (it
, &pos
);
18591 if (STRINGP (prop
))
18593 if (SCHARS (prop
) == 0)
18600 it
->string_from_prefix_prop_p
= 1;
18601 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18602 it
->current
.overlay_string_index
= -1;
18603 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18604 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18605 it
->method
= GET_FROM_STRING
;
18606 it
->stop_charpos
= 0;
18608 it
->base_level_stop
= 0;
18610 /* Force paragraph direction to be that of the parent
18612 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18613 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18615 it
->paragraph_embedding
= L2R
;
18617 /* Set up the bidi iterator for this display string. */
18620 it
->bidi_it
.string
.lstring
= it
->string
;
18621 it
->bidi_it
.string
.s
= NULL
;
18622 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18623 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18624 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18625 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18626 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18629 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18631 it
->method
= GET_FROM_STRETCH
;
18634 #ifdef HAVE_WINDOW_SYSTEM
18635 else if (IMAGEP (prop
))
18637 it
->what
= IT_IMAGE
;
18638 it
->image_id
= lookup_image (it
->f
, prop
);
18639 it
->method
= GET_FROM_IMAGE
;
18641 #endif /* HAVE_WINDOW_SYSTEM */
18644 pop_it (it
); /* bogus display property, give up */
18651 /* Return the character-property PROP at the current position in IT. */
18654 get_it_property (struct it
*it
, Lisp_Object prop
)
18656 Lisp_Object position
;
18658 if (STRINGP (it
->object
))
18659 position
= make_number (IT_STRING_CHARPOS (*it
));
18660 else if (BUFFERP (it
->object
))
18661 position
= make_number (IT_CHARPOS (*it
));
18665 return Fget_char_property (position
, prop
, it
->object
);
18668 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18671 handle_line_prefix (struct it
*it
)
18673 Lisp_Object prefix
;
18675 if (it
->continuation_lines_width
> 0)
18677 prefix
= get_it_property (it
, Qwrap_prefix
);
18679 prefix
= Vwrap_prefix
;
18683 prefix
= get_it_property (it
, Qline_prefix
);
18685 prefix
= Vline_prefix
;
18687 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
18689 /* If the prefix is wider than the window, and we try to wrap
18690 it, it would acquire its own wrap prefix, and so on till the
18691 iterator stack overflows. So, don't wrap the prefix. */
18692 it
->line_wrap
= TRUNCATE
;
18693 it
->avoid_cursor_p
= 1;
18699 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18700 only for R2L lines from display_line and display_string, when they
18701 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18702 the line/string needs to be continued on the next glyph row. */
18704 unproduce_glyphs (struct it
*it
, int n
)
18706 struct glyph
*glyph
, *end
;
18708 xassert (it
->glyph_row
);
18709 xassert (it
->glyph_row
->reversed_p
);
18710 xassert (it
->area
== TEXT_AREA
);
18711 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18713 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18714 n
= it
->glyph_row
->used
[TEXT_AREA
];
18715 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18716 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18717 for ( ; glyph
< end
; glyph
++)
18718 glyph
[-n
] = *glyph
;
18721 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18722 and ROW->maxpos. */
18724 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18725 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18726 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18728 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18729 lines' rows is implemented for bidi-reordered rows. */
18731 /* ROW->minpos is the value of min_pos, the minimal buffer position
18732 we have in ROW, or ROW->start.pos if that is smaller. */
18733 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18734 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18736 /* We didn't find buffer positions smaller than ROW->start, or
18737 didn't find _any_ valid buffer positions in any of the glyphs,
18738 so we must trust the iterator's computed positions. */
18739 row
->minpos
= row
->start
.pos
;
18742 max_pos
= CHARPOS (it
->current
.pos
);
18743 max_bpos
= BYTEPOS (it
->current
.pos
);
18746 /* Here are the various use-cases for ending the row, and the
18747 corresponding values for ROW->maxpos:
18749 Line ends in a newline from buffer eol_pos + 1
18750 Line is continued from buffer max_pos + 1
18751 Line is truncated on right it->current.pos
18752 Line ends in a newline from string max_pos + 1(*)
18753 (*) + 1 only when line ends in a forward scan
18754 Line is continued from string max_pos
18755 Line is continued from display vector max_pos
18756 Line is entirely from a string min_pos == max_pos
18757 Line is entirely from a display vector min_pos == max_pos
18758 Line that ends at ZV ZV
18760 If you discover other use-cases, please add them here as
18762 if (row
->ends_at_zv_p
)
18763 row
->maxpos
= it
->current
.pos
;
18764 else if (row
->used
[TEXT_AREA
])
18766 int seen_this_string
= 0;
18767 struct glyph_row
*r1
= row
- 1;
18769 /* Did we see the same display string on the previous row? */
18770 if (STRINGP (it
->object
)
18771 /* this is not the first row */
18772 && row
> it
->w
->desired_matrix
->rows
18773 /* previous row is not the header line */
18774 && !r1
->mode_line_p
18775 /* previous row also ends in a newline from a string */
18776 && r1
->ends_in_newline_from_string_p
)
18778 struct glyph
*start
, *end
;
18780 /* Search for the last glyph of the previous row that came
18781 from buffer or string. Depending on whether the row is
18782 L2R or R2L, we need to process it front to back or the
18783 other way round. */
18784 if (!r1
->reversed_p
)
18786 start
= r1
->glyphs
[TEXT_AREA
];
18787 end
= start
+ r1
->used
[TEXT_AREA
];
18788 /* Glyphs inserted by redisplay have an integer (zero)
18789 as their object. */
18791 && INTEGERP ((end
- 1)->object
)
18792 && (end
- 1)->charpos
<= 0)
18796 if (EQ ((end
- 1)->object
, it
->object
))
18797 seen_this_string
= 1;
18800 /* If all the glyphs of the previous row were inserted
18801 by redisplay, it means the previous row was
18802 produced from a single newline, which is only
18803 possible if that newline came from the same string
18804 as the one which produced this ROW. */
18805 seen_this_string
= 1;
18809 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18810 start
= end
+ r1
->used
[TEXT_AREA
];
18812 && INTEGERP ((end
+ 1)->object
)
18813 && (end
+ 1)->charpos
<= 0)
18817 if (EQ ((end
+ 1)->object
, it
->object
))
18818 seen_this_string
= 1;
18821 seen_this_string
= 1;
18824 /* Take note of each display string that covers a newline only
18825 once, the first time we see it. This is for when a display
18826 string includes more than one newline in it. */
18827 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18829 /* If we were scanning the buffer forward when we displayed
18830 the string, we want to account for at least one buffer
18831 position that belongs to this row (position covered by
18832 the display string), so that cursor positioning will
18833 consider this row as a candidate when point is at the end
18834 of the visual line represented by this row. This is not
18835 required when scanning back, because max_pos will already
18836 have a much larger value. */
18837 if (CHARPOS (row
->end
.pos
) > max_pos
)
18838 INC_BOTH (max_pos
, max_bpos
);
18839 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18841 else if (CHARPOS (it
->eol_pos
) > 0)
18842 SET_TEXT_POS (row
->maxpos
,
18843 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18844 else if (row
->continued_p
)
18846 /* If max_pos is different from IT's current position, it
18847 means IT->method does not belong to the display element
18848 at max_pos. However, it also means that the display
18849 element at max_pos was displayed in its entirety on this
18850 line, which is equivalent to saying that the next line
18851 starts at the next buffer position. */
18852 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18853 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18856 INC_BOTH (max_pos
, max_bpos
);
18857 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18860 else if (row
->truncated_on_right_p
)
18861 /* display_line already called reseat_at_next_visible_line_start,
18862 which puts the iterator at the beginning of the next line, in
18863 the logical order. */
18864 row
->maxpos
= it
->current
.pos
;
18865 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18866 /* A line that is entirely from a string/image/stretch... */
18867 row
->maxpos
= row
->minpos
;
18872 row
->maxpos
= it
->current
.pos
;
18875 /* Construct the glyph row IT->glyph_row in the desired matrix of
18876 IT->w from text at the current position of IT. See dispextern.h
18877 for an overview of struct it. Value is non-zero if
18878 IT->glyph_row displays text, as opposed to a line displaying ZV
18882 display_line (struct it
*it
)
18884 struct glyph_row
*row
= it
->glyph_row
;
18885 Lisp_Object overlay_arrow_string
;
18887 void *wrap_data
= NULL
;
18888 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18889 int wrap_row_used
= -1;
18890 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18891 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18892 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18893 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18894 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18896 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18897 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18899 /* We always start displaying at hpos zero even if hscrolled. */
18900 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18902 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18903 >= it
->w
->desired_matrix
->nrows
)
18905 it
->w
->nrows_scale_factor
++;
18906 fonts_changed_p
= 1;
18910 /* Is IT->w showing the region? */
18911 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18913 /* Clear the result glyph row and enable it. */
18914 prepare_desired_row (row
);
18916 row
->y
= it
->current_y
;
18917 row
->start
= it
->start
;
18918 row
->continuation_lines_width
= it
->continuation_lines_width
;
18919 row
->displays_text_p
= 1;
18920 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18921 it
->starts_in_middle_of_char_p
= 0;
18923 /* Arrange the overlays nicely for our purposes. Usually, we call
18924 display_line on only one line at a time, in which case this
18925 can't really hurt too much, or we call it on lines which appear
18926 one after another in the buffer, in which case all calls to
18927 recenter_overlay_lists but the first will be pretty cheap. */
18928 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18930 /* Move over display elements that are not visible because we are
18931 hscrolled. This may stop at an x-position < IT->first_visible_x
18932 if the first glyph is partially visible or if we hit a line end. */
18933 if (it
->current_x
< it
->first_visible_x
)
18935 this_line_min_pos
= row
->start
.pos
;
18936 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18937 MOVE_TO_POS
| MOVE_TO_X
);
18938 /* Record the smallest positions seen while we moved over
18939 display elements that are not visible. This is needed by
18940 redisplay_internal for optimizing the case where the cursor
18941 stays inside the same line. The rest of this function only
18942 considers positions that are actually displayed, so
18943 RECORD_MAX_MIN_POS will not otherwise record positions that
18944 are hscrolled to the left of the left edge of the window. */
18945 min_pos
= CHARPOS (this_line_min_pos
);
18946 min_bpos
= BYTEPOS (this_line_min_pos
);
18950 /* We only do this when not calling `move_it_in_display_line_to'
18951 above, because move_it_in_display_line_to calls
18952 handle_line_prefix itself. */
18953 handle_line_prefix (it
);
18956 /* Get the initial row height. This is either the height of the
18957 text hscrolled, if there is any, or zero. */
18958 row
->ascent
= it
->max_ascent
;
18959 row
->height
= it
->max_ascent
+ it
->max_descent
;
18960 row
->phys_ascent
= it
->max_phys_ascent
;
18961 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18962 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18964 /* Utility macro to record max and min buffer positions seen until now. */
18965 #define RECORD_MAX_MIN_POS(IT) \
18968 int composition_p = !STRINGP ((IT)->string) \
18969 && ((IT)->what == IT_COMPOSITION); \
18970 EMACS_INT current_pos = \
18971 composition_p ? (IT)->cmp_it.charpos \
18972 : IT_CHARPOS (*(IT)); \
18973 EMACS_INT current_bpos = \
18974 composition_p ? CHAR_TO_BYTE (current_pos) \
18975 : IT_BYTEPOS (*(IT)); \
18976 if (current_pos < min_pos) \
18978 min_pos = current_pos; \
18979 min_bpos = current_bpos; \
18981 if (IT_CHARPOS (*it) > max_pos) \
18983 max_pos = IT_CHARPOS (*it); \
18984 max_bpos = IT_BYTEPOS (*it); \
18989 /* Loop generating characters. The loop is left with IT on the next
18990 character to display. */
18993 int n_glyphs_before
, hpos_before
, x_before
;
18995 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18997 /* Retrieve the next thing to display. Value is zero if end of
18999 if (!get_next_display_element (it
))
19001 /* Maybe add a space at the end of this line that is used to
19002 display the cursor there under X. Set the charpos of the
19003 first glyph of blank lines not corresponding to any text
19005 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19006 row
->exact_window_width_line_p
= 1;
19007 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19008 || row
->used
[TEXT_AREA
] == 0)
19010 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19011 row
->displays_text_p
= 0;
19013 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19014 && (!MINI_WINDOW_P (it
->w
)
19015 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19016 row
->indicate_empty_line_p
= 1;
19019 it
->continuation_lines_width
= 0;
19020 row
->ends_at_zv_p
= 1;
19021 /* A row that displays right-to-left text must always have
19022 its last face extended all the way to the end of line,
19023 even if this row ends in ZV, because we still write to
19024 the screen left to right. We also need to extend the
19025 last face if the default face is remapped to some
19026 different face, otherwise the functions that clear
19027 portions of the screen will clear with the default face's
19028 background color. */
19029 if (row
->reversed_p
19030 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19031 extend_face_to_end_of_line (it
);
19035 /* Now, get the metrics of what we want to display. This also
19036 generates glyphs in `row' (which is IT->glyph_row). */
19037 n_glyphs_before
= row
->used
[TEXT_AREA
];
19040 /* Remember the line height so far in case the next element doesn't
19041 fit on the line. */
19042 if (it
->line_wrap
!= TRUNCATE
)
19044 ascent
= it
->max_ascent
;
19045 descent
= it
->max_descent
;
19046 phys_ascent
= it
->max_phys_ascent
;
19047 phys_descent
= it
->max_phys_descent
;
19049 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19051 if (IT_DISPLAYING_WHITESPACE (it
))
19055 SAVE_IT (wrap_it
, *it
, wrap_data
);
19057 wrap_row_used
= row
->used
[TEXT_AREA
];
19058 wrap_row_ascent
= row
->ascent
;
19059 wrap_row_height
= row
->height
;
19060 wrap_row_phys_ascent
= row
->phys_ascent
;
19061 wrap_row_phys_height
= row
->phys_height
;
19062 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19063 wrap_row_min_pos
= min_pos
;
19064 wrap_row_min_bpos
= min_bpos
;
19065 wrap_row_max_pos
= max_pos
;
19066 wrap_row_max_bpos
= max_bpos
;
19072 PRODUCE_GLYPHS (it
);
19074 /* If this display element was in marginal areas, continue with
19076 if (it
->area
!= TEXT_AREA
)
19078 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19079 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19080 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19081 row
->phys_height
= max (row
->phys_height
,
19082 it
->max_phys_ascent
+ it
->max_phys_descent
);
19083 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19084 it
->max_extra_line_spacing
);
19085 set_iterator_to_next (it
, 1);
19089 /* Does the display element fit on the line? If we truncate
19090 lines, we should draw past the right edge of the window. If
19091 we don't truncate, we want to stop so that we can display the
19092 continuation glyph before the right margin. If lines are
19093 continued, there are two possible strategies for characters
19094 resulting in more than 1 glyph (e.g. tabs): Display as many
19095 glyphs as possible in this line and leave the rest for the
19096 continuation line, or display the whole element in the next
19097 line. Original redisplay did the former, so we do it also. */
19098 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19099 hpos_before
= it
->hpos
;
19102 if (/* Not a newline. */
19104 /* Glyphs produced fit entirely in the line. */
19105 && it
->current_x
< it
->last_visible_x
)
19107 it
->hpos
+= nglyphs
;
19108 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19109 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19110 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19111 row
->phys_height
= max (row
->phys_height
,
19112 it
->max_phys_ascent
+ it
->max_phys_descent
);
19113 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19114 it
->max_extra_line_spacing
);
19115 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19116 row
->x
= x
- it
->first_visible_x
;
19117 /* Record the maximum and minimum buffer positions seen so
19118 far in glyphs that will be displayed by this row. */
19120 RECORD_MAX_MIN_POS (it
);
19125 struct glyph
*glyph
;
19127 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19129 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19130 new_x
= x
+ glyph
->pixel_width
;
19132 if (/* Lines are continued. */
19133 it
->line_wrap
!= TRUNCATE
19134 && (/* Glyph doesn't fit on the line. */
19135 new_x
> it
->last_visible_x
19136 /* Or it fits exactly on a window system frame. */
19137 || (new_x
== it
->last_visible_x
19138 && FRAME_WINDOW_P (it
->f
))))
19140 /* End of a continued line. */
19143 || (new_x
== it
->last_visible_x
19144 && FRAME_WINDOW_P (it
->f
)))
19146 /* Current glyph is the only one on the line or
19147 fits exactly on the line. We must continue
19148 the line because we can't draw the cursor
19149 after the glyph. */
19150 row
->continued_p
= 1;
19151 it
->current_x
= new_x
;
19152 it
->continuation_lines_width
+= new_x
;
19154 if (i
== nglyphs
- 1)
19156 /* If line-wrap is on, check if a previous
19157 wrap point was found. */
19158 if (wrap_row_used
> 0
19159 /* Even if there is a previous wrap
19160 point, continue the line here as
19161 usual, if (i) the previous character
19162 was a space or tab AND (ii) the
19163 current character is not. */
19165 || IT_DISPLAYING_WHITESPACE (it
)))
19168 /* Record the maximum and minimum buffer
19169 positions seen so far in glyphs that will be
19170 displayed by this row. */
19172 RECORD_MAX_MIN_POS (it
);
19173 set_iterator_to_next (it
, 1);
19174 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19176 if (!get_next_display_element (it
))
19178 row
->exact_window_width_line_p
= 1;
19179 it
->continuation_lines_width
= 0;
19180 row
->continued_p
= 0;
19181 row
->ends_at_zv_p
= 1;
19183 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19185 row
->continued_p
= 0;
19186 row
->exact_window_width_line_p
= 1;
19190 else if (it
->bidi_p
)
19191 RECORD_MAX_MIN_POS (it
);
19193 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19194 && !FRAME_WINDOW_P (it
->f
))
19196 /* A padding glyph that doesn't fit on this line.
19197 This means the whole character doesn't fit
19199 if (row
->reversed_p
)
19200 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19201 - n_glyphs_before
);
19202 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19204 /* Fill the rest of the row with continuation
19205 glyphs like in 20.x. */
19206 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19207 < row
->glyphs
[1 + TEXT_AREA
])
19208 produce_special_glyphs (it
, IT_CONTINUATION
);
19210 row
->continued_p
= 1;
19211 it
->current_x
= x_before
;
19212 it
->continuation_lines_width
+= x_before
;
19214 /* Restore the height to what it was before the
19215 element not fitting on the line. */
19216 it
->max_ascent
= ascent
;
19217 it
->max_descent
= descent
;
19218 it
->max_phys_ascent
= phys_ascent
;
19219 it
->max_phys_descent
= phys_descent
;
19221 else if (wrap_row_used
> 0)
19224 if (row
->reversed_p
)
19225 unproduce_glyphs (it
,
19226 row
->used
[TEXT_AREA
] - wrap_row_used
);
19227 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19228 it
->continuation_lines_width
+= wrap_x
;
19229 row
->used
[TEXT_AREA
] = wrap_row_used
;
19230 row
->ascent
= wrap_row_ascent
;
19231 row
->height
= wrap_row_height
;
19232 row
->phys_ascent
= wrap_row_phys_ascent
;
19233 row
->phys_height
= wrap_row_phys_height
;
19234 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19235 min_pos
= wrap_row_min_pos
;
19236 min_bpos
= wrap_row_min_bpos
;
19237 max_pos
= wrap_row_max_pos
;
19238 max_bpos
= wrap_row_max_bpos
;
19239 row
->continued_p
= 1;
19240 row
->ends_at_zv_p
= 0;
19241 row
->exact_window_width_line_p
= 0;
19242 it
->continuation_lines_width
+= x
;
19244 /* Make sure that a non-default face is extended
19245 up to the right margin of the window. */
19246 extend_face_to_end_of_line (it
);
19248 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19250 /* A TAB that extends past the right edge of the
19251 window. This produces a single glyph on
19252 window system frames. We leave the glyph in
19253 this row and let it fill the row, but don't
19254 consume the TAB. */
19255 it
->continuation_lines_width
+= it
->last_visible_x
;
19256 row
->ends_in_middle_of_char_p
= 1;
19257 row
->continued_p
= 1;
19258 glyph
->pixel_width
= it
->last_visible_x
- x
;
19259 it
->starts_in_middle_of_char_p
= 1;
19263 /* Something other than a TAB that draws past
19264 the right edge of the window. Restore
19265 positions to values before the element. */
19266 if (row
->reversed_p
)
19267 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19268 - (n_glyphs_before
+ i
));
19269 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19271 /* Display continuation glyphs. */
19272 if (!FRAME_WINDOW_P (it
->f
))
19273 produce_special_glyphs (it
, IT_CONTINUATION
);
19274 row
->continued_p
= 1;
19276 it
->current_x
= x_before
;
19277 it
->continuation_lines_width
+= x
;
19278 extend_face_to_end_of_line (it
);
19280 if (nglyphs
> 1 && i
> 0)
19282 row
->ends_in_middle_of_char_p
= 1;
19283 it
->starts_in_middle_of_char_p
= 1;
19286 /* Restore the height to what it was before the
19287 element not fitting on the line. */
19288 it
->max_ascent
= ascent
;
19289 it
->max_descent
= descent
;
19290 it
->max_phys_ascent
= phys_ascent
;
19291 it
->max_phys_descent
= phys_descent
;
19296 else if (new_x
> it
->first_visible_x
)
19298 /* Increment number of glyphs actually displayed. */
19301 /* Record the maximum and minimum buffer positions
19302 seen so far in glyphs that will be displayed by
19305 RECORD_MAX_MIN_POS (it
);
19307 if (x
< it
->first_visible_x
)
19308 /* Glyph is partially visible, i.e. row starts at
19309 negative X position. */
19310 row
->x
= x
- it
->first_visible_x
;
19314 /* Glyph is completely off the left margin of the
19315 window. This should not happen because of the
19316 move_it_in_display_line at the start of this
19317 function, unless the text display area of the
19318 window is empty. */
19319 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19322 /* Even if this display element produced no glyphs at all,
19323 we want to record its position. */
19324 if (it
->bidi_p
&& nglyphs
== 0)
19325 RECORD_MAX_MIN_POS (it
);
19327 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19328 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19329 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19330 row
->phys_height
= max (row
->phys_height
,
19331 it
->max_phys_ascent
+ it
->max_phys_descent
);
19332 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19333 it
->max_extra_line_spacing
);
19335 /* End of this display line if row is continued. */
19336 if (row
->continued_p
|| row
->ends_at_zv_p
)
19341 /* Is this a line end? If yes, we're also done, after making
19342 sure that a non-default face is extended up to the right
19343 margin of the window. */
19344 if (ITERATOR_AT_END_OF_LINE_P (it
))
19346 int used_before
= row
->used
[TEXT_AREA
];
19348 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19350 /* Add a space at the end of the line that is used to
19351 display the cursor there. */
19352 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19353 append_space_for_newline (it
, 0);
19355 /* Extend the face to the end of the line. */
19356 extend_face_to_end_of_line (it
);
19358 /* Make sure we have the position. */
19359 if (used_before
== 0)
19360 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19362 /* Record the position of the newline, for use in
19364 it
->eol_pos
= it
->current
.pos
;
19366 /* Consume the line end. This skips over invisible lines. */
19367 set_iterator_to_next (it
, 1);
19368 it
->continuation_lines_width
= 0;
19372 /* Proceed with next display element. Note that this skips
19373 over lines invisible because of selective display. */
19374 set_iterator_to_next (it
, 1);
19376 /* If we truncate lines, we are done when the last displayed
19377 glyphs reach past the right margin of the window. */
19378 if (it
->line_wrap
== TRUNCATE
19379 && (FRAME_WINDOW_P (it
->f
)
19380 ? (it
->current_x
>= it
->last_visible_x
)
19381 : (it
->current_x
> it
->last_visible_x
)))
19383 /* Maybe add truncation glyphs. */
19384 if (!FRAME_WINDOW_P (it
->f
))
19388 if (!row
->reversed_p
)
19390 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19391 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19396 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19397 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19399 /* Remove any padding glyphs at the front of ROW, to
19400 make room for the truncation glyphs we will be
19401 adding below. The loop below always inserts at
19402 least one truncation glyph, so also remove the
19403 last glyph added to ROW. */
19404 unproduce_glyphs (it
, i
+ 1);
19405 /* Adjust i for the loop below. */
19406 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19409 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19411 row
->used
[TEXT_AREA
] = i
;
19412 produce_special_glyphs (it
, IT_TRUNCATION
);
19415 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19417 /* Don't truncate if we can overflow newline into fringe. */
19418 if (!get_next_display_element (it
))
19420 it
->continuation_lines_width
= 0;
19421 row
->ends_at_zv_p
= 1;
19422 row
->exact_window_width_line_p
= 1;
19425 if (ITERATOR_AT_END_OF_LINE_P (it
))
19427 row
->exact_window_width_line_p
= 1;
19428 goto at_end_of_line
;
19432 row
->truncated_on_right_p
= 1;
19433 it
->continuation_lines_width
= 0;
19434 reseat_at_next_visible_line_start (it
, 0);
19435 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19436 it
->hpos
= hpos_before
;
19437 it
->current_x
= x_before
;
19443 bidi_unshelve_cache (wrap_data
, 1);
19445 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19446 at the left window margin. */
19447 if (it
->first_visible_x
19448 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19450 if (!FRAME_WINDOW_P (it
->f
))
19451 insert_left_trunc_glyphs (it
);
19452 row
->truncated_on_left_p
= 1;
19455 /* Remember the position at which this line ends.
19457 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19458 cannot be before the call to find_row_edges below, since that is
19459 where these positions are determined. */
19460 row
->end
= it
->current
;
19463 row
->minpos
= row
->start
.pos
;
19464 row
->maxpos
= row
->end
.pos
;
19468 /* ROW->minpos and ROW->maxpos must be the smallest and
19469 `1 + the largest' buffer positions in ROW. But if ROW was
19470 bidi-reordered, these two positions can be anywhere in the
19471 row, so we must determine them now. */
19472 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19475 /* If the start of this line is the overlay arrow-position, then
19476 mark this glyph row as the one containing the overlay arrow.
19477 This is clearly a mess with variable size fonts. It would be
19478 better to let it be displayed like cursors under X. */
19479 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19480 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19481 !NILP (overlay_arrow_string
)))
19483 /* Overlay arrow in window redisplay is a fringe bitmap. */
19484 if (STRINGP (overlay_arrow_string
))
19486 struct glyph_row
*arrow_row
19487 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19488 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19489 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19490 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19491 struct glyph
*p2
, *end
;
19493 /* Copy the arrow glyphs. */
19494 while (glyph
< arrow_end
)
19497 /* Throw away padding glyphs. */
19499 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19500 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19506 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19511 xassert (INTEGERP (overlay_arrow_string
));
19512 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19514 overlay_arrow_seen
= 1;
19517 /* Highlight trailing whitespace. */
19518 if (!NILP (Vshow_trailing_whitespace
))
19519 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19521 /* Compute pixel dimensions of this line. */
19522 compute_line_metrics (it
);
19524 /* Implementation note: No changes in the glyphs of ROW or in their
19525 faces can be done past this point, because compute_line_metrics
19526 computes ROW's hash value and stores it within the glyph_row
19529 /* Record whether this row ends inside an ellipsis. */
19530 row
->ends_in_ellipsis_p
19531 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19532 && it
->ellipsis_p
);
19534 /* Save fringe bitmaps in this row. */
19535 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19536 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19537 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19538 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19540 it
->left_user_fringe_bitmap
= 0;
19541 it
->left_user_fringe_face_id
= 0;
19542 it
->right_user_fringe_bitmap
= 0;
19543 it
->right_user_fringe_face_id
= 0;
19545 /* Maybe set the cursor. */
19546 cvpos
= it
->w
->cursor
.vpos
;
19548 /* In bidi-reordered rows, keep checking for proper cursor
19549 position even if one has been found already, because buffer
19550 positions in such rows change non-linearly with ROW->VPOS,
19551 when a line is continued. One exception: when we are at ZV,
19552 display cursor on the first suitable glyph row, since all
19553 the empty rows after that also have their position set to ZV. */
19554 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19555 lines' rows is implemented for bidi-reordered rows. */
19557 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19558 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19559 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19560 && cursor_row_p (row
))
19561 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19563 /* Prepare for the next line. This line starts horizontally at (X
19564 HPOS) = (0 0). Vertical positions are incremented. As a
19565 convenience for the caller, IT->glyph_row is set to the next
19567 it
->current_x
= it
->hpos
= 0;
19568 it
->current_y
+= row
->height
;
19569 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19572 /* The next row should by default use the same value of the
19573 reversed_p flag as this one. set_iterator_to_next decides when
19574 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19575 the flag accordingly. */
19576 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19577 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19578 it
->start
= row
->end
;
19579 return row
->displays_text_p
;
19581 #undef RECORD_MAX_MIN_POS
19584 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19585 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19586 doc
: /* Return paragraph direction at point in BUFFER.
19587 Value is either `left-to-right' or `right-to-left'.
19588 If BUFFER is omitted or nil, it defaults to the current buffer.
19590 Paragraph direction determines how the text in the paragraph is displayed.
19591 In left-to-right paragraphs, text begins at the left margin of the window
19592 and the reading direction is generally left to right. In right-to-left
19593 paragraphs, text begins at the right margin and is read from right to left.
19595 See also `bidi-paragraph-direction'. */)
19596 (Lisp_Object buffer
)
19598 struct buffer
*buf
= current_buffer
;
19599 struct buffer
*old
= buf
;
19601 if (! NILP (buffer
))
19603 CHECK_BUFFER (buffer
);
19604 buf
= XBUFFER (buffer
);
19607 if (NILP (BVAR (buf
, bidi_display_reordering
))
19608 || NILP (BVAR (buf
, enable_multibyte_characters
))
19609 /* When we are loading loadup.el, the character property tables
19610 needed for bidi iteration are not yet available. */
19611 || !NILP (Vpurify_flag
))
19612 return Qleft_to_right
;
19613 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19614 return BVAR (buf
, bidi_paragraph_direction
);
19617 /* Determine the direction from buffer text. We could try to
19618 use current_matrix if it is up to date, but this seems fast
19619 enough as it is. */
19620 struct bidi_it itb
;
19621 EMACS_INT pos
= BUF_PT (buf
);
19622 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19624 void *itb_data
= bidi_shelve_cache ();
19626 set_buffer_temp (buf
);
19627 /* bidi_paragraph_init finds the base direction of the paragraph
19628 by searching forward from paragraph start. We need the base
19629 direction of the current or _previous_ paragraph, so we need
19630 to make sure we are within that paragraph. To that end, find
19631 the previous non-empty line. */
19632 if (pos
>= ZV
&& pos
> BEGV
)
19635 bytepos
= CHAR_TO_BYTE (pos
);
19637 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19638 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19640 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19641 || c
== ' ' || c
== '\t' || c
== '\f')
19643 if (bytepos
<= BEGV_BYTE
)
19648 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19651 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19652 itb
.paragraph_dir
= NEUTRAL_DIR
;
19653 itb
.string
.s
= NULL
;
19654 itb
.string
.lstring
= Qnil
;
19655 itb
.string
.bufpos
= 0;
19656 itb
.string
.unibyte
= 0;
19657 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19658 bidi_unshelve_cache (itb_data
, 0);
19659 set_buffer_temp (old
);
19660 switch (itb
.paragraph_dir
)
19663 return Qleft_to_right
;
19666 return Qright_to_left
;
19676 /***********************************************************************
19678 ***********************************************************************/
19680 /* Redisplay the menu bar in the frame for window W.
19682 The menu bar of X frames that don't have X toolkit support is
19683 displayed in a special window W->frame->menu_bar_window.
19685 The menu bar of terminal frames is treated specially as far as
19686 glyph matrices are concerned. Menu bar lines are not part of
19687 windows, so the update is done directly on the frame matrix rows
19688 for the menu bar. */
19691 display_menu_bar (struct window
*w
)
19693 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19698 /* Don't do all this for graphical frames. */
19700 if (FRAME_W32_P (f
))
19703 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19709 if (FRAME_NS_P (f
))
19711 #endif /* HAVE_NS */
19713 #ifdef USE_X_TOOLKIT
19714 xassert (!FRAME_WINDOW_P (f
));
19715 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19716 it
.first_visible_x
= 0;
19717 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19718 #else /* not USE_X_TOOLKIT */
19719 if (FRAME_WINDOW_P (f
))
19721 /* Menu bar lines are displayed in the desired matrix of the
19722 dummy window menu_bar_window. */
19723 struct window
*menu_w
;
19724 xassert (WINDOWP (f
->menu_bar_window
));
19725 menu_w
= XWINDOW (f
->menu_bar_window
);
19726 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19728 it
.first_visible_x
= 0;
19729 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19733 /* This is a TTY frame, i.e. character hpos/vpos are used as
19735 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19737 it
.first_visible_x
= 0;
19738 it
.last_visible_x
= FRAME_COLS (f
);
19740 #endif /* not USE_X_TOOLKIT */
19742 /* FIXME: This should be controlled by a user option. See the
19743 comments in redisplay_tool_bar and display_mode_line about
19745 it
.paragraph_embedding
= L2R
;
19747 if (! mode_line_inverse_video
)
19748 /* Force the menu-bar to be displayed in the default face. */
19749 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19751 /* Clear all rows of the menu bar. */
19752 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19754 struct glyph_row
*row
= it
.glyph_row
+ i
;
19755 clear_glyph_row (row
);
19756 row
->enabled_p
= 1;
19757 row
->full_width_p
= 1;
19760 /* Display all items of the menu bar. */
19761 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19762 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19764 Lisp_Object string
;
19766 /* Stop at nil string. */
19767 string
= AREF (items
, i
+ 1);
19771 /* Remember where item was displayed. */
19772 ASET (items
, i
+ 3, make_number (it
.hpos
));
19774 /* Display the item, pad with one space. */
19775 if (it
.current_x
< it
.last_visible_x
)
19776 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19777 SCHARS (string
) + 1, 0, 0, -1);
19780 /* Fill out the line with spaces. */
19781 if (it
.current_x
< it
.last_visible_x
)
19782 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19784 /* Compute the total height of the lines. */
19785 compute_line_metrics (&it
);
19790 /***********************************************************************
19792 ***********************************************************************/
19794 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19795 FORCE is non-zero, redisplay mode lines unconditionally.
19796 Otherwise, redisplay only mode lines that are garbaged. Value is
19797 the number of windows whose mode lines were redisplayed. */
19800 redisplay_mode_lines (Lisp_Object window
, int force
)
19804 while (!NILP (window
))
19806 struct window
*w
= XWINDOW (window
);
19808 if (WINDOWP (w
->hchild
))
19809 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19810 else if (WINDOWP (w
->vchild
))
19811 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19813 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19814 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19816 struct text_pos lpoint
;
19817 struct buffer
*old
= current_buffer
;
19819 /* Set the window's buffer for the mode line display. */
19820 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19821 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19823 /* Point refers normally to the selected window. For any
19824 other window, set up appropriate value. */
19825 if (!EQ (window
, selected_window
))
19827 struct text_pos pt
;
19829 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19830 if (CHARPOS (pt
) < BEGV
)
19831 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19832 else if (CHARPOS (pt
) > (ZV
- 1))
19833 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19835 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19838 /* Display mode lines. */
19839 clear_glyph_matrix (w
->desired_matrix
);
19840 if (display_mode_lines (w
))
19843 w
->must_be_updated_p
= 1;
19846 /* Restore old settings. */
19847 set_buffer_internal_1 (old
);
19848 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19858 /* Display the mode and/or header line of window W. Value is the
19859 sum number of mode lines and header lines displayed. */
19862 display_mode_lines (struct window
*w
)
19864 Lisp_Object old_selected_window
, old_selected_frame
;
19867 old_selected_frame
= selected_frame
;
19868 selected_frame
= w
->frame
;
19869 old_selected_window
= selected_window
;
19870 XSETWINDOW (selected_window
, w
);
19872 /* These will be set while the mode line specs are processed. */
19873 line_number_displayed
= 0;
19874 w
->column_number_displayed
= Qnil
;
19876 if (WINDOW_WANTS_MODELINE_P (w
))
19878 struct window
*sel_w
= XWINDOW (old_selected_window
);
19880 /* Select mode line face based on the real selected window. */
19881 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19882 BVAR (current_buffer
, mode_line_format
));
19886 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19888 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19889 BVAR (current_buffer
, header_line_format
));
19893 selected_frame
= old_selected_frame
;
19894 selected_window
= old_selected_window
;
19899 /* Display mode or header line of window W. FACE_ID specifies which
19900 line to display; it is either MODE_LINE_FACE_ID or
19901 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19902 display. Value is the pixel height of the mode/header line
19906 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19910 int count
= SPECPDL_INDEX ();
19912 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19913 /* Don't extend on a previously drawn mode-line.
19914 This may happen if called from pos_visible_p. */
19915 it
.glyph_row
->enabled_p
= 0;
19916 prepare_desired_row (it
.glyph_row
);
19918 it
.glyph_row
->mode_line_p
= 1;
19920 if (! mode_line_inverse_video
)
19921 /* Force the mode-line to be displayed in the default face. */
19922 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19924 /* FIXME: This should be controlled by a user option. But
19925 supporting such an option is not trivial, since the mode line is
19926 made up of many separate strings. */
19927 it
.paragraph_embedding
= L2R
;
19929 record_unwind_protect (unwind_format_mode_line
,
19930 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19932 mode_line_target
= MODE_LINE_DISPLAY
;
19934 /* Temporarily make frame's keyboard the current kboard so that
19935 kboard-local variables in the mode_line_format will get the right
19937 push_kboard (FRAME_KBOARD (it
.f
));
19938 record_unwind_save_match_data ();
19939 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19942 unbind_to (count
, Qnil
);
19944 /* Fill up with spaces. */
19945 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19947 compute_line_metrics (&it
);
19948 it
.glyph_row
->full_width_p
= 1;
19949 it
.glyph_row
->continued_p
= 0;
19950 it
.glyph_row
->truncated_on_left_p
= 0;
19951 it
.glyph_row
->truncated_on_right_p
= 0;
19953 /* Make a 3D mode-line have a shadow at its right end. */
19954 face
= FACE_FROM_ID (it
.f
, face_id
);
19955 extend_face_to_end_of_line (&it
);
19956 if (face
->box
!= FACE_NO_BOX
)
19958 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19959 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19960 last
->right_box_line_p
= 1;
19963 return it
.glyph_row
->height
;
19966 /* Move element ELT in LIST to the front of LIST.
19967 Return the updated list. */
19970 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19972 register Lisp_Object tail
, prev
;
19973 register Lisp_Object tem
;
19977 while (CONSP (tail
))
19983 /* Splice out the link TAIL. */
19985 list
= XCDR (tail
);
19987 Fsetcdr (prev
, XCDR (tail
));
19989 /* Now make it the first. */
19990 Fsetcdr (tail
, list
);
19995 tail
= XCDR (tail
);
19999 /* Not found--return unchanged LIST. */
20003 /* Contribute ELT to the mode line for window IT->w. How it
20004 translates into text depends on its data type.
20006 IT describes the display environment in which we display, as usual.
20008 DEPTH is the depth in recursion. It is used to prevent
20009 infinite recursion here.
20011 FIELD_WIDTH is the number of characters the display of ELT should
20012 occupy in the mode line, and PRECISION is the maximum number of
20013 characters to display from ELT's representation. See
20014 display_string for details.
20016 Returns the hpos of the end of the text generated by ELT.
20018 PROPS is a property list to add to any string we encounter.
20020 If RISKY is nonzero, remove (disregard) any properties in any string
20021 we encounter, and ignore :eval and :propertize.
20023 The global variable `mode_line_target' determines whether the
20024 output is passed to `store_mode_line_noprop',
20025 `store_mode_line_string', or `display_string'. */
20028 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20029 Lisp_Object elt
, Lisp_Object props
, int risky
)
20031 int n
= 0, field
, prec
;
20036 elt
= build_string ("*too-deep*");
20040 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
20044 /* A string: output it and check for %-constructs within it. */
20046 EMACS_INT offset
= 0;
20048 if (SCHARS (elt
) > 0
20049 && (!NILP (props
) || risky
))
20051 Lisp_Object oprops
, aelt
;
20052 oprops
= Ftext_properties_at (make_number (0), elt
);
20054 /* If the starting string's properties are not what
20055 we want, translate the string. Also, if the string
20056 is risky, do that anyway. */
20058 if (NILP (Fequal (props
, oprops
)) || risky
)
20060 /* If the starting string has properties,
20061 merge the specified ones onto the existing ones. */
20062 if (! NILP (oprops
) && !risky
)
20066 oprops
= Fcopy_sequence (oprops
);
20068 while (CONSP (tem
))
20070 oprops
= Fplist_put (oprops
, XCAR (tem
),
20071 XCAR (XCDR (tem
)));
20072 tem
= XCDR (XCDR (tem
));
20077 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20078 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20080 /* AELT is what we want. Move it to the front
20081 without consing. */
20083 mode_line_proptrans_alist
20084 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20090 /* If AELT has the wrong props, it is useless.
20091 so get rid of it. */
20093 mode_line_proptrans_alist
20094 = Fdelq (aelt
, mode_line_proptrans_alist
);
20096 elt
= Fcopy_sequence (elt
);
20097 Fset_text_properties (make_number (0), Flength (elt
),
20099 /* Add this item to mode_line_proptrans_alist. */
20100 mode_line_proptrans_alist
20101 = Fcons (Fcons (elt
, props
),
20102 mode_line_proptrans_alist
);
20103 /* Truncate mode_line_proptrans_alist
20104 to at most 50 elements. */
20105 tem
= Fnthcdr (make_number (50),
20106 mode_line_proptrans_alist
);
20108 XSETCDR (tem
, Qnil
);
20117 prec
= precision
- n
;
20118 switch (mode_line_target
)
20120 case MODE_LINE_NOPROP
:
20121 case MODE_LINE_TITLE
:
20122 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20124 case MODE_LINE_STRING
:
20125 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20127 case MODE_LINE_DISPLAY
:
20128 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20129 0, prec
, 0, STRING_MULTIBYTE (elt
));
20136 /* Handle the non-literal case. */
20138 while ((precision
<= 0 || n
< precision
)
20139 && SREF (elt
, offset
) != 0
20140 && (mode_line_target
!= MODE_LINE_DISPLAY
20141 || it
->current_x
< it
->last_visible_x
))
20143 EMACS_INT last_offset
= offset
;
20145 /* Advance to end of string or next format specifier. */
20146 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20149 if (offset
- 1 != last_offset
)
20151 EMACS_INT nchars
, nbytes
;
20153 /* Output to end of string or up to '%'. Field width
20154 is length of string. Don't output more than
20155 PRECISION allows us. */
20158 prec
= c_string_width (SDATA (elt
) + last_offset
,
20159 offset
- last_offset
, precision
- n
,
20162 switch (mode_line_target
)
20164 case MODE_LINE_NOPROP
:
20165 case MODE_LINE_TITLE
:
20166 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20168 case MODE_LINE_STRING
:
20170 EMACS_INT bytepos
= last_offset
;
20171 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20172 EMACS_INT endpos
= (precision
<= 0
20173 ? string_byte_to_char (elt
, offset
)
20174 : charpos
+ nchars
);
20176 n
+= store_mode_line_string (NULL
,
20177 Fsubstring (elt
, make_number (charpos
),
20178 make_number (endpos
)),
20182 case MODE_LINE_DISPLAY
:
20184 EMACS_INT bytepos
= last_offset
;
20185 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20187 if (precision
<= 0)
20188 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20189 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20191 STRING_MULTIBYTE (elt
));
20196 else /* c == '%' */
20198 EMACS_INT percent_position
= offset
;
20200 /* Get the specified minimum width. Zero means
20203 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20204 field
= field
* 10 + c
- '0';
20206 /* Don't pad beyond the total padding allowed. */
20207 if (field_width
- n
> 0 && field
> field_width
- n
)
20208 field
= field_width
- n
;
20210 /* Note that either PRECISION <= 0 or N < PRECISION. */
20211 prec
= precision
- n
;
20214 n
+= display_mode_element (it
, depth
, field
, prec
,
20215 Vglobal_mode_string
, props
,
20220 EMACS_INT bytepos
, charpos
;
20222 Lisp_Object string
;
20224 bytepos
= percent_position
;
20225 charpos
= (STRING_MULTIBYTE (elt
)
20226 ? string_byte_to_char (elt
, bytepos
)
20228 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20229 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20231 switch (mode_line_target
)
20233 case MODE_LINE_NOPROP
:
20234 case MODE_LINE_TITLE
:
20235 n
+= store_mode_line_noprop (spec
, field
, prec
);
20237 case MODE_LINE_STRING
:
20239 Lisp_Object tem
= build_string (spec
);
20240 props
= Ftext_properties_at (make_number (charpos
), elt
);
20241 /* Should only keep face property in props */
20242 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20245 case MODE_LINE_DISPLAY
:
20247 int nglyphs_before
, nwritten
;
20249 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20250 nwritten
= display_string (spec
, string
, elt
,
20255 /* Assign to the glyphs written above the
20256 string where the `%x' came from, position
20260 struct glyph
*glyph
20261 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20265 for (i
= 0; i
< nwritten
; ++i
)
20267 glyph
[i
].object
= elt
;
20268 glyph
[i
].charpos
= charpos
;
20285 /* A symbol: process the value of the symbol recursively
20286 as if it appeared here directly. Avoid error if symbol void.
20287 Special case: if value of symbol is a string, output the string
20290 register Lisp_Object tem
;
20292 /* If the variable is not marked as risky to set
20293 then its contents are risky to use. */
20294 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20297 tem
= Fboundp (elt
);
20300 tem
= Fsymbol_value (elt
);
20301 /* If value is a string, output that string literally:
20302 don't check for % within it. */
20306 if (!EQ (tem
, elt
))
20308 /* Give up right away for nil or t. */
20318 register Lisp_Object car
, tem
;
20320 /* A cons cell: five distinct cases.
20321 If first element is :eval or :propertize, do something special.
20322 If first element is a string or a cons, process all the elements
20323 and effectively concatenate them.
20324 If first element is a negative number, truncate displaying cdr to
20325 at most that many characters. If positive, pad (with spaces)
20326 to at least that many characters.
20327 If first element is a symbol, process the cadr or caddr recursively
20328 according to whether the symbol's value is non-nil or nil. */
20330 if (EQ (car
, QCeval
))
20332 /* An element of the form (:eval FORM) means evaluate FORM
20333 and use the result as mode line elements. */
20338 if (CONSP (XCDR (elt
)))
20341 spec
= safe_eval (XCAR (XCDR (elt
)));
20342 n
+= display_mode_element (it
, depth
, field_width
- n
,
20343 precision
- n
, spec
, props
,
20347 else if (EQ (car
, QCpropertize
))
20349 /* An element of the form (:propertize ELT PROPS...)
20350 means display ELT but applying properties PROPS. */
20355 if (CONSP (XCDR (elt
)))
20356 n
+= display_mode_element (it
, depth
, field_width
- n
,
20357 precision
- n
, XCAR (XCDR (elt
)),
20358 XCDR (XCDR (elt
)), risky
);
20360 else if (SYMBOLP (car
))
20362 tem
= Fboundp (car
);
20366 /* elt is now the cdr, and we know it is a cons cell.
20367 Use its car if CAR has a non-nil value. */
20370 tem
= Fsymbol_value (car
);
20377 /* Symbol's value is nil (or symbol is unbound)
20378 Get the cddr of the original list
20379 and if possible find the caddr and use that. */
20383 else if (!CONSP (elt
))
20388 else if (INTEGERP (car
))
20390 register int lim
= XINT (car
);
20394 /* Negative int means reduce maximum width. */
20395 if (precision
<= 0)
20398 precision
= min (precision
, -lim
);
20402 /* Padding specified. Don't let it be more than
20403 current maximum. */
20405 lim
= min (precision
, lim
);
20407 /* If that's more padding than already wanted, queue it.
20408 But don't reduce padding already specified even if
20409 that is beyond the current truncation point. */
20410 field_width
= max (lim
, field_width
);
20414 else if (STRINGP (car
) || CONSP (car
))
20416 Lisp_Object halftail
= elt
;
20420 && (precision
<= 0 || n
< precision
))
20422 n
+= display_mode_element (it
, depth
,
20423 /* Do padding only after the last
20424 element in the list. */
20425 (! CONSP (XCDR (elt
))
20428 precision
- n
, XCAR (elt
),
20432 if ((len
& 1) == 0)
20433 halftail
= XCDR (halftail
);
20434 /* Check for cycle. */
20435 if (EQ (halftail
, elt
))
20444 elt
= build_string ("*invalid*");
20448 /* Pad to FIELD_WIDTH. */
20449 if (field_width
> 0 && n
< field_width
)
20451 switch (mode_line_target
)
20453 case MODE_LINE_NOPROP
:
20454 case MODE_LINE_TITLE
:
20455 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20457 case MODE_LINE_STRING
:
20458 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20460 case MODE_LINE_DISPLAY
:
20461 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20470 /* Store a mode-line string element in mode_line_string_list.
20472 If STRING is non-null, display that C string. Otherwise, the Lisp
20473 string LISP_STRING is displayed.
20475 FIELD_WIDTH is the minimum number of output glyphs to produce.
20476 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20477 with spaces. FIELD_WIDTH <= 0 means don't pad.
20479 PRECISION is the maximum number of characters to output from
20480 STRING. PRECISION <= 0 means don't truncate the string.
20482 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20483 properties to the string.
20485 PROPS are the properties to add to the string.
20486 The mode_line_string_face face property is always added to the string.
20490 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20491 int field_width
, int precision
, Lisp_Object props
)
20496 if (string
!= NULL
)
20498 len
= strlen (string
);
20499 if (precision
> 0 && len
> precision
)
20501 lisp_string
= make_string (string
, len
);
20503 props
= mode_line_string_face_prop
;
20504 else if (!NILP (mode_line_string_face
))
20506 Lisp_Object face
= Fplist_get (props
, Qface
);
20507 props
= Fcopy_sequence (props
);
20509 face
= mode_line_string_face
;
20511 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20512 props
= Fplist_put (props
, Qface
, face
);
20514 Fadd_text_properties (make_number (0), make_number (len
),
20515 props
, lisp_string
);
20519 len
= XFASTINT (Flength (lisp_string
));
20520 if (precision
> 0 && len
> precision
)
20523 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20526 if (!NILP (mode_line_string_face
))
20530 props
= Ftext_properties_at (make_number (0), lisp_string
);
20531 face
= Fplist_get (props
, Qface
);
20533 face
= mode_line_string_face
;
20535 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20536 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20538 lisp_string
= Fcopy_sequence (lisp_string
);
20541 Fadd_text_properties (make_number (0), make_number (len
),
20542 props
, lisp_string
);
20547 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20551 if (field_width
> len
)
20553 field_width
-= len
;
20554 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20556 Fadd_text_properties (make_number (0), make_number (field_width
),
20557 props
, lisp_string
);
20558 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20566 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20568 doc
: /* Format a string out of a mode line format specification.
20569 First arg FORMAT specifies the mode line format (see `mode-line-format'
20570 for details) to use.
20572 By default, the format is evaluated for the currently selected window.
20574 Optional second arg FACE specifies the face property to put on all
20575 characters for which no face is specified. The value nil means the
20576 default face. The value t means whatever face the window's mode line
20577 currently uses (either `mode-line' or `mode-line-inactive',
20578 depending on whether the window is the selected window or not).
20579 An integer value means the value string has no text
20582 Optional third and fourth args WINDOW and BUFFER specify the window
20583 and buffer to use as the context for the formatting (defaults
20584 are the selected window and the WINDOW's buffer). */)
20585 (Lisp_Object format
, Lisp_Object face
,
20586 Lisp_Object window
, Lisp_Object buffer
)
20591 struct buffer
*old_buffer
= NULL
;
20593 int no_props
= INTEGERP (face
);
20594 int count
= SPECPDL_INDEX ();
20596 int string_start
= 0;
20599 window
= selected_window
;
20600 CHECK_WINDOW (window
);
20601 w
= XWINDOW (window
);
20604 buffer
= w
->buffer
;
20605 CHECK_BUFFER (buffer
);
20607 /* Make formatting the modeline a non-op when noninteractive, otherwise
20608 there will be problems later caused by a partially initialized frame. */
20609 if (NILP (format
) || noninteractive
)
20610 return empty_unibyte_string
;
20615 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20616 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20617 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20618 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20619 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20620 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20621 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20624 if (XBUFFER (buffer
) != current_buffer
)
20625 old_buffer
= current_buffer
;
20627 /* Save things including mode_line_proptrans_alist,
20628 and set that to nil so that we don't alter the outer value. */
20629 record_unwind_protect (unwind_format_mode_line
,
20630 format_mode_line_unwind_data
20631 (old_buffer
, selected_window
, 1));
20632 mode_line_proptrans_alist
= Qnil
;
20634 Fselect_window (window
, Qt
);
20636 set_buffer_internal_1 (XBUFFER (buffer
));
20638 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20642 mode_line_target
= MODE_LINE_NOPROP
;
20643 mode_line_string_face_prop
= Qnil
;
20644 mode_line_string_list
= Qnil
;
20645 string_start
= MODE_LINE_NOPROP_LEN (0);
20649 mode_line_target
= MODE_LINE_STRING
;
20650 mode_line_string_list
= Qnil
;
20651 mode_line_string_face
= face
;
20652 mode_line_string_face_prop
20653 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20656 push_kboard (FRAME_KBOARD (it
.f
));
20657 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20662 len
= MODE_LINE_NOPROP_LEN (string_start
);
20663 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20667 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20668 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20669 empty_unibyte_string
);
20672 unbind_to (count
, Qnil
);
20676 /* Write a null-terminated, right justified decimal representation of
20677 the positive integer D to BUF using a minimal field width WIDTH. */
20680 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20682 register char *p
= buf
;
20690 *p
++ = d
% 10 + '0';
20695 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20706 /* Write a null-terminated, right justified decimal and "human
20707 readable" representation of the nonnegative integer D to BUF using
20708 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20710 static const char power_letter
[] =
20724 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20726 /* We aim to represent the nonnegative integer D as
20727 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20728 EMACS_INT quotient
= d
;
20730 /* -1 means: do not use TENTHS. */
20734 /* Length of QUOTIENT.TENTHS as a string. */
20740 if (1000 <= quotient
)
20742 /* Scale to the appropriate EXPONENT. */
20745 remainder
= quotient
% 1000;
20749 while (1000 <= quotient
);
20751 /* Round to nearest and decide whether to use TENTHS or not. */
20754 tenths
= remainder
/ 100;
20755 if (50 <= remainder
% 100)
20762 if (quotient
== 10)
20770 if (500 <= remainder
)
20772 if (quotient
< 999)
20783 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20784 if (tenths
== -1 && quotient
<= 99)
20791 p
= psuffix
= buf
+ max (width
, length
);
20793 /* Print EXPONENT. */
20794 *psuffix
++ = power_letter
[exponent
];
20797 /* Print TENTHS. */
20800 *--p
= '0' + tenths
;
20804 /* Print QUOTIENT. */
20807 int digit
= quotient
% 10;
20808 *--p
= '0' + digit
;
20810 while ((quotient
/= 10) != 0);
20812 /* Print leading spaces. */
20817 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20818 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20819 type of CODING_SYSTEM. Return updated pointer into BUF. */
20821 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20824 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20827 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20828 const unsigned char *eol_str
;
20830 /* The EOL conversion we are using. */
20831 Lisp_Object eoltype
;
20833 val
= CODING_SYSTEM_SPEC (coding_system
);
20836 if (!VECTORP (val
)) /* Not yet decided. */
20841 eoltype
= eol_mnemonic_undecided
;
20842 /* Don't mention EOL conversion if it isn't decided. */
20847 Lisp_Object eolvalue
;
20849 attrs
= AREF (val
, 0);
20850 eolvalue
= AREF (val
, 2);
20853 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20857 /* The EOL conversion that is normal on this system. */
20859 if (NILP (eolvalue
)) /* Not yet decided. */
20860 eoltype
= eol_mnemonic_undecided
;
20861 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20862 eoltype
= eol_mnemonic_undecided
;
20863 else /* eolvalue is Qunix, Qdos, or Qmac. */
20864 eoltype
= (EQ (eolvalue
, Qunix
)
20865 ? eol_mnemonic_unix
20866 : (EQ (eolvalue
, Qdos
) == 1
20867 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20873 /* Mention the EOL conversion if it is not the usual one. */
20874 if (STRINGP (eoltype
))
20876 eol_str
= SDATA (eoltype
);
20877 eol_str_len
= SBYTES (eoltype
);
20879 else if (CHARACTERP (eoltype
))
20881 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20882 int c
= XFASTINT (eoltype
);
20883 eol_str_len
= CHAR_STRING (c
, tmp
);
20888 eol_str
= invalid_eol_type
;
20889 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20891 memcpy (buf
, eol_str
, eol_str_len
);
20892 buf
+= eol_str_len
;
20898 /* Return a string for the output of a mode line %-spec for window W,
20899 generated by character C. FIELD_WIDTH > 0 means pad the string
20900 returned with spaces to that value. Return a Lisp string in
20901 *STRING if the resulting string is taken from that Lisp string.
20903 Note we operate on the current buffer for most purposes,
20904 the exception being w->base_line_pos. */
20906 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20908 static const char *
20909 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20910 Lisp_Object
*string
)
20913 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20914 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20915 struct buffer
*b
= current_buffer
;
20923 if (!NILP (BVAR (b
, read_only
)))
20925 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20930 /* This differs from %* only for a modified read-only buffer. */
20931 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20933 if (!NILP (BVAR (b
, read_only
)))
20938 /* This differs from %* in ignoring read-only-ness. */
20939 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20951 if (command_loop_level
> 5)
20953 p
= decode_mode_spec_buf
;
20954 for (i
= 0; i
< command_loop_level
; i
++)
20957 return decode_mode_spec_buf
;
20965 if (command_loop_level
> 5)
20967 p
= decode_mode_spec_buf
;
20968 for (i
= 0; i
< command_loop_level
; i
++)
20971 return decode_mode_spec_buf
;
20978 /* Let lots_of_dashes be a string of infinite length. */
20979 if (mode_line_target
== MODE_LINE_NOPROP
||
20980 mode_line_target
== MODE_LINE_STRING
)
20982 if (field_width
<= 0
20983 || field_width
> sizeof (lots_of_dashes
))
20985 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20986 decode_mode_spec_buf
[i
] = '-';
20987 decode_mode_spec_buf
[i
] = '\0';
20988 return decode_mode_spec_buf
;
20991 return lots_of_dashes
;
20995 obj
= BVAR (b
, name
);
20999 /* %c and %l are ignored in `frame-title-format'.
21000 (In redisplay_internal, the frame title is drawn _before_ the
21001 windows are updated, so the stuff which depends on actual
21002 window contents (such as %l) may fail to render properly, or
21003 even crash emacs.) */
21004 if (mode_line_target
== MODE_LINE_TITLE
)
21008 EMACS_INT col
= current_column ();
21009 w
->column_number_displayed
= make_number (col
);
21010 pint2str (decode_mode_spec_buf
, field_width
, col
);
21011 return decode_mode_spec_buf
;
21015 #ifndef SYSTEM_MALLOC
21017 if (NILP (Vmemory_full
))
21020 return "!MEM FULL! ";
21027 /* %F displays the frame name. */
21028 if (!NILP (f
->title
))
21029 return SSDATA (f
->title
);
21030 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21031 return SSDATA (f
->name
);
21035 obj
= BVAR (b
, filename
);
21040 EMACS_INT size
= ZV
- BEGV
;
21041 pint2str (decode_mode_spec_buf
, field_width
, size
);
21042 return decode_mode_spec_buf
;
21047 EMACS_INT size
= ZV
- BEGV
;
21048 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21049 return decode_mode_spec_buf
;
21054 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21055 EMACS_INT topline
, nlines
, height
;
21058 /* %c and %l are ignored in `frame-title-format'. */
21059 if (mode_line_target
== MODE_LINE_TITLE
)
21062 startpos
= XMARKER (w
->start
)->charpos
;
21063 startpos_byte
= marker_byte_position (w
->start
);
21064 height
= WINDOW_TOTAL_LINES (w
);
21066 /* If we decided that this buffer isn't suitable for line numbers,
21067 don't forget that too fast. */
21068 if (EQ (w
->base_line_pos
, w
->buffer
))
21070 /* But do forget it, if the window shows a different buffer now. */
21071 else if (BUFFERP (w
->base_line_pos
))
21072 w
->base_line_pos
= Qnil
;
21074 /* If the buffer is very big, don't waste time. */
21075 if (INTEGERP (Vline_number_display_limit
)
21076 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21078 w
->base_line_pos
= Qnil
;
21079 w
->base_line_number
= Qnil
;
21083 if (INTEGERP (w
->base_line_number
)
21084 && INTEGERP (w
->base_line_pos
)
21085 && XFASTINT (w
->base_line_pos
) <= startpos
)
21087 line
= XFASTINT (w
->base_line_number
);
21088 linepos
= XFASTINT (w
->base_line_pos
);
21089 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21094 linepos
= BUF_BEGV (b
);
21095 linepos_byte
= BUF_BEGV_BYTE (b
);
21098 /* Count lines from base line to window start position. */
21099 nlines
= display_count_lines (linepos_byte
,
21103 topline
= nlines
+ line
;
21105 /* Determine a new base line, if the old one is too close
21106 or too far away, or if we did not have one.
21107 "Too close" means it's plausible a scroll-down would
21108 go back past it. */
21109 if (startpos
== BUF_BEGV (b
))
21111 w
->base_line_number
= make_number (topline
);
21112 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21114 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21115 || linepos
== BUF_BEGV (b
))
21117 EMACS_INT limit
= BUF_BEGV (b
);
21118 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
21119 EMACS_INT position
;
21120 EMACS_INT distance
=
21121 (height
* 2 + 30) * line_number_display_limit_width
;
21123 if (startpos
- distance
> limit
)
21125 limit
= startpos
- distance
;
21126 limit_byte
= CHAR_TO_BYTE (limit
);
21129 nlines
= display_count_lines (startpos_byte
,
21131 - (height
* 2 + 30),
21133 /* If we couldn't find the lines we wanted within
21134 line_number_display_limit_width chars per line,
21135 give up on line numbers for this window. */
21136 if (position
== limit_byte
&& limit
== startpos
- distance
)
21138 w
->base_line_pos
= w
->buffer
;
21139 w
->base_line_number
= Qnil
;
21143 w
->base_line_number
= make_number (topline
- nlines
);
21144 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21147 /* Now count lines from the start pos to point. */
21148 nlines
= display_count_lines (startpos_byte
,
21149 PT_BYTE
, PT
, &junk
);
21151 /* Record that we did display the line number. */
21152 line_number_displayed
= 1;
21154 /* Make the string to show. */
21155 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21156 return decode_mode_spec_buf
;
21159 char* p
= decode_mode_spec_buf
;
21160 int pad
= field_width
- 2;
21166 return decode_mode_spec_buf
;
21172 obj
= BVAR (b
, mode_name
);
21176 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21182 EMACS_INT pos
= marker_position (w
->start
);
21183 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21185 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21187 if (pos
<= BUF_BEGV (b
))
21192 else if (pos
<= BUF_BEGV (b
))
21196 if (total
> 1000000)
21197 /* Do it differently for a large value, to avoid overflow. */
21198 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21200 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21201 /* We can't normally display a 3-digit number,
21202 so get us a 2-digit number that is close. */
21205 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21206 return decode_mode_spec_buf
;
21210 /* Display percentage of size above the bottom of the screen. */
21213 EMACS_INT toppos
= marker_position (w
->start
);
21214 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21215 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21217 if (botpos
>= BUF_ZV (b
))
21219 if (toppos
<= BUF_BEGV (b
))
21226 if (total
> 1000000)
21227 /* Do it differently for a large value, to avoid overflow. */
21228 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21230 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21231 /* We can't normally display a 3-digit number,
21232 so get us a 2-digit number that is close. */
21235 if (toppos
<= BUF_BEGV (b
))
21236 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21238 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21239 return decode_mode_spec_buf
;
21244 /* status of process */
21245 obj
= Fget_buffer_process (Fcurrent_buffer ());
21247 return "no process";
21249 obj
= Fsymbol_name (Fprocess_status (obj
));
21255 int count
= inhibit_garbage_collection ();
21256 Lisp_Object val
= call1 (intern ("file-remote-p"),
21257 BVAR (current_buffer
, directory
));
21258 unbind_to (count
, Qnil
);
21266 case 't': /* indicate TEXT or BINARY */
21270 /* coding-system (not including end-of-line format) */
21272 /* coding-system (including end-of-line type) */
21274 int eol_flag
= (c
== 'Z');
21275 char *p
= decode_mode_spec_buf
;
21277 if (! FRAME_WINDOW_P (f
))
21279 /* No need to mention EOL here--the terminal never needs
21280 to do EOL conversion. */
21281 p
= decode_mode_spec_coding (CODING_ID_NAME
21282 (FRAME_KEYBOARD_CODING (f
)->id
),
21284 p
= decode_mode_spec_coding (CODING_ID_NAME
21285 (FRAME_TERMINAL_CODING (f
)->id
),
21288 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21291 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21292 #ifdef subprocesses
21293 obj
= Fget_buffer_process (Fcurrent_buffer ());
21294 if (PROCESSP (obj
))
21296 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21298 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21301 #endif /* subprocesses */
21304 return decode_mode_spec_buf
;
21311 return SSDATA (obj
);
21318 /* Count up to COUNT lines starting from START_BYTE.
21319 But don't go beyond LIMIT_BYTE.
21320 Return the number of lines thus found (always nonnegative).
21322 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21325 display_count_lines (EMACS_INT start_byte
,
21326 EMACS_INT limit_byte
, EMACS_INT count
,
21327 EMACS_INT
*byte_pos_ptr
)
21329 register unsigned char *cursor
;
21330 unsigned char *base
;
21332 register EMACS_INT ceiling
;
21333 register unsigned char *ceiling_addr
;
21334 EMACS_INT orig_count
= count
;
21336 /* If we are not in selective display mode,
21337 check only for newlines. */
21338 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21339 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21343 while (start_byte
< limit_byte
)
21345 ceiling
= BUFFER_CEILING_OF (start_byte
);
21346 ceiling
= min (limit_byte
- 1, ceiling
);
21347 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21348 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21351 if (selective_display
)
21352 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21355 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21358 if (cursor
!= ceiling_addr
)
21362 start_byte
+= cursor
- base
+ 1;
21363 *byte_pos_ptr
= start_byte
;
21367 if (++cursor
== ceiling_addr
)
21373 start_byte
+= cursor
- base
;
21378 while (start_byte
> limit_byte
)
21380 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21381 ceiling
= max (limit_byte
, ceiling
);
21382 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21383 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21386 if (selective_display
)
21387 while (--cursor
!= ceiling_addr
21388 && *cursor
!= '\n' && *cursor
!= 015)
21391 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21394 if (cursor
!= ceiling_addr
)
21398 start_byte
+= cursor
- base
+ 1;
21399 *byte_pos_ptr
= start_byte
;
21400 /* When scanning backwards, we should
21401 not count the newline posterior to which we stop. */
21402 return - orig_count
- 1;
21408 /* Here we add 1 to compensate for the last decrement
21409 of CURSOR, which took it past the valid range. */
21410 start_byte
+= cursor
- base
+ 1;
21414 *byte_pos_ptr
= limit_byte
;
21417 return - orig_count
+ count
;
21418 return orig_count
- count
;
21424 /***********************************************************************
21426 ***********************************************************************/
21428 /* Display a NUL-terminated string, starting with index START.
21430 If STRING is non-null, display that C string. Otherwise, the Lisp
21431 string LISP_STRING is displayed. There's a case that STRING is
21432 non-null and LISP_STRING is not nil. It means STRING is a string
21433 data of LISP_STRING. In that case, we display LISP_STRING while
21434 ignoring its text properties.
21436 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21437 FACE_STRING. Display STRING or LISP_STRING with the face at
21438 FACE_STRING_POS in FACE_STRING:
21440 Display the string in the environment given by IT, but use the
21441 standard display table, temporarily.
21443 FIELD_WIDTH is the minimum number of output glyphs to produce.
21444 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21445 with spaces. If STRING has more characters, more than FIELD_WIDTH
21446 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21448 PRECISION is the maximum number of characters to output from
21449 STRING. PRECISION < 0 means don't truncate the string.
21451 This is roughly equivalent to printf format specifiers:
21453 FIELD_WIDTH PRECISION PRINTF
21454 ----------------------------------------
21460 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21461 display them, and < 0 means obey the current buffer's value of
21462 enable_multibyte_characters.
21464 Value is the number of columns displayed. */
21467 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21468 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21469 int field_width
, int precision
, int max_x
, int multibyte
)
21471 int hpos_at_start
= it
->hpos
;
21472 int saved_face_id
= it
->face_id
;
21473 struct glyph_row
*row
= it
->glyph_row
;
21474 EMACS_INT it_charpos
;
21476 /* Initialize the iterator IT for iteration over STRING beginning
21477 with index START. */
21478 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21479 precision
, field_width
, multibyte
);
21480 if (string
&& STRINGP (lisp_string
))
21481 /* LISP_STRING is the one returned by decode_mode_spec. We should
21482 ignore its text properties. */
21483 it
->stop_charpos
= it
->end_charpos
;
21485 /* If displaying STRING, set up the face of the iterator from
21486 FACE_STRING, if that's given. */
21487 if (STRINGP (face_string
))
21493 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21494 0, it
->region_beg_charpos
,
21495 it
->region_end_charpos
,
21496 &endptr
, it
->base_face_id
, 0);
21497 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21498 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21501 /* Set max_x to the maximum allowed X position. Don't let it go
21502 beyond the right edge of the window. */
21504 max_x
= it
->last_visible_x
;
21506 max_x
= min (max_x
, it
->last_visible_x
);
21508 /* Skip over display elements that are not visible. because IT->w is
21510 if (it
->current_x
< it
->first_visible_x
)
21511 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21512 MOVE_TO_POS
| MOVE_TO_X
);
21514 row
->ascent
= it
->max_ascent
;
21515 row
->height
= it
->max_ascent
+ it
->max_descent
;
21516 row
->phys_ascent
= it
->max_phys_ascent
;
21517 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21518 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21520 if (STRINGP (it
->string
))
21521 it_charpos
= IT_STRING_CHARPOS (*it
);
21523 it_charpos
= IT_CHARPOS (*it
);
21525 /* This condition is for the case that we are called with current_x
21526 past last_visible_x. */
21527 while (it
->current_x
< max_x
)
21529 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21531 /* Get the next display element. */
21532 if (!get_next_display_element (it
))
21535 /* Produce glyphs. */
21536 x_before
= it
->current_x
;
21537 n_glyphs_before
= row
->used
[TEXT_AREA
];
21538 PRODUCE_GLYPHS (it
);
21540 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21543 while (i
< nglyphs
)
21545 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21547 if (it
->line_wrap
!= TRUNCATE
21548 && x
+ glyph
->pixel_width
> max_x
)
21550 /* End of continued line or max_x reached. */
21551 if (CHAR_GLYPH_PADDING_P (*glyph
))
21553 /* A wide character is unbreakable. */
21554 if (row
->reversed_p
)
21555 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21556 - n_glyphs_before
);
21557 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21558 it
->current_x
= x_before
;
21562 if (row
->reversed_p
)
21563 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21564 - (n_glyphs_before
+ i
));
21565 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21570 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21572 /* Glyph is at least partially visible. */
21574 if (x
< it
->first_visible_x
)
21575 row
->x
= x
- it
->first_visible_x
;
21579 /* Glyph is off the left margin of the display area.
21580 Should not happen. */
21584 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21585 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21586 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21587 row
->phys_height
= max (row
->phys_height
,
21588 it
->max_phys_ascent
+ it
->max_phys_descent
);
21589 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21590 it
->max_extra_line_spacing
);
21591 x
+= glyph
->pixel_width
;
21595 /* Stop if max_x reached. */
21599 /* Stop at line ends. */
21600 if (ITERATOR_AT_END_OF_LINE_P (it
))
21602 it
->continuation_lines_width
= 0;
21606 set_iterator_to_next (it
, 1);
21607 if (STRINGP (it
->string
))
21608 it_charpos
= IT_STRING_CHARPOS (*it
);
21610 it_charpos
= IT_CHARPOS (*it
);
21612 /* Stop if truncating at the right edge. */
21613 if (it
->line_wrap
== TRUNCATE
21614 && it
->current_x
>= it
->last_visible_x
)
21616 /* Add truncation mark, but don't do it if the line is
21617 truncated at a padding space. */
21618 if (it_charpos
< it
->string_nchars
)
21620 if (!FRAME_WINDOW_P (it
->f
))
21624 if (it
->current_x
> it
->last_visible_x
)
21626 if (!row
->reversed_p
)
21628 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21629 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21634 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21635 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21637 unproduce_glyphs (it
, ii
+ 1);
21638 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21640 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21642 row
->used
[TEXT_AREA
] = ii
;
21643 produce_special_glyphs (it
, IT_TRUNCATION
);
21646 produce_special_glyphs (it
, IT_TRUNCATION
);
21648 row
->truncated_on_right_p
= 1;
21654 /* Maybe insert a truncation at the left. */
21655 if (it
->first_visible_x
21658 if (!FRAME_WINDOW_P (it
->f
))
21659 insert_left_trunc_glyphs (it
);
21660 row
->truncated_on_left_p
= 1;
21663 it
->face_id
= saved_face_id
;
21665 /* Value is number of columns displayed. */
21666 return it
->hpos
- hpos_at_start
;
21671 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21672 appears as an element of LIST or as the car of an element of LIST.
21673 If PROPVAL is a list, compare each element against LIST in that
21674 way, and return 1/2 if any element of PROPVAL is found in LIST.
21675 Otherwise return 0. This function cannot quit.
21676 The return value is 2 if the text is invisible but with an ellipsis
21677 and 1 if it's invisible and without an ellipsis. */
21680 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21682 register Lisp_Object tail
, proptail
;
21684 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21686 register Lisp_Object tem
;
21688 if (EQ (propval
, tem
))
21690 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21691 return NILP (XCDR (tem
)) ? 1 : 2;
21694 if (CONSP (propval
))
21696 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21698 Lisp_Object propelt
;
21699 propelt
= XCAR (proptail
);
21700 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21702 register Lisp_Object tem
;
21704 if (EQ (propelt
, tem
))
21706 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21707 return NILP (XCDR (tem
)) ? 1 : 2;
21715 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21716 doc
: /* Non-nil if the property makes the text invisible.
21717 POS-OR-PROP can be a marker or number, in which case it is taken to be
21718 a position in the current buffer and the value of the `invisible' property
21719 is checked; or it can be some other value, which is then presumed to be the
21720 value of the `invisible' property of the text of interest.
21721 The non-nil value returned can be t for truly invisible text or something
21722 else if the text is replaced by an ellipsis. */)
21723 (Lisp_Object pos_or_prop
)
21726 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21727 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21729 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21730 return (invis
== 0 ? Qnil
21732 : make_number (invis
));
21735 /* Calculate a width or height in pixels from a specification using
21736 the following elements:
21739 NUM - a (fractional) multiple of the default font width/height
21740 (NUM) - specifies exactly NUM pixels
21741 UNIT - a fixed number of pixels, see below.
21742 ELEMENT - size of a display element in pixels, see below.
21743 (NUM . SPEC) - equals NUM * SPEC
21744 (+ SPEC SPEC ...) - add pixel values
21745 (- SPEC SPEC ...) - subtract pixel values
21746 (- SPEC) - negate pixel value
21749 INT or FLOAT - a number constant
21750 SYMBOL - use symbol's (buffer local) variable binding.
21753 in - pixels per inch *)
21754 mm - pixels per 1/1000 meter *)
21755 cm - pixels per 1/100 meter *)
21756 width - width of current font in pixels.
21757 height - height of current font in pixels.
21759 *) using the ratio(s) defined in display-pixels-per-inch.
21763 left-fringe - left fringe width in pixels
21764 right-fringe - right fringe width in pixels
21766 left-margin - left margin width in pixels
21767 right-margin - right margin width in pixels
21769 scroll-bar - scroll-bar area width in pixels
21773 Pixels corresponding to 5 inches:
21776 Total width of non-text areas on left side of window (if scroll-bar is on left):
21777 '(space :width (+ left-fringe left-margin scroll-bar))
21779 Align to first text column (in header line):
21780 '(space :align-to 0)
21782 Align to middle of text area minus half the width of variable `my-image'
21783 containing a loaded image:
21784 '(space :align-to (0.5 . (- text my-image)))
21786 Width of left margin minus width of 1 character in the default font:
21787 '(space :width (- left-margin 1))
21789 Width of left margin minus width of 2 characters in the current font:
21790 '(space :width (- left-margin (2 . width)))
21792 Center 1 character over left-margin (in header line):
21793 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21795 Different ways to express width of left fringe plus left margin minus one pixel:
21796 '(space :width (- (+ left-fringe left-margin) (1)))
21797 '(space :width (+ left-fringe left-margin (- (1))))
21798 '(space :width (+ left-fringe left-margin (-1)))
21802 #define NUMVAL(X) \
21803 ((INTEGERP (X) || FLOATP (X)) \
21808 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21809 struct font
*font
, int width_p
, int *align_to
)
21813 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21814 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21817 return OK_PIXELS (0);
21819 xassert (FRAME_LIVE_P (it
->f
));
21821 if (SYMBOLP (prop
))
21823 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21825 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21827 if (unit
[0] == 'i' && unit
[1] == 'n')
21829 else if (unit
[0] == 'm' && unit
[1] == 'm')
21831 else if (unit
[0] == 'c' && unit
[1] == 'm')
21838 #ifdef HAVE_WINDOW_SYSTEM
21839 if (FRAME_WINDOW_P (it
->f
)
21841 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21842 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21844 return OK_PIXELS (ppi
/ pixels
);
21847 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21848 || (CONSP (Vdisplay_pixels_per_inch
)
21850 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21851 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21853 return OK_PIXELS (ppi
/ pixels
);
21859 #ifdef HAVE_WINDOW_SYSTEM
21860 if (EQ (prop
, Qheight
))
21861 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21862 if (EQ (prop
, Qwidth
))
21863 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21865 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21866 return OK_PIXELS (1);
21869 if (EQ (prop
, Qtext
))
21870 return OK_PIXELS (width_p
21871 ? window_box_width (it
->w
, TEXT_AREA
)
21872 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21874 if (align_to
&& *align_to
< 0)
21877 if (EQ (prop
, Qleft
))
21878 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21879 if (EQ (prop
, Qright
))
21880 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21881 if (EQ (prop
, Qcenter
))
21882 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21883 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21884 if (EQ (prop
, Qleft_fringe
))
21885 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21886 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21887 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21888 if (EQ (prop
, Qright_fringe
))
21889 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21890 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21891 : window_box_right_offset (it
->w
, TEXT_AREA
));
21892 if (EQ (prop
, Qleft_margin
))
21893 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21894 if (EQ (prop
, Qright_margin
))
21895 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21896 if (EQ (prop
, Qscroll_bar
))
21897 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21899 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21900 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21901 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21906 if (EQ (prop
, Qleft_fringe
))
21907 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21908 if (EQ (prop
, Qright_fringe
))
21909 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21910 if (EQ (prop
, Qleft_margin
))
21911 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21912 if (EQ (prop
, Qright_margin
))
21913 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21914 if (EQ (prop
, Qscroll_bar
))
21915 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21918 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21921 if (INTEGERP (prop
) || FLOATP (prop
))
21923 int base_unit
= (width_p
21924 ? FRAME_COLUMN_WIDTH (it
->f
)
21925 : FRAME_LINE_HEIGHT (it
->f
));
21926 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21931 Lisp_Object car
= XCAR (prop
);
21932 Lisp_Object cdr
= XCDR (prop
);
21936 #ifdef HAVE_WINDOW_SYSTEM
21937 if (FRAME_WINDOW_P (it
->f
)
21938 && valid_image_p (prop
))
21940 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21941 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21943 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21946 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21952 while (CONSP (cdr
))
21954 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21955 font
, width_p
, align_to
))
21958 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21963 if (EQ (car
, Qminus
))
21965 return OK_PIXELS (pixels
);
21968 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21971 if (INTEGERP (car
) || FLOATP (car
))
21974 pixels
= XFLOATINT (car
);
21976 return OK_PIXELS (pixels
);
21977 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21978 font
, width_p
, align_to
))
21979 return OK_PIXELS (pixels
* fact
);
21990 /***********************************************************************
21992 ***********************************************************************/
21994 #ifdef HAVE_WINDOW_SYSTEM
21999 dump_glyph_string (struct glyph_string
*s
)
22001 fprintf (stderr
, "glyph string\n");
22002 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22003 s
->x
, s
->y
, s
->width
, s
->height
);
22004 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22005 fprintf (stderr
, " hl = %d\n", s
->hl
);
22006 fprintf (stderr
, " left overhang = %d, right = %d\n",
22007 s
->left_overhang
, s
->right_overhang
);
22008 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22009 fprintf (stderr
, " extends to end of line = %d\n",
22010 s
->extends_to_end_of_line_p
);
22011 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22012 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22015 #endif /* GLYPH_DEBUG */
22017 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22018 of XChar2b structures for S; it can't be allocated in
22019 init_glyph_string because it must be allocated via `alloca'. W
22020 is the window on which S is drawn. ROW and AREA are the glyph row
22021 and area within the row from which S is constructed. START is the
22022 index of the first glyph structure covered by S. HL is a
22023 face-override for drawing S. */
22026 #define OPTIONAL_HDC(hdc) HDC hdc,
22027 #define DECLARE_HDC(hdc) HDC hdc;
22028 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22029 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22032 #ifndef OPTIONAL_HDC
22033 #define OPTIONAL_HDC(hdc)
22034 #define DECLARE_HDC(hdc)
22035 #define ALLOCATE_HDC(hdc, f)
22036 #define RELEASE_HDC(hdc, f)
22040 init_glyph_string (struct glyph_string
*s
,
22042 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22043 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22045 memset (s
, 0, sizeof *s
);
22047 s
->f
= XFRAME (w
->frame
);
22051 s
->display
= FRAME_X_DISPLAY (s
->f
);
22052 s
->window
= FRAME_X_WINDOW (s
->f
);
22053 s
->char2b
= char2b
;
22057 s
->first_glyph
= row
->glyphs
[area
] + start
;
22058 s
->height
= row
->height
;
22059 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22060 s
->ybase
= s
->y
+ row
->ascent
;
22064 /* Append the list of glyph strings with head H and tail T to the list
22065 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22068 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22069 struct glyph_string
*h
, struct glyph_string
*t
)
22083 /* Prepend the list of glyph strings with head H and tail T to the
22084 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22088 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22089 struct glyph_string
*h
, struct glyph_string
*t
)
22103 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22104 Set *HEAD and *TAIL to the resulting list. */
22107 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22108 struct glyph_string
*s
)
22110 s
->next
= s
->prev
= NULL
;
22111 append_glyph_string_lists (head
, tail
, s
, s
);
22115 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22116 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22117 make sure that X resources for the face returned are allocated.
22118 Value is a pointer to a realized face that is ready for display if
22119 DISPLAY_P is non-zero. */
22121 static inline struct face
*
22122 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22123 XChar2b
*char2b
, int display_p
)
22125 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22129 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22131 if (code
!= FONT_INVALID_CODE
)
22132 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22134 STORE_XCHAR2B (char2b
, 0, 0);
22137 /* Make sure X resources of the face are allocated. */
22138 #ifdef HAVE_X_WINDOWS
22142 xassert (face
!= NULL
);
22143 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22150 /* Get face and two-byte form of character glyph GLYPH on frame F.
22151 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22152 a pointer to a realized face that is ready for display. */
22154 static inline struct face
*
22155 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22156 XChar2b
*char2b
, int *two_byte_p
)
22160 xassert (glyph
->type
== CHAR_GLYPH
);
22161 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22170 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22171 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22173 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22175 if (code
!= FONT_INVALID_CODE
)
22176 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22178 STORE_XCHAR2B (char2b
, 0, 0);
22181 /* Make sure X resources of the face are allocated. */
22182 xassert (face
!= NULL
);
22183 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22188 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22189 Return 1 if FONT has a glyph for C, otherwise return 0. */
22192 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22196 if (CHAR_BYTE8_P (c
))
22197 code
= CHAR_TO_BYTE8 (c
);
22199 code
= font
->driver
->encode_char (font
, c
);
22201 if (code
== FONT_INVALID_CODE
)
22203 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22208 /* Fill glyph string S with composition components specified by S->cmp.
22210 BASE_FACE is the base face of the composition.
22211 S->cmp_from is the index of the first component for S.
22213 OVERLAPS non-zero means S should draw the foreground only, and use
22214 its physical height for clipping. See also draw_glyphs.
22216 Value is the index of a component not in S. */
22219 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22223 /* For all glyphs of this composition, starting at the offset
22224 S->cmp_from, until we reach the end of the definition or encounter a
22225 glyph that requires the different face, add it to S. */
22230 s
->for_overlaps
= overlaps
;
22233 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22235 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22237 /* TAB in a composition means display glyphs with padding space
22238 on the left or right. */
22241 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22244 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22251 s
->font
= s
->face
->font
;
22253 else if (s
->face
!= face
)
22261 if (s
->face
== NULL
)
22263 s
->face
= base_face
->ascii_face
;
22264 s
->font
= s
->face
->font
;
22267 /* All glyph strings for the same composition has the same width,
22268 i.e. the width set for the first component of the composition. */
22269 s
->width
= s
->first_glyph
->pixel_width
;
22271 /* If the specified font could not be loaded, use the frame's
22272 default font, but record the fact that we couldn't load it in
22273 the glyph string so that we can draw rectangles for the
22274 characters of the glyph string. */
22275 if (s
->font
== NULL
)
22277 s
->font_not_found_p
= 1;
22278 s
->font
= FRAME_FONT (s
->f
);
22281 /* Adjust base line for subscript/superscript text. */
22282 s
->ybase
+= s
->first_glyph
->voffset
;
22284 /* This glyph string must always be drawn with 16-bit functions. */
22291 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22292 int start
, int end
, int overlaps
)
22294 struct glyph
*glyph
, *last
;
22295 Lisp_Object lgstring
;
22298 s
->for_overlaps
= overlaps
;
22299 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22300 last
= s
->row
->glyphs
[s
->area
] + end
;
22301 s
->cmp_id
= glyph
->u
.cmp
.id
;
22302 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22303 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22304 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22305 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22306 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22308 while (glyph
< last
22309 && glyph
->u
.cmp
.automatic
22310 && glyph
->u
.cmp
.id
== s
->cmp_id
22311 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22312 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22314 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22316 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22317 unsigned code
= LGLYPH_CODE (lglyph
);
22319 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22321 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22322 return glyph
- s
->row
->glyphs
[s
->area
];
22326 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22327 See the comment of fill_glyph_string for arguments.
22328 Value is the index of the first glyph not in S. */
22332 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22333 int start
, int end
, int overlaps
)
22335 struct glyph
*glyph
, *last
;
22338 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22339 s
->for_overlaps
= overlaps
;
22340 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22341 last
= s
->row
->glyphs
[s
->area
] + end
;
22342 voffset
= glyph
->voffset
;
22343 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22344 s
->font
= s
->face
->font
;
22346 s
->width
= glyph
->pixel_width
;
22348 while (glyph
< last
22349 && glyph
->type
== GLYPHLESS_GLYPH
22350 && glyph
->voffset
== voffset
22351 && glyph
->face_id
== face_id
)
22354 s
->width
+= glyph
->pixel_width
;
22357 s
->ybase
+= voffset
;
22358 return glyph
- s
->row
->glyphs
[s
->area
];
22362 /* Fill glyph string S from a sequence of character glyphs.
22364 FACE_ID is the face id of the string. START is the index of the
22365 first glyph to consider, END is the index of the last + 1.
22366 OVERLAPS non-zero means S should draw the foreground only, and use
22367 its physical height for clipping. See also draw_glyphs.
22369 Value is the index of the first glyph not in S. */
22372 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22373 int start
, int end
, int overlaps
)
22375 struct glyph
*glyph
, *last
;
22377 int glyph_not_available_p
;
22379 xassert (s
->f
== XFRAME (s
->w
->frame
));
22380 xassert (s
->nchars
== 0);
22381 xassert (start
>= 0 && end
> start
);
22383 s
->for_overlaps
= overlaps
;
22384 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22385 last
= s
->row
->glyphs
[s
->area
] + end
;
22386 voffset
= glyph
->voffset
;
22387 s
->padding_p
= glyph
->padding_p
;
22388 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22390 while (glyph
< last
22391 && glyph
->type
== CHAR_GLYPH
22392 && glyph
->voffset
== voffset
22393 /* Same face id implies same font, nowadays. */
22394 && glyph
->face_id
== face_id
22395 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22399 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22400 s
->char2b
+ s
->nchars
,
22402 s
->two_byte_p
= two_byte_p
;
22404 xassert (s
->nchars
<= end
- start
);
22405 s
->width
+= glyph
->pixel_width
;
22406 if (glyph
++->padding_p
!= s
->padding_p
)
22410 s
->font
= s
->face
->font
;
22412 /* If the specified font could not be loaded, use the frame's font,
22413 but record the fact that we couldn't load it in
22414 S->font_not_found_p so that we can draw rectangles for the
22415 characters of the glyph string. */
22416 if (s
->font
== NULL
|| glyph_not_available_p
)
22418 s
->font_not_found_p
= 1;
22419 s
->font
= FRAME_FONT (s
->f
);
22422 /* Adjust base line for subscript/superscript text. */
22423 s
->ybase
+= voffset
;
22425 xassert (s
->face
&& s
->face
->gc
);
22426 return glyph
- s
->row
->glyphs
[s
->area
];
22430 /* Fill glyph string S from image glyph S->first_glyph. */
22433 fill_image_glyph_string (struct glyph_string
*s
)
22435 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22436 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22438 s
->slice
= s
->first_glyph
->slice
.img
;
22439 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22440 s
->font
= s
->face
->font
;
22441 s
->width
= s
->first_glyph
->pixel_width
;
22443 /* Adjust base line for subscript/superscript text. */
22444 s
->ybase
+= s
->first_glyph
->voffset
;
22448 /* Fill glyph string S from a sequence of stretch glyphs.
22450 START is the index of the first glyph to consider,
22451 END is the index of the last + 1.
22453 Value is the index of the first glyph not in S. */
22456 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22458 struct glyph
*glyph
, *last
;
22459 int voffset
, face_id
;
22461 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22463 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22464 last
= s
->row
->glyphs
[s
->area
] + end
;
22465 face_id
= glyph
->face_id
;
22466 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22467 s
->font
= s
->face
->font
;
22468 s
->width
= glyph
->pixel_width
;
22470 voffset
= glyph
->voffset
;
22474 && glyph
->type
== STRETCH_GLYPH
22475 && glyph
->voffset
== voffset
22476 && glyph
->face_id
== face_id
);
22478 s
->width
+= glyph
->pixel_width
;
22480 /* Adjust base line for subscript/superscript text. */
22481 s
->ybase
+= voffset
;
22483 /* The case that face->gc == 0 is handled when drawing the glyph
22484 string by calling PREPARE_FACE_FOR_DISPLAY. */
22486 return glyph
- s
->row
->glyphs
[s
->area
];
22489 static struct font_metrics
*
22490 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22492 static struct font_metrics metrics
;
22493 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22495 if (! font
|| code
== FONT_INVALID_CODE
)
22497 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22502 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22503 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22504 assumed to be zero. */
22507 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22509 *left
= *right
= 0;
22511 if (glyph
->type
== CHAR_GLYPH
)
22515 struct font_metrics
*pcm
;
22517 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22518 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22520 if (pcm
->rbearing
> pcm
->width
)
22521 *right
= pcm
->rbearing
- pcm
->width
;
22522 if (pcm
->lbearing
< 0)
22523 *left
= -pcm
->lbearing
;
22526 else if (glyph
->type
== COMPOSITE_GLYPH
)
22528 if (! glyph
->u
.cmp
.automatic
)
22530 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22532 if (cmp
->rbearing
> cmp
->pixel_width
)
22533 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22534 if (cmp
->lbearing
< 0)
22535 *left
= - cmp
->lbearing
;
22539 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22540 struct font_metrics metrics
;
22542 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22543 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22544 if (metrics
.rbearing
> metrics
.width
)
22545 *right
= metrics
.rbearing
- metrics
.width
;
22546 if (metrics
.lbearing
< 0)
22547 *left
= - metrics
.lbearing
;
22553 /* Return the index of the first glyph preceding glyph string S that
22554 is overwritten by S because of S's left overhang. Value is -1
22555 if no glyphs are overwritten. */
22558 left_overwritten (struct glyph_string
*s
)
22562 if (s
->left_overhang
)
22565 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22566 int first
= s
->first_glyph
- glyphs
;
22568 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22569 x
-= glyphs
[i
].pixel_width
;
22580 /* Return the index of the first glyph preceding glyph string S that
22581 is overwriting S because of its right overhang. Value is -1 if no
22582 glyph in front of S overwrites S. */
22585 left_overwriting (struct glyph_string
*s
)
22588 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22589 int first
= s
->first_glyph
- glyphs
;
22593 for (i
= first
- 1; i
>= 0; --i
)
22596 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22599 x
-= glyphs
[i
].pixel_width
;
22606 /* Return the index of the last glyph following glyph string S that is
22607 overwritten by S because of S's right overhang. Value is -1 if
22608 no such glyph is found. */
22611 right_overwritten (struct glyph_string
*s
)
22615 if (s
->right_overhang
)
22618 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22619 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22620 int end
= s
->row
->used
[s
->area
];
22622 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22623 x
+= glyphs
[i
].pixel_width
;
22632 /* Return the index of the last glyph following glyph string S that
22633 overwrites S because of its left overhang. Value is negative
22634 if no such glyph is found. */
22637 right_overwriting (struct glyph_string
*s
)
22640 int end
= s
->row
->used
[s
->area
];
22641 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22642 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22646 for (i
= first
; i
< end
; ++i
)
22649 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22652 x
+= glyphs
[i
].pixel_width
;
22659 /* Set background width of glyph string S. START is the index of the
22660 first glyph following S. LAST_X is the right-most x-position + 1
22661 in the drawing area. */
22664 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22666 /* If the face of this glyph string has to be drawn to the end of
22667 the drawing area, set S->extends_to_end_of_line_p. */
22669 if (start
== s
->row
->used
[s
->area
]
22670 && s
->area
== TEXT_AREA
22671 && ((s
->row
->fill_line_p
22672 && (s
->hl
== DRAW_NORMAL_TEXT
22673 || s
->hl
== DRAW_IMAGE_RAISED
22674 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22675 || s
->hl
== DRAW_MOUSE_FACE
))
22676 s
->extends_to_end_of_line_p
= 1;
22678 /* If S extends its face to the end of the line, set its
22679 background_width to the distance to the right edge of the drawing
22681 if (s
->extends_to_end_of_line_p
)
22682 s
->background_width
= last_x
- s
->x
+ 1;
22684 s
->background_width
= s
->width
;
22688 /* Compute overhangs and x-positions for glyph string S and its
22689 predecessors, or successors. X is the starting x-position for S.
22690 BACKWARD_P non-zero means process predecessors. */
22693 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22699 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22700 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22710 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22711 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22721 /* The following macros are only called from draw_glyphs below.
22722 They reference the following parameters of that function directly:
22723 `w', `row', `area', and `overlap_p'
22724 as well as the following local variables:
22725 `s', `f', and `hdc' (in W32) */
22728 /* On W32, silently add local `hdc' variable to argument list of
22729 init_glyph_string. */
22730 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22731 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22733 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22734 init_glyph_string (s, char2b, w, row, area, start, hl)
22737 /* Add a glyph string for a stretch glyph to the list of strings
22738 between HEAD and TAIL. START is the index of the stretch glyph in
22739 row area AREA of glyph row ROW. END is the index of the last glyph
22740 in that glyph row area. X is the current output position assigned
22741 to the new glyph string constructed. HL overrides that face of the
22742 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22743 is the right-most x-position of the drawing area. */
22745 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22746 and below -- keep them on one line. */
22747 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22750 s = (struct glyph_string *) alloca (sizeof *s); \
22751 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22752 START = fill_stretch_glyph_string (s, START, END); \
22753 append_glyph_string (&HEAD, &TAIL, s); \
22759 /* Add a glyph string for an image glyph to the list of strings
22760 between HEAD and TAIL. START is the index of the image glyph in
22761 row area AREA of glyph row ROW. END is the index of the last glyph
22762 in that glyph row area. X is the current output position assigned
22763 to the new glyph string constructed. HL overrides that face of the
22764 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22765 is the right-most x-position of the drawing area. */
22767 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22770 s = (struct glyph_string *) alloca (sizeof *s); \
22771 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22772 fill_image_glyph_string (s); \
22773 append_glyph_string (&HEAD, &TAIL, s); \
22780 /* Add a glyph string for a sequence of character glyphs to the list
22781 of strings between HEAD and TAIL. START is the index of the first
22782 glyph in row area AREA of glyph row ROW that is part of the new
22783 glyph string. END is the index of the last glyph in that glyph row
22784 area. X is the current output position assigned to the new glyph
22785 string constructed. HL overrides that face of the glyph; e.g. it
22786 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22787 right-most x-position of the drawing area. */
22789 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22795 face_id = (row)->glyphs[area][START].face_id; \
22797 s = (struct glyph_string *) alloca (sizeof *s); \
22798 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22799 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22800 append_glyph_string (&HEAD, &TAIL, s); \
22802 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22807 /* Add a glyph string for a composite sequence to the list of strings
22808 between HEAD and TAIL. START is the index of the first glyph in
22809 row area AREA of glyph row ROW that is part of the new glyph
22810 string. END is the index of the last glyph in that glyph row area.
22811 X is the current output position assigned to the new glyph string
22812 constructed. HL overrides that face of the glyph; e.g. it is
22813 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22814 x-position of the drawing area. */
22816 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22818 int face_id = (row)->glyphs[area][START].face_id; \
22819 struct face *base_face = FACE_FROM_ID (f, face_id); \
22820 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22821 struct composition *cmp = composition_table[cmp_id]; \
22823 struct glyph_string *first_s = NULL; \
22826 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22828 /* Make glyph_strings for each glyph sequence that is drawable by \
22829 the same face, and append them to HEAD/TAIL. */ \
22830 for (n = 0; n < cmp->glyph_len;) \
22832 s = (struct glyph_string *) alloca (sizeof *s); \
22833 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22834 append_glyph_string (&(HEAD), &(TAIL), s); \
22840 n = fill_composite_glyph_string (s, base_face, overlaps); \
22848 /* Add a glyph string for a glyph-string sequence to the list of strings
22849 between HEAD and TAIL. */
22851 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22855 Lisp_Object gstring; \
22857 face_id = (row)->glyphs[area][START].face_id; \
22858 gstring = (composition_gstring_from_id \
22859 ((row)->glyphs[area][START].u.cmp.id)); \
22860 s = (struct glyph_string *) alloca (sizeof *s); \
22861 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22862 * LGSTRING_GLYPH_LEN (gstring)); \
22863 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22864 append_glyph_string (&(HEAD), &(TAIL), s); \
22866 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22870 /* Add a glyph string for a sequence of glyphless character's glyphs
22871 to the list of strings between HEAD and TAIL. The meanings of
22872 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22874 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22879 face_id = (row)->glyphs[area][START].face_id; \
22881 s = (struct glyph_string *) alloca (sizeof *s); \
22882 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22883 append_glyph_string (&HEAD, &TAIL, s); \
22885 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22891 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22892 of AREA of glyph row ROW on window W between indices START and END.
22893 HL overrides the face for drawing glyph strings, e.g. it is
22894 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22895 x-positions of the drawing area.
22897 This is an ugly monster macro construct because we must use alloca
22898 to allocate glyph strings (because draw_glyphs can be called
22899 asynchronously). */
22901 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22904 HEAD = TAIL = NULL; \
22905 while (START < END) \
22907 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22908 switch (first_glyph->type) \
22911 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22915 case COMPOSITE_GLYPH: \
22916 if (first_glyph->u.cmp.automatic) \
22917 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22920 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22924 case STRETCH_GLYPH: \
22925 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22929 case IMAGE_GLYPH: \
22930 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22934 case GLYPHLESS_GLYPH: \
22935 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22945 set_glyph_string_background_width (s, START, LAST_X); \
22952 /* Draw glyphs between START and END in AREA of ROW on window W,
22953 starting at x-position X. X is relative to AREA in W. HL is a
22954 face-override with the following meaning:
22956 DRAW_NORMAL_TEXT draw normally
22957 DRAW_CURSOR draw in cursor face
22958 DRAW_MOUSE_FACE draw in mouse face.
22959 DRAW_INVERSE_VIDEO draw in mode line face
22960 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22961 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22963 If OVERLAPS is non-zero, draw only the foreground of characters and
22964 clip to the physical height of ROW. Non-zero value also defines
22965 the overlapping part to be drawn:
22967 OVERLAPS_PRED overlap with preceding rows
22968 OVERLAPS_SUCC overlap with succeeding rows
22969 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22970 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22972 Value is the x-position reached, relative to AREA of W. */
22975 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22976 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22977 enum draw_glyphs_face hl
, int overlaps
)
22979 struct glyph_string
*head
, *tail
;
22980 struct glyph_string
*s
;
22981 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22982 int i
, j
, x_reached
, last_x
, area_left
= 0;
22983 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22986 ALLOCATE_HDC (hdc
, f
);
22988 /* Let's rather be paranoid than getting a SEGV. */
22989 end
= min (end
, row
->used
[area
]);
22990 start
= max (0, start
);
22991 start
= min (end
, start
);
22993 /* Translate X to frame coordinates. Set last_x to the right
22994 end of the drawing area. */
22995 if (row
->full_width_p
)
22997 /* X is relative to the left edge of W, without scroll bars
22999 area_left
= WINDOW_LEFT_EDGE_X (w
);
23000 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23004 area_left
= window_box_left (w
, area
);
23005 last_x
= area_left
+ window_box_width (w
, area
);
23009 /* Build a doubly-linked list of glyph_string structures between
23010 head and tail from what we have to draw. Note that the macro
23011 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23012 the reason we use a separate variable `i'. */
23014 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23016 x_reached
= tail
->x
+ tail
->background_width
;
23020 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23021 the row, redraw some glyphs in front or following the glyph
23022 strings built above. */
23023 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23025 struct glyph_string
*h
, *t
;
23026 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23027 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23028 int check_mouse_face
= 0;
23031 /* If mouse highlighting is on, we may need to draw adjacent
23032 glyphs using mouse-face highlighting. */
23033 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23035 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23037 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23038 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23040 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23042 check_mouse_face
= 1;
23043 mouse_beg_col
= (row
== mouse_beg_row
)
23044 ? hlinfo
->mouse_face_beg_col
: 0;
23045 mouse_end_col
= (row
== mouse_end_row
)
23046 ? hlinfo
->mouse_face_end_col
23047 : row
->used
[TEXT_AREA
];
23051 /* Compute overhangs for all glyph strings. */
23052 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23053 for (s
= head
; s
; s
= s
->next
)
23054 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23056 /* Prepend glyph strings for glyphs in front of the first glyph
23057 string that are overwritten because of the first glyph
23058 string's left overhang. The background of all strings
23059 prepended must be drawn because the first glyph string
23061 i
= left_overwritten (head
);
23064 enum draw_glyphs_face overlap_hl
;
23066 /* If this row contains mouse highlighting, attempt to draw
23067 the overlapped glyphs with the correct highlight. This
23068 code fails if the overlap encompasses more than one glyph
23069 and mouse-highlight spans only some of these glyphs.
23070 However, making it work perfectly involves a lot more
23071 code, and I don't know if the pathological case occurs in
23072 practice, so we'll stick to this for now. --- cyd */
23073 if (check_mouse_face
23074 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23075 overlap_hl
= DRAW_MOUSE_FACE
;
23077 overlap_hl
= DRAW_NORMAL_TEXT
;
23080 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23081 overlap_hl
, dummy_x
, last_x
);
23083 compute_overhangs_and_x (t
, head
->x
, 1);
23084 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23088 /* Prepend glyph strings for glyphs in front of the first glyph
23089 string that overwrite that glyph string because of their
23090 right overhang. For these strings, only the foreground must
23091 be drawn, because it draws over the glyph string at `head'.
23092 The background must not be drawn because this would overwrite
23093 right overhangs of preceding glyphs for which no glyph
23095 i
= left_overwriting (head
);
23098 enum draw_glyphs_face overlap_hl
;
23100 if (check_mouse_face
23101 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23102 overlap_hl
= DRAW_MOUSE_FACE
;
23104 overlap_hl
= DRAW_NORMAL_TEXT
;
23107 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23108 overlap_hl
, dummy_x
, last_x
);
23109 for (s
= h
; s
; s
= s
->next
)
23110 s
->background_filled_p
= 1;
23111 compute_overhangs_and_x (t
, head
->x
, 1);
23112 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23115 /* Append glyphs strings for glyphs following the last glyph
23116 string tail that are overwritten by tail. The background of
23117 these strings has to be drawn because tail's foreground draws
23119 i
= right_overwritten (tail
);
23122 enum draw_glyphs_face overlap_hl
;
23124 if (check_mouse_face
23125 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23126 overlap_hl
= DRAW_MOUSE_FACE
;
23128 overlap_hl
= DRAW_NORMAL_TEXT
;
23130 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23131 overlap_hl
, x
, last_x
);
23132 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23133 we don't have `end = i;' here. */
23134 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23135 append_glyph_string_lists (&head
, &tail
, h
, t
);
23139 /* Append glyph strings for glyphs following the last glyph
23140 string tail that overwrite tail. The foreground of such
23141 glyphs has to be drawn because it writes into the background
23142 of tail. The background must not be drawn because it could
23143 paint over the foreground of following glyphs. */
23144 i
= right_overwriting (tail
);
23147 enum draw_glyphs_face overlap_hl
;
23148 if (check_mouse_face
23149 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23150 overlap_hl
= DRAW_MOUSE_FACE
;
23152 overlap_hl
= DRAW_NORMAL_TEXT
;
23155 i
++; /* We must include the Ith glyph. */
23156 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23157 overlap_hl
, x
, last_x
);
23158 for (s
= h
; s
; s
= s
->next
)
23159 s
->background_filled_p
= 1;
23160 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23161 append_glyph_string_lists (&head
, &tail
, h
, t
);
23163 if (clip_head
|| clip_tail
)
23164 for (s
= head
; s
; s
= s
->next
)
23166 s
->clip_head
= clip_head
;
23167 s
->clip_tail
= clip_tail
;
23171 /* Draw all strings. */
23172 for (s
= head
; s
; s
= s
->next
)
23173 FRAME_RIF (f
)->draw_glyph_string (s
);
23176 /* When focus a sole frame and move horizontally, this sets on_p to 0
23177 causing a failure to erase prev cursor position. */
23178 if (area
== TEXT_AREA
23179 && !row
->full_width_p
23180 /* When drawing overlapping rows, only the glyph strings'
23181 foreground is drawn, which doesn't erase a cursor
23185 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23186 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23187 : (tail
? tail
->x
+ tail
->background_width
: x
));
23191 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23192 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23196 /* Value is the x-position up to which drawn, relative to AREA of W.
23197 This doesn't include parts drawn because of overhangs. */
23198 if (row
->full_width_p
)
23199 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23201 x_reached
-= area_left
;
23203 RELEASE_HDC (hdc
, f
);
23208 /* Expand row matrix if too narrow. Don't expand if area
23211 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23213 if (!fonts_changed_p \
23214 && (it->glyph_row->glyphs[area] \
23215 < it->glyph_row->glyphs[area + 1])) \
23217 it->w->ncols_scale_factor++; \
23218 fonts_changed_p = 1; \
23222 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23223 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23226 append_glyph (struct it
*it
)
23228 struct glyph
*glyph
;
23229 enum glyph_row_area area
= it
->area
;
23231 xassert (it
->glyph_row
);
23232 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23234 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23235 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23237 /* If the glyph row is reversed, we need to prepend the glyph
23238 rather than append it. */
23239 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23243 /* Make room for the additional glyph. */
23244 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23246 glyph
= it
->glyph_row
->glyphs
[area
];
23248 glyph
->charpos
= CHARPOS (it
->position
);
23249 glyph
->object
= it
->object
;
23250 if (it
->pixel_width
> 0)
23252 glyph
->pixel_width
= it
->pixel_width
;
23253 glyph
->padding_p
= 0;
23257 /* Assure at least 1-pixel width. Otherwise, cursor can't
23258 be displayed correctly. */
23259 glyph
->pixel_width
= 1;
23260 glyph
->padding_p
= 1;
23262 glyph
->ascent
= it
->ascent
;
23263 glyph
->descent
= it
->descent
;
23264 glyph
->voffset
= it
->voffset
;
23265 glyph
->type
= CHAR_GLYPH
;
23266 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23267 glyph
->multibyte_p
= it
->multibyte_p
;
23268 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23269 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23270 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23271 || it
->phys_descent
> it
->descent
);
23272 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23273 glyph
->face_id
= it
->face_id
;
23274 glyph
->u
.ch
= it
->char_to_display
;
23275 glyph
->slice
.img
= null_glyph_slice
;
23276 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23279 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23280 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23282 glyph
->bidi_type
= it
->bidi_it
.type
;
23286 glyph
->resolved_level
= 0;
23287 glyph
->bidi_type
= UNKNOWN_BT
;
23289 ++it
->glyph_row
->used
[area
];
23292 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23295 /* Store one glyph for the composition IT->cmp_it.id in
23296 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23300 append_composite_glyph (struct it
*it
)
23302 struct glyph
*glyph
;
23303 enum glyph_row_area area
= it
->area
;
23305 xassert (it
->glyph_row
);
23307 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23308 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23310 /* If the glyph row is reversed, we need to prepend the glyph
23311 rather than append it. */
23312 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23316 /* Make room for the new glyph. */
23317 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23319 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23321 glyph
->charpos
= it
->cmp_it
.charpos
;
23322 glyph
->object
= it
->object
;
23323 glyph
->pixel_width
= it
->pixel_width
;
23324 glyph
->ascent
= it
->ascent
;
23325 glyph
->descent
= it
->descent
;
23326 glyph
->voffset
= it
->voffset
;
23327 glyph
->type
= COMPOSITE_GLYPH
;
23328 if (it
->cmp_it
.ch
< 0)
23330 glyph
->u
.cmp
.automatic
= 0;
23331 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23332 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23336 glyph
->u
.cmp
.automatic
= 1;
23337 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23338 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23339 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23341 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23342 glyph
->multibyte_p
= it
->multibyte_p
;
23343 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23344 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23345 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23346 || it
->phys_descent
> it
->descent
);
23347 glyph
->padding_p
= 0;
23348 glyph
->glyph_not_available_p
= 0;
23349 glyph
->face_id
= it
->face_id
;
23350 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23353 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23354 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23356 glyph
->bidi_type
= it
->bidi_it
.type
;
23358 ++it
->glyph_row
->used
[area
];
23361 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23365 /* Change IT->ascent and IT->height according to the setting of
23369 take_vertical_position_into_account (struct it
*it
)
23373 if (it
->voffset
< 0)
23374 /* Increase the ascent so that we can display the text higher
23376 it
->ascent
-= it
->voffset
;
23378 /* Increase the descent so that we can display the text lower
23380 it
->descent
+= it
->voffset
;
23385 /* Produce glyphs/get display metrics for the image IT is loaded with.
23386 See the description of struct display_iterator in dispextern.h for
23387 an overview of struct display_iterator. */
23390 produce_image_glyph (struct it
*it
)
23394 int glyph_ascent
, crop
;
23395 struct glyph_slice slice
;
23397 xassert (it
->what
== IT_IMAGE
);
23399 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23401 /* Make sure X resources of the face is loaded. */
23402 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23404 if (it
->image_id
< 0)
23406 /* Fringe bitmap. */
23407 it
->ascent
= it
->phys_ascent
= 0;
23408 it
->descent
= it
->phys_descent
= 0;
23409 it
->pixel_width
= 0;
23414 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23416 /* Make sure X resources of the image is loaded. */
23417 prepare_image_for_display (it
->f
, img
);
23419 slice
.x
= slice
.y
= 0;
23420 slice
.width
= img
->width
;
23421 slice
.height
= img
->height
;
23423 if (INTEGERP (it
->slice
.x
))
23424 slice
.x
= XINT (it
->slice
.x
);
23425 else if (FLOATP (it
->slice
.x
))
23426 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23428 if (INTEGERP (it
->slice
.y
))
23429 slice
.y
= XINT (it
->slice
.y
);
23430 else if (FLOATP (it
->slice
.y
))
23431 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23433 if (INTEGERP (it
->slice
.width
))
23434 slice
.width
= XINT (it
->slice
.width
);
23435 else if (FLOATP (it
->slice
.width
))
23436 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23438 if (INTEGERP (it
->slice
.height
))
23439 slice
.height
= XINT (it
->slice
.height
);
23440 else if (FLOATP (it
->slice
.height
))
23441 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23443 if (slice
.x
>= img
->width
)
23444 slice
.x
= img
->width
;
23445 if (slice
.y
>= img
->height
)
23446 slice
.y
= img
->height
;
23447 if (slice
.x
+ slice
.width
>= img
->width
)
23448 slice
.width
= img
->width
- slice
.x
;
23449 if (slice
.y
+ slice
.height
> img
->height
)
23450 slice
.height
= img
->height
- slice
.y
;
23452 if (slice
.width
== 0 || slice
.height
== 0)
23455 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23457 it
->descent
= slice
.height
- glyph_ascent
;
23459 it
->descent
+= img
->vmargin
;
23460 if (slice
.y
+ slice
.height
== img
->height
)
23461 it
->descent
+= img
->vmargin
;
23462 it
->phys_descent
= it
->descent
;
23464 it
->pixel_width
= slice
.width
;
23466 it
->pixel_width
+= img
->hmargin
;
23467 if (slice
.x
+ slice
.width
== img
->width
)
23468 it
->pixel_width
+= img
->hmargin
;
23470 /* It's quite possible for images to have an ascent greater than
23471 their height, so don't get confused in that case. */
23472 if (it
->descent
< 0)
23477 if (face
->box
!= FACE_NO_BOX
)
23479 if (face
->box_line_width
> 0)
23482 it
->ascent
+= face
->box_line_width
;
23483 if (slice
.y
+ slice
.height
== img
->height
)
23484 it
->descent
+= face
->box_line_width
;
23487 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23488 it
->pixel_width
+= eabs (face
->box_line_width
);
23489 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23490 it
->pixel_width
+= eabs (face
->box_line_width
);
23493 take_vertical_position_into_account (it
);
23495 /* Automatically crop wide image glyphs at right edge so we can
23496 draw the cursor on same display row. */
23497 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23498 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23500 it
->pixel_width
-= crop
;
23501 slice
.width
-= crop
;
23506 struct glyph
*glyph
;
23507 enum glyph_row_area area
= it
->area
;
23509 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23510 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23512 glyph
->charpos
= CHARPOS (it
->position
);
23513 glyph
->object
= it
->object
;
23514 glyph
->pixel_width
= it
->pixel_width
;
23515 glyph
->ascent
= glyph_ascent
;
23516 glyph
->descent
= it
->descent
;
23517 glyph
->voffset
= it
->voffset
;
23518 glyph
->type
= IMAGE_GLYPH
;
23519 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23520 glyph
->multibyte_p
= it
->multibyte_p
;
23521 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23522 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23523 glyph
->overlaps_vertically_p
= 0;
23524 glyph
->padding_p
= 0;
23525 glyph
->glyph_not_available_p
= 0;
23526 glyph
->face_id
= it
->face_id
;
23527 glyph
->u
.img_id
= img
->id
;
23528 glyph
->slice
.img
= slice
;
23529 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23532 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23533 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23535 glyph
->bidi_type
= it
->bidi_it
.type
;
23537 ++it
->glyph_row
->used
[area
];
23540 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23545 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23546 of the glyph, WIDTH and HEIGHT are the width and height of the
23547 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23550 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23551 int width
, int height
, int ascent
)
23553 struct glyph
*glyph
;
23554 enum glyph_row_area area
= it
->area
;
23556 xassert (ascent
>= 0 && ascent
<= height
);
23558 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23559 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23561 /* If the glyph row is reversed, we need to prepend the glyph
23562 rather than append it. */
23563 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23567 /* Make room for the additional glyph. */
23568 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23570 glyph
= it
->glyph_row
->glyphs
[area
];
23572 glyph
->charpos
= CHARPOS (it
->position
);
23573 glyph
->object
= object
;
23574 glyph
->pixel_width
= width
;
23575 glyph
->ascent
= ascent
;
23576 glyph
->descent
= height
- ascent
;
23577 glyph
->voffset
= it
->voffset
;
23578 glyph
->type
= STRETCH_GLYPH
;
23579 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23580 glyph
->multibyte_p
= it
->multibyte_p
;
23581 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23582 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23583 glyph
->overlaps_vertically_p
= 0;
23584 glyph
->padding_p
= 0;
23585 glyph
->glyph_not_available_p
= 0;
23586 glyph
->face_id
= it
->face_id
;
23587 glyph
->u
.stretch
.ascent
= ascent
;
23588 glyph
->u
.stretch
.height
= height
;
23589 glyph
->slice
.img
= null_glyph_slice
;
23590 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23593 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23594 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23596 glyph
->bidi_type
= it
->bidi_it
.type
;
23600 glyph
->resolved_level
= 0;
23601 glyph
->bidi_type
= UNKNOWN_BT
;
23603 ++it
->glyph_row
->used
[area
];
23606 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23609 #endif /* HAVE_WINDOW_SYSTEM */
23611 /* Produce a stretch glyph for iterator IT. IT->object is the value
23612 of the glyph property displayed. The value must be a list
23613 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23616 1. `:width WIDTH' specifies that the space should be WIDTH *
23617 canonical char width wide. WIDTH may be an integer or floating
23620 2. `:relative-width FACTOR' specifies that the width of the stretch
23621 should be computed from the width of the first character having the
23622 `glyph' property, and should be FACTOR times that width.
23624 3. `:align-to HPOS' specifies that the space should be wide enough
23625 to reach HPOS, a value in canonical character units.
23627 Exactly one of the above pairs must be present.
23629 4. `:height HEIGHT' specifies that the height of the stretch produced
23630 should be HEIGHT, measured in canonical character units.
23632 5. `:relative-height FACTOR' specifies that the height of the
23633 stretch should be FACTOR times the height of the characters having
23634 the glyph property.
23636 Either none or exactly one of 4 or 5 must be present.
23638 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23639 of the stretch should be used for the ascent of the stretch.
23640 ASCENT must be in the range 0 <= ASCENT <= 100. */
23643 produce_stretch_glyph (struct it
*it
)
23645 /* (space :width WIDTH :height HEIGHT ...) */
23646 Lisp_Object prop
, plist
;
23647 int width
= 0, height
= 0, align_to
= -1;
23648 int zero_width_ok_p
= 0;
23651 struct face
*face
= NULL
;
23652 struct font
*font
= NULL
;
23654 #ifdef HAVE_WINDOW_SYSTEM
23655 int zero_height_ok_p
= 0;
23657 if (FRAME_WINDOW_P (it
->f
))
23659 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23660 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23661 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23665 /* List should start with `space'. */
23666 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23667 plist
= XCDR (it
->object
);
23669 /* Compute the width of the stretch. */
23670 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23671 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23673 /* Absolute width `:width WIDTH' specified and valid. */
23674 zero_width_ok_p
= 1;
23677 #ifdef HAVE_WINDOW_SYSTEM
23678 else if (FRAME_WINDOW_P (it
->f
)
23679 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23681 /* Relative width `:relative-width FACTOR' specified and valid.
23682 Compute the width of the characters having the `glyph'
23685 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23688 if (it
->multibyte_p
)
23689 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23692 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23693 if (! ASCII_CHAR_P (it2
.c
))
23694 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23697 it2
.glyph_row
= NULL
;
23698 it2
.what
= IT_CHARACTER
;
23699 x_produce_glyphs (&it2
);
23700 width
= NUMVAL (prop
) * it2
.pixel_width
;
23702 #endif /* HAVE_WINDOW_SYSTEM */
23703 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23704 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23706 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23707 align_to
= (align_to
< 0
23709 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23710 else if (align_to
< 0)
23711 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23712 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23713 zero_width_ok_p
= 1;
23716 /* Nothing specified -> width defaults to canonical char width. */
23717 width
= FRAME_COLUMN_WIDTH (it
->f
);
23719 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23722 #ifdef HAVE_WINDOW_SYSTEM
23723 /* Compute height. */
23724 if (FRAME_WINDOW_P (it
->f
))
23726 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23727 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23730 zero_height_ok_p
= 1;
23732 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23734 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23736 height
= FONT_HEIGHT (font
);
23738 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23741 /* Compute percentage of height used for ascent. If
23742 `:ascent ASCENT' is present and valid, use that. Otherwise,
23743 derive the ascent from the font in use. */
23744 if (prop
= Fplist_get (plist
, QCascent
),
23745 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23746 ascent
= height
* NUMVAL (prop
) / 100.0;
23747 else if (!NILP (prop
)
23748 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23749 ascent
= min (max (0, (int)tem
), height
);
23751 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23754 #endif /* HAVE_WINDOW_SYSTEM */
23757 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23758 && it
->current_x
+ width
> it
->last_visible_x
)
23760 width
= it
->last_visible_x
- it
->current_x
;
23761 #ifdef HAVE_WINDOW_SYSTEM
23762 /* Subtract one more pixel from the stretch width, but only on
23763 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23764 width
-= FRAME_WINDOW_P (it
->f
);
23768 if (width
> 0 && height
> 0 && it
->glyph_row
)
23770 Lisp_Object o_object
= it
->object
;
23771 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23774 if (!STRINGP (object
))
23775 object
= it
->w
->buffer
;
23776 #ifdef HAVE_WINDOW_SYSTEM
23777 if (FRAME_WINDOW_P (it
->f
))
23778 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23782 it
->object
= object
;
23783 it
->char_to_display
= ' ';
23784 it
->pixel_width
= it
->len
= 1;
23786 tty_append_glyph (it
);
23787 it
->object
= o_object
;
23791 it
->pixel_width
= width
;
23792 #ifdef HAVE_WINDOW_SYSTEM
23793 if (FRAME_WINDOW_P (it
->f
))
23795 it
->ascent
= it
->phys_ascent
= ascent
;
23796 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23797 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23798 take_vertical_position_into_account (it
);
23802 it
->nglyphs
= width
;
23805 #ifdef HAVE_WINDOW_SYSTEM
23807 /* Calculate line-height and line-spacing properties.
23808 An integer value specifies explicit pixel value.
23809 A float value specifies relative value to current face height.
23810 A cons (float . face-name) specifies relative value to
23811 height of specified face font.
23813 Returns height in pixels, or nil. */
23817 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23818 int boff
, int override
)
23820 Lisp_Object face_name
= Qnil
;
23821 int ascent
, descent
, height
;
23823 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23828 face_name
= XCAR (val
);
23830 if (!NUMBERP (val
))
23831 val
= make_number (1);
23832 if (NILP (face_name
))
23834 height
= it
->ascent
+ it
->descent
;
23839 if (NILP (face_name
))
23841 font
= FRAME_FONT (it
->f
);
23842 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23844 else if (EQ (face_name
, Qt
))
23853 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23855 return make_number (-1);
23857 face
= FACE_FROM_ID (it
->f
, face_id
);
23860 return make_number (-1);
23861 boff
= font
->baseline_offset
;
23862 if (font
->vertical_centering
)
23863 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23866 ascent
= FONT_BASE (font
) + boff
;
23867 descent
= FONT_DESCENT (font
) - boff
;
23871 it
->override_ascent
= ascent
;
23872 it
->override_descent
= descent
;
23873 it
->override_boff
= boff
;
23876 height
= ascent
+ descent
;
23880 height
= (int)(XFLOAT_DATA (val
) * height
);
23881 else if (INTEGERP (val
))
23882 height
*= XINT (val
);
23884 return make_number (height
);
23888 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23889 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23890 and only if this is for a character for which no font was found.
23892 If the display method (it->glyphless_method) is
23893 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23894 length of the acronym or the hexadecimal string, UPPER_XOFF and
23895 UPPER_YOFF are pixel offsets for the upper part of the string,
23896 LOWER_XOFF and LOWER_YOFF are for the lower part.
23898 For the other display methods, LEN through LOWER_YOFF are zero. */
23901 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23902 short upper_xoff
, short upper_yoff
,
23903 short lower_xoff
, short lower_yoff
)
23905 struct glyph
*glyph
;
23906 enum glyph_row_area area
= it
->area
;
23908 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23909 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23911 /* If the glyph row is reversed, we need to prepend the glyph
23912 rather than append it. */
23913 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23917 /* Make room for the additional glyph. */
23918 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23920 glyph
= it
->glyph_row
->glyphs
[area
];
23922 glyph
->charpos
= CHARPOS (it
->position
);
23923 glyph
->object
= it
->object
;
23924 glyph
->pixel_width
= it
->pixel_width
;
23925 glyph
->ascent
= it
->ascent
;
23926 glyph
->descent
= it
->descent
;
23927 glyph
->voffset
= it
->voffset
;
23928 glyph
->type
= GLYPHLESS_GLYPH
;
23929 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23930 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23931 glyph
->u
.glyphless
.len
= len
;
23932 glyph
->u
.glyphless
.ch
= it
->c
;
23933 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23934 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23935 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23936 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23937 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23938 glyph
->multibyte_p
= it
->multibyte_p
;
23939 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23940 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23941 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23942 || it
->phys_descent
> it
->descent
);
23943 glyph
->padding_p
= 0;
23944 glyph
->glyph_not_available_p
= 0;
23945 glyph
->face_id
= face_id
;
23946 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23949 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23950 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23952 glyph
->bidi_type
= it
->bidi_it
.type
;
23954 ++it
->glyph_row
->used
[area
];
23957 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23961 /* Produce a glyph for a glyphless character for iterator IT.
23962 IT->glyphless_method specifies which method to use for displaying
23963 the character. See the description of enum
23964 glyphless_display_method in dispextern.h for the detail.
23966 FOR_NO_FONT is nonzero if and only if this is for a character for
23967 which no font was found. ACRONYM, if non-nil, is an acronym string
23968 for the character. */
23971 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23976 int base_width
, base_height
, width
, height
;
23977 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23980 /* Get the metrics of the base font. We always refer to the current
23982 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23983 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23984 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23985 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23986 base_height
= it
->ascent
+ it
->descent
;
23987 base_width
= font
->average_width
;
23989 /* Get a face ID for the glyph by utilizing a cache (the same way as
23990 done for `escape-glyph' in get_next_display_element). */
23991 if (it
->f
== last_glyphless_glyph_frame
23992 && it
->face_id
== last_glyphless_glyph_face_id
)
23994 face_id
= last_glyphless_glyph_merged_face_id
;
23998 /* Merge the `glyphless-char' face into the current face. */
23999 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24000 last_glyphless_glyph_frame
= it
->f
;
24001 last_glyphless_glyph_face_id
= it
->face_id
;
24002 last_glyphless_glyph_merged_face_id
= face_id
;
24005 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24007 it
->pixel_width
= THIN_SPACE_WIDTH
;
24009 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24011 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24013 width
= CHAR_WIDTH (it
->c
);
24016 else if (width
> 4)
24018 it
->pixel_width
= base_width
* width
;
24020 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24026 unsigned int code
[6];
24028 int ascent
, descent
;
24029 struct font_metrics metrics_upper
, metrics_lower
;
24031 face
= FACE_FROM_ID (it
->f
, face_id
);
24032 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24033 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24035 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24037 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24038 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24039 if (CONSP (acronym
))
24040 acronym
= XCAR (acronym
);
24041 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24045 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24046 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24049 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24050 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24051 upper_len
= (len
+ 1) / 2;
24052 font
->driver
->text_extents (font
, code
, upper_len
,
24054 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24059 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24060 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24061 upper_xoff
= upper_yoff
= 2; /* the typical case */
24062 if (base_width
>= width
)
24064 /* Align the upper to the left, the lower to the right. */
24065 it
->pixel_width
= base_width
;
24066 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24070 /* Center the shorter one. */
24071 it
->pixel_width
= width
;
24072 if (metrics_upper
.width
>= metrics_lower
.width
)
24073 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24076 /* FIXME: This code doesn't look right. It formerly was
24077 missing the "lower_xoff = 0;", which couldn't have
24078 been right since it left lower_xoff uninitialized. */
24080 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24084 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24085 top, bottom, and between upper and lower strings. */
24086 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24087 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24088 /* Center vertically.
24089 H:base_height, D:base_descent
24090 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24092 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24093 descent = D - H/2 + h/2;
24094 lower_yoff = descent - 2 - ld;
24095 upper_yoff = lower_yoff - la - 1 - ud; */
24096 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24097 descent
= it
->descent
- (base_height
- height
) / 2;
24098 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24099 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24100 - metrics_upper
.descent
);
24101 /* Don't make the height shorter than the base height. */
24102 if (height
> base_height
)
24104 it
->ascent
= ascent
;
24105 it
->descent
= descent
;
24109 it
->phys_ascent
= it
->ascent
;
24110 it
->phys_descent
= it
->descent
;
24112 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24113 upper_xoff
, upper_yoff
,
24114 lower_xoff
, lower_yoff
);
24116 take_vertical_position_into_account (it
);
24121 Produce glyphs/get display metrics for the display element IT is
24122 loaded with. See the description of struct it in dispextern.h
24123 for an overview of struct it. */
24126 x_produce_glyphs (struct it
*it
)
24128 int extra_line_spacing
= it
->extra_line_spacing
;
24130 it
->glyph_not_available_p
= 0;
24132 if (it
->what
== IT_CHARACTER
)
24135 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24136 struct font
*font
= face
->font
;
24137 struct font_metrics
*pcm
= NULL
;
24138 int boff
; /* baseline offset */
24142 /* When no suitable font is found, display this character by
24143 the method specified in the first extra slot of
24144 Vglyphless_char_display. */
24145 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24147 xassert (it
->what
== IT_GLYPHLESS
);
24148 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24152 boff
= font
->baseline_offset
;
24153 if (font
->vertical_centering
)
24154 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24156 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24162 if (it
->override_ascent
>= 0)
24164 it
->ascent
= it
->override_ascent
;
24165 it
->descent
= it
->override_descent
;
24166 boff
= it
->override_boff
;
24170 it
->ascent
= FONT_BASE (font
) + boff
;
24171 it
->descent
= FONT_DESCENT (font
) - boff
;
24174 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24176 pcm
= get_per_char_metric (font
, &char2b
);
24177 if (pcm
->width
== 0
24178 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24184 it
->phys_ascent
= pcm
->ascent
+ boff
;
24185 it
->phys_descent
= pcm
->descent
- boff
;
24186 it
->pixel_width
= pcm
->width
;
24190 it
->glyph_not_available_p
= 1;
24191 it
->phys_ascent
= it
->ascent
;
24192 it
->phys_descent
= it
->descent
;
24193 it
->pixel_width
= font
->space_width
;
24196 if (it
->constrain_row_ascent_descent_p
)
24198 if (it
->descent
> it
->max_descent
)
24200 it
->ascent
+= it
->descent
- it
->max_descent
;
24201 it
->descent
= it
->max_descent
;
24203 if (it
->ascent
> it
->max_ascent
)
24205 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24206 it
->ascent
= it
->max_ascent
;
24208 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24209 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24210 extra_line_spacing
= 0;
24213 /* If this is a space inside a region of text with
24214 `space-width' property, change its width. */
24215 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24217 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24219 /* If face has a box, add the box thickness to the character
24220 height. If character has a box line to the left and/or
24221 right, add the box line width to the character's width. */
24222 if (face
->box
!= FACE_NO_BOX
)
24224 int thick
= face
->box_line_width
;
24228 it
->ascent
+= thick
;
24229 it
->descent
+= thick
;
24234 if (it
->start_of_box_run_p
)
24235 it
->pixel_width
+= thick
;
24236 if (it
->end_of_box_run_p
)
24237 it
->pixel_width
+= thick
;
24240 /* If face has an overline, add the height of the overline
24241 (1 pixel) and a 1 pixel margin to the character height. */
24242 if (face
->overline_p
)
24243 it
->ascent
+= overline_margin
;
24245 if (it
->constrain_row_ascent_descent_p
)
24247 if (it
->ascent
> it
->max_ascent
)
24248 it
->ascent
= it
->max_ascent
;
24249 if (it
->descent
> it
->max_descent
)
24250 it
->descent
= it
->max_descent
;
24253 take_vertical_position_into_account (it
);
24255 /* If we have to actually produce glyphs, do it. */
24260 /* Translate a space with a `space-width' property
24261 into a stretch glyph. */
24262 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24263 / FONT_HEIGHT (font
));
24264 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24265 it
->ascent
+ it
->descent
, ascent
);
24270 /* If characters with lbearing or rbearing are displayed
24271 in this line, record that fact in a flag of the
24272 glyph row. This is used to optimize X output code. */
24273 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24274 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24276 if (! stretched_p
&& it
->pixel_width
== 0)
24277 /* We assure that all visible glyphs have at least 1-pixel
24279 it
->pixel_width
= 1;
24281 else if (it
->char_to_display
== '\n')
24283 /* A newline has no width, but we need the height of the
24284 line. But if previous part of the line sets a height,
24285 don't increase that height */
24287 Lisp_Object height
;
24288 Lisp_Object total_height
= Qnil
;
24290 it
->override_ascent
= -1;
24291 it
->pixel_width
= 0;
24294 height
= get_it_property (it
, Qline_height
);
24295 /* Split (line-height total-height) list */
24297 && CONSP (XCDR (height
))
24298 && NILP (XCDR (XCDR (height
))))
24300 total_height
= XCAR (XCDR (height
));
24301 height
= XCAR (height
);
24303 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24305 if (it
->override_ascent
>= 0)
24307 it
->ascent
= it
->override_ascent
;
24308 it
->descent
= it
->override_descent
;
24309 boff
= it
->override_boff
;
24313 it
->ascent
= FONT_BASE (font
) + boff
;
24314 it
->descent
= FONT_DESCENT (font
) - boff
;
24317 if (EQ (height
, Qt
))
24319 if (it
->descent
> it
->max_descent
)
24321 it
->ascent
+= it
->descent
- it
->max_descent
;
24322 it
->descent
= it
->max_descent
;
24324 if (it
->ascent
> it
->max_ascent
)
24326 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24327 it
->ascent
= it
->max_ascent
;
24329 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24330 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24331 it
->constrain_row_ascent_descent_p
= 1;
24332 extra_line_spacing
= 0;
24336 Lisp_Object spacing
;
24338 it
->phys_ascent
= it
->ascent
;
24339 it
->phys_descent
= it
->descent
;
24341 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24342 && face
->box
!= FACE_NO_BOX
24343 && face
->box_line_width
> 0)
24345 it
->ascent
+= face
->box_line_width
;
24346 it
->descent
+= face
->box_line_width
;
24349 && XINT (height
) > it
->ascent
+ it
->descent
)
24350 it
->ascent
= XINT (height
) - it
->descent
;
24352 if (!NILP (total_height
))
24353 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24356 spacing
= get_it_property (it
, Qline_spacing
);
24357 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24359 if (INTEGERP (spacing
))
24361 extra_line_spacing
= XINT (spacing
);
24362 if (!NILP (total_height
))
24363 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24367 else /* i.e. (it->char_to_display == '\t') */
24369 if (font
->space_width
> 0)
24371 int tab_width
= it
->tab_width
* font
->space_width
;
24372 int x
= it
->current_x
+ it
->continuation_lines_width
;
24373 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24375 /* If the distance from the current position to the next tab
24376 stop is less than a space character width, use the
24377 tab stop after that. */
24378 if (next_tab_x
- x
< font
->space_width
)
24379 next_tab_x
+= tab_width
;
24381 it
->pixel_width
= next_tab_x
- x
;
24383 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24384 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24388 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24389 it
->ascent
+ it
->descent
, it
->ascent
);
24394 it
->pixel_width
= 0;
24399 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24401 /* A static composition.
24403 Note: A composition is represented as one glyph in the
24404 glyph matrix. There are no padding glyphs.
24406 Important note: pixel_width, ascent, and descent are the
24407 values of what is drawn by draw_glyphs (i.e. the values of
24408 the overall glyphs composed). */
24409 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24410 int boff
; /* baseline offset */
24411 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24412 int glyph_len
= cmp
->glyph_len
;
24413 struct font
*font
= face
->font
;
24417 /* If we have not yet calculated pixel size data of glyphs of
24418 the composition for the current face font, calculate them
24419 now. Theoretically, we have to check all fonts for the
24420 glyphs, but that requires much time and memory space. So,
24421 here we check only the font of the first glyph. This may
24422 lead to incorrect display, but it's very rare, and C-l
24423 (recenter-top-bottom) can correct the display anyway. */
24424 if (! cmp
->font
|| cmp
->font
!= font
)
24426 /* Ascent and descent of the font of the first character
24427 of this composition (adjusted by baseline offset).
24428 Ascent and descent of overall glyphs should not be less
24429 than these, respectively. */
24430 int font_ascent
, font_descent
, font_height
;
24431 /* Bounding box of the overall glyphs. */
24432 int leftmost
, rightmost
, lowest
, highest
;
24433 int lbearing
, rbearing
;
24434 int i
, width
, ascent
, descent
;
24435 int left_padded
= 0, right_padded
= 0;
24436 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24438 struct font_metrics
*pcm
;
24439 int font_not_found_p
;
24442 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24443 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24445 if (glyph_len
< cmp
->glyph_len
)
24447 for (i
= 0; i
< glyph_len
; i
++)
24449 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24451 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24456 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24457 : IT_CHARPOS (*it
));
24458 /* If no suitable font is found, use the default font. */
24459 font_not_found_p
= font
== NULL
;
24460 if (font_not_found_p
)
24462 face
= face
->ascii_face
;
24465 boff
= font
->baseline_offset
;
24466 if (font
->vertical_centering
)
24467 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24468 font_ascent
= FONT_BASE (font
) + boff
;
24469 font_descent
= FONT_DESCENT (font
) - boff
;
24470 font_height
= FONT_HEIGHT (font
);
24472 cmp
->font
= (void *) font
;
24475 if (! font_not_found_p
)
24477 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24479 pcm
= get_per_char_metric (font
, &char2b
);
24482 /* Initialize the bounding box. */
24485 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24486 ascent
= pcm
->ascent
;
24487 descent
= pcm
->descent
;
24488 lbearing
= pcm
->lbearing
;
24489 rbearing
= pcm
->rbearing
;
24493 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24494 ascent
= FONT_BASE (font
);
24495 descent
= FONT_DESCENT (font
);
24502 lowest
= - descent
+ boff
;
24503 highest
= ascent
+ boff
;
24505 if (! font_not_found_p
24506 && font
->default_ascent
24507 && CHAR_TABLE_P (Vuse_default_ascent
)
24508 && !NILP (Faref (Vuse_default_ascent
,
24509 make_number (it
->char_to_display
))))
24510 highest
= font
->default_ascent
+ boff
;
24512 /* Draw the first glyph at the normal position. It may be
24513 shifted to right later if some other glyphs are drawn
24515 cmp
->offsets
[i
* 2] = 0;
24516 cmp
->offsets
[i
* 2 + 1] = boff
;
24517 cmp
->lbearing
= lbearing
;
24518 cmp
->rbearing
= rbearing
;
24520 /* Set cmp->offsets for the remaining glyphs. */
24521 for (i
++; i
< glyph_len
; i
++)
24523 int left
, right
, btm
, top
;
24524 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24526 struct face
*this_face
;
24530 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24531 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24532 font
= this_face
->font
;
24538 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24540 pcm
= get_per_char_metric (font
, &char2b
);
24543 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24546 width
= pcm
->width
;
24547 ascent
= pcm
->ascent
;
24548 descent
= pcm
->descent
;
24549 lbearing
= pcm
->lbearing
;
24550 rbearing
= pcm
->rbearing
;
24551 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24553 /* Relative composition with or without
24554 alternate chars. */
24555 left
= (leftmost
+ rightmost
- width
) / 2;
24556 btm
= - descent
+ boff
;
24557 if (font
->relative_compose
24558 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24559 || NILP (Faref (Vignore_relative_composition
,
24560 make_number (ch
)))))
24563 if (- descent
>= font
->relative_compose
)
24564 /* One extra pixel between two glyphs. */
24566 else if (ascent
<= 0)
24567 /* One extra pixel between two glyphs. */
24568 btm
= lowest
- 1 - ascent
- descent
;
24573 /* A composition rule is specified by an integer
24574 value that encodes global and new reference
24575 points (GREF and NREF). GREF and NREF are
24576 specified by numbers as below:
24578 0---1---2 -- ascent
24582 9--10--11 -- center
24584 ---3---4---5--- baseline
24586 6---7---8 -- descent
24588 int rule
= COMPOSITION_RULE (cmp
, i
);
24589 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24591 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24592 grefx
= gref
% 3, nrefx
= nref
% 3;
24593 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24595 xoff
= font_height
* (xoff
- 128) / 256;
24597 yoff
= font_height
* (yoff
- 128) / 256;
24600 + grefx
* (rightmost
- leftmost
) / 2
24601 - nrefx
* width
/ 2
24604 btm
= ((grefy
== 0 ? highest
24606 : grefy
== 2 ? lowest
24607 : (highest
+ lowest
) / 2)
24608 - (nrefy
== 0 ? ascent
+ descent
24609 : nrefy
== 1 ? descent
- boff
24611 : (ascent
+ descent
) / 2)
24615 cmp
->offsets
[i
* 2] = left
;
24616 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24618 /* Update the bounding box of the overall glyphs. */
24621 right
= left
+ width
;
24622 if (left
< leftmost
)
24624 if (right
> rightmost
)
24627 top
= btm
+ descent
+ ascent
;
24633 if (cmp
->lbearing
> left
+ lbearing
)
24634 cmp
->lbearing
= left
+ lbearing
;
24635 if (cmp
->rbearing
< left
+ rbearing
)
24636 cmp
->rbearing
= left
+ rbearing
;
24640 /* If there are glyphs whose x-offsets are negative,
24641 shift all glyphs to the right and make all x-offsets
24645 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24646 cmp
->offsets
[i
* 2] -= leftmost
;
24647 rightmost
-= leftmost
;
24648 cmp
->lbearing
-= leftmost
;
24649 cmp
->rbearing
-= leftmost
;
24652 if (left_padded
&& cmp
->lbearing
< 0)
24654 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24655 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24656 rightmost
-= cmp
->lbearing
;
24657 cmp
->rbearing
-= cmp
->lbearing
;
24660 if (right_padded
&& rightmost
< cmp
->rbearing
)
24662 rightmost
= cmp
->rbearing
;
24665 cmp
->pixel_width
= rightmost
;
24666 cmp
->ascent
= highest
;
24667 cmp
->descent
= - lowest
;
24668 if (cmp
->ascent
< font_ascent
)
24669 cmp
->ascent
= font_ascent
;
24670 if (cmp
->descent
< font_descent
)
24671 cmp
->descent
= font_descent
;
24675 && (cmp
->lbearing
< 0
24676 || cmp
->rbearing
> cmp
->pixel_width
))
24677 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24679 it
->pixel_width
= cmp
->pixel_width
;
24680 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24681 it
->descent
= it
->phys_descent
= cmp
->descent
;
24682 if (face
->box
!= FACE_NO_BOX
)
24684 int thick
= face
->box_line_width
;
24688 it
->ascent
+= thick
;
24689 it
->descent
+= thick
;
24694 if (it
->start_of_box_run_p
)
24695 it
->pixel_width
+= thick
;
24696 if (it
->end_of_box_run_p
)
24697 it
->pixel_width
+= thick
;
24700 /* If face has an overline, add the height of the overline
24701 (1 pixel) and a 1 pixel margin to the character height. */
24702 if (face
->overline_p
)
24703 it
->ascent
+= overline_margin
;
24705 take_vertical_position_into_account (it
);
24706 if (it
->ascent
< 0)
24708 if (it
->descent
< 0)
24711 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
24712 append_composite_glyph (it
);
24714 else if (it
->what
== IT_COMPOSITION
)
24716 /* A dynamic (automatic) composition. */
24717 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24718 Lisp_Object gstring
;
24719 struct font_metrics metrics
;
24723 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24725 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24728 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24729 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24730 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24731 it
->descent
= it
->phys_descent
= metrics
.descent
;
24732 if (face
->box
!= FACE_NO_BOX
)
24734 int thick
= face
->box_line_width
;
24738 it
->ascent
+= thick
;
24739 it
->descent
+= thick
;
24744 if (it
->start_of_box_run_p
)
24745 it
->pixel_width
+= thick
;
24746 if (it
->end_of_box_run_p
)
24747 it
->pixel_width
+= thick
;
24749 /* If face has an overline, add the height of the overline
24750 (1 pixel) and a 1 pixel margin to the character height. */
24751 if (face
->overline_p
)
24752 it
->ascent
+= overline_margin
;
24753 take_vertical_position_into_account (it
);
24754 if (it
->ascent
< 0)
24756 if (it
->descent
< 0)
24760 append_composite_glyph (it
);
24762 else if (it
->what
== IT_GLYPHLESS
)
24763 produce_glyphless_glyph (it
, 0, Qnil
);
24764 else if (it
->what
== IT_IMAGE
)
24765 produce_image_glyph (it
);
24766 else if (it
->what
== IT_STRETCH
)
24767 produce_stretch_glyph (it
);
24770 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24771 because this isn't true for images with `:ascent 100'. */
24772 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24773 if (it
->area
== TEXT_AREA
)
24774 it
->current_x
+= it
->pixel_width
;
24776 if (extra_line_spacing
> 0)
24778 it
->descent
+= extra_line_spacing
;
24779 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24780 it
->max_extra_line_spacing
= extra_line_spacing
;
24783 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24784 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24785 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24786 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24790 Output LEN glyphs starting at START at the nominal cursor position.
24791 Advance the nominal cursor over the text. The global variable
24792 updated_window contains the window being updated, updated_row is
24793 the glyph row being updated, and updated_area is the area of that
24794 row being updated. */
24797 x_write_glyphs (struct glyph
*start
, int len
)
24799 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
24801 xassert (updated_window
&& updated_row
);
24802 /* When the window is hscrolled, cursor hpos can legitimately be out
24803 of bounds, but we draw the cursor at the corresponding window
24804 margin in that case. */
24805 if (!updated_row
->reversed_p
&& chpos
< 0)
24807 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
24808 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
24812 /* Write glyphs. */
24814 hpos
= start
- updated_row
->glyphs
[updated_area
];
24815 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24816 updated_row
, updated_area
,
24818 DRAW_NORMAL_TEXT
, 0);
24820 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24821 if (updated_area
== TEXT_AREA
24822 && updated_window
->phys_cursor_on_p
24823 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24825 && chpos
< hpos
+ len
)
24826 updated_window
->phys_cursor_on_p
= 0;
24830 /* Advance the output cursor. */
24831 output_cursor
.hpos
+= len
;
24832 output_cursor
.x
= x
;
24837 Insert LEN glyphs from START at the nominal cursor position. */
24840 x_insert_glyphs (struct glyph
*start
, int len
)
24844 int line_height
, shift_by_width
, shifted_region_width
;
24845 struct glyph_row
*row
;
24846 struct glyph
*glyph
;
24847 int frame_x
, frame_y
;
24850 xassert (updated_window
&& updated_row
);
24852 w
= updated_window
;
24853 f
= XFRAME (WINDOW_FRAME (w
));
24855 /* Get the height of the line we are in. */
24857 line_height
= row
->height
;
24859 /* Get the width of the glyphs to insert. */
24860 shift_by_width
= 0;
24861 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24862 shift_by_width
+= glyph
->pixel_width
;
24864 /* Get the width of the region to shift right. */
24865 shifted_region_width
= (window_box_width (w
, updated_area
)
24870 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24871 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24873 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24874 line_height
, shift_by_width
);
24876 /* Write the glyphs. */
24877 hpos
= start
- row
->glyphs
[updated_area
];
24878 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24880 DRAW_NORMAL_TEXT
, 0);
24882 /* Advance the output cursor. */
24883 output_cursor
.hpos
+= len
;
24884 output_cursor
.x
+= shift_by_width
;
24890 Erase the current text line from the nominal cursor position
24891 (inclusive) to pixel column TO_X (exclusive). The idea is that
24892 everything from TO_X onward is already erased.
24894 TO_X is a pixel position relative to updated_area of
24895 updated_window. TO_X == -1 means clear to the end of this area. */
24898 x_clear_end_of_line (int to_x
)
24901 struct window
*w
= updated_window
;
24902 int max_x
, min_y
, max_y
;
24903 int from_x
, from_y
, to_y
;
24905 xassert (updated_window
&& updated_row
);
24906 f
= XFRAME (w
->frame
);
24908 if (updated_row
->full_width_p
)
24909 max_x
= WINDOW_TOTAL_WIDTH (w
);
24911 max_x
= window_box_width (w
, updated_area
);
24912 max_y
= window_text_bottom_y (w
);
24914 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24915 of window. For TO_X > 0, truncate to end of drawing area. */
24921 to_x
= min (to_x
, max_x
);
24923 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24925 /* Notice if the cursor will be cleared by this operation. */
24926 if (!updated_row
->full_width_p
)
24927 notice_overwritten_cursor (w
, updated_area
,
24928 output_cursor
.x
, -1,
24930 MATRIX_ROW_BOTTOM_Y (updated_row
));
24932 from_x
= output_cursor
.x
;
24934 /* Translate to frame coordinates. */
24935 if (updated_row
->full_width_p
)
24937 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24938 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24942 int area_left
= window_box_left (w
, updated_area
);
24943 from_x
+= area_left
;
24947 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24948 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24949 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24951 /* Prevent inadvertently clearing to end of the X window. */
24952 if (to_x
> from_x
&& to_y
> from_y
)
24955 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24956 to_x
- from_x
, to_y
- from_y
);
24961 #endif /* HAVE_WINDOW_SYSTEM */
24965 /***********************************************************************
24967 ***********************************************************************/
24969 /* Value is the internal representation of the specified cursor type
24970 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24971 of the bar cursor. */
24973 static enum text_cursor_kinds
24974 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24976 enum text_cursor_kinds type
;
24981 if (EQ (arg
, Qbox
))
24982 return FILLED_BOX_CURSOR
;
24984 if (EQ (arg
, Qhollow
))
24985 return HOLLOW_BOX_CURSOR
;
24987 if (EQ (arg
, Qbar
))
24994 && EQ (XCAR (arg
), Qbar
)
24995 && INTEGERP (XCDR (arg
))
24996 && XINT (XCDR (arg
)) >= 0)
24998 *width
= XINT (XCDR (arg
));
25002 if (EQ (arg
, Qhbar
))
25005 return HBAR_CURSOR
;
25009 && EQ (XCAR (arg
), Qhbar
)
25010 && INTEGERP (XCDR (arg
))
25011 && XINT (XCDR (arg
)) >= 0)
25013 *width
= XINT (XCDR (arg
));
25014 return HBAR_CURSOR
;
25017 /* Treat anything unknown as "hollow box cursor".
25018 It was bad to signal an error; people have trouble fixing
25019 .Xdefaults with Emacs, when it has something bad in it. */
25020 type
= HOLLOW_BOX_CURSOR
;
25025 /* Set the default cursor types for specified frame. */
25027 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25032 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25033 FRAME_CURSOR_WIDTH (f
) = width
;
25035 /* By default, set up the blink-off state depending on the on-state. */
25037 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25040 FRAME_BLINK_OFF_CURSOR (f
)
25041 = get_specified_cursor_type (XCDR (tem
), &width
);
25042 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25045 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25049 #ifdef HAVE_WINDOW_SYSTEM
25051 /* Return the cursor we want to be displayed in window W. Return
25052 width of bar/hbar cursor through WIDTH arg. Return with
25053 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25054 (i.e. if the `system caret' should track this cursor).
25056 In a mini-buffer window, we want the cursor only to appear if we
25057 are reading input from this window. For the selected window, we
25058 want the cursor type given by the frame parameter or buffer local
25059 setting of cursor-type. If explicitly marked off, draw no cursor.
25060 In all other cases, we want a hollow box cursor. */
25062 static enum text_cursor_kinds
25063 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25064 int *active_cursor
)
25066 struct frame
*f
= XFRAME (w
->frame
);
25067 struct buffer
*b
= XBUFFER (w
->buffer
);
25068 int cursor_type
= DEFAULT_CURSOR
;
25069 Lisp_Object alt_cursor
;
25070 int non_selected
= 0;
25072 *active_cursor
= 1;
25075 if (cursor_in_echo_area
25076 && FRAME_HAS_MINIBUF_P (f
)
25077 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25079 if (w
== XWINDOW (echo_area_window
))
25081 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25083 *width
= FRAME_CURSOR_WIDTH (f
);
25084 return FRAME_DESIRED_CURSOR (f
);
25087 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25090 *active_cursor
= 0;
25094 /* Detect a nonselected window or nonselected frame. */
25095 else if (w
!= XWINDOW (f
->selected_window
)
25096 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25098 *active_cursor
= 0;
25100 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25106 /* Never display a cursor in a window in which cursor-type is nil. */
25107 if (NILP (BVAR (b
, cursor_type
)))
25110 /* Get the normal cursor type for this window. */
25111 if (EQ (BVAR (b
, cursor_type
), Qt
))
25113 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25114 *width
= FRAME_CURSOR_WIDTH (f
);
25117 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25119 /* Use cursor-in-non-selected-windows instead
25120 for non-selected window or frame. */
25123 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25124 if (!EQ (Qt
, alt_cursor
))
25125 return get_specified_cursor_type (alt_cursor
, width
);
25126 /* t means modify the normal cursor type. */
25127 if (cursor_type
== FILLED_BOX_CURSOR
)
25128 cursor_type
= HOLLOW_BOX_CURSOR
;
25129 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25131 return cursor_type
;
25134 /* Use normal cursor if not blinked off. */
25135 if (!w
->cursor_off_p
)
25137 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25139 if (cursor_type
== FILLED_BOX_CURSOR
)
25141 /* Using a block cursor on large images can be very annoying.
25142 So use a hollow cursor for "large" images.
25143 If image is not transparent (no mask), also use hollow cursor. */
25144 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25145 if (img
!= NULL
&& IMAGEP (img
->spec
))
25147 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25148 where N = size of default frame font size.
25149 This should cover most of the "tiny" icons people may use. */
25151 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25152 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25153 cursor_type
= HOLLOW_BOX_CURSOR
;
25156 else if (cursor_type
!= NO_CURSOR
)
25158 /* Display current only supports BOX and HOLLOW cursors for images.
25159 So for now, unconditionally use a HOLLOW cursor when cursor is
25160 not a solid box cursor. */
25161 cursor_type
= HOLLOW_BOX_CURSOR
;
25164 return cursor_type
;
25167 /* Cursor is blinked off, so determine how to "toggle" it. */
25169 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25170 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25171 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25173 /* Then see if frame has specified a specific blink off cursor type. */
25174 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25176 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25177 return FRAME_BLINK_OFF_CURSOR (f
);
25181 /* Some people liked having a permanently visible blinking cursor,
25182 while others had very strong opinions against it. So it was
25183 decided to remove it. KFS 2003-09-03 */
25185 /* Finally perform built-in cursor blinking:
25186 filled box <-> hollow box
25187 wide [h]bar <-> narrow [h]bar
25188 narrow [h]bar <-> no cursor
25189 other type <-> no cursor */
25191 if (cursor_type
== FILLED_BOX_CURSOR
)
25192 return HOLLOW_BOX_CURSOR
;
25194 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25197 return cursor_type
;
25205 /* Notice when the text cursor of window W has been completely
25206 overwritten by a drawing operation that outputs glyphs in AREA
25207 starting at X0 and ending at X1 in the line starting at Y0 and
25208 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25209 the rest of the line after X0 has been written. Y coordinates
25210 are window-relative. */
25213 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25214 int x0
, int x1
, int y0
, int y1
)
25216 int cx0
, cx1
, cy0
, cy1
;
25217 struct glyph_row
*row
;
25219 if (!w
->phys_cursor_on_p
)
25221 if (area
!= TEXT_AREA
)
25224 if (w
->phys_cursor
.vpos
< 0
25225 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25226 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25227 !(row
->enabled_p
&& row
->displays_text_p
)))
25230 if (row
->cursor_in_fringe_p
)
25232 row
->cursor_in_fringe_p
= 0;
25233 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25234 w
->phys_cursor_on_p
= 0;
25238 cx0
= w
->phys_cursor
.x
;
25239 cx1
= cx0
+ w
->phys_cursor_width
;
25240 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25243 /* The cursor image will be completely removed from the
25244 screen if the output area intersects the cursor area in
25245 y-direction. When we draw in [y0 y1[, and some part of
25246 the cursor is at y < y0, that part must have been drawn
25247 before. When scrolling, the cursor is erased before
25248 actually scrolling, so we don't come here. When not
25249 scrolling, the rows above the old cursor row must have
25250 changed, and in this case these rows must have written
25251 over the cursor image.
25253 Likewise if part of the cursor is below y1, with the
25254 exception of the cursor being in the first blank row at
25255 the buffer and window end because update_text_area
25256 doesn't draw that row. (Except when it does, but
25257 that's handled in update_text_area.) */
25259 cy0
= w
->phys_cursor
.y
;
25260 cy1
= cy0
+ w
->phys_cursor_height
;
25261 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25264 w
->phys_cursor_on_p
= 0;
25267 #endif /* HAVE_WINDOW_SYSTEM */
25270 /************************************************************************
25272 ************************************************************************/
25274 #ifdef HAVE_WINDOW_SYSTEM
25277 Fix the display of area AREA of overlapping row ROW in window W
25278 with respect to the overlapping part OVERLAPS. */
25281 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25282 enum glyph_row_area area
, int overlaps
)
25289 for (i
= 0; i
< row
->used
[area
];)
25291 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25293 int start
= i
, start_x
= x
;
25297 x
+= row
->glyphs
[area
][i
].pixel_width
;
25300 while (i
< row
->used
[area
]
25301 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25303 draw_glyphs (w
, start_x
, row
, area
,
25305 DRAW_NORMAL_TEXT
, overlaps
);
25309 x
+= row
->glyphs
[area
][i
].pixel_width
;
25319 Draw the cursor glyph of window W in glyph row ROW. See the
25320 comment of draw_glyphs for the meaning of HL. */
25323 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25324 enum draw_glyphs_face hl
)
25326 /* If cursor hpos is out of bounds, don't draw garbage. This can
25327 happen in mini-buffer windows when switching between echo area
25328 glyphs and mini-buffer. */
25329 if ((row
->reversed_p
25330 ? (w
->phys_cursor
.hpos
>= 0)
25331 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25333 int on_p
= w
->phys_cursor_on_p
;
25335 int hpos
= w
->phys_cursor
.hpos
;
25337 /* When the window is hscrolled, cursor hpos can legitimately be
25338 out of bounds, but we draw the cursor at the corresponding
25339 window margin in that case. */
25340 if (!row
->reversed_p
&& hpos
< 0)
25342 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25343 hpos
= row
->used
[TEXT_AREA
] - 1;
25345 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25347 w
->phys_cursor_on_p
= on_p
;
25349 if (hl
== DRAW_CURSOR
)
25350 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25351 /* When we erase the cursor, and ROW is overlapped by other
25352 rows, make sure that these overlapping parts of other rows
25354 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25356 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25358 if (row
> w
->current_matrix
->rows
25359 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25360 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25361 OVERLAPS_ERASED_CURSOR
);
25363 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25364 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25365 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25366 OVERLAPS_ERASED_CURSOR
);
25373 Erase the image of a cursor of window W from the screen. */
25376 erase_phys_cursor (struct window
*w
)
25378 struct frame
*f
= XFRAME (w
->frame
);
25379 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25380 int hpos
= w
->phys_cursor
.hpos
;
25381 int vpos
= w
->phys_cursor
.vpos
;
25382 int mouse_face_here_p
= 0;
25383 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25384 struct glyph_row
*cursor_row
;
25385 struct glyph
*cursor_glyph
;
25386 enum draw_glyphs_face hl
;
25388 /* No cursor displayed or row invalidated => nothing to do on the
25390 if (w
->phys_cursor_type
== NO_CURSOR
)
25391 goto mark_cursor_off
;
25393 /* VPOS >= active_glyphs->nrows means that window has been resized.
25394 Don't bother to erase the cursor. */
25395 if (vpos
>= active_glyphs
->nrows
)
25396 goto mark_cursor_off
;
25398 /* If row containing cursor is marked invalid, there is nothing we
25400 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25401 if (!cursor_row
->enabled_p
)
25402 goto mark_cursor_off
;
25404 /* If line spacing is > 0, old cursor may only be partially visible in
25405 window after split-window. So adjust visible height. */
25406 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25407 window_text_bottom_y (w
) - cursor_row
->y
);
25409 /* If row is completely invisible, don't attempt to delete a cursor which
25410 isn't there. This can happen if cursor is at top of a window, and
25411 we switch to a buffer with a header line in that window. */
25412 if (cursor_row
->visible_height
<= 0)
25413 goto mark_cursor_off
;
25415 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25416 if (cursor_row
->cursor_in_fringe_p
)
25418 cursor_row
->cursor_in_fringe_p
= 0;
25419 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25420 goto mark_cursor_off
;
25423 /* This can happen when the new row is shorter than the old one.
25424 In this case, either draw_glyphs or clear_end_of_line
25425 should have cleared the cursor. Note that we wouldn't be
25426 able to erase the cursor in this case because we don't have a
25427 cursor glyph at hand. */
25428 if ((cursor_row
->reversed_p
25429 ? (w
->phys_cursor
.hpos
< 0)
25430 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25431 goto mark_cursor_off
;
25433 /* When the window is hscrolled, cursor hpos can legitimately be out
25434 of bounds, but we draw the cursor at the corresponding window
25435 margin in that case. */
25436 if (!cursor_row
->reversed_p
&& hpos
< 0)
25438 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25439 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25441 /* If the cursor is in the mouse face area, redisplay that when
25442 we clear the cursor. */
25443 if (! NILP (hlinfo
->mouse_face_window
)
25444 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25445 /* Don't redraw the cursor's spot in mouse face if it is at the
25446 end of a line (on a newline). The cursor appears there, but
25447 mouse highlighting does not. */
25448 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25449 mouse_face_here_p
= 1;
25451 /* Maybe clear the display under the cursor. */
25452 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25455 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25458 cursor_glyph
= get_phys_cursor_glyph (w
);
25459 if (cursor_glyph
== NULL
)
25460 goto mark_cursor_off
;
25462 width
= cursor_glyph
->pixel_width
;
25463 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25464 x
= w
->phys_cursor
.x
;
25466 width
-= left_x
- x
;
25467 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25468 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25469 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25472 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25475 /* Erase the cursor by redrawing the character underneath it. */
25476 if (mouse_face_here_p
)
25477 hl
= DRAW_MOUSE_FACE
;
25479 hl
= DRAW_NORMAL_TEXT
;
25480 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25483 w
->phys_cursor_on_p
= 0;
25484 w
->phys_cursor_type
= NO_CURSOR
;
25489 Display or clear cursor of window W. If ON is zero, clear the
25490 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25491 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25494 display_and_set_cursor (struct window
*w
, int on
,
25495 int hpos
, int vpos
, int x
, int y
)
25497 struct frame
*f
= XFRAME (w
->frame
);
25498 int new_cursor_type
;
25499 int new_cursor_width
;
25501 struct glyph_row
*glyph_row
;
25502 struct glyph
*glyph
;
25504 /* This is pointless on invisible frames, and dangerous on garbaged
25505 windows and frames; in the latter case, the frame or window may
25506 be in the midst of changing its size, and x and y may be off the
25508 if (! FRAME_VISIBLE_P (f
)
25509 || FRAME_GARBAGED_P (f
)
25510 || vpos
>= w
->current_matrix
->nrows
25511 || hpos
>= w
->current_matrix
->matrix_w
)
25514 /* If cursor is off and we want it off, return quickly. */
25515 if (!on
&& !w
->phys_cursor_on_p
)
25518 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25519 /* If cursor row is not enabled, we don't really know where to
25520 display the cursor. */
25521 if (!glyph_row
->enabled_p
)
25523 w
->phys_cursor_on_p
= 0;
25528 if (!glyph_row
->exact_window_width_line_p
25529 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25530 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25532 xassert (interrupt_input_blocked
);
25534 /* Set new_cursor_type to the cursor we want to be displayed. */
25535 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25536 &new_cursor_width
, &active_cursor
);
25538 /* If cursor is currently being shown and we don't want it to be or
25539 it is in the wrong place, or the cursor type is not what we want,
25541 if (w
->phys_cursor_on_p
25543 || w
->phys_cursor
.x
!= x
25544 || w
->phys_cursor
.y
!= y
25545 || new_cursor_type
!= w
->phys_cursor_type
25546 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25547 && new_cursor_width
!= w
->phys_cursor_width
)))
25548 erase_phys_cursor (w
);
25550 /* Don't check phys_cursor_on_p here because that flag is only set
25551 to zero in some cases where we know that the cursor has been
25552 completely erased, to avoid the extra work of erasing the cursor
25553 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25554 still not be visible, or it has only been partly erased. */
25557 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25558 w
->phys_cursor_height
= glyph_row
->height
;
25560 /* Set phys_cursor_.* before x_draw_.* is called because some
25561 of them may need the information. */
25562 w
->phys_cursor
.x
= x
;
25563 w
->phys_cursor
.y
= glyph_row
->y
;
25564 w
->phys_cursor
.hpos
= hpos
;
25565 w
->phys_cursor
.vpos
= vpos
;
25568 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25569 new_cursor_type
, new_cursor_width
,
25570 on
, active_cursor
);
25574 /* Switch the display of W's cursor on or off, according to the value
25578 update_window_cursor (struct window
*w
, int on
)
25580 /* Don't update cursor in windows whose frame is in the process
25581 of being deleted. */
25582 if (w
->current_matrix
)
25584 int hpos
= w
->phys_cursor
.hpos
;
25585 int vpos
= w
->phys_cursor
.vpos
;
25586 struct glyph_row
*row
;
25588 if (vpos
>= w
->current_matrix
->nrows
25589 || hpos
>= w
->current_matrix
->matrix_w
)
25592 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25594 /* When the window is hscrolled, cursor hpos can legitimately be
25595 out of bounds, but we draw the cursor at the corresponding
25596 window margin in that case. */
25597 if (!row
->reversed_p
&& hpos
< 0)
25599 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25600 hpos
= row
->used
[TEXT_AREA
] - 1;
25603 display_and_set_cursor (w
, on
, hpos
, vpos
,
25604 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25610 /* Call update_window_cursor with parameter ON_P on all leaf windows
25611 in the window tree rooted at W. */
25614 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25618 if (!NILP (w
->hchild
))
25619 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25620 else if (!NILP (w
->vchild
))
25621 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25623 update_window_cursor (w
, on_p
);
25625 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25631 Display the cursor on window W, or clear it, according to ON_P.
25632 Don't change the cursor's position. */
25635 x_update_cursor (struct frame
*f
, int on_p
)
25637 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25642 Clear the cursor of window W to background color, and mark the
25643 cursor as not shown. This is used when the text where the cursor
25644 is about to be rewritten. */
25647 x_clear_cursor (struct window
*w
)
25649 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25650 update_window_cursor (w
, 0);
25653 #endif /* HAVE_WINDOW_SYSTEM */
25655 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25658 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25659 int start_hpos
, int end_hpos
,
25660 enum draw_glyphs_face draw
)
25662 #ifdef HAVE_WINDOW_SYSTEM
25663 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25665 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25669 #if defined (HAVE_GPM) || defined (MSDOS)
25670 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25674 /* Display the active region described by mouse_face_* according to DRAW. */
25677 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25679 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25680 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25682 if (/* If window is in the process of being destroyed, don't bother
25684 w
->current_matrix
!= NULL
25685 /* Don't update mouse highlight if hidden */
25686 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25687 /* Recognize when we are called to operate on rows that don't exist
25688 anymore. This can happen when a window is split. */
25689 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25691 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25692 struct glyph_row
*row
, *first
, *last
;
25694 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25695 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25697 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25699 int start_hpos
, end_hpos
, start_x
;
25701 /* For all but the first row, the highlight starts at column 0. */
25704 /* R2L rows have BEG and END in reversed order, but the
25705 screen drawing geometry is always left to right. So
25706 we need to mirror the beginning and end of the
25707 highlighted area in R2L rows. */
25708 if (!row
->reversed_p
)
25710 start_hpos
= hlinfo
->mouse_face_beg_col
;
25711 start_x
= hlinfo
->mouse_face_beg_x
;
25713 else if (row
== last
)
25715 start_hpos
= hlinfo
->mouse_face_end_col
;
25716 start_x
= hlinfo
->mouse_face_end_x
;
25724 else if (row
->reversed_p
&& row
== last
)
25726 start_hpos
= hlinfo
->mouse_face_end_col
;
25727 start_x
= hlinfo
->mouse_face_end_x
;
25737 if (!row
->reversed_p
)
25738 end_hpos
= hlinfo
->mouse_face_end_col
;
25739 else if (row
== first
)
25740 end_hpos
= hlinfo
->mouse_face_beg_col
;
25743 end_hpos
= row
->used
[TEXT_AREA
];
25744 if (draw
== DRAW_NORMAL_TEXT
)
25745 row
->fill_line_p
= 1; /* Clear to end of line */
25748 else if (row
->reversed_p
&& row
== first
)
25749 end_hpos
= hlinfo
->mouse_face_beg_col
;
25752 end_hpos
= row
->used
[TEXT_AREA
];
25753 if (draw
== DRAW_NORMAL_TEXT
)
25754 row
->fill_line_p
= 1; /* Clear to end of line */
25757 if (end_hpos
> start_hpos
)
25759 draw_row_with_mouse_face (w
, start_x
, row
,
25760 start_hpos
, end_hpos
, draw
);
25763 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25767 #ifdef HAVE_WINDOW_SYSTEM
25768 /* When we've written over the cursor, arrange for it to
25769 be displayed again. */
25770 if (FRAME_WINDOW_P (f
)
25771 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25773 int hpos
= w
->phys_cursor
.hpos
;
25775 /* When the window is hscrolled, cursor hpos can legitimately be
25776 out of bounds, but we draw the cursor at the corresponding
25777 window margin in that case. */
25778 if (!row
->reversed_p
&& hpos
< 0)
25780 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25781 hpos
= row
->used
[TEXT_AREA
] - 1;
25784 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
25785 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25788 #endif /* HAVE_WINDOW_SYSTEM */
25791 #ifdef HAVE_WINDOW_SYSTEM
25792 /* Change the mouse cursor. */
25793 if (FRAME_WINDOW_P (f
))
25795 if (draw
== DRAW_NORMAL_TEXT
25796 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25797 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25798 else if (draw
== DRAW_MOUSE_FACE
)
25799 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25801 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25803 #endif /* HAVE_WINDOW_SYSTEM */
25807 Clear out the mouse-highlighted active region.
25808 Redraw it un-highlighted first. Value is non-zero if mouse
25809 face was actually drawn unhighlighted. */
25812 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25816 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25818 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25822 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25823 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25824 hlinfo
->mouse_face_window
= Qnil
;
25825 hlinfo
->mouse_face_overlay
= Qnil
;
25829 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25830 within the mouse face on that window. */
25832 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25834 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25836 /* Quickly resolve the easy cases. */
25837 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25838 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25840 if (vpos
< hlinfo
->mouse_face_beg_row
25841 || vpos
> hlinfo
->mouse_face_end_row
)
25843 if (vpos
> hlinfo
->mouse_face_beg_row
25844 && vpos
< hlinfo
->mouse_face_end_row
)
25847 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25849 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25851 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25854 else if ((vpos
== hlinfo
->mouse_face_beg_row
25855 && hpos
>= hlinfo
->mouse_face_beg_col
)
25856 || (vpos
== hlinfo
->mouse_face_end_row
25857 && hpos
< hlinfo
->mouse_face_end_col
))
25862 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25864 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25867 else if ((vpos
== hlinfo
->mouse_face_beg_row
25868 && hpos
<= hlinfo
->mouse_face_beg_col
)
25869 || (vpos
== hlinfo
->mouse_face_end_row
25870 && hpos
> hlinfo
->mouse_face_end_col
))
25878 Non-zero if physical cursor of window W is within mouse face. */
25881 cursor_in_mouse_face_p (struct window
*w
)
25883 int hpos
= w
->phys_cursor
.hpos
;
25884 int vpos
= w
->phys_cursor
.vpos
;
25885 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25887 /* When the window is hscrolled, cursor hpos can legitimately be out
25888 of bounds, but we draw the cursor at the corresponding window
25889 margin in that case. */
25890 if (!row
->reversed_p
&& hpos
< 0)
25892 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25893 hpos
= row
->used
[TEXT_AREA
] - 1;
25895 return coords_in_mouse_face_p (w
, hpos
, vpos
);
25900 /* Find the glyph rows START_ROW and END_ROW of window W that display
25901 characters between buffer positions START_CHARPOS and END_CHARPOS
25902 (excluding END_CHARPOS). DISP_STRING is a display string that
25903 covers these buffer positions. This is similar to
25904 row_containing_pos, but is more accurate when bidi reordering makes
25905 buffer positions change non-linearly with glyph rows. */
25907 rows_from_pos_range (struct window
*w
,
25908 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25909 Lisp_Object disp_string
,
25910 struct glyph_row
**start
, struct glyph_row
**end
)
25912 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25913 int last_y
= window_text_bottom_y (w
);
25914 struct glyph_row
*row
;
25919 while (!first
->enabled_p
25920 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25923 /* Find the START row. */
25925 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25928 /* A row can potentially be the START row if the range of the
25929 characters it displays intersects the range
25930 [START_CHARPOS..END_CHARPOS). */
25931 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25932 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25933 /* See the commentary in row_containing_pos, for the
25934 explanation of the complicated way to check whether
25935 some position is beyond the end of the characters
25936 displayed by a row. */
25937 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25938 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25939 && !row
->ends_at_zv_p
25940 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25941 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25942 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25943 && !row
->ends_at_zv_p
25944 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25946 /* Found a candidate row. Now make sure at least one of the
25947 glyphs it displays has a charpos from the range
25948 [START_CHARPOS..END_CHARPOS).
25950 This is not obvious because bidi reordering could make
25951 buffer positions of a row be 1,2,3,102,101,100, and if we
25952 want to highlight characters in [50..60), we don't want
25953 this row, even though [50..60) does intersect [1..103),
25954 the range of character positions given by the row's start
25955 and end positions. */
25956 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25957 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25961 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25962 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25963 /* A glyph that comes from DISP_STRING is by
25964 definition to be highlighted. */
25965 || EQ (g
->object
, disp_string
))
25974 /* Find the END row. */
25976 /* If the last row is partially visible, start looking for END
25977 from that row, instead of starting from FIRST. */
25978 && !(row
->enabled_p
25979 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25981 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25983 struct glyph_row
*next
= row
+ 1;
25984 EMACS_INT next_start
= MATRIX_ROW_START_CHARPOS (next
);
25986 if (!next
->enabled_p
25987 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25988 /* The first row >= START whose range of displayed characters
25989 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25990 is the row END + 1. */
25991 || (start_charpos
< next_start
25992 && end_charpos
< next_start
)
25993 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25994 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25995 && !next
->ends_at_zv_p
25996 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25997 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25998 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25999 && !next
->ends_at_zv_p
26000 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26007 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26008 but none of the characters it displays are in the range, it is
26010 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26011 struct glyph
*s
= g
;
26012 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26016 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26017 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26018 /* If the buffer position of the first glyph in
26019 the row is equal to END_CHARPOS, it means
26020 the last character to be highlighted is the
26021 newline of ROW, and we must consider NEXT as
26023 || (((!next
->reversed_p
&& g
== s
)
26024 || (next
->reversed_p
&& g
== e
- 1))
26025 && (g
->charpos
== end_charpos
26026 /* Special case for when NEXT is an
26027 empty line at ZV. */
26028 || (g
->charpos
== -1
26029 && !row
->ends_at_zv_p
26030 && next_start
== end_charpos
)))))
26031 /* A glyph that comes from DISP_STRING is by
26032 definition to be highlighted. */
26033 || EQ (g
->object
, disp_string
))
26042 /* The first row that ends at ZV must be the last to be
26044 else if (next
->ends_at_zv_p
)
26053 /* This function sets the mouse_face_* elements of HLINFO, assuming
26054 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26055 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26056 for the overlay or run of text properties specifying the mouse
26057 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26058 before-string and after-string that must also be highlighted.
26059 DISP_STRING, if non-nil, is a display string that may cover some
26060 or all of the highlighted text. */
26063 mouse_face_from_buffer_pos (Lisp_Object window
,
26064 Mouse_HLInfo
*hlinfo
,
26065 EMACS_INT mouse_charpos
,
26066 EMACS_INT start_charpos
,
26067 EMACS_INT end_charpos
,
26068 Lisp_Object before_string
,
26069 Lisp_Object after_string
,
26070 Lisp_Object disp_string
)
26072 struct window
*w
= XWINDOW (window
);
26073 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26074 struct glyph_row
*r1
, *r2
;
26075 struct glyph
*glyph
, *end
;
26076 EMACS_INT ignore
, pos
;
26079 xassert (NILP (disp_string
) || STRINGP (disp_string
));
26080 xassert (NILP (before_string
) || STRINGP (before_string
));
26081 xassert (NILP (after_string
) || STRINGP (after_string
));
26083 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26084 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26086 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26087 /* If the before-string or display-string contains newlines,
26088 rows_from_pos_range skips to its last row. Move back. */
26089 if (!NILP (before_string
) || !NILP (disp_string
))
26091 struct glyph_row
*prev
;
26092 while ((prev
= r1
- 1, prev
>= first
)
26093 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26094 && prev
->used
[TEXT_AREA
] > 0)
26096 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26097 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26098 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26100 || !(EQ (glyph
->object
, before_string
)
26101 || EQ (glyph
->object
, disp_string
)))
26108 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26109 hlinfo
->mouse_face_past_end
= 1;
26111 else if (!NILP (after_string
))
26113 /* If the after-string has newlines, advance to its last row. */
26114 struct glyph_row
*next
;
26115 struct glyph_row
*last
26116 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26118 for (next
= r2
+ 1;
26120 && next
->used
[TEXT_AREA
] > 0
26121 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26125 /* The rest of the display engine assumes that mouse_face_beg_row is
26126 either above mouse_face_end_row or identical to it. But with
26127 bidi-reordered continued lines, the row for START_CHARPOS could
26128 be below the row for END_CHARPOS. If so, swap the rows and store
26129 them in correct order. */
26132 struct glyph_row
*tem
= r2
;
26138 hlinfo
->mouse_face_beg_y
= r1
->y
;
26139 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26140 hlinfo
->mouse_face_end_y
= r2
->y
;
26141 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26143 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26144 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26145 could be anywhere in the row and in any order. The strategy
26146 below is to find the leftmost and the rightmost glyph that
26147 belongs to either of these 3 strings, or whose position is
26148 between START_CHARPOS and END_CHARPOS, and highlight all the
26149 glyphs between those two. This may cover more than just the text
26150 between START_CHARPOS and END_CHARPOS if the range of characters
26151 strides the bidi level boundary, e.g. if the beginning is in R2L
26152 text while the end is in L2R text or vice versa. */
26153 if (!r1
->reversed_p
)
26155 /* This row is in a left to right paragraph. Scan it left to
26157 glyph
= r1
->glyphs
[TEXT_AREA
];
26158 end
= glyph
+ r1
->used
[TEXT_AREA
];
26161 /* Skip truncation glyphs at the start of the glyph row. */
26162 if (r1
->displays_text_p
)
26164 && INTEGERP (glyph
->object
)
26165 && glyph
->charpos
< 0;
26167 x
+= glyph
->pixel_width
;
26169 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26170 or DISP_STRING, and the first glyph from buffer whose
26171 position is between START_CHARPOS and END_CHARPOS. */
26173 && !INTEGERP (glyph
->object
)
26174 && !EQ (glyph
->object
, disp_string
)
26175 && !(BUFFERP (glyph
->object
)
26176 && (glyph
->charpos
>= start_charpos
26177 && glyph
->charpos
< end_charpos
));
26180 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26181 are present at buffer positions between START_CHARPOS and
26182 END_CHARPOS, or if they come from an overlay. */
26183 if (EQ (glyph
->object
, before_string
))
26185 pos
= string_buffer_position (before_string
,
26187 /* If pos == 0, it means before_string came from an
26188 overlay, not from a buffer position. */
26189 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26192 else if (EQ (glyph
->object
, after_string
))
26194 pos
= string_buffer_position (after_string
, end_charpos
);
26195 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26198 x
+= glyph
->pixel_width
;
26200 hlinfo
->mouse_face_beg_x
= x
;
26201 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26205 /* This row is in a right to left paragraph. Scan it right to
26209 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26210 glyph
= end
+ r1
->used
[TEXT_AREA
];
26212 /* Skip truncation glyphs at the start of the glyph row. */
26213 if (r1
->displays_text_p
)
26215 && INTEGERP (glyph
->object
)
26216 && glyph
->charpos
< 0;
26220 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26221 or DISP_STRING, and the first glyph from buffer whose
26222 position is between START_CHARPOS and END_CHARPOS. */
26224 && !INTEGERP (glyph
->object
)
26225 && !EQ (glyph
->object
, disp_string
)
26226 && !(BUFFERP (glyph
->object
)
26227 && (glyph
->charpos
>= start_charpos
26228 && glyph
->charpos
< end_charpos
));
26231 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26232 are present at buffer positions between START_CHARPOS and
26233 END_CHARPOS, or if they come from an overlay. */
26234 if (EQ (glyph
->object
, before_string
))
26236 pos
= string_buffer_position (before_string
, start_charpos
);
26237 /* If pos == 0, it means before_string came from an
26238 overlay, not from a buffer position. */
26239 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26242 else if (EQ (glyph
->object
, after_string
))
26244 pos
= string_buffer_position (after_string
, end_charpos
);
26245 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26250 glyph
++; /* first glyph to the right of the highlighted area */
26251 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26252 x
+= g
->pixel_width
;
26253 hlinfo
->mouse_face_beg_x
= x
;
26254 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26257 /* If the highlight ends in a different row, compute GLYPH and END
26258 for the end row. Otherwise, reuse the values computed above for
26259 the row where the highlight begins. */
26262 if (!r2
->reversed_p
)
26264 glyph
= r2
->glyphs
[TEXT_AREA
];
26265 end
= glyph
+ r2
->used
[TEXT_AREA
];
26270 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26271 glyph
= end
+ r2
->used
[TEXT_AREA
];
26275 if (!r2
->reversed_p
)
26277 /* Skip truncation and continuation glyphs near the end of the
26278 row, and also blanks and stretch glyphs inserted by
26279 extend_face_to_end_of_line. */
26281 && INTEGERP ((end
- 1)->object
))
26283 /* Scan the rest of the glyph row from the end, looking for the
26284 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26285 DISP_STRING, or whose position is between START_CHARPOS
26289 && !INTEGERP (end
->object
)
26290 && !EQ (end
->object
, disp_string
)
26291 && !(BUFFERP (end
->object
)
26292 && (end
->charpos
>= start_charpos
26293 && end
->charpos
< end_charpos
));
26296 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26297 are present at buffer positions between START_CHARPOS and
26298 END_CHARPOS, or if they come from an overlay. */
26299 if (EQ (end
->object
, before_string
))
26301 pos
= string_buffer_position (before_string
, start_charpos
);
26302 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26305 else if (EQ (end
->object
, after_string
))
26307 pos
= string_buffer_position (after_string
, end_charpos
);
26308 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26312 /* Find the X coordinate of the last glyph to be highlighted. */
26313 for (; glyph
<= end
; ++glyph
)
26314 x
+= glyph
->pixel_width
;
26316 hlinfo
->mouse_face_end_x
= x
;
26317 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26321 /* Skip truncation and continuation glyphs near the end of the
26322 row, and also blanks and stretch glyphs inserted by
26323 extend_face_to_end_of_line. */
26327 && INTEGERP (end
->object
))
26329 x
+= end
->pixel_width
;
26332 /* Scan the rest of the glyph row from the end, looking for the
26333 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26334 DISP_STRING, or whose position is between START_CHARPOS
26338 && !INTEGERP (end
->object
)
26339 && !EQ (end
->object
, disp_string
)
26340 && !(BUFFERP (end
->object
)
26341 && (end
->charpos
>= start_charpos
26342 && end
->charpos
< end_charpos
));
26345 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26346 are present at buffer positions between START_CHARPOS and
26347 END_CHARPOS, or if they come from an overlay. */
26348 if (EQ (end
->object
, before_string
))
26350 pos
= string_buffer_position (before_string
, start_charpos
);
26351 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26354 else if (EQ (end
->object
, after_string
))
26356 pos
= string_buffer_position (after_string
, end_charpos
);
26357 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26360 x
+= end
->pixel_width
;
26362 /* If we exited the above loop because we arrived at the last
26363 glyph of the row, and its buffer position is still not in
26364 range, it means the last character in range is the preceding
26365 newline. Bump the end column and x values to get past the
26368 && BUFFERP (end
->object
)
26369 && (end
->charpos
< start_charpos
26370 || end
->charpos
>= end_charpos
))
26372 x
+= end
->pixel_width
;
26375 hlinfo
->mouse_face_end_x
= x
;
26376 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26379 hlinfo
->mouse_face_window
= window
;
26380 hlinfo
->mouse_face_face_id
26381 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26383 !hlinfo
->mouse_face_hidden
, -1);
26384 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26387 /* The following function is not used anymore (replaced with
26388 mouse_face_from_string_pos), but I leave it here for the time
26389 being, in case someone would. */
26391 #if 0 /* not used */
26393 /* Find the position of the glyph for position POS in OBJECT in
26394 window W's current matrix, and return in *X, *Y the pixel
26395 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26397 RIGHT_P non-zero means return the position of the right edge of the
26398 glyph, RIGHT_P zero means return the left edge position.
26400 If no glyph for POS exists in the matrix, return the position of
26401 the glyph with the next smaller position that is in the matrix, if
26402 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26403 exists in the matrix, return the position of the glyph with the
26404 next larger position in OBJECT.
26406 Value is non-zero if a glyph was found. */
26409 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26410 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26412 int yb
= window_text_bottom_y (w
);
26413 struct glyph_row
*r
;
26414 struct glyph
*best_glyph
= NULL
;
26415 struct glyph_row
*best_row
= NULL
;
26418 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26419 r
->enabled_p
&& r
->y
< yb
;
26422 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26423 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26426 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26427 if (EQ (g
->object
, object
))
26429 if (g
->charpos
== pos
)
26436 else if (best_glyph
== NULL
26437 || ((eabs (g
->charpos
- pos
)
26438 < eabs (best_glyph
->charpos
- pos
))
26441 : g
->charpos
> pos
)))
26455 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26459 *x
+= best_glyph
->pixel_width
;
26464 *vpos
= best_row
- w
->current_matrix
->rows
;
26467 return best_glyph
!= NULL
;
26469 #endif /* not used */
26471 /* Find the positions of the first and the last glyphs in window W's
26472 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26473 (assumed to be a string), and return in HLINFO's mouse_face_*
26474 members the pixel and column/row coordinates of those glyphs. */
26477 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26478 Lisp_Object object
,
26479 EMACS_INT startpos
, EMACS_INT endpos
)
26481 int yb
= window_text_bottom_y (w
);
26482 struct glyph_row
*r
;
26483 struct glyph
*g
, *e
;
26487 /* Find the glyph row with at least one position in the range
26488 [STARTPOS..ENDPOS], and the first glyph in that row whose
26489 position belongs to that range. */
26490 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26491 r
->enabled_p
&& r
->y
< yb
;
26494 if (!r
->reversed_p
)
26496 g
= r
->glyphs
[TEXT_AREA
];
26497 e
= g
+ r
->used
[TEXT_AREA
];
26498 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26499 if (EQ (g
->object
, object
)
26500 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26502 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26503 hlinfo
->mouse_face_beg_y
= r
->y
;
26504 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26505 hlinfo
->mouse_face_beg_x
= gx
;
26514 e
= r
->glyphs
[TEXT_AREA
];
26515 g
= e
+ r
->used
[TEXT_AREA
];
26516 for ( ; g
> e
; --g
)
26517 if (EQ ((g
-1)->object
, object
)
26518 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26520 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26521 hlinfo
->mouse_face_beg_y
= r
->y
;
26522 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26523 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26524 gx
+= g1
->pixel_width
;
26525 hlinfo
->mouse_face_beg_x
= gx
;
26537 /* Starting with the next row, look for the first row which does NOT
26538 include any glyphs whose positions are in the range. */
26539 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26541 g
= r
->glyphs
[TEXT_AREA
];
26542 e
= g
+ r
->used
[TEXT_AREA
];
26544 for ( ; g
< e
; ++g
)
26545 if (EQ (g
->object
, object
)
26546 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26555 /* The highlighted region ends on the previous row. */
26558 /* Set the end row and its vertical pixel coordinate. */
26559 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26560 hlinfo
->mouse_face_end_y
= r
->y
;
26562 /* Compute and set the end column and the end column's horizontal
26563 pixel coordinate. */
26564 if (!r
->reversed_p
)
26566 g
= r
->glyphs
[TEXT_AREA
];
26567 e
= g
+ r
->used
[TEXT_AREA
];
26568 for ( ; e
> g
; --e
)
26569 if (EQ ((e
-1)->object
, object
)
26570 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26572 hlinfo
->mouse_face_end_col
= e
- g
;
26574 for (gx
= r
->x
; g
< e
; ++g
)
26575 gx
+= g
->pixel_width
;
26576 hlinfo
->mouse_face_end_x
= gx
;
26580 e
= r
->glyphs
[TEXT_AREA
];
26581 g
= e
+ r
->used
[TEXT_AREA
];
26582 for (gx
= r
->x
; e
< g
; ++e
)
26584 if (EQ (e
->object
, object
)
26585 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26587 gx
+= e
->pixel_width
;
26589 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26590 hlinfo
->mouse_face_end_x
= gx
;
26594 #ifdef HAVE_WINDOW_SYSTEM
26596 /* See if position X, Y is within a hot-spot of an image. */
26599 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26601 if (!CONSP (hot_spot
))
26604 if (EQ (XCAR (hot_spot
), Qrect
))
26606 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26607 Lisp_Object rect
= XCDR (hot_spot
);
26611 if (!CONSP (XCAR (rect
)))
26613 if (!CONSP (XCDR (rect
)))
26615 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26617 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26619 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26621 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26625 else if (EQ (XCAR (hot_spot
), Qcircle
))
26627 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26628 Lisp_Object circ
= XCDR (hot_spot
);
26629 Lisp_Object lr
, lx0
, ly0
;
26631 && CONSP (XCAR (circ
))
26632 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26633 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26634 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26636 double r
= XFLOATINT (lr
);
26637 double dx
= XINT (lx0
) - x
;
26638 double dy
= XINT (ly0
) - y
;
26639 return (dx
* dx
+ dy
* dy
<= r
* r
);
26642 else if (EQ (XCAR (hot_spot
), Qpoly
))
26644 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26645 if (VECTORP (XCDR (hot_spot
)))
26647 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26648 Lisp_Object
*poly
= v
->contents
;
26649 int n
= v
->header
.size
;
26652 Lisp_Object lx
, ly
;
26655 /* Need an even number of coordinates, and at least 3 edges. */
26656 if (n
< 6 || n
& 1)
26659 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26660 If count is odd, we are inside polygon. Pixels on edges
26661 may or may not be included depending on actual geometry of the
26663 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26664 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26666 x0
= XINT (lx
), y0
= XINT (ly
);
26667 for (i
= 0; i
< n
; i
+= 2)
26669 int x1
= x0
, y1
= y0
;
26670 if ((lx
= poly
[i
], !INTEGERP (lx
))
26671 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26673 x0
= XINT (lx
), y0
= XINT (ly
);
26675 /* Does this segment cross the X line? */
26683 if (y
> y0
&& y
> y1
)
26685 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26695 find_hot_spot (Lisp_Object map
, int x
, int y
)
26697 while (CONSP (map
))
26699 if (CONSP (XCAR (map
))
26700 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26708 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26710 doc
: /* Lookup in image map MAP coordinates X and Y.
26711 An image map is an alist where each element has the format (AREA ID PLIST).
26712 An AREA is specified as either a rectangle, a circle, or a polygon:
26713 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26714 pixel coordinates of the upper left and bottom right corners.
26715 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26716 and the radius of the circle; r may be a float or integer.
26717 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26718 vector describes one corner in the polygon.
26719 Returns the alist element for the first matching AREA in MAP. */)
26720 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26728 return find_hot_spot (map
, XINT (x
), XINT (y
));
26732 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26734 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26736 /* Do not change cursor shape while dragging mouse. */
26737 if (!NILP (do_mouse_tracking
))
26740 if (!NILP (pointer
))
26742 if (EQ (pointer
, Qarrow
))
26743 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26744 else if (EQ (pointer
, Qhand
))
26745 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26746 else if (EQ (pointer
, Qtext
))
26747 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26748 else if (EQ (pointer
, intern ("hdrag")))
26749 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26750 #ifdef HAVE_X_WINDOWS
26751 else if (EQ (pointer
, intern ("vdrag")))
26752 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26754 else if (EQ (pointer
, intern ("hourglass")))
26755 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26756 else if (EQ (pointer
, Qmodeline
))
26757 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26759 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26762 if (cursor
!= No_Cursor
)
26763 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26766 #endif /* HAVE_WINDOW_SYSTEM */
26768 /* Take proper action when mouse has moved to the mode or header line
26769 or marginal area AREA of window W, x-position X and y-position Y.
26770 X is relative to the start of the text display area of W, so the
26771 width of bitmap areas and scroll bars must be subtracted to get a
26772 position relative to the start of the mode line. */
26775 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26776 enum window_part area
)
26778 struct window
*w
= XWINDOW (window
);
26779 struct frame
*f
= XFRAME (w
->frame
);
26780 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26781 #ifdef HAVE_WINDOW_SYSTEM
26782 Display_Info
*dpyinfo
;
26784 Cursor cursor
= No_Cursor
;
26785 Lisp_Object pointer
= Qnil
;
26786 int dx
, dy
, width
, height
;
26788 Lisp_Object string
, object
= Qnil
;
26789 Lisp_Object pos
, help
;
26791 Lisp_Object mouse_face
;
26792 int original_x_pixel
= x
;
26793 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26794 struct glyph_row
*row
;
26796 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26801 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26802 returns them in row/column units! */
26803 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26804 &object
, &dx
, &dy
, &width
, &height
);
26806 row
= (area
== ON_MODE_LINE
26807 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26808 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26810 /* Find the glyph under the mouse pointer. */
26811 if (row
->mode_line_p
&& row
->enabled_p
)
26813 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26814 end
= glyph
+ row
->used
[TEXT_AREA
];
26816 for (x0
= original_x_pixel
;
26817 glyph
< end
&& x0
>= glyph
->pixel_width
;
26819 x0
-= glyph
->pixel_width
;
26827 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26828 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26829 returns them in row/column units! */
26830 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26831 &object
, &dx
, &dy
, &width
, &height
);
26836 #ifdef HAVE_WINDOW_SYSTEM
26837 if (IMAGEP (object
))
26839 Lisp_Object image_map
, hotspot
;
26840 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26842 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26844 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26848 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26849 If so, we could look for mouse-enter, mouse-leave
26850 properties in PLIST (and do something...). */
26851 hotspot
= XCDR (hotspot
);
26852 if (CONSP (hotspot
)
26853 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26855 pointer
= Fplist_get (plist
, Qpointer
);
26856 if (NILP (pointer
))
26858 help
= Fplist_get (plist
, Qhelp_echo
);
26861 help_echo_string
= help
;
26862 /* Is this correct? ++kfs */
26863 XSETWINDOW (help_echo_window
, w
);
26864 help_echo_object
= w
->buffer
;
26865 help_echo_pos
= charpos
;
26869 if (NILP (pointer
))
26870 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26872 #endif /* HAVE_WINDOW_SYSTEM */
26874 if (STRINGP (string
))
26876 pos
= make_number (charpos
);
26877 /* If we're on a string with `help-echo' text property, arrange
26878 for the help to be displayed. This is done by setting the
26879 global variable help_echo_string to the help string. */
26882 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26885 help_echo_string
= help
;
26886 XSETWINDOW (help_echo_window
, w
);
26887 help_echo_object
= string
;
26888 help_echo_pos
= charpos
;
26892 #ifdef HAVE_WINDOW_SYSTEM
26893 if (FRAME_WINDOW_P (f
))
26895 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26896 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26897 if (NILP (pointer
))
26898 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26900 /* Change the mouse pointer according to what is under X/Y. */
26902 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26905 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26906 if (!KEYMAPP (map
))
26907 map
= Fget_text_property (pos
, Qkeymap
, string
);
26908 if (!KEYMAPP (map
))
26909 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26914 /* Change the mouse face according to what is under X/Y. */
26915 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26916 if (!NILP (mouse_face
)
26917 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26922 struct glyph
* tmp_glyph
;
26926 int total_pixel_width
;
26927 EMACS_INT begpos
, endpos
, ignore
;
26931 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26932 Qmouse_face
, string
, Qnil
);
26938 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26940 endpos
= SCHARS (string
);
26944 /* Calculate the glyph position GPOS of GLYPH in the
26945 displayed string, relative to the beginning of the
26946 highlighted part of the string.
26948 Note: GPOS is different from CHARPOS. CHARPOS is the
26949 position of GLYPH in the internal string object. A mode
26950 line string format has structures which are converted to
26951 a flattened string by the Emacs Lisp interpreter. The
26952 internal string is an element of those structures. The
26953 displayed string is the flattened string. */
26954 tmp_glyph
= row_start_glyph
;
26955 while (tmp_glyph
< glyph
26956 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26957 && begpos
<= tmp_glyph
->charpos
26958 && tmp_glyph
->charpos
< endpos
)))
26960 gpos
= glyph
- tmp_glyph
;
26962 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26963 the highlighted part of the displayed string to which
26964 GLYPH belongs. Note: GSEQ_LENGTH is different from
26965 SCHARS (STRING), because the latter returns the length of
26966 the internal string. */
26967 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26969 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26970 && begpos
<= tmp_glyph
->charpos
26971 && tmp_glyph
->charpos
< endpos
));
26974 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26976 /* Calculate the total pixel width of all the glyphs between
26977 the beginning of the highlighted area and GLYPH. */
26978 total_pixel_width
= 0;
26979 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26980 total_pixel_width
+= tmp_glyph
->pixel_width
;
26982 /* Pre calculation of re-rendering position. Note: X is in
26983 column units here, after the call to mode_line_string or
26984 marginal_area_string. */
26986 vpos
= (area
== ON_MODE_LINE
26987 ? (w
->current_matrix
)->nrows
- 1
26990 /* If GLYPH's position is included in the region that is
26991 already drawn in mouse face, we have nothing to do. */
26992 if ( EQ (window
, hlinfo
->mouse_face_window
)
26993 && (!row
->reversed_p
26994 ? (hlinfo
->mouse_face_beg_col
<= hpos
26995 && hpos
< hlinfo
->mouse_face_end_col
)
26996 /* In R2L rows we swap BEG and END, see below. */
26997 : (hlinfo
->mouse_face_end_col
<= hpos
26998 && hpos
< hlinfo
->mouse_face_beg_col
))
26999 && hlinfo
->mouse_face_beg_row
== vpos
)
27002 if (clear_mouse_face (hlinfo
))
27003 cursor
= No_Cursor
;
27005 if (!row
->reversed_p
)
27007 hlinfo
->mouse_face_beg_col
= hpos
;
27008 hlinfo
->mouse_face_beg_x
= original_x_pixel
27009 - (total_pixel_width
+ dx
);
27010 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27011 hlinfo
->mouse_face_end_x
= 0;
27015 /* In R2L rows, show_mouse_face expects BEG and END
27016 coordinates to be swapped. */
27017 hlinfo
->mouse_face_end_col
= hpos
;
27018 hlinfo
->mouse_face_end_x
= original_x_pixel
27019 - (total_pixel_width
+ dx
);
27020 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27021 hlinfo
->mouse_face_beg_x
= 0;
27024 hlinfo
->mouse_face_beg_row
= vpos
;
27025 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27026 hlinfo
->mouse_face_beg_y
= 0;
27027 hlinfo
->mouse_face_end_y
= 0;
27028 hlinfo
->mouse_face_past_end
= 0;
27029 hlinfo
->mouse_face_window
= window
;
27031 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27037 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27039 if (NILP (pointer
))
27042 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27043 clear_mouse_face (hlinfo
);
27045 #ifdef HAVE_WINDOW_SYSTEM
27046 if (FRAME_WINDOW_P (f
))
27047 define_frame_cursor1 (f
, cursor
, pointer
);
27053 Take proper action when the mouse has moved to position X, Y on
27054 frame F as regards highlighting characters that have mouse-face
27055 properties. Also de-highlighting chars where the mouse was before.
27056 X and Y can be negative or out of range. */
27059 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27061 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27062 enum window_part part
= ON_NOTHING
;
27063 Lisp_Object window
;
27065 Cursor cursor
= No_Cursor
;
27066 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27069 /* When a menu is active, don't highlight because this looks odd. */
27070 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27071 if (popup_activated ())
27075 if (NILP (Vmouse_highlight
)
27076 || !f
->glyphs_initialized_p
27077 || f
->pointer_invisible
)
27080 hlinfo
->mouse_face_mouse_x
= x
;
27081 hlinfo
->mouse_face_mouse_y
= y
;
27082 hlinfo
->mouse_face_mouse_frame
= f
;
27084 if (hlinfo
->mouse_face_defer
)
27087 if (gc_in_progress
)
27089 hlinfo
->mouse_face_deferred_gc
= 1;
27093 /* Which window is that in? */
27094 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27096 /* If displaying active text in another window, clear that. */
27097 if (! EQ (window
, hlinfo
->mouse_face_window
)
27098 /* Also clear if we move out of text area in same window. */
27099 || (!NILP (hlinfo
->mouse_face_window
)
27102 && part
!= ON_MODE_LINE
27103 && part
!= ON_HEADER_LINE
))
27104 clear_mouse_face (hlinfo
);
27106 /* Not on a window -> return. */
27107 if (!WINDOWP (window
))
27110 /* Reset help_echo_string. It will get recomputed below. */
27111 help_echo_string
= Qnil
;
27113 /* Convert to window-relative pixel coordinates. */
27114 w
= XWINDOW (window
);
27115 frame_to_window_pixel_xy (w
, &x
, &y
);
27117 #ifdef HAVE_WINDOW_SYSTEM
27118 /* Handle tool-bar window differently since it doesn't display a
27120 if (EQ (window
, f
->tool_bar_window
))
27122 note_tool_bar_highlight (f
, x
, y
);
27127 /* Mouse is on the mode, header line or margin? */
27128 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27129 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27131 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27135 #ifdef HAVE_WINDOW_SYSTEM
27136 if (part
== ON_VERTICAL_BORDER
)
27138 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27139 help_echo_string
= build_string ("drag-mouse-1: resize");
27141 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27142 || part
== ON_SCROLL_BAR
)
27143 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27145 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27148 /* Are we in a window whose display is up to date?
27149 And verify the buffer's text has not changed. */
27150 b
= XBUFFER (w
->buffer
);
27151 if (part
== ON_TEXT
27152 && EQ (w
->window_end_valid
, w
->buffer
)
27153 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27154 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27156 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27158 struct glyph
*glyph
;
27159 Lisp_Object object
;
27160 Lisp_Object mouse_face
= Qnil
, position
;
27161 Lisp_Object
*overlay_vec
= NULL
;
27162 ptrdiff_t i
, noverlays
;
27163 struct buffer
*obuf
;
27164 EMACS_INT obegv
, ozv
;
27167 /* Find the glyph under X/Y. */
27168 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27170 #ifdef HAVE_WINDOW_SYSTEM
27171 /* Look for :pointer property on image. */
27172 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27174 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27175 if (img
!= NULL
&& IMAGEP (img
->spec
))
27177 Lisp_Object image_map
, hotspot
;
27178 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27180 && (hotspot
= find_hot_spot (image_map
,
27181 glyph
->slice
.img
.x
+ dx
,
27182 glyph
->slice
.img
.y
+ dy
),
27184 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27188 /* Could check XCAR (hotspot) to see if we enter/leave
27190 If so, we could look for mouse-enter, mouse-leave
27191 properties in PLIST (and do something...). */
27192 hotspot
= XCDR (hotspot
);
27193 if (CONSP (hotspot
)
27194 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27196 pointer
= Fplist_get (plist
, Qpointer
);
27197 if (NILP (pointer
))
27199 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27200 if (!NILP (help_echo_string
))
27202 help_echo_window
= window
;
27203 help_echo_object
= glyph
->object
;
27204 help_echo_pos
= glyph
->charpos
;
27208 if (NILP (pointer
))
27209 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27212 #endif /* HAVE_WINDOW_SYSTEM */
27214 /* Clear mouse face if X/Y not over text. */
27216 || area
!= TEXT_AREA
27217 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27218 /* Glyph's OBJECT is an integer for glyphs inserted by the
27219 display engine for its internal purposes, like truncation
27220 and continuation glyphs and blanks beyond the end of
27221 line's text on text terminals. If we are over such a
27222 glyph, we are not over any text. */
27223 || INTEGERP (glyph
->object
)
27224 /* R2L rows have a stretch glyph at their front, which
27225 stands for no text, whereas L2R rows have no glyphs at
27226 all beyond the end of text. Treat such stretch glyphs
27227 like we do with NULL glyphs in L2R rows. */
27228 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27229 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27230 && glyph
->type
== STRETCH_GLYPH
27231 && glyph
->avoid_cursor_p
))
27233 if (clear_mouse_face (hlinfo
))
27234 cursor
= No_Cursor
;
27235 #ifdef HAVE_WINDOW_SYSTEM
27236 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27238 if (area
!= TEXT_AREA
)
27239 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27241 pointer
= Vvoid_text_area_pointer
;
27247 pos
= glyph
->charpos
;
27248 object
= glyph
->object
;
27249 if (!STRINGP (object
) && !BUFFERP (object
))
27252 /* If we get an out-of-range value, return now; avoid an error. */
27253 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27256 /* Make the window's buffer temporarily current for
27257 overlays_at and compute_char_face. */
27258 obuf
= current_buffer
;
27259 current_buffer
= b
;
27265 /* Is this char mouse-active or does it have help-echo? */
27266 position
= make_number (pos
);
27268 if (BUFFERP (object
))
27270 /* Put all the overlays we want in a vector in overlay_vec. */
27271 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27272 /* Sort overlays into increasing priority order. */
27273 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27278 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27281 cursor
= No_Cursor
;
27283 /* Check mouse-face highlighting. */
27285 /* If there exists an overlay with mouse-face overlapping
27286 the one we are currently highlighting, we have to
27287 check if we enter the overlapping overlay, and then
27288 highlight only that. */
27289 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27290 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27292 /* Find the highest priority overlay with a mouse-face. */
27293 Lisp_Object overlay
= Qnil
;
27294 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27296 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27297 if (!NILP (mouse_face
))
27298 overlay
= overlay_vec
[i
];
27301 /* If we're highlighting the same overlay as before, there's
27302 no need to do that again. */
27303 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27304 goto check_help_echo
;
27305 hlinfo
->mouse_face_overlay
= overlay
;
27307 /* Clear the display of the old active region, if any. */
27308 if (clear_mouse_face (hlinfo
))
27309 cursor
= No_Cursor
;
27311 /* If no overlay applies, get a text property. */
27312 if (NILP (overlay
))
27313 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27315 /* Next, compute the bounds of the mouse highlighting and
27317 if (!NILP (mouse_face
) && STRINGP (object
))
27319 /* The mouse-highlighting comes from a display string
27320 with a mouse-face. */
27324 s
= Fprevious_single_property_change
27325 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27326 e
= Fnext_single_property_change
27327 (position
, Qmouse_face
, object
, Qnil
);
27329 s
= make_number (0);
27331 e
= make_number (SCHARS (object
) - 1);
27332 mouse_face_from_string_pos (w
, hlinfo
, object
,
27333 XINT (s
), XINT (e
));
27334 hlinfo
->mouse_face_past_end
= 0;
27335 hlinfo
->mouse_face_window
= window
;
27336 hlinfo
->mouse_face_face_id
27337 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27338 glyph
->face_id
, 1);
27339 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27340 cursor
= No_Cursor
;
27344 /* The mouse-highlighting, if any, comes from an overlay
27345 or text property in the buffer. */
27346 Lisp_Object buffer
IF_LINT (= Qnil
);
27347 Lisp_Object disp_string
IF_LINT (= Qnil
);
27349 if (STRINGP (object
))
27351 /* If we are on a display string with no mouse-face,
27352 check if the text under it has one. */
27353 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27354 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27355 pos
= string_buffer_position (object
, start
);
27358 mouse_face
= get_char_property_and_overlay
27359 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27360 buffer
= w
->buffer
;
27361 disp_string
= object
;
27367 disp_string
= Qnil
;
27370 if (!NILP (mouse_face
))
27372 Lisp_Object before
, after
;
27373 Lisp_Object before_string
, after_string
;
27374 /* To correctly find the limits of mouse highlight
27375 in a bidi-reordered buffer, we must not use the
27376 optimization of limiting the search in
27377 previous-single-property-change and
27378 next-single-property-change, because
27379 rows_from_pos_range needs the real start and end
27380 positions to DTRT in this case. That's because
27381 the first row visible in a window does not
27382 necessarily display the character whose position
27383 is the smallest. */
27385 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27386 ? Fmarker_position (w
->start
)
27389 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27390 ? make_number (BUF_Z (XBUFFER (buffer
))
27391 - XFASTINT (w
->window_end_pos
))
27394 if (NILP (overlay
))
27396 /* Handle the text property case. */
27397 before
= Fprevious_single_property_change
27398 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27399 after
= Fnext_single_property_change
27400 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27401 before_string
= after_string
= Qnil
;
27405 /* Handle the overlay case. */
27406 before
= Foverlay_start (overlay
);
27407 after
= Foverlay_end (overlay
);
27408 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27409 after_string
= Foverlay_get (overlay
, Qafter_string
);
27411 if (!STRINGP (before_string
)) before_string
= Qnil
;
27412 if (!STRINGP (after_string
)) after_string
= Qnil
;
27415 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27418 : XFASTINT (before
),
27420 ? BUF_Z (XBUFFER (buffer
))
27421 : XFASTINT (after
),
27422 before_string
, after_string
,
27424 cursor
= No_Cursor
;
27431 /* Look for a `help-echo' property. */
27432 if (NILP (help_echo_string
)) {
27433 Lisp_Object help
, overlay
;
27435 /* Check overlays first. */
27436 help
= overlay
= Qnil
;
27437 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27439 overlay
= overlay_vec
[i
];
27440 help
= Foverlay_get (overlay
, Qhelp_echo
);
27445 help_echo_string
= help
;
27446 help_echo_window
= window
;
27447 help_echo_object
= overlay
;
27448 help_echo_pos
= pos
;
27452 Lisp_Object obj
= glyph
->object
;
27453 EMACS_INT charpos
= glyph
->charpos
;
27455 /* Try text properties. */
27458 && charpos
< SCHARS (obj
))
27460 help
= Fget_text_property (make_number (charpos
),
27464 /* If the string itself doesn't specify a help-echo,
27465 see if the buffer text ``under'' it does. */
27466 struct glyph_row
*r
27467 = MATRIX_ROW (w
->current_matrix
, vpos
);
27468 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27469 EMACS_INT p
= string_buffer_position (obj
, start
);
27472 help
= Fget_char_property (make_number (p
),
27473 Qhelp_echo
, w
->buffer
);
27482 else if (BUFFERP (obj
)
27485 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27490 help_echo_string
= help
;
27491 help_echo_window
= window
;
27492 help_echo_object
= obj
;
27493 help_echo_pos
= charpos
;
27498 #ifdef HAVE_WINDOW_SYSTEM
27499 /* Look for a `pointer' property. */
27500 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27502 /* Check overlays first. */
27503 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27504 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27506 if (NILP (pointer
))
27508 Lisp_Object obj
= glyph
->object
;
27509 EMACS_INT charpos
= glyph
->charpos
;
27511 /* Try text properties. */
27514 && charpos
< SCHARS (obj
))
27516 pointer
= Fget_text_property (make_number (charpos
),
27518 if (NILP (pointer
))
27520 /* If the string itself doesn't specify a pointer,
27521 see if the buffer text ``under'' it does. */
27522 struct glyph_row
*r
27523 = MATRIX_ROW (w
->current_matrix
, vpos
);
27524 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27525 EMACS_INT p
= string_buffer_position (obj
, start
);
27527 pointer
= Fget_char_property (make_number (p
),
27528 Qpointer
, w
->buffer
);
27531 else if (BUFFERP (obj
)
27534 pointer
= Fget_text_property (make_number (charpos
),
27538 #endif /* HAVE_WINDOW_SYSTEM */
27542 current_buffer
= obuf
;
27547 #ifdef HAVE_WINDOW_SYSTEM
27548 if (FRAME_WINDOW_P (f
))
27549 define_frame_cursor1 (f
, cursor
, pointer
);
27551 /* This is here to prevent a compiler error, about "label at end of
27552 compound statement". */
27559 Clear any mouse-face on window W. This function is part of the
27560 redisplay interface, and is called from try_window_id and similar
27561 functions to ensure the mouse-highlight is off. */
27564 x_clear_window_mouse_face (struct window
*w
)
27566 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27567 Lisp_Object window
;
27570 XSETWINDOW (window
, w
);
27571 if (EQ (window
, hlinfo
->mouse_face_window
))
27572 clear_mouse_face (hlinfo
);
27578 Just discard the mouse face information for frame F, if any.
27579 This is used when the size of F is changed. */
27582 cancel_mouse_face (struct frame
*f
)
27584 Lisp_Object window
;
27585 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27587 window
= hlinfo
->mouse_face_window
;
27588 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27590 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27591 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27592 hlinfo
->mouse_face_window
= Qnil
;
27598 /***********************************************************************
27600 ***********************************************************************/
27602 #ifdef HAVE_WINDOW_SYSTEM
27604 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27605 which intersects rectangle R. R is in window-relative coordinates. */
27608 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27609 enum glyph_row_area area
)
27611 struct glyph
*first
= row
->glyphs
[area
];
27612 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27613 struct glyph
*last
;
27614 int first_x
, start_x
, x
;
27616 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27617 /* If row extends face to end of line write the whole line. */
27618 draw_glyphs (w
, 0, row
, area
,
27619 0, row
->used
[area
],
27620 DRAW_NORMAL_TEXT
, 0);
27623 /* Set START_X to the window-relative start position for drawing glyphs of
27624 AREA. The first glyph of the text area can be partially visible.
27625 The first glyphs of other areas cannot. */
27626 start_x
= window_box_left_offset (w
, area
);
27628 if (area
== TEXT_AREA
)
27631 /* Find the first glyph that must be redrawn. */
27633 && x
+ first
->pixel_width
< r
->x
)
27635 x
+= first
->pixel_width
;
27639 /* Find the last one. */
27643 && x
< r
->x
+ r
->width
)
27645 x
+= last
->pixel_width
;
27651 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27652 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27653 DRAW_NORMAL_TEXT
, 0);
27658 /* Redraw the parts of the glyph row ROW on window W intersecting
27659 rectangle R. R is in window-relative coordinates. Value is
27660 non-zero if mouse-face was overwritten. */
27663 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27665 xassert (row
->enabled_p
);
27667 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27668 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27669 0, row
->used
[TEXT_AREA
],
27670 DRAW_NORMAL_TEXT
, 0);
27673 if (row
->used
[LEFT_MARGIN_AREA
])
27674 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27675 if (row
->used
[TEXT_AREA
])
27676 expose_area (w
, row
, r
, TEXT_AREA
);
27677 if (row
->used
[RIGHT_MARGIN_AREA
])
27678 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27679 draw_row_fringe_bitmaps (w
, row
);
27682 return row
->mouse_face_p
;
27686 /* Redraw those parts of glyphs rows during expose event handling that
27687 overlap other rows. Redrawing of an exposed line writes over parts
27688 of lines overlapping that exposed line; this function fixes that.
27690 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27691 row in W's current matrix that is exposed and overlaps other rows.
27692 LAST_OVERLAPPING_ROW is the last such row. */
27695 expose_overlaps (struct window
*w
,
27696 struct glyph_row
*first_overlapping_row
,
27697 struct glyph_row
*last_overlapping_row
,
27700 struct glyph_row
*row
;
27702 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27703 if (row
->overlapping_p
)
27705 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27708 if (row
->used
[LEFT_MARGIN_AREA
])
27709 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27711 if (row
->used
[TEXT_AREA
])
27712 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27714 if (row
->used
[RIGHT_MARGIN_AREA
])
27715 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27721 /* Return non-zero if W's cursor intersects rectangle R. */
27724 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27726 XRectangle cr
, result
;
27727 struct glyph
*cursor_glyph
;
27728 struct glyph_row
*row
;
27730 if (w
->phys_cursor
.vpos
>= 0
27731 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27732 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27734 && row
->cursor_in_fringe_p
)
27736 /* Cursor is in the fringe. */
27737 cr
.x
= window_box_right_offset (w
,
27738 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27739 ? RIGHT_MARGIN_AREA
27742 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27743 cr
.height
= row
->height
;
27744 return x_intersect_rectangles (&cr
, r
, &result
);
27747 cursor_glyph
= get_phys_cursor_glyph (w
);
27750 /* r is relative to W's box, but w->phys_cursor.x is relative
27751 to left edge of W's TEXT area. Adjust it. */
27752 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27753 cr
.y
= w
->phys_cursor
.y
;
27754 cr
.width
= cursor_glyph
->pixel_width
;
27755 cr
.height
= w
->phys_cursor_height
;
27756 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27757 I assume the effect is the same -- and this is portable. */
27758 return x_intersect_rectangles (&cr
, r
, &result
);
27760 /* If we don't understand the format, pretend we're not in the hot-spot. */
27766 Draw a vertical window border to the right of window W if W doesn't
27767 have vertical scroll bars. */
27770 x_draw_vertical_border (struct window
*w
)
27772 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27774 /* We could do better, if we knew what type of scroll-bar the adjacent
27775 windows (on either side) have... But we don't :-(
27776 However, I think this works ok. ++KFS 2003-04-25 */
27778 /* Redraw borders between horizontally adjacent windows. Don't
27779 do it for frames with vertical scroll bars because either the
27780 right scroll bar of a window, or the left scroll bar of its
27781 neighbor will suffice as a border. */
27782 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27785 if (!WINDOW_RIGHTMOST_P (w
)
27786 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27788 int x0
, x1
, y0
, y1
;
27790 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27793 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27796 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27798 else if (!WINDOW_LEFTMOST_P (w
)
27799 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27801 int x0
, x1
, y0
, y1
;
27803 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27806 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27809 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27814 /* Redraw the part of window W intersection rectangle FR. Pixel
27815 coordinates in FR are frame-relative. Call this function with
27816 input blocked. Value is non-zero if the exposure overwrites
27820 expose_window (struct window
*w
, XRectangle
*fr
)
27822 struct frame
*f
= XFRAME (w
->frame
);
27824 int mouse_face_overwritten_p
= 0;
27826 /* If window is not yet fully initialized, do nothing. This can
27827 happen when toolkit scroll bars are used and a window is split.
27828 Reconfiguring the scroll bar will generate an expose for a newly
27830 if (w
->current_matrix
== NULL
)
27833 /* When we're currently updating the window, display and current
27834 matrix usually don't agree. Arrange for a thorough display
27836 if (w
== updated_window
)
27838 SET_FRAME_GARBAGED (f
);
27842 /* Frame-relative pixel rectangle of W. */
27843 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27844 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27845 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27846 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27848 if (x_intersect_rectangles (fr
, &wr
, &r
))
27850 int yb
= window_text_bottom_y (w
);
27851 struct glyph_row
*row
;
27852 int cursor_cleared_p
, phys_cursor_on_p
;
27853 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27855 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27856 r
.x
, r
.y
, r
.width
, r
.height
));
27858 /* Convert to window coordinates. */
27859 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27860 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27862 /* Turn off the cursor. */
27863 if (!w
->pseudo_window_p
27864 && phys_cursor_in_rect_p (w
, &r
))
27866 x_clear_cursor (w
);
27867 cursor_cleared_p
= 1;
27870 cursor_cleared_p
= 0;
27872 /* If the row containing the cursor extends face to end of line,
27873 then expose_area might overwrite the cursor outside the
27874 rectangle and thus notice_overwritten_cursor might clear
27875 w->phys_cursor_on_p. We remember the original value and
27876 check later if it is changed. */
27877 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27879 /* Update lines intersecting rectangle R. */
27880 first_overlapping_row
= last_overlapping_row
= NULL
;
27881 for (row
= w
->current_matrix
->rows
;
27886 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27888 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27889 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27890 || (r
.y
>= y0
&& r
.y
< y1
)
27891 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27893 /* A header line may be overlapping, but there is no need
27894 to fix overlapping areas for them. KFS 2005-02-12 */
27895 if (row
->overlapping_p
&& !row
->mode_line_p
)
27897 if (first_overlapping_row
== NULL
)
27898 first_overlapping_row
= row
;
27899 last_overlapping_row
= row
;
27903 if (expose_line (w
, row
, &r
))
27904 mouse_face_overwritten_p
= 1;
27907 else if (row
->overlapping_p
)
27909 /* We must redraw a row overlapping the exposed area. */
27911 ? y0
+ row
->phys_height
> r
.y
27912 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27914 if (first_overlapping_row
== NULL
)
27915 first_overlapping_row
= row
;
27916 last_overlapping_row
= row
;
27924 /* Display the mode line if there is one. */
27925 if (WINDOW_WANTS_MODELINE_P (w
)
27926 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27928 && row
->y
< r
.y
+ r
.height
)
27930 if (expose_line (w
, row
, &r
))
27931 mouse_face_overwritten_p
= 1;
27934 if (!w
->pseudo_window_p
)
27936 /* Fix the display of overlapping rows. */
27937 if (first_overlapping_row
)
27938 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27941 /* Draw border between windows. */
27942 x_draw_vertical_border (w
);
27944 /* Turn the cursor on again. */
27945 if (cursor_cleared_p
27946 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27947 update_window_cursor (w
, 1);
27951 return mouse_face_overwritten_p
;
27956 /* Redraw (parts) of all windows in the window tree rooted at W that
27957 intersect R. R contains frame pixel coordinates. Value is
27958 non-zero if the exposure overwrites mouse-face. */
27961 expose_window_tree (struct window
*w
, XRectangle
*r
)
27963 struct frame
*f
= XFRAME (w
->frame
);
27964 int mouse_face_overwritten_p
= 0;
27966 while (w
&& !FRAME_GARBAGED_P (f
))
27968 if (!NILP (w
->hchild
))
27969 mouse_face_overwritten_p
27970 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27971 else if (!NILP (w
->vchild
))
27972 mouse_face_overwritten_p
27973 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27975 mouse_face_overwritten_p
|= expose_window (w
, r
);
27977 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27980 return mouse_face_overwritten_p
;
27985 Redisplay an exposed area of frame F. X and Y are the upper-left
27986 corner of the exposed rectangle. W and H are width and height of
27987 the exposed area. All are pixel values. W or H zero means redraw
27988 the entire frame. */
27991 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27994 int mouse_face_overwritten_p
= 0;
27996 TRACE ((stderr
, "expose_frame "));
27998 /* No need to redraw if frame will be redrawn soon. */
27999 if (FRAME_GARBAGED_P (f
))
28001 TRACE ((stderr
, " garbaged\n"));
28005 /* If basic faces haven't been realized yet, there is no point in
28006 trying to redraw anything. This can happen when we get an expose
28007 event while Emacs is starting, e.g. by moving another window. */
28008 if (FRAME_FACE_CACHE (f
) == NULL
28009 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28011 TRACE ((stderr
, " no faces\n"));
28015 if (w
== 0 || h
== 0)
28018 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28019 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28029 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28030 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28032 if (WINDOWP (f
->tool_bar_window
))
28033 mouse_face_overwritten_p
28034 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28036 #ifdef HAVE_X_WINDOWS
28038 #ifndef USE_X_TOOLKIT
28039 if (WINDOWP (f
->menu_bar_window
))
28040 mouse_face_overwritten_p
28041 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28042 #endif /* not USE_X_TOOLKIT */
28046 /* Some window managers support a focus-follows-mouse style with
28047 delayed raising of frames. Imagine a partially obscured frame,
28048 and moving the mouse into partially obscured mouse-face on that
28049 frame. The visible part of the mouse-face will be highlighted,
28050 then the WM raises the obscured frame. With at least one WM, KDE
28051 2.1, Emacs is not getting any event for the raising of the frame
28052 (even tried with SubstructureRedirectMask), only Expose events.
28053 These expose events will draw text normally, i.e. not
28054 highlighted. Which means we must redo the highlight here.
28055 Subsume it under ``we love X''. --gerd 2001-08-15 */
28056 /* Included in Windows version because Windows most likely does not
28057 do the right thing if any third party tool offers
28058 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28059 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28061 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28062 if (f
== hlinfo
->mouse_face_mouse_frame
)
28064 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28065 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28066 clear_mouse_face (hlinfo
);
28067 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28074 Determine the intersection of two rectangles R1 and R2. Return
28075 the intersection in *RESULT. Value is non-zero if RESULT is not
28079 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28081 XRectangle
*left
, *right
;
28082 XRectangle
*upper
, *lower
;
28083 int intersection_p
= 0;
28085 /* Rearrange so that R1 is the left-most rectangle. */
28087 left
= r1
, right
= r2
;
28089 left
= r2
, right
= r1
;
28091 /* X0 of the intersection is right.x0, if this is inside R1,
28092 otherwise there is no intersection. */
28093 if (right
->x
<= left
->x
+ left
->width
)
28095 result
->x
= right
->x
;
28097 /* The right end of the intersection is the minimum of
28098 the right ends of left and right. */
28099 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28102 /* Same game for Y. */
28104 upper
= r1
, lower
= r2
;
28106 upper
= r2
, lower
= r1
;
28108 /* The upper end of the intersection is lower.y0, if this is inside
28109 of upper. Otherwise, there is no intersection. */
28110 if (lower
->y
<= upper
->y
+ upper
->height
)
28112 result
->y
= lower
->y
;
28114 /* The lower end of the intersection is the minimum of the lower
28115 ends of upper and lower. */
28116 result
->height
= (min (lower
->y
+ lower
->height
,
28117 upper
->y
+ upper
->height
)
28119 intersection_p
= 1;
28123 return intersection_p
;
28126 #endif /* HAVE_WINDOW_SYSTEM */
28129 /***********************************************************************
28131 ***********************************************************************/
28134 syms_of_xdisp (void)
28136 Vwith_echo_area_save_vector
= Qnil
;
28137 staticpro (&Vwith_echo_area_save_vector
);
28139 Vmessage_stack
= Qnil
;
28140 staticpro (&Vmessage_stack
);
28142 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28144 message_dolog_marker1
= Fmake_marker ();
28145 staticpro (&message_dolog_marker1
);
28146 message_dolog_marker2
= Fmake_marker ();
28147 staticpro (&message_dolog_marker2
);
28148 message_dolog_marker3
= Fmake_marker ();
28149 staticpro (&message_dolog_marker3
);
28152 defsubr (&Sdump_frame_glyph_matrix
);
28153 defsubr (&Sdump_glyph_matrix
);
28154 defsubr (&Sdump_glyph_row
);
28155 defsubr (&Sdump_tool_bar_row
);
28156 defsubr (&Strace_redisplay
);
28157 defsubr (&Strace_to_stderr
);
28159 #ifdef HAVE_WINDOW_SYSTEM
28160 defsubr (&Stool_bar_lines_needed
);
28161 defsubr (&Slookup_image_map
);
28163 defsubr (&Sformat_mode_line
);
28164 defsubr (&Sinvisible_p
);
28165 defsubr (&Scurrent_bidi_paragraph_direction
);
28167 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28168 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28169 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28170 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28171 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28172 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28173 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28174 DEFSYM (Qeval
, "eval");
28175 DEFSYM (QCdata
, ":data");
28176 DEFSYM (Qdisplay
, "display");
28177 DEFSYM (Qspace_width
, "space-width");
28178 DEFSYM (Qraise
, "raise");
28179 DEFSYM (Qslice
, "slice");
28180 DEFSYM (Qspace
, "space");
28181 DEFSYM (Qmargin
, "margin");
28182 DEFSYM (Qpointer
, "pointer");
28183 DEFSYM (Qleft_margin
, "left-margin");
28184 DEFSYM (Qright_margin
, "right-margin");
28185 DEFSYM (Qcenter
, "center");
28186 DEFSYM (Qline_height
, "line-height");
28187 DEFSYM (QCalign_to
, ":align-to");
28188 DEFSYM (QCrelative_width
, ":relative-width");
28189 DEFSYM (QCrelative_height
, ":relative-height");
28190 DEFSYM (QCeval
, ":eval");
28191 DEFSYM (QCpropertize
, ":propertize");
28192 DEFSYM (QCfile
, ":file");
28193 DEFSYM (Qfontified
, "fontified");
28194 DEFSYM (Qfontification_functions
, "fontification-functions");
28195 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28196 DEFSYM (Qescape_glyph
, "escape-glyph");
28197 DEFSYM (Qnobreak_space
, "nobreak-space");
28198 DEFSYM (Qimage
, "image");
28199 DEFSYM (Qtext
, "text");
28200 DEFSYM (Qboth
, "both");
28201 DEFSYM (Qboth_horiz
, "both-horiz");
28202 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28203 DEFSYM (QCmap
, ":map");
28204 DEFSYM (QCpointer
, ":pointer");
28205 DEFSYM (Qrect
, "rect");
28206 DEFSYM (Qcircle
, "circle");
28207 DEFSYM (Qpoly
, "poly");
28208 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28209 DEFSYM (Qgrow_only
, "grow-only");
28210 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28211 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28212 DEFSYM (Qposition
, "position");
28213 DEFSYM (Qbuffer_position
, "buffer-position");
28214 DEFSYM (Qobject
, "object");
28215 DEFSYM (Qbar
, "bar");
28216 DEFSYM (Qhbar
, "hbar");
28217 DEFSYM (Qbox
, "box");
28218 DEFSYM (Qhollow
, "hollow");
28219 DEFSYM (Qhand
, "hand");
28220 DEFSYM (Qarrow
, "arrow");
28221 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28223 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28224 Fcons (intern_c_string ("void-variable"), Qnil
)),
28226 staticpro (&list_of_error
);
28228 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28229 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28230 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28231 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28233 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28234 staticpro (&echo_buffer
[0]);
28235 staticpro (&echo_buffer
[1]);
28237 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28238 staticpro (&echo_area_buffer
[0]);
28239 staticpro (&echo_area_buffer
[1]);
28241 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28242 staticpro (&Vmessages_buffer_name
);
28244 mode_line_proptrans_alist
= Qnil
;
28245 staticpro (&mode_line_proptrans_alist
);
28246 mode_line_string_list
= Qnil
;
28247 staticpro (&mode_line_string_list
);
28248 mode_line_string_face
= Qnil
;
28249 staticpro (&mode_line_string_face
);
28250 mode_line_string_face_prop
= Qnil
;
28251 staticpro (&mode_line_string_face_prop
);
28252 Vmode_line_unwind_vector
= Qnil
;
28253 staticpro (&Vmode_line_unwind_vector
);
28255 help_echo_string
= Qnil
;
28256 staticpro (&help_echo_string
);
28257 help_echo_object
= Qnil
;
28258 staticpro (&help_echo_object
);
28259 help_echo_window
= Qnil
;
28260 staticpro (&help_echo_window
);
28261 previous_help_echo_string
= Qnil
;
28262 staticpro (&previous_help_echo_string
);
28263 help_echo_pos
= -1;
28265 DEFSYM (Qright_to_left
, "right-to-left");
28266 DEFSYM (Qleft_to_right
, "left-to-right");
28268 #ifdef HAVE_WINDOW_SYSTEM
28269 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28270 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
28271 For example, if a block cursor is over a tab, it will be drawn as
28272 wide as that tab on the display. */);
28273 x_stretch_cursor_p
= 0;
28276 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28277 doc
: /* *Non-nil means highlight trailing whitespace.
28278 The face used for trailing whitespace is `trailing-whitespace'. */);
28279 Vshow_trailing_whitespace
= Qnil
;
28281 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28282 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28283 If the value is t, Emacs highlights non-ASCII chars which have the
28284 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28285 or `escape-glyph' face respectively.
28287 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28288 U+2011 (non-breaking hyphen) are affected.
28290 Any other non-nil value means to display these characters as a escape
28291 glyph followed by an ordinary space or hyphen.
28293 A value of nil means no special handling of these characters. */);
28294 Vnobreak_char_display
= Qt
;
28296 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28297 doc
: /* *The pointer shape to show in void text areas.
28298 A value of nil means to show the text pointer. Other options are `arrow',
28299 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28300 Vvoid_text_area_pointer
= Qarrow
;
28302 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28303 doc
: /* Non-nil means don't actually do any redisplay.
28304 This is used for internal purposes. */);
28305 Vinhibit_redisplay
= Qnil
;
28307 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28308 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28309 Vglobal_mode_string
= Qnil
;
28311 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28312 doc
: /* Marker for where to display an arrow on top of the buffer text.
28313 This must be the beginning of a line in order to work.
28314 See also `overlay-arrow-string'. */);
28315 Voverlay_arrow_position
= Qnil
;
28317 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28318 doc
: /* String to display as an arrow in non-window frames.
28319 See also `overlay-arrow-position'. */);
28320 Voverlay_arrow_string
= make_pure_c_string ("=>");
28322 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28323 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28324 The symbols on this list are examined during redisplay to determine
28325 where to display overlay arrows. */);
28326 Voverlay_arrow_variable_list
28327 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28329 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28330 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28331 If that fails to bring point back on frame, point is centered instead.
28332 If this is zero, point is always centered after it moves off frame.
28333 If you want scrolling to always be a line at a time, you should set
28334 `scroll-conservatively' to a large value rather than set this to 1. */);
28336 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28337 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28338 If point moves off-screen, redisplay will scroll by up to
28339 `scroll-conservatively' lines in order to bring point just barely
28340 onto the screen again. If that cannot be done, then redisplay
28341 recenters point as usual.
28343 If the value is greater than 100, redisplay will never recenter point,
28344 but will always scroll just enough text to bring point into view, even
28345 if you move far away.
28347 A value of zero means always recenter point if it moves off screen. */);
28348 scroll_conservatively
= 0;
28350 DEFVAR_INT ("scroll-margin", scroll_margin
,
28351 doc
: /* *Number of lines of margin at the top and bottom of a window.
28352 Recenter the window whenever point gets within this many lines
28353 of the top or bottom of the window. */);
28356 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28357 doc
: /* Pixels per inch value for non-window system displays.
28358 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28359 Vdisplay_pixels_per_inch
= make_float (72.0);
28362 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28365 DEFVAR_LISP ("truncate-partial-width-windows",
28366 Vtruncate_partial_width_windows
,
28367 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28368 For an integer value, truncate lines in each window narrower than the
28369 full frame width, provided the window width is less than that integer;
28370 otherwise, respect the value of `truncate-lines'.
28372 For any other non-nil value, truncate lines in all windows that do
28373 not span the full frame width.
28375 A value of nil means to respect the value of `truncate-lines'.
28377 If `word-wrap' is enabled, you might want to reduce this. */);
28378 Vtruncate_partial_width_windows
= make_number (50);
28380 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28381 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28382 Any other value means to use the appropriate face, `mode-line',
28383 `header-line', or `menu' respectively. */);
28384 mode_line_inverse_video
= 1;
28386 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28387 doc
: /* *Maximum buffer size for which line number should be displayed.
28388 If the buffer is bigger than this, the line number does not appear
28389 in the mode line. A value of nil means no limit. */);
28390 Vline_number_display_limit
= Qnil
;
28392 DEFVAR_INT ("line-number-display-limit-width",
28393 line_number_display_limit_width
,
28394 doc
: /* *Maximum line width (in characters) for line number display.
28395 If the average length of the lines near point is bigger than this, then the
28396 line number may be omitted from the mode line. */);
28397 line_number_display_limit_width
= 200;
28399 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28400 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28401 highlight_nonselected_windows
= 0;
28403 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28404 doc
: /* Non-nil if more than one frame is visible on this display.
28405 Minibuffer-only frames don't count, but iconified frames do.
28406 This variable is not guaranteed to be accurate except while processing
28407 `frame-title-format' and `icon-title-format'. */);
28409 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28410 doc
: /* Template for displaying the title bar of visible frames.
28411 \(Assuming the window manager supports this feature.)
28413 This variable has the same structure as `mode-line-format', except that
28414 the %c and %l constructs are ignored. It is used only on frames for
28415 which no explicit name has been set \(see `modify-frame-parameters'). */);
28417 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28418 doc
: /* Template for displaying the title bar of an iconified frame.
28419 \(Assuming the window manager supports this feature.)
28420 This variable has the same structure as `mode-line-format' (which see),
28421 and is used only on frames for which no explicit name has been set
28422 \(see `modify-frame-parameters'). */);
28424 = Vframe_title_format
28425 = pure_cons (intern_c_string ("multiple-frames"),
28426 pure_cons (make_pure_c_string ("%b"),
28427 pure_cons (pure_cons (empty_unibyte_string
,
28428 pure_cons (intern_c_string ("invocation-name"),
28429 pure_cons (make_pure_c_string ("@"),
28430 pure_cons (intern_c_string ("system-name"),
28434 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28435 doc
: /* Maximum number of lines to keep in the message log buffer.
28436 If nil, disable message logging. If t, log messages but don't truncate
28437 the buffer when it becomes large. */);
28438 Vmessage_log_max
= make_number (100);
28440 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28441 doc
: /* Functions called before redisplay, if window sizes have changed.
28442 The value should be a list of functions that take one argument.
28443 Just before redisplay, for each frame, if any of its windows have changed
28444 size since the last redisplay, or have been split or deleted,
28445 all the functions in the list are called, with the frame as argument. */);
28446 Vwindow_size_change_functions
= Qnil
;
28448 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28449 doc
: /* List of functions to call before redisplaying a window with scrolling.
28450 Each function is called with two arguments, the window and its new
28451 display-start position. Note that these functions are also called by
28452 `set-window-buffer'. Also note that the value of `window-end' is not
28453 valid when these functions are called.
28455 Warning: Do not use this feature to alter the way the window
28456 is scrolled. It is not designed for that, and such use probably won't
28458 Vwindow_scroll_functions
= Qnil
;
28460 DEFVAR_LISP ("window-text-change-functions",
28461 Vwindow_text_change_functions
,
28462 doc
: /* Functions to call in redisplay when text in the window might change. */);
28463 Vwindow_text_change_functions
= Qnil
;
28465 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28466 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28467 Each function is called with two arguments, the window and the end trigger value.
28468 See `set-window-redisplay-end-trigger'. */);
28469 Vredisplay_end_trigger_functions
= Qnil
;
28471 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28472 doc
: /* *Non-nil means autoselect window with mouse pointer.
28473 If nil, do not autoselect windows.
28474 A positive number means delay autoselection by that many seconds: a
28475 window is autoselected only after the mouse has remained in that
28476 window for the duration of the delay.
28477 A negative number has a similar effect, but causes windows to be
28478 autoselected only after the mouse has stopped moving. \(Because of
28479 the way Emacs compares mouse events, you will occasionally wait twice
28480 that time before the window gets selected.\)
28481 Any other value means to autoselect window instantaneously when the
28482 mouse pointer enters it.
28484 Autoselection selects the minibuffer only if it is active, and never
28485 unselects the minibuffer if it is active.
28487 When customizing this variable make sure that the actual value of
28488 `focus-follows-mouse' matches the behavior of your window manager. */);
28489 Vmouse_autoselect_window
= Qnil
;
28491 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28492 doc
: /* *Non-nil means automatically resize tool-bars.
28493 This dynamically changes the tool-bar's height to the minimum height
28494 that is needed to make all tool-bar items visible.
28495 If value is `grow-only', the tool-bar's height is only increased
28496 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28497 Vauto_resize_tool_bars
= Qt
;
28499 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28500 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28501 auto_raise_tool_bar_buttons_p
= 1;
28503 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28504 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28505 make_cursor_line_fully_visible_p
= 1;
28507 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28508 doc
: /* *Border below tool-bar in pixels.
28509 If an integer, use it as the height of the border.
28510 If it is one of `internal-border-width' or `border-width', use the
28511 value of the corresponding frame parameter.
28512 Otherwise, no border is added below the tool-bar. */);
28513 Vtool_bar_border
= Qinternal_border_width
;
28515 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28516 doc
: /* *Margin around tool-bar buttons in pixels.
28517 If an integer, use that for both horizontal and vertical margins.
28518 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28519 HORZ specifying the horizontal margin, and VERT specifying the
28520 vertical margin. */);
28521 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28523 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28524 doc
: /* *Relief thickness of tool-bar buttons. */);
28525 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28527 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28528 doc
: /* Tool bar style to use.
28530 image - show images only
28531 text - show text only
28532 both - show both, text below image
28533 both-horiz - show text to the right of the image
28534 text-image-horiz - show text to the left of the image
28535 any other - use system default or image if no system default. */);
28536 Vtool_bar_style
= Qnil
;
28538 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28539 doc
: /* *Maximum number of characters a label can have to be shown.
28540 The tool bar style must also show labels for this to have any effect, see
28541 `tool-bar-style'. */);
28542 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28544 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28545 doc
: /* List of functions to call to fontify regions of text.
28546 Each function is called with one argument POS. Functions must
28547 fontify a region starting at POS in the current buffer, and give
28548 fontified regions the property `fontified'. */);
28549 Vfontification_functions
= Qnil
;
28550 Fmake_variable_buffer_local (Qfontification_functions
);
28552 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28553 unibyte_display_via_language_environment
,
28554 doc
: /* *Non-nil means display unibyte text according to language environment.
28555 Specifically, this means that raw bytes in the range 160-255 decimal
28556 are displayed by converting them to the equivalent multibyte characters
28557 according to the current language environment. As a result, they are
28558 displayed according to the current fontset.
28560 Note that this variable affects only how these bytes are displayed,
28561 but does not change the fact they are interpreted as raw bytes. */);
28562 unibyte_display_via_language_environment
= 0;
28564 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28565 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28566 If a float, it specifies a fraction of the mini-window frame's height.
28567 If an integer, it specifies a number of lines. */);
28568 Vmax_mini_window_height
= make_float (0.25);
28570 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28571 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28572 A value of nil means don't automatically resize mini-windows.
28573 A value of t means resize them to fit the text displayed in them.
28574 A value of `grow-only', the default, means let mini-windows grow only;
28575 they return to their normal size when the minibuffer is closed, or the
28576 echo area becomes empty. */);
28577 Vresize_mini_windows
= Qgrow_only
;
28579 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28580 doc
: /* Alist specifying how to blink the cursor off.
28581 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28582 `cursor-type' frame-parameter or variable equals ON-STATE,
28583 comparing using `equal', Emacs uses OFF-STATE to specify
28584 how to blink it off. ON-STATE and OFF-STATE are values for
28585 the `cursor-type' frame parameter.
28587 If a frame's ON-STATE has no entry in this list,
28588 the frame's other specifications determine how to blink the cursor off. */);
28589 Vblink_cursor_alist
= Qnil
;
28591 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28592 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28593 If non-nil, windows are automatically scrolled horizontally to make
28594 point visible. */);
28595 automatic_hscrolling_p
= 1;
28596 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28598 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28599 doc
: /* *How many columns away from the window edge point is allowed to get
28600 before automatic hscrolling will horizontally scroll the window. */);
28601 hscroll_margin
= 5;
28603 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28604 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28605 When point is less than `hscroll-margin' columns from the window
28606 edge, automatic hscrolling will scroll the window by the amount of columns
28607 determined by this variable. If its value is a positive integer, scroll that
28608 many columns. If it's a positive floating-point number, it specifies the
28609 fraction of the window's width to scroll. If it's nil or zero, point will be
28610 centered horizontally after the scroll. Any other value, including negative
28611 numbers, are treated as if the value were zero.
28613 Automatic hscrolling always moves point outside the scroll margin, so if
28614 point was more than scroll step columns inside the margin, the window will
28615 scroll more than the value given by the scroll step.
28617 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28618 and `scroll-right' overrides this variable's effect. */);
28619 Vhscroll_step
= make_number (0);
28621 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28622 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28623 Bind this around calls to `message' to let it take effect. */);
28624 message_truncate_lines
= 0;
28626 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28627 doc
: /* Normal hook run to update the menu bar definitions.
28628 Redisplay runs this hook before it redisplays the menu bar.
28629 This is used to update submenus such as Buffers,
28630 whose contents depend on various data. */);
28631 Vmenu_bar_update_hook
= Qnil
;
28633 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28634 doc
: /* Frame for which we are updating a menu.
28635 The enable predicate for a menu binding should check this variable. */);
28636 Vmenu_updating_frame
= Qnil
;
28638 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28639 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28640 inhibit_menubar_update
= 0;
28642 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28643 doc
: /* Prefix prepended to all continuation lines at display time.
28644 The value may be a string, an image, or a stretch-glyph; it is
28645 interpreted in the same way as the value of a `display' text property.
28647 This variable is overridden by any `wrap-prefix' text or overlay
28650 To add a prefix to non-continuation lines, use `line-prefix'. */);
28651 Vwrap_prefix
= Qnil
;
28652 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28653 Fmake_variable_buffer_local (Qwrap_prefix
);
28655 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28656 doc
: /* Prefix prepended to all non-continuation lines at display time.
28657 The value may be a string, an image, or a stretch-glyph; it is
28658 interpreted in the same way as the value of a `display' text property.
28660 This variable is overridden by any `line-prefix' text or overlay
28663 To add a prefix to continuation lines, use `wrap-prefix'. */);
28664 Vline_prefix
= Qnil
;
28665 DEFSYM (Qline_prefix
, "line-prefix");
28666 Fmake_variable_buffer_local (Qline_prefix
);
28668 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28669 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28670 inhibit_eval_during_redisplay
= 0;
28672 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28673 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28674 inhibit_free_realized_faces
= 0;
28677 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28678 doc
: /* Inhibit try_window_id display optimization. */);
28679 inhibit_try_window_id
= 0;
28681 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28682 doc
: /* Inhibit try_window_reusing display optimization. */);
28683 inhibit_try_window_reusing
= 0;
28685 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28686 doc
: /* Inhibit try_cursor_movement display optimization. */);
28687 inhibit_try_cursor_movement
= 0;
28688 #endif /* GLYPH_DEBUG */
28690 DEFVAR_INT ("overline-margin", overline_margin
,
28691 doc
: /* *Space between overline and text, in pixels.
28692 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28693 margin to the character height. */);
28694 overline_margin
= 2;
28696 DEFVAR_INT ("underline-minimum-offset",
28697 underline_minimum_offset
,
28698 doc
: /* Minimum distance between baseline and underline.
28699 This can improve legibility of underlined text at small font sizes,
28700 particularly when using variable `x-use-underline-position-properties'
28701 with fonts that specify an UNDERLINE_POSITION relatively close to the
28702 baseline. The default value is 1. */);
28703 underline_minimum_offset
= 1;
28705 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28706 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28707 This feature only works when on a window system that can change
28708 cursor shapes. */);
28709 display_hourglass_p
= 1;
28711 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28712 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28713 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28715 hourglass_atimer
= NULL
;
28716 hourglass_shown_p
= 0;
28718 DEFSYM (Qglyphless_char
, "glyphless-char");
28719 DEFSYM (Qhex_code
, "hex-code");
28720 DEFSYM (Qempty_box
, "empty-box");
28721 DEFSYM (Qthin_space
, "thin-space");
28722 DEFSYM (Qzero_width
, "zero-width");
28724 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28725 /* Intern this now in case it isn't already done.
28726 Setting this variable twice is harmless.
28727 But don't staticpro it here--that is done in alloc.c. */
28728 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28729 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28731 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28732 doc
: /* Char-table defining glyphless characters.
28733 Each element, if non-nil, should be one of the following:
28734 an ASCII acronym string: display this string in a box
28735 `hex-code': display the hexadecimal code of a character in a box
28736 `empty-box': display as an empty box
28737 `thin-space': display as 1-pixel width space
28738 `zero-width': don't display
28739 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28740 display method for graphical terminals and text terminals respectively.
28741 GRAPHICAL and TEXT should each have one of the values listed above.
28743 The char-table has one extra slot to control the display of a character for
28744 which no font is found. This slot only takes effect on graphical terminals.
28745 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28746 `thin-space'. The default is `empty-box'. */);
28747 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28748 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28753 /* Initialize this module when Emacs starts. */
28758 current_header_line_height
= current_mode_line_height
= -1;
28760 CHARPOS (this_line_start_pos
) = 0;
28762 if (!noninteractive
)
28764 struct window
*m
= XWINDOW (minibuf_window
);
28765 Lisp_Object frame
= m
->frame
;
28766 struct frame
*f
= XFRAME (frame
);
28767 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28768 struct window
*r
= XWINDOW (root
);
28771 echo_area_window
= minibuf_window
;
28773 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28774 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28775 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28776 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28777 XSETFASTINT (m
->total_lines
, 1);
28778 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28780 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28781 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28782 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28784 /* The default ellipsis glyphs `...'. */
28785 for (i
= 0; i
< 3; ++i
)
28786 default_invis_vector
[i
] = make_number ('.');
28790 /* Allocate the buffer for frame titles.
28791 Also used for `format-mode-line'. */
28793 mode_line_noprop_buf
= (char *) xmalloc (size
);
28794 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28795 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28796 mode_line_target
= MODE_LINE_DISPLAY
;
28799 help_echo_showing_p
= 0;
28802 /* Since w32 does not support atimers, it defines its own implementation of
28803 the following three functions in w32fns.c. */
28806 /* Platform-independent portion of hourglass implementation. */
28808 /* Return non-zero if hourglass timer has been started or hourglass is
28811 hourglass_started (void)
28813 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28816 /* Cancel a currently active hourglass timer, and start a new one. */
28818 start_hourglass (void)
28820 #if defined (HAVE_WINDOW_SYSTEM)
28822 int secs
, usecs
= 0;
28824 cancel_hourglass ();
28826 if (INTEGERP (Vhourglass_delay
)
28827 && XINT (Vhourglass_delay
) > 0)
28828 secs
= XFASTINT (Vhourglass_delay
);
28829 else if (FLOATP (Vhourglass_delay
)
28830 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28833 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28834 secs
= XFASTINT (tem
);
28835 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28838 secs
= DEFAULT_HOURGLASS_DELAY
;
28840 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28841 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28842 show_hourglass
, NULL
);
28847 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28850 cancel_hourglass (void)
28852 #if defined (HAVE_WINDOW_SYSTEM)
28853 if (hourglass_atimer
)
28855 cancel_atimer (hourglass_atimer
);
28856 hourglass_atimer
= NULL
;
28859 if (hourglass_shown_p
)
28863 #endif /* ! WINDOWSNT */