1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 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
;
2754 IT_CHARPOS (*it
) = charpos
;
2756 /* Compute byte position if not specified. */
2757 if (bytepos
< charpos
)
2758 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2760 IT_BYTEPOS (*it
) = bytepos
;
2762 it
->start
= it
->current
;
2763 /* Do we need to reorder bidirectional text? Not if this is a
2764 unibyte buffer: by definition, none of the single-byte
2765 characters are strong R2L, so no reordering is needed. And
2766 bidi.c doesn't support unibyte buffers anyway. Also, don't
2767 reorder while we are loading loadup.el, since the tables of
2768 character properties needed for reordering are not yet
2772 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2775 /* If we are to reorder bidirectional text, init the bidi
2779 /* Note the paragraph direction that this buffer wants to
2781 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2783 it
->paragraph_embedding
= L2R
;
2784 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2786 it
->paragraph_embedding
= R2L
;
2788 it
->paragraph_embedding
= NEUTRAL_DIR
;
2789 bidi_unshelve_cache (NULL
, 0);
2790 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2794 /* Compute faces etc. */
2795 reseat (it
, it
->current
.pos
, 1);
2802 /* Initialize IT for the display of window W with window start POS. */
2805 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2807 struct glyph_row
*row
;
2808 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2810 row
= w
->desired_matrix
->rows
+ first_vpos
;
2811 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2812 it
->first_vpos
= first_vpos
;
2814 /* Don't reseat to previous visible line start if current start
2815 position is in a string or image. */
2816 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2818 int start_at_line_beg_p
;
2819 int first_y
= it
->current_y
;
2821 /* If window start is not at a line start, skip forward to POS to
2822 get the correct continuation lines width. */
2823 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2824 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2825 if (!start_at_line_beg_p
)
2829 reseat_at_previous_visible_line_start (it
);
2830 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2832 new_x
= it
->current_x
+ it
->pixel_width
;
2834 /* If lines are continued, this line may end in the middle
2835 of a multi-glyph character (e.g. a control character
2836 displayed as \003, or in the middle of an overlay
2837 string). In this case move_it_to above will not have
2838 taken us to the start of the continuation line but to the
2839 end of the continued line. */
2840 if (it
->current_x
> 0
2841 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2842 && (/* And glyph doesn't fit on the line. */
2843 new_x
> it
->last_visible_x
2844 /* Or it fits exactly and we're on a window
2846 || (new_x
== it
->last_visible_x
2847 && FRAME_WINDOW_P (it
->f
))))
2849 if ((it
->current
.dpvec_index
>= 0
2850 || it
->current
.overlay_string_index
>= 0)
2851 /* If we are on a newline from a display vector or
2852 overlay string, then we are already at the end of
2853 a screen line; no need to go to the next line in
2854 that case, as this line is not really continued.
2855 (If we do go to the next line, C-e will not DTRT.) */
2858 set_iterator_to_next (it
, 1);
2859 move_it_in_display_line_to (it
, -1, -1, 0);
2862 it
->continuation_lines_width
+= it
->current_x
;
2864 /* If the character at POS is displayed via a display
2865 vector, move_it_to above stops at the final glyph of
2866 IT->dpvec. To make the caller redisplay that character
2867 again (a.k.a. start at POS), we need to reset the
2868 dpvec_index to the beginning of IT->dpvec. */
2869 else if (it
->current
.dpvec_index
>= 0)
2870 it
->current
.dpvec_index
= 0;
2872 /* We're starting a new display line, not affected by the
2873 height of the continued line, so clear the appropriate
2874 fields in the iterator structure. */
2875 it
->max_ascent
= it
->max_descent
= 0;
2876 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2878 it
->current_y
= first_y
;
2880 it
->current_x
= it
->hpos
= 0;
2886 /* Return 1 if POS is a position in ellipses displayed for invisible
2887 text. W is the window we display, for text property lookup. */
2890 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2892 Lisp_Object prop
, window
;
2894 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2896 /* If POS specifies a position in a display vector, this might
2897 be for an ellipsis displayed for invisible text. We won't
2898 get the iterator set up for delivering that ellipsis unless
2899 we make sure that it gets aware of the invisible text. */
2900 if (pos
->dpvec_index
>= 0
2901 && pos
->overlay_string_index
< 0
2902 && CHARPOS (pos
->string_pos
) < 0
2904 && (XSETWINDOW (window
, w
),
2905 prop
= Fget_char_property (make_number (charpos
),
2906 Qinvisible
, window
),
2907 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2909 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2911 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2918 /* Initialize IT for stepping through current_buffer in window W,
2919 starting at position POS that includes overlay string and display
2920 vector/ control character translation position information. Value
2921 is zero if there are overlay strings with newlines at POS. */
2924 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2926 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2927 int i
, overlay_strings_with_newlines
= 0;
2929 /* If POS specifies a position in a display vector, this might
2930 be for an ellipsis displayed for invisible text. We won't
2931 get the iterator set up for delivering that ellipsis unless
2932 we make sure that it gets aware of the invisible text. */
2933 if (in_ellipses_for_invisible_text_p (pos
, w
))
2939 /* Keep in mind: the call to reseat in init_iterator skips invisible
2940 text, so we might end up at a position different from POS. This
2941 is only a problem when POS is a row start after a newline and an
2942 overlay starts there with an after-string, and the overlay has an
2943 invisible property. Since we don't skip invisible text in
2944 display_line and elsewhere immediately after consuming the
2945 newline before the row start, such a POS will not be in a string,
2946 but the call to init_iterator below will move us to the
2948 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2950 /* This only scans the current chunk -- it should scan all chunks.
2951 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2952 to 16 in 22.1 to make this a lesser problem. */
2953 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2955 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2956 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2958 while (s
< e
&& *s
!= '\n')
2963 overlay_strings_with_newlines
= 1;
2968 /* If position is within an overlay string, set up IT to the right
2970 if (pos
->overlay_string_index
>= 0)
2974 /* If the first overlay string happens to have a `display'
2975 property for an image, the iterator will be set up for that
2976 image, and we have to undo that setup first before we can
2977 correct the overlay string index. */
2978 if (it
->method
== GET_FROM_IMAGE
)
2981 /* We already have the first chunk of overlay strings in
2982 IT->overlay_strings. Load more until the one for
2983 pos->overlay_string_index is in IT->overlay_strings. */
2984 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2986 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2987 it
->current
.overlay_string_index
= 0;
2990 load_overlay_strings (it
, 0);
2991 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2995 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2996 relative_index
= (it
->current
.overlay_string_index
2997 % OVERLAY_STRING_CHUNK_SIZE
);
2998 it
->string
= it
->overlay_strings
[relative_index
];
2999 xassert (STRINGP (it
->string
));
3000 it
->current
.string_pos
= pos
->string_pos
;
3001 it
->method
= GET_FROM_STRING
;
3004 if (CHARPOS (pos
->string_pos
) >= 0)
3006 /* Recorded position is not in an overlay string, but in another
3007 string. This can only be a string from a `display' property.
3008 IT should already be filled with that string. */
3009 it
->current
.string_pos
= pos
->string_pos
;
3010 xassert (STRINGP (it
->string
));
3013 /* Restore position in display vector translations, control
3014 character translations or ellipses. */
3015 if (pos
->dpvec_index
>= 0)
3017 if (it
->dpvec
== NULL
)
3018 get_next_display_element (it
);
3019 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3020 it
->current
.dpvec_index
= pos
->dpvec_index
;
3024 return !overlay_strings_with_newlines
;
3028 /* Initialize IT for stepping through current_buffer in window W
3029 starting at ROW->start. */
3032 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3034 init_from_display_pos (it
, w
, &row
->start
);
3035 it
->start
= row
->start
;
3036 it
->continuation_lines_width
= row
->continuation_lines_width
;
3041 /* Initialize IT for stepping through current_buffer in window W
3042 starting in the line following ROW, i.e. starting at ROW->end.
3043 Value is zero if there are overlay strings with newlines at ROW's
3047 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3051 if (init_from_display_pos (it
, w
, &row
->end
))
3053 if (row
->continued_p
)
3054 it
->continuation_lines_width
3055 = row
->continuation_lines_width
+ row
->pixel_width
;
3066 /***********************************************************************
3068 ***********************************************************************/
3070 /* Called when IT reaches IT->stop_charpos. Handle text property and
3071 overlay changes. Set IT->stop_charpos to the next position where
3075 handle_stop (struct it
*it
)
3077 enum prop_handled handled
;
3078 int handle_overlay_change_p
;
3082 it
->current
.dpvec_index
= -1;
3083 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3084 it
->ignore_overlay_strings_at_pos_p
= 0;
3087 /* Use face of preceding text for ellipsis (if invisible) */
3088 if (it
->selective_display_ellipsis_p
)
3089 it
->saved_face_id
= it
->face_id
;
3093 handled
= HANDLED_NORMALLY
;
3095 /* Call text property handlers. */
3096 for (p
= it_props
; p
->handler
; ++p
)
3098 handled
= p
->handler (it
);
3100 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3102 else if (handled
== HANDLED_RETURN
)
3104 /* We still want to show before and after strings from
3105 overlays even if the actual buffer text is replaced. */
3106 if (!handle_overlay_change_p
3108 || !get_overlay_strings_1 (it
, 0, 0))
3111 setup_for_ellipsis (it
, 0);
3112 /* When handling a display spec, we might load an
3113 empty string. In that case, discard it here. We
3114 used to discard it in handle_single_display_spec,
3115 but that causes get_overlay_strings_1, above, to
3116 ignore overlay strings that we must check. */
3117 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3121 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3125 it
->ignore_overlay_strings_at_pos_p
= 1;
3126 it
->string_from_display_prop_p
= 0;
3127 it
->from_disp_prop_p
= 0;
3128 handle_overlay_change_p
= 0;
3130 handled
= HANDLED_RECOMPUTE_PROPS
;
3133 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3134 handle_overlay_change_p
= 0;
3137 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3139 /* Don't check for overlay strings below when set to deliver
3140 characters from a display vector. */
3141 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3142 handle_overlay_change_p
= 0;
3144 /* Handle overlay changes.
3145 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3146 if it finds overlays. */
3147 if (handle_overlay_change_p
)
3148 handled
= handle_overlay_change (it
);
3153 setup_for_ellipsis (it
, 0);
3157 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3159 /* Determine where to stop next. */
3160 if (handled
== HANDLED_NORMALLY
)
3161 compute_stop_pos (it
);
3165 /* Compute IT->stop_charpos from text property and overlay change
3166 information for IT's current position. */
3169 compute_stop_pos (struct it
*it
)
3171 register INTERVAL iv
, next_iv
;
3172 Lisp_Object object
, limit
, position
;
3173 EMACS_INT charpos
, bytepos
;
3175 if (STRINGP (it
->string
))
3177 /* Strings are usually short, so don't limit the search for
3179 it
->stop_charpos
= it
->end_charpos
;
3180 object
= it
->string
;
3182 charpos
= IT_STRING_CHARPOS (*it
);
3183 bytepos
= IT_STRING_BYTEPOS (*it
);
3189 /* If end_charpos is out of range for some reason, such as a
3190 misbehaving display function, rationalize it (Bug#5984). */
3191 if (it
->end_charpos
> ZV
)
3192 it
->end_charpos
= ZV
;
3193 it
->stop_charpos
= it
->end_charpos
;
3195 /* If next overlay change is in front of the current stop pos
3196 (which is IT->end_charpos), stop there. Note: value of
3197 next_overlay_change is point-max if no overlay change
3199 charpos
= IT_CHARPOS (*it
);
3200 bytepos
= IT_BYTEPOS (*it
);
3201 pos
= next_overlay_change (charpos
);
3202 if (pos
< it
->stop_charpos
)
3203 it
->stop_charpos
= pos
;
3205 /* If showing the region, we have to stop at the region
3206 start or end because the face might change there. */
3207 if (it
->region_beg_charpos
> 0)
3209 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3210 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3211 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3212 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3215 /* Set up variables for computing the stop position from text
3216 property changes. */
3217 XSETBUFFER (object
, current_buffer
);
3218 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3221 /* Get the interval containing IT's position. Value is a null
3222 interval if there isn't such an interval. */
3223 position
= make_number (charpos
);
3224 iv
= validate_interval_range (object
, &position
, &position
, 0);
3225 if (!NULL_INTERVAL_P (iv
))
3227 Lisp_Object values_here
[LAST_PROP_IDX
];
3230 /* Get properties here. */
3231 for (p
= it_props
; p
->handler
; ++p
)
3232 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3234 /* Look for an interval following iv that has different
3236 for (next_iv
= next_interval (iv
);
3237 (!NULL_INTERVAL_P (next_iv
)
3239 || XFASTINT (limit
) > next_iv
->position
));
3240 next_iv
= next_interval (next_iv
))
3242 for (p
= it_props
; p
->handler
; ++p
)
3244 Lisp_Object new_value
;
3246 new_value
= textget (next_iv
->plist
, *p
->name
);
3247 if (!EQ (values_here
[p
->idx
], new_value
))
3255 if (!NULL_INTERVAL_P (next_iv
))
3257 if (INTEGERP (limit
)
3258 && next_iv
->position
>= XFASTINT (limit
))
3259 /* No text property change up to limit. */
3260 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3262 /* Text properties change in next_iv. */
3263 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3267 if (it
->cmp_it
.id
< 0)
3269 EMACS_INT stoppos
= it
->end_charpos
;
3271 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3273 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3274 stoppos
, it
->string
);
3277 xassert (STRINGP (it
->string
)
3278 || (it
->stop_charpos
>= BEGV
3279 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3283 /* Return the position of the next overlay change after POS in
3284 current_buffer. Value is point-max if no overlay change
3285 follows. This is like `next-overlay-change' but doesn't use
3289 next_overlay_change (EMACS_INT pos
)
3291 ptrdiff_t i
, noverlays
;
3293 Lisp_Object
*overlays
;
3295 /* Get all overlays at the given position. */
3296 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3298 /* If any of these overlays ends before endpos,
3299 use its ending point instead. */
3300 for (i
= 0; i
< noverlays
; ++i
)
3305 oend
= OVERLAY_END (overlays
[i
]);
3306 oendpos
= OVERLAY_POSITION (oend
);
3307 endpos
= min (endpos
, oendpos
);
3313 /* How many characters forward to search for a display property or
3314 display string. Searching too far forward makes the bidi display
3315 sluggish, especially in small windows. */
3316 #define MAX_DISP_SCAN 250
3318 /* Return the character position of a display string at or after
3319 position specified by POSITION. If no display string exists at or
3320 after POSITION, return ZV. A display string is either an overlay
3321 with `display' property whose value is a string, or a `display'
3322 text property whose value is a string. STRING is data about the
3323 string to iterate; if STRING->lstring is nil, we are iterating a
3324 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3325 on a GUI frame. DISP_PROP is set to zero if we searched
3326 MAX_DISP_SCAN characters forward without finding any display
3327 strings, non-zero otherwise. It is set to 2 if the display string
3328 uses any kind of `(space ...)' spec that will produce a stretch of
3329 white space in the text area. */
3331 compute_display_string_pos (struct text_pos
*position
,
3332 struct bidi_string_data
*string
,
3333 int frame_window_p
, int *disp_prop
)
3335 /* OBJECT = nil means current buffer. */
3336 Lisp_Object object
=
3337 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3338 Lisp_Object pos
, spec
, limpos
;
3339 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3340 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3341 EMACS_INT begb
= string_p
? 0 : BEGV
;
3342 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3344 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3345 struct text_pos tpos
;
3351 /* We don't support display properties whose values are strings
3352 that have display string properties. */
3353 || string
->from_disp_str
3354 /* C strings cannot have display properties. */
3355 || (string
->s
&& !STRINGP (object
)))
3361 /* If the character at CHARPOS is where the display string begins,
3363 pos
= make_number (charpos
);
3364 if (STRINGP (object
))
3365 bufpos
= string
->bufpos
;
3369 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3371 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3374 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3382 /* Look forward for the first character with a `display' property
3383 that will replace the underlying text when displayed. */
3384 limpos
= make_number (lim
);
3386 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3387 CHARPOS (tpos
) = XFASTINT (pos
);
3388 if (CHARPOS (tpos
) >= lim
)
3393 if (STRINGP (object
))
3394 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3396 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3397 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3398 if (!STRINGP (object
))
3399 bufpos
= CHARPOS (tpos
);
3400 } while (NILP (spec
)
3401 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3402 bufpos
, frame_window_p
)));
3406 return CHARPOS (tpos
);
3409 /* Return the character position of the end of the display string that
3410 started at CHARPOS. If there's no display string at CHARPOS,
3411 return -1. A display string is either an overlay with `display'
3412 property whose value is a string or a `display' text property whose
3413 value is a string. */
3415 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3417 /* OBJECT = nil means current buffer. */
3418 Lisp_Object object
=
3419 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3420 Lisp_Object pos
= make_number (charpos
);
3422 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3424 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3427 /* It could happen that the display property or overlay was removed
3428 since we found it in compute_display_string_pos above. One way
3429 this can happen is if JIT font-lock was called (through
3430 handle_fontified_prop), and jit-lock-functions remove text
3431 properties or overlays from the portion of buffer that includes
3432 CHARPOS. Muse mode is known to do that, for example. In this
3433 case, we return -1 to the caller, to signal that no display
3434 string is actually present at CHARPOS. See bidi_fetch_char for
3435 how this is handled.
3437 An alternative would be to never look for display properties past
3438 it->stop_charpos. But neither compute_display_string_pos nor
3439 bidi_fetch_char that calls it know or care where the next
3441 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3444 /* Look forward for the first character where the `display' property
3446 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3448 return XFASTINT (pos
);
3453 /***********************************************************************
3455 ***********************************************************************/
3457 /* Handle changes in the `fontified' property of the current buffer by
3458 calling hook functions from Qfontification_functions to fontify
3461 static enum prop_handled
3462 handle_fontified_prop (struct it
*it
)
3464 Lisp_Object prop
, pos
;
3465 enum prop_handled handled
= HANDLED_NORMALLY
;
3467 if (!NILP (Vmemory_full
))
3470 /* Get the value of the `fontified' property at IT's current buffer
3471 position. (The `fontified' property doesn't have a special
3472 meaning in strings.) If the value is nil, call functions from
3473 Qfontification_functions. */
3474 if (!STRINGP (it
->string
)
3476 && !NILP (Vfontification_functions
)
3477 && !NILP (Vrun_hooks
)
3478 && (pos
= make_number (IT_CHARPOS (*it
)),
3479 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3480 /* Ignore the special cased nil value always present at EOB since
3481 no amount of fontifying will be able to change it. */
3482 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3484 int count
= SPECPDL_INDEX ();
3486 struct buffer
*obuf
= current_buffer
;
3487 int begv
= BEGV
, zv
= ZV
;
3488 int old_clip_changed
= current_buffer
->clip_changed
;
3490 val
= Vfontification_functions
;
3491 specbind (Qfontification_functions
, Qnil
);
3493 xassert (it
->end_charpos
== ZV
);
3495 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3496 safe_call1 (val
, pos
);
3499 Lisp_Object fns
, fn
;
3500 struct gcpro gcpro1
, gcpro2
;
3505 for (; CONSP (val
); val
= XCDR (val
))
3511 /* A value of t indicates this hook has a local
3512 binding; it means to run the global binding too.
3513 In a global value, t should not occur. If it
3514 does, we must ignore it to avoid an endless
3516 for (fns
= Fdefault_value (Qfontification_functions
);
3522 safe_call1 (fn
, pos
);
3526 safe_call1 (fn
, pos
);
3532 unbind_to (count
, Qnil
);
3534 /* Fontification functions routinely call `save-restriction'.
3535 Normally, this tags clip_changed, which can confuse redisplay
3536 (see discussion in Bug#6671). Since we don't perform any
3537 special handling of fontification changes in the case where
3538 `save-restriction' isn't called, there's no point doing so in
3539 this case either. So, if the buffer's restrictions are
3540 actually left unchanged, reset clip_changed. */
3541 if (obuf
== current_buffer
)
3543 if (begv
== BEGV
&& zv
== ZV
)
3544 current_buffer
->clip_changed
= old_clip_changed
;
3546 /* There isn't much we can reasonably do to protect against
3547 misbehaving fontification, but here's a fig leaf. */
3548 else if (!NILP (BVAR (obuf
, name
)))
3549 set_buffer_internal_1 (obuf
);
3551 /* The fontification code may have added/removed text.
3552 It could do even a lot worse, but let's at least protect against
3553 the most obvious case where only the text past `pos' gets changed',
3554 as is/was done in grep.el where some escapes sequences are turned
3555 into face properties (bug#7876). */
3556 it
->end_charpos
= ZV
;
3558 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3559 something. This avoids an endless loop if they failed to
3560 fontify the text for which reason ever. */
3561 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3562 handled
= HANDLED_RECOMPUTE_PROPS
;
3570 /***********************************************************************
3572 ***********************************************************************/
3574 /* Set up iterator IT from face properties at its current position.
3575 Called from handle_stop. */
3577 static enum prop_handled
3578 handle_face_prop (struct it
*it
)
3581 EMACS_INT next_stop
;
3583 if (!STRINGP (it
->string
))
3586 = face_at_buffer_position (it
->w
,
3588 it
->region_beg_charpos
,
3589 it
->region_end_charpos
,
3592 + TEXT_PROP_DISTANCE_LIMIT
),
3593 0, it
->base_face_id
);
3595 /* Is this a start of a run of characters with box face?
3596 Caveat: this can be called for a freshly initialized
3597 iterator; face_id is -1 in this case. We know that the new
3598 face will not change until limit, i.e. if the new face has a
3599 box, all characters up to limit will have one. But, as
3600 usual, we don't know whether limit is really the end. */
3601 if (new_face_id
!= it
->face_id
)
3603 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3605 /* If new face has a box but old face has not, this is
3606 the start of a run of characters with box, i.e. it has
3607 a shadow on the left side. The value of face_id of the
3608 iterator will be -1 if this is the initial call that gets
3609 the face. In this case, we have to look in front of IT's
3610 position and see whether there is a face != new_face_id. */
3611 it
->start_of_box_run_p
3612 = (new_face
->box
!= FACE_NO_BOX
3613 && (it
->face_id
>= 0
3614 || IT_CHARPOS (*it
) == BEG
3615 || new_face_id
!= face_before_it_pos (it
)));
3616 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3624 Lisp_Object from_overlay
3625 = (it
->current
.overlay_string_index
>= 0
3626 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3629 /* See if we got to this string directly or indirectly from
3630 an overlay property. That includes the before-string or
3631 after-string of an overlay, strings in display properties
3632 provided by an overlay, their text properties, etc.
3634 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3635 if (! NILP (from_overlay
))
3636 for (i
= it
->sp
- 1; i
>= 0; i
--)
3638 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3640 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3641 else if (! NILP (it
->stack
[i
].from_overlay
))
3642 from_overlay
= it
->stack
[i
].from_overlay
;
3644 if (!NILP (from_overlay
))
3648 if (! NILP (from_overlay
))
3650 bufpos
= IT_CHARPOS (*it
);
3651 /* For a string from an overlay, the base face depends
3652 only on text properties and ignores overlays. */
3654 = face_for_overlay_string (it
->w
,
3656 it
->region_beg_charpos
,
3657 it
->region_end_charpos
,
3660 + TEXT_PROP_DISTANCE_LIMIT
),
3668 /* For strings from a `display' property, use the face at
3669 IT's current buffer position as the base face to merge
3670 with, so that overlay strings appear in the same face as
3671 surrounding text, unless they specify their own
3673 base_face_id
= underlying_face_id (it
);
3676 new_face_id
= face_at_string_position (it
->w
,
3678 IT_STRING_CHARPOS (*it
),
3680 it
->region_beg_charpos
,
3681 it
->region_end_charpos
,
3685 /* Is this a start of a run of characters with box? Caveat:
3686 this can be called for a freshly allocated iterator; face_id
3687 is -1 is this case. We know that the new face will not
3688 change until the next check pos, i.e. if the new face has a
3689 box, all characters up to that position will have a
3690 box. But, as usual, we don't know whether that position
3691 is really the end. */
3692 if (new_face_id
!= it
->face_id
)
3694 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3695 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3697 /* If new face has a box but old face hasn't, this is the
3698 start of a run of characters with box, i.e. it has a
3699 shadow on the left side. */
3700 it
->start_of_box_run_p
3701 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3702 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3706 it
->face_id
= new_face_id
;
3707 return HANDLED_NORMALLY
;
3711 /* Return the ID of the face ``underlying'' IT's current position,
3712 which is in a string. If the iterator is associated with a
3713 buffer, return the face at IT's current buffer position.
3714 Otherwise, use the iterator's base_face_id. */
3717 underlying_face_id (struct it
*it
)
3719 int face_id
= it
->base_face_id
, i
;
3721 xassert (STRINGP (it
->string
));
3723 for (i
= it
->sp
- 1; i
>= 0; --i
)
3724 if (NILP (it
->stack
[i
].string
))
3725 face_id
= it
->stack
[i
].face_id
;
3731 /* Compute the face one character before or after the current position
3732 of IT, in the visual order. BEFORE_P non-zero means get the face
3733 in front (to the left in L2R paragraphs, to the right in R2L
3734 paragraphs) of IT's screen position. Value is the ID of the face. */
3737 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3740 EMACS_INT next_check_charpos
;
3742 void *it_copy_data
= NULL
;
3744 xassert (it
->s
== NULL
);
3746 if (STRINGP (it
->string
))
3748 EMACS_INT bufpos
, charpos
;
3751 /* No face change past the end of the string (for the case
3752 we are padding with spaces). No face change before the
3754 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3755 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3760 /* Set charpos to the position before or after IT's current
3761 position, in the logical order, which in the non-bidi
3762 case is the same as the visual order. */
3764 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3765 else if (it
->what
== IT_COMPOSITION
)
3766 /* For composition, we must check the character after the
3768 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3770 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3776 /* With bidi iteration, the character before the current
3777 in the visual order cannot be found by simple
3778 iteration, because "reverse" reordering is not
3779 supported. Instead, we need to use the move_it_*
3780 family of functions. */
3781 /* Ignore face changes before the first visible
3782 character on this display line. */
3783 if (it
->current_x
<= it
->first_visible_x
)
3785 SAVE_IT (it_copy
, *it
, it_copy_data
);
3786 /* Implementation note: Since move_it_in_display_line
3787 works in the iterator geometry, and thinks the first
3788 character is always the leftmost, even in R2L lines,
3789 we don't need to distinguish between the R2L and L2R
3791 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3792 it_copy
.current_x
- 1, MOVE_TO_X
);
3793 charpos
= IT_STRING_CHARPOS (it_copy
);
3794 RESTORE_IT (it
, it
, it_copy_data
);
3798 /* Set charpos to the string position of the character
3799 that comes after IT's current position in the visual
3801 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3805 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3807 charpos
= it_copy
.bidi_it
.charpos
;
3810 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3812 if (it
->current
.overlay_string_index
>= 0)
3813 bufpos
= IT_CHARPOS (*it
);
3817 base_face_id
= underlying_face_id (it
);
3819 /* Get the face for ASCII, or unibyte. */
3820 face_id
= face_at_string_position (it
->w
,
3824 it
->region_beg_charpos
,
3825 it
->region_end_charpos
,
3826 &next_check_charpos
,
3829 /* Correct the face for charsets different from ASCII. Do it
3830 for the multibyte case only. The face returned above is
3831 suitable for unibyte text if IT->string is unibyte. */
3832 if (STRING_MULTIBYTE (it
->string
))
3834 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3835 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3837 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3839 c
= string_char_and_length (p
, &len
);
3840 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3845 struct text_pos pos
;
3847 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3848 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3851 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3852 pos
= it
->current
.pos
;
3857 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3860 if (it
->what
== IT_COMPOSITION
)
3862 /* For composition, we must check the position after
3864 pos
.charpos
+= it
->cmp_it
.nchars
;
3865 pos
.bytepos
+= it
->len
;
3868 INC_TEXT_POS (pos
, it
->multibyte_p
);
3875 /* With bidi iteration, the character before the current
3876 in the visual order cannot be found by simple
3877 iteration, because "reverse" reordering is not
3878 supported. Instead, we need to use the move_it_*
3879 family of functions. */
3880 /* Ignore face changes before the first visible
3881 character on this display line. */
3882 if (it
->current_x
<= it
->first_visible_x
)
3884 SAVE_IT (it_copy
, *it
, it_copy_data
);
3885 /* Implementation note: Since move_it_in_display_line
3886 works in the iterator geometry, and thinks the first
3887 character is always the leftmost, even in R2L lines,
3888 we don't need to distinguish between the R2L and L2R
3890 move_it_in_display_line (&it_copy
, ZV
,
3891 it_copy
.current_x
- 1, MOVE_TO_X
);
3892 pos
= it_copy
.current
.pos
;
3893 RESTORE_IT (it
, it
, it_copy_data
);
3897 /* Set charpos to the buffer position of the character
3898 that comes after IT's current position in the visual
3900 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3904 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3907 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3910 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3912 /* Determine face for CHARSET_ASCII, or unibyte. */
3913 face_id
= face_at_buffer_position (it
->w
,
3915 it
->region_beg_charpos
,
3916 it
->region_end_charpos
,
3917 &next_check_charpos
,
3920 /* Correct the face for charsets different from ASCII. Do it
3921 for the multibyte case only. The face returned above is
3922 suitable for unibyte text if current_buffer is unibyte. */
3923 if (it
->multibyte_p
)
3925 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3926 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3927 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3936 /***********************************************************************
3938 ***********************************************************************/
3940 /* Set up iterator IT from invisible properties at its current
3941 position. Called from handle_stop. */
3943 static enum prop_handled
3944 handle_invisible_prop (struct it
*it
)
3946 enum prop_handled handled
= HANDLED_NORMALLY
;
3948 if (STRINGP (it
->string
))
3950 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3952 /* Get the value of the invisible text property at the
3953 current position. Value will be nil if there is no such
3955 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3956 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3959 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3963 handled
= HANDLED_RECOMPUTE_PROPS
;
3965 /* Get the position at which the next change of the
3966 invisible text property can be found in IT->string.
3967 Value will be nil if the property value is the same for
3968 all the rest of IT->string. */
3969 XSETINT (limit
, SCHARS (it
->string
));
3970 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3973 /* Text at current position is invisible. The next
3974 change in the property is at position end_charpos.
3975 Move IT's current position to that position. */
3976 if (INTEGERP (end_charpos
)
3977 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3979 struct text_pos old
;
3982 old
= it
->current
.string_pos
;
3983 oldpos
= CHARPOS (old
);
3986 if (it
->bidi_it
.first_elt
3987 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3988 bidi_paragraph_init (it
->paragraph_embedding
,
3990 /* Bidi-iterate out of the invisible text. */
3993 bidi_move_to_visually_next (&it
->bidi_it
);
3995 while (oldpos
<= it
->bidi_it
.charpos
3996 && it
->bidi_it
.charpos
< endpos
);
3998 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3999 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4000 if (IT_CHARPOS (*it
) >= endpos
)
4001 it
->prev_stop
= endpos
;
4005 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4006 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4011 /* The rest of the string is invisible. If this is an
4012 overlay string, proceed with the next overlay string
4013 or whatever comes and return a character from there. */
4014 if (it
->current
.overlay_string_index
>= 0)
4016 next_overlay_string (it
);
4017 /* Don't check for overlay strings when we just
4018 finished processing them. */
4019 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4023 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4024 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4032 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4033 Lisp_Object pos
, prop
, overlay
;
4035 /* First of all, is there invisible text at this position? */
4036 tem
= start_charpos
= IT_CHARPOS (*it
);
4037 pos
= make_number (tem
);
4038 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4040 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4042 /* If we are on invisible text, skip over it. */
4043 if (invis_p
&& start_charpos
< it
->end_charpos
)
4045 /* Record whether we have to display an ellipsis for the
4047 int display_ellipsis_p
= invis_p
== 2;
4049 handled
= HANDLED_RECOMPUTE_PROPS
;
4051 /* Loop skipping over invisible text. The loop is left at
4052 ZV or with IT on the first char being visible again. */
4055 /* Try to skip some invisible text. Return value is the
4056 position reached which can be equal to where we start
4057 if there is nothing invisible there. This skips both
4058 over invisible text properties and overlays with
4059 invisible property. */
4060 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4062 /* If we skipped nothing at all we weren't at invisible
4063 text in the first place. If everything to the end of
4064 the buffer was skipped, end the loop. */
4065 if (newpos
== tem
|| newpos
>= ZV
)
4069 /* We skipped some characters but not necessarily
4070 all there are. Check if we ended up on visible
4071 text. Fget_char_property returns the property of
4072 the char before the given position, i.e. if we
4073 get invis_p = 0, this means that the char at
4074 newpos is visible. */
4075 pos
= make_number (newpos
);
4076 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4077 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4080 /* If we ended up on invisible text, proceed to
4081 skip starting with next_stop. */
4085 /* If there are adjacent invisible texts, don't lose the
4086 second one's ellipsis. */
4088 display_ellipsis_p
= 1;
4092 /* The position newpos is now either ZV or on visible text. */
4093 if (it
->bidi_p
&& newpos
< ZV
)
4095 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4096 int on_newline
= FETCH_BYTE (bpos
) == '\n';
4098 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4100 /* If the invisible text ends on a newline or on a
4101 character after a newline, we can avoid the costly,
4102 character by character, bidi iteration to NEWPOS, and
4103 instead simply reseat the iterator there. That's
4104 because all bidi reordering information is tossed at
4105 the newline. This is a big win for modes that hide
4106 complete lines, like Outline, Org, etc. */
4107 if (on_newline
|| after_newline
)
4109 struct text_pos tpos
;
4110 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4112 SET_TEXT_POS (tpos
, newpos
, bpos
);
4113 reseat_1 (it
, tpos
, 0);
4114 /* If we reseat on a newline, we need to prep the
4115 bidi iterator for advancing to the next character
4116 after the newline, keeping the current paragraph
4117 direction (so that PRODUCE_GLYPHS does TRT wrt
4118 prepending/appending glyphs to a glyph row). */
4121 it
->bidi_it
.first_elt
= 0;
4122 it
->bidi_it
.paragraph_dir
= pdir
;
4123 it
->bidi_it
.ch
= '\n';
4124 it
->bidi_it
.nchars
= 1;
4125 it
->bidi_it
.ch_len
= 1;
4128 else /* Must use the slow method. */
4130 /* With bidi iteration, the region of invisible text
4131 could start and/or end in the middle of a
4132 non-base embedding level. Therefore, we need to
4133 skip invisible text using the bidi iterator,
4134 starting at IT's current position, until we find
4135 ourselves outside of the invisible text.
4136 Skipping invisible text _after_ bidi iteration
4137 avoids affecting the visual order of the
4138 displayed text when invisible properties are
4139 added or removed. */
4140 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4142 /* If we were `reseat'ed to a new paragraph,
4143 determine the paragraph base direction. We
4144 need to do it now because
4145 next_element_from_buffer may not have a
4146 chance to do it, if we are going to skip any
4147 text at the beginning, which resets the
4149 bidi_paragraph_init (it
->paragraph_embedding
,
4154 bidi_move_to_visually_next (&it
->bidi_it
);
4156 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4157 && it
->bidi_it
.charpos
< newpos
);
4158 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4159 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4160 /* If we overstepped NEWPOS, record its position in
4161 the iterator, so that we skip invisible text if
4162 later the bidi iteration lands us in the
4163 invisible region again. */
4164 if (IT_CHARPOS (*it
) >= newpos
)
4165 it
->prev_stop
= newpos
;
4170 IT_CHARPOS (*it
) = newpos
;
4171 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4174 /* If there are before-strings at the start of invisible
4175 text, and the text is invisible because of a text
4176 property, arrange to show before-strings because 20.x did
4177 it that way. (If the text is invisible because of an
4178 overlay property instead of a text property, this is
4179 already handled in the overlay code.) */
4181 && get_overlay_strings (it
, it
->stop_charpos
))
4183 handled
= HANDLED_RECOMPUTE_PROPS
;
4184 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4186 else if (display_ellipsis_p
)
4188 /* Make sure that the glyphs of the ellipsis will get
4189 correct `charpos' values. If we would not update
4190 it->position here, the glyphs would belong to the
4191 last visible character _before_ the invisible
4192 text, which confuses `set_cursor_from_row'.
4194 We use the last invisible position instead of the
4195 first because this way the cursor is always drawn on
4196 the first "." of the ellipsis, whenever PT is inside
4197 the invisible text. Otherwise the cursor would be
4198 placed _after_ the ellipsis when the point is after the
4199 first invisible character. */
4200 if (!STRINGP (it
->object
))
4202 it
->position
.charpos
= newpos
- 1;
4203 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4206 /* Let the ellipsis display before
4207 considering any properties of the following char.
4208 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4209 handled
= HANDLED_RETURN
;
4218 /* Make iterator IT return `...' next.
4219 Replaces LEN characters from buffer. */
4222 setup_for_ellipsis (struct it
*it
, int len
)
4224 /* Use the display table definition for `...'. Invalid glyphs
4225 will be handled by the method returning elements from dpvec. */
4226 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4228 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4229 it
->dpvec
= v
->contents
;
4230 it
->dpend
= v
->contents
+ v
->header
.size
;
4234 /* Default `...'. */
4235 it
->dpvec
= default_invis_vector
;
4236 it
->dpend
= default_invis_vector
+ 3;
4239 it
->dpvec_char_len
= len
;
4240 it
->current
.dpvec_index
= 0;
4241 it
->dpvec_face_id
= -1;
4243 /* Remember the current face id in case glyphs specify faces.
4244 IT's face is restored in set_iterator_to_next.
4245 saved_face_id was set to preceding char's face in handle_stop. */
4246 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4247 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4249 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4255 /***********************************************************************
4257 ***********************************************************************/
4259 /* Set up iterator IT from `display' property at its current position.
4260 Called from handle_stop.
4261 We return HANDLED_RETURN if some part of the display property
4262 overrides the display of the buffer text itself.
4263 Otherwise we return HANDLED_NORMALLY. */
4265 static enum prop_handled
4266 handle_display_prop (struct it
*it
)
4268 Lisp_Object propval
, object
, overlay
;
4269 struct text_pos
*position
;
4271 /* Nonzero if some property replaces the display of the text itself. */
4272 int display_replaced_p
= 0;
4274 if (STRINGP (it
->string
))
4276 object
= it
->string
;
4277 position
= &it
->current
.string_pos
;
4278 bufpos
= CHARPOS (it
->current
.pos
);
4282 XSETWINDOW (object
, it
->w
);
4283 position
= &it
->current
.pos
;
4284 bufpos
= CHARPOS (*position
);
4287 /* Reset those iterator values set from display property values. */
4288 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4289 it
->space_width
= Qnil
;
4290 it
->font_height
= Qnil
;
4293 /* We don't support recursive `display' properties, i.e. string
4294 values that have a string `display' property, that have a string
4295 `display' property etc. */
4296 if (!it
->string_from_display_prop_p
)
4297 it
->area
= TEXT_AREA
;
4299 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4300 Qdisplay
, object
, &overlay
);
4302 return HANDLED_NORMALLY
;
4303 /* Now OVERLAY is the overlay that gave us this property, or nil
4304 if it was a text property. */
4306 if (!STRINGP (it
->string
))
4307 object
= it
->w
->buffer
;
4309 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4311 FRAME_WINDOW_P (it
->f
));
4313 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4316 /* Subroutine of handle_display_prop. Returns non-zero if the display
4317 specification in SPEC is a replacing specification, i.e. it would
4318 replace the text covered by `display' property with something else,
4319 such as an image or a display string. If SPEC includes any kind or
4320 `(space ...) specification, the value is 2; this is used by
4321 compute_display_string_pos, which see.
4323 See handle_single_display_spec for documentation of arguments.
4324 frame_window_p is non-zero if the window being redisplayed is on a
4325 GUI frame; this argument is used only if IT is NULL, see below.
4327 IT can be NULL, if this is called by the bidi reordering code
4328 through compute_display_string_pos, which see. In that case, this
4329 function only examines SPEC, but does not otherwise "handle" it, in
4330 the sense that it doesn't set up members of IT from the display
4333 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4334 Lisp_Object overlay
, struct text_pos
*position
,
4335 EMACS_INT bufpos
, int frame_window_p
)
4337 int replacing_p
= 0;
4341 /* Simple specerties. */
4342 && !EQ (XCAR (spec
), Qimage
)
4343 && !EQ (XCAR (spec
), Qspace
)
4344 && !EQ (XCAR (spec
), Qwhen
)
4345 && !EQ (XCAR (spec
), Qslice
)
4346 && !EQ (XCAR (spec
), Qspace_width
)
4347 && !EQ (XCAR (spec
), Qheight
)
4348 && !EQ (XCAR (spec
), Qraise
)
4349 /* Marginal area specifications. */
4350 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4351 && !EQ (XCAR (spec
), Qleft_fringe
)
4352 && !EQ (XCAR (spec
), Qright_fringe
)
4353 && !NILP (XCAR (spec
)))
4355 for (; CONSP (spec
); spec
= XCDR (spec
))
4357 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4358 overlay
, position
, bufpos
,
4359 replacing_p
, frame_window_p
)))
4362 /* If some text in a string is replaced, `position' no
4363 longer points to the position of `object'. */
4364 if (!it
|| STRINGP (object
))
4369 else if (VECTORP (spec
))
4372 for (i
= 0; i
< ASIZE (spec
); ++i
)
4373 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4374 overlay
, position
, bufpos
,
4375 replacing_p
, frame_window_p
)))
4378 /* If some text in a string is replaced, `position' no
4379 longer points to the position of `object'. */
4380 if (!it
|| STRINGP (object
))
4386 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4387 position
, bufpos
, 0,
4395 /* Value is the position of the end of the `display' property starting
4396 at START_POS in OBJECT. */
4398 static struct text_pos
4399 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4402 struct text_pos end_pos
;
4404 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4405 Qdisplay
, object
, Qnil
);
4406 CHARPOS (end_pos
) = XFASTINT (end
);
4407 if (STRINGP (object
))
4408 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4410 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4416 /* Set up IT from a single `display' property specification SPEC. OBJECT
4417 is the object in which the `display' property was found. *POSITION
4418 is the position in OBJECT at which the `display' property was found.
4419 BUFPOS is the buffer position of OBJECT (different from POSITION if
4420 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4421 previously saw a display specification which already replaced text
4422 display with something else, for example an image; we ignore such
4423 properties after the first one has been processed.
4425 OVERLAY is the overlay this `display' property came from,
4426 or nil if it was a text property.
4428 If SPEC is a `space' or `image' specification, and in some other
4429 cases too, set *POSITION to the position where the `display'
4432 If IT is NULL, only examine the property specification in SPEC, but
4433 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4434 is intended to be displayed in a window on a GUI frame.
4436 Value is non-zero if something was found which replaces the display
4437 of buffer or string text. */
4440 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4441 Lisp_Object overlay
, struct text_pos
*position
,
4442 EMACS_INT bufpos
, int display_replaced_p
,
4446 Lisp_Object location
, value
;
4447 struct text_pos start_pos
= *position
;
4450 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4451 If the result is non-nil, use VALUE instead of SPEC. */
4453 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4462 if (!NILP (form
) && !EQ (form
, Qt
))
4464 int count
= SPECPDL_INDEX ();
4465 struct gcpro gcpro1
;
4467 /* Bind `object' to the object having the `display' property, a
4468 buffer or string. Bind `position' to the position in the
4469 object where the property was found, and `buffer-position'
4470 to the current position in the buffer. */
4473 XSETBUFFER (object
, current_buffer
);
4474 specbind (Qobject
, object
);
4475 specbind (Qposition
, make_number (CHARPOS (*position
)));
4476 specbind (Qbuffer_position
, make_number (bufpos
));
4478 form
= safe_eval (form
);
4480 unbind_to (count
, Qnil
);
4486 /* Handle `(height HEIGHT)' specifications. */
4488 && EQ (XCAR (spec
), Qheight
)
4489 && CONSP (XCDR (spec
)))
4493 if (!FRAME_WINDOW_P (it
->f
))
4496 it
->font_height
= XCAR (XCDR (spec
));
4497 if (!NILP (it
->font_height
))
4499 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4500 int new_height
= -1;
4502 if (CONSP (it
->font_height
)
4503 && (EQ (XCAR (it
->font_height
), Qplus
)
4504 || EQ (XCAR (it
->font_height
), Qminus
))
4505 && CONSP (XCDR (it
->font_height
))
4506 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4508 /* `(+ N)' or `(- N)' where N is an integer. */
4509 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4510 if (EQ (XCAR (it
->font_height
), Qplus
))
4512 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4514 else if (FUNCTIONP (it
->font_height
))
4516 /* Call function with current height as argument.
4517 Value is the new height. */
4519 height
= safe_call1 (it
->font_height
,
4520 face
->lface
[LFACE_HEIGHT_INDEX
]);
4521 if (NUMBERP (height
))
4522 new_height
= XFLOATINT (height
);
4524 else if (NUMBERP (it
->font_height
))
4526 /* Value is a multiple of the canonical char height. */
4529 f
= FACE_FROM_ID (it
->f
,
4530 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4531 new_height
= (XFLOATINT (it
->font_height
)
4532 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4536 /* Evaluate IT->font_height with `height' bound to the
4537 current specified height to get the new height. */
4538 int count
= SPECPDL_INDEX ();
4540 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4541 value
= safe_eval (it
->font_height
);
4542 unbind_to (count
, Qnil
);
4544 if (NUMBERP (value
))
4545 new_height
= XFLOATINT (value
);
4549 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4556 /* Handle `(space-width WIDTH)'. */
4558 && EQ (XCAR (spec
), Qspace_width
)
4559 && CONSP (XCDR (spec
)))
4563 if (!FRAME_WINDOW_P (it
->f
))
4566 value
= XCAR (XCDR (spec
));
4567 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4568 it
->space_width
= value
;
4574 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4576 && EQ (XCAR (spec
), Qslice
))
4582 if (!FRAME_WINDOW_P (it
->f
))
4585 if (tem
= XCDR (spec
), CONSP (tem
))
4587 it
->slice
.x
= XCAR (tem
);
4588 if (tem
= XCDR (tem
), CONSP (tem
))
4590 it
->slice
.y
= XCAR (tem
);
4591 if (tem
= XCDR (tem
), CONSP (tem
))
4593 it
->slice
.width
= XCAR (tem
);
4594 if (tem
= XCDR (tem
), CONSP (tem
))
4595 it
->slice
.height
= XCAR (tem
);
4604 /* Handle `(raise FACTOR)'. */
4606 && EQ (XCAR (spec
), Qraise
)
4607 && CONSP (XCDR (spec
)))
4611 if (!FRAME_WINDOW_P (it
->f
))
4614 #ifdef HAVE_WINDOW_SYSTEM
4615 value
= XCAR (XCDR (spec
));
4616 if (NUMBERP (value
))
4618 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4619 it
->voffset
= - (XFLOATINT (value
)
4620 * (FONT_HEIGHT (face
->font
)));
4622 #endif /* HAVE_WINDOW_SYSTEM */
4628 /* Don't handle the other kinds of display specifications
4629 inside a string that we got from a `display' property. */
4630 if (it
&& it
->string_from_display_prop_p
)
4633 /* Characters having this form of property are not displayed, so
4634 we have to find the end of the property. */
4637 start_pos
= *position
;
4638 *position
= display_prop_end (it
, object
, start_pos
);
4642 /* Stop the scan at that end position--we assume that all
4643 text properties change there. */
4645 it
->stop_charpos
= position
->charpos
;
4647 /* Handle `(left-fringe BITMAP [FACE])'
4648 and `(right-fringe BITMAP [FACE])'. */
4650 && (EQ (XCAR (spec
), Qleft_fringe
)
4651 || EQ (XCAR (spec
), Qright_fringe
))
4652 && CONSP (XCDR (spec
)))
4658 if (!FRAME_WINDOW_P (it
->f
))
4659 /* If we return here, POSITION has been advanced
4660 across the text with this property. */
4663 else if (!frame_window_p
)
4666 #ifdef HAVE_WINDOW_SYSTEM
4667 value
= XCAR (XCDR (spec
));
4668 if (!SYMBOLP (value
)
4669 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4670 /* If we return here, POSITION has been advanced
4671 across the text with this property. */
4676 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4678 if (CONSP (XCDR (XCDR (spec
))))
4680 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4681 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4687 /* Save current settings of IT so that we can restore them
4688 when we are finished with the glyph property value. */
4689 push_it (it
, position
);
4691 it
->area
= TEXT_AREA
;
4692 it
->what
= IT_IMAGE
;
4693 it
->image_id
= -1; /* no image */
4694 it
->position
= start_pos
;
4695 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4696 it
->method
= GET_FROM_IMAGE
;
4697 it
->from_overlay
= Qnil
;
4698 it
->face_id
= face_id
;
4699 it
->from_disp_prop_p
= 1;
4701 /* Say that we haven't consumed the characters with
4702 `display' property yet. The call to pop_it in
4703 set_iterator_to_next will clean this up. */
4704 *position
= start_pos
;
4706 if (EQ (XCAR (spec
), Qleft_fringe
))
4708 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4709 it
->left_user_fringe_face_id
= face_id
;
4713 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4714 it
->right_user_fringe_face_id
= face_id
;
4717 #endif /* HAVE_WINDOW_SYSTEM */
4721 /* Prepare to handle `((margin left-margin) ...)',
4722 `((margin right-margin) ...)' and `((margin nil) ...)'
4723 prefixes for display specifications. */
4724 location
= Qunbound
;
4725 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4729 value
= XCDR (spec
);
4731 value
= XCAR (value
);
4734 if (EQ (XCAR (tem
), Qmargin
)
4735 && (tem
= XCDR (tem
),
4736 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4738 || EQ (tem
, Qleft_margin
)
4739 || EQ (tem
, Qright_margin
))))
4743 if (EQ (location
, Qunbound
))
4749 /* After this point, VALUE is the property after any
4750 margin prefix has been stripped. It must be a string,
4751 an image specification, or `(space ...)'.
4753 LOCATION specifies where to display: `left-margin',
4754 `right-margin' or nil. */
4756 valid_p
= (STRINGP (value
)
4757 #ifdef HAVE_WINDOW_SYSTEM
4758 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4759 && valid_image_p (value
))
4760 #endif /* not HAVE_WINDOW_SYSTEM */
4761 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4763 if (valid_p
&& !display_replaced_p
)
4769 /* Callers need to know whether the display spec is any kind
4770 of `(space ...)' spec that is about to affect text-area
4772 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4777 /* Save current settings of IT so that we can restore them
4778 when we are finished with the glyph property value. */
4779 push_it (it
, position
);
4780 it
->from_overlay
= overlay
;
4781 it
->from_disp_prop_p
= 1;
4783 if (NILP (location
))
4784 it
->area
= TEXT_AREA
;
4785 else if (EQ (location
, Qleft_margin
))
4786 it
->area
= LEFT_MARGIN_AREA
;
4788 it
->area
= RIGHT_MARGIN_AREA
;
4790 if (STRINGP (value
))
4793 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4794 it
->current
.overlay_string_index
= -1;
4795 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4796 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4797 it
->method
= GET_FROM_STRING
;
4798 it
->stop_charpos
= 0;
4800 it
->base_level_stop
= 0;
4801 it
->string_from_display_prop_p
= 1;
4802 /* Say that we haven't consumed the characters with
4803 `display' property yet. The call to pop_it in
4804 set_iterator_to_next will clean this up. */
4805 if (BUFFERP (object
))
4806 *position
= start_pos
;
4808 /* Force paragraph direction to be that of the parent
4809 object. If the parent object's paragraph direction is
4810 not yet determined, default to L2R. */
4811 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4812 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4814 it
->paragraph_embedding
= L2R
;
4816 /* Set up the bidi iterator for this display string. */
4819 it
->bidi_it
.string
.lstring
= it
->string
;
4820 it
->bidi_it
.string
.s
= NULL
;
4821 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4822 it
->bidi_it
.string
.bufpos
= bufpos
;
4823 it
->bidi_it
.string
.from_disp_str
= 1;
4824 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4825 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4828 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4830 it
->method
= GET_FROM_STRETCH
;
4832 *position
= it
->position
= start_pos
;
4833 retval
= 1 + (it
->area
== TEXT_AREA
);
4835 #ifdef HAVE_WINDOW_SYSTEM
4838 it
->what
= IT_IMAGE
;
4839 it
->image_id
= lookup_image (it
->f
, value
);
4840 it
->position
= start_pos
;
4841 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4842 it
->method
= GET_FROM_IMAGE
;
4844 /* Say that we haven't consumed the characters with
4845 `display' property yet. The call to pop_it in
4846 set_iterator_to_next will clean this up. */
4847 *position
= start_pos
;
4849 #endif /* HAVE_WINDOW_SYSTEM */
4854 /* Invalid property or property not supported. Restore
4855 POSITION to what it was before. */
4856 *position
= start_pos
;
4860 /* Check if PROP is a display property value whose text should be
4861 treated as intangible. OVERLAY is the overlay from which PROP
4862 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4863 specify the buffer position covered by PROP. */
4866 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4867 EMACS_INT charpos
, EMACS_INT bytepos
)
4869 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4870 struct text_pos position
;
4872 SET_TEXT_POS (position
, charpos
, bytepos
);
4873 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4874 &position
, charpos
, frame_window_p
);
4878 /* Return 1 if PROP is a display sub-property value containing STRING.
4880 Implementation note: this and the following function are really
4881 special cases of handle_display_spec and
4882 handle_single_display_spec, and should ideally use the same code.
4883 Until they do, these two pairs must be consistent and must be
4884 modified in sync. */
4887 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4889 if (EQ (string
, prop
))
4892 /* Skip over `when FORM'. */
4893 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4898 /* Actually, the condition following `when' should be eval'ed,
4899 like handle_single_display_spec does, and we should return
4900 zero if it evaluates to nil. However, this function is
4901 called only when the buffer was already displayed and some
4902 glyph in the glyph matrix was found to come from a display
4903 string. Therefore, the condition was already evaluated, and
4904 the result was non-nil, otherwise the display string wouldn't
4905 have been displayed and we would have never been called for
4906 this property. Thus, we can skip the evaluation and assume
4907 its result is non-nil. */
4912 /* Skip over `margin LOCATION'. */
4913 if (EQ (XCAR (prop
), Qmargin
))
4924 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4928 /* Return 1 if STRING appears in the `display' property PROP. */
4931 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4934 && !EQ (XCAR (prop
), Qwhen
)
4935 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4937 /* A list of sub-properties. */
4938 while (CONSP (prop
))
4940 if (single_display_spec_string_p (XCAR (prop
), string
))
4945 else if (VECTORP (prop
))
4947 /* A vector of sub-properties. */
4949 for (i
= 0; i
< ASIZE (prop
); ++i
)
4950 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4954 return single_display_spec_string_p (prop
, string
);
4959 /* Look for STRING in overlays and text properties in the current
4960 buffer, between character positions FROM and TO (excluding TO).
4961 BACK_P non-zero means look back (in this case, TO is supposed to be
4963 Value is the first character position where STRING was found, or
4964 zero if it wasn't found before hitting TO.
4966 This function may only use code that doesn't eval because it is
4967 called asynchronously from note_mouse_highlight. */
4970 string_buffer_position_lim (Lisp_Object string
,
4971 EMACS_INT from
, EMACS_INT to
, int back_p
)
4973 Lisp_Object limit
, prop
, pos
;
4976 pos
= make_number (from
);
4978 if (!back_p
) /* looking forward */
4980 limit
= make_number (min (to
, ZV
));
4981 while (!found
&& !EQ (pos
, limit
))
4983 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4984 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4987 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4991 else /* looking back */
4993 limit
= make_number (max (to
, BEGV
));
4994 while (!found
&& !EQ (pos
, limit
))
4996 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4997 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5000 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5005 return found
? XINT (pos
) : 0;
5008 /* Determine which buffer position in current buffer STRING comes from.
5009 AROUND_CHARPOS is an approximate position where it could come from.
5010 Value is the buffer position or 0 if it couldn't be determined.
5012 This function is necessary because we don't record buffer positions
5013 in glyphs generated from strings (to keep struct glyph small).
5014 This function may only use code that doesn't eval because it is
5015 called asynchronously from note_mouse_highlight. */
5018 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
5020 const int MAX_DISTANCE
= 1000;
5021 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
5022 around_charpos
+ MAX_DISTANCE
,
5026 found
= string_buffer_position_lim (string
, around_charpos
,
5027 around_charpos
- MAX_DISTANCE
, 1);
5033 /***********************************************************************
5034 `composition' property
5035 ***********************************************************************/
5037 /* Set up iterator IT from `composition' property at its current
5038 position. Called from handle_stop. */
5040 static enum prop_handled
5041 handle_composition_prop (struct it
*it
)
5043 Lisp_Object prop
, string
;
5044 EMACS_INT pos
, pos_byte
, start
, end
;
5046 if (STRINGP (it
->string
))
5050 pos
= IT_STRING_CHARPOS (*it
);
5051 pos_byte
= IT_STRING_BYTEPOS (*it
);
5052 string
= it
->string
;
5053 s
= SDATA (string
) + pos_byte
;
5054 it
->c
= STRING_CHAR (s
);
5058 pos
= IT_CHARPOS (*it
);
5059 pos_byte
= IT_BYTEPOS (*it
);
5061 it
->c
= FETCH_CHAR (pos_byte
);
5064 /* If there's a valid composition and point is not inside of the
5065 composition (in the case that the composition is from the current
5066 buffer), draw a glyph composed from the composition components. */
5067 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5068 && COMPOSITION_VALID_P (start
, end
, prop
)
5069 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5072 /* As we can't handle this situation (perhaps font-lock added
5073 a new composition), we just return here hoping that next
5074 redisplay will detect this composition much earlier. */
5075 return HANDLED_NORMALLY
;
5078 if (STRINGP (it
->string
))
5079 pos_byte
= string_char_to_byte (it
->string
, start
);
5081 pos_byte
= CHAR_TO_BYTE (start
);
5083 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5086 if (it
->cmp_it
.id
>= 0)
5089 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5090 it
->cmp_it
.nglyphs
= -1;
5094 return HANDLED_NORMALLY
;
5099 /***********************************************************************
5101 ***********************************************************************/
5103 /* The following structure is used to record overlay strings for
5104 later sorting in load_overlay_strings. */
5106 struct overlay_entry
5108 Lisp_Object overlay
;
5115 /* Set up iterator IT from overlay strings at its current position.
5116 Called from handle_stop. */
5118 static enum prop_handled
5119 handle_overlay_change (struct it
*it
)
5121 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5122 return HANDLED_RECOMPUTE_PROPS
;
5124 return HANDLED_NORMALLY
;
5128 /* Set up the next overlay string for delivery by IT, if there is an
5129 overlay string to deliver. Called by set_iterator_to_next when the
5130 end of the current overlay string is reached. If there are more
5131 overlay strings to display, IT->string and
5132 IT->current.overlay_string_index are set appropriately here.
5133 Otherwise IT->string is set to nil. */
5136 next_overlay_string (struct it
*it
)
5138 ++it
->current
.overlay_string_index
;
5139 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5141 /* No more overlay strings. Restore IT's settings to what
5142 they were before overlay strings were processed, and
5143 continue to deliver from current_buffer. */
5145 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5148 || (NILP (it
->string
)
5149 && it
->method
== GET_FROM_BUFFER
5150 && it
->stop_charpos
>= BEGV
5151 && it
->stop_charpos
<= it
->end_charpos
));
5152 it
->current
.overlay_string_index
= -1;
5153 it
->n_overlay_strings
= 0;
5154 it
->overlay_strings_charpos
= -1;
5156 /* If we're at the end of the buffer, record that we have
5157 processed the overlay strings there already, so that
5158 next_element_from_buffer doesn't try it again. */
5159 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5160 it
->overlay_strings_at_end_processed_p
= 1;
5164 /* There are more overlay strings to process. If
5165 IT->current.overlay_string_index has advanced to a position
5166 where we must load IT->overlay_strings with more strings, do
5167 it. We must load at the IT->overlay_strings_charpos where
5168 IT->n_overlay_strings was originally computed; when invisible
5169 text is present, this might not be IT_CHARPOS (Bug#7016). */
5170 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5172 if (it
->current
.overlay_string_index
&& i
== 0)
5173 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5175 /* Initialize IT to deliver display elements from the overlay
5177 it
->string
= it
->overlay_strings
[i
];
5178 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5179 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5180 it
->method
= GET_FROM_STRING
;
5181 it
->stop_charpos
= 0;
5182 if (it
->cmp_it
.stop_pos
>= 0)
5183 it
->cmp_it
.stop_pos
= 0;
5185 it
->base_level_stop
= 0;
5187 /* Set up the bidi iterator for this overlay string. */
5190 it
->bidi_it
.string
.lstring
= it
->string
;
5191 it
->bidi_it
.string
.s
= NULL
;
5192 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5193 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5194 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5195 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5196 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5204 /* Compare two overlay_entry structures E1 and E2. Used as a
5205 comparison function for qsort in load_overlay_strings. Overlay
5206 strings for the same position are sorted so that
5208 1. All after-strings come in front of before-strings, except
5209 when they come from the same overlay.
5211 2. Within after-strings, strings are sorted so that overlay strings
5212 from overlays with higher priorities come first.
5214 2. Within before-strings, strings are sorted so that overlay
5215 strings from overlays with higher priorities come last.
5217 Value is analogous to strcmp. */
5221 compare_overlay_entries (const void *e1
, const void *e2
)
5223 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5224 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5227 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5229 /* Let after-strings appear in front of before-strings if
5230 they come from different overlays. */
5231 if (EQ (entry1
->overlay
, entry2
->overlay
))
5232 result
= entry1
->after_string_p
? 1 : -1;
5234 result
= entry1
->after_string_p
? -1 : 1;
5236 else if (entry1
->after_string_p
)
5237 /* After-strings sorted in order of decreasing priority. */
5238 result
= entry2
->priority
- entry1
->priority
;
5240 /* Before-strings sorted in order of increasing priority. */
5241 result
= entry1
->priority
- entry2
->priority
;
5247 /* Load the vector IT->overlay_strings with overlay strings from IT's
5248 current buffer position, or from CHARPOS if that is > 0. Set
5249 IT->n_overlays to the total number of overlay strings found.
5251 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5252 a time. On entry into load_overlay_strings,
5253 IT->current.overlay_string_index gives the number of overlay
5254 strings that have already been loaded by previous calls to this
5257 IT->add_overlay_start contains an additional overlay start
5258 position to consider for taking overlay strings from, if non-zero.
5259 This position comes into play when the overlay has an `invisible'
5260 property, and both before and after-strings. When we've skipped to
5261 the end of the overlay, because of its `invisible' property, we
5262 nevertheless want its before-string to appear.
5263 IT->add_overlay_start will contain the overlay start position
5266 Overlay strings are sorted so that after-string strings come in
5267 front of before-string strings. Within before and after-strings,
5268 strings are sorted by overlay priority. See also function
5269 compare_overlay_entries. */
5272 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5274 Lisp_Object overlay
, window
, str
, invisible
;
5275 struct Lisp_Overlay
*ov
;
5276 EMACS_INT start
, end
;
5278 int n
= 0, i
, j
, invis_p
;
5279 struct overlay_entry
*entries
5280 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5283 charpos
= IT_CHARPOS (*it
);
5285 /* Append the overlay string STRING of overlay OVERLAY to vector
5286 `entries' which has size `size' and currently contains `n'
5287 elements. AFTER_P non-zero means STRING is an after-string of
5289 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5292 Lisp_Object priority; \
5296 int new_size = 2 * size; \
5297 struct overlay_entry *old = entries; \
5299 (struct overlay_entry *) alloca (new_size \
5300 * sizeof *entries); \
5301 memcpy (entries, old, size * sizeof *entries); \
5305 entries[n].string = (STRING); \
5306 entries[n].overlay = (OVERLAY); \
5307 priority = Foverlay_get ((OVERLAY), Qpriority); \
5308 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5309 entries[n].after_string_p = (AFTER_P); \
5314 /* Process overlay before the overlay center. */
5315 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5317 XSETMISC (overlay
, ov
);
5318 xassert (OVERLAYP (overlay
));
5319 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5320 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5325 /* Skip this overlay if it doesn't start or end at IT's current
5327 if (end
!= charpos
&& start
!= charpos
)
5330 /* Skip this overlay if it doesn't apply to IT->w. */
5331 window
= Foverlay_get (overlay
, Qwindow
);
5332 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5335 /* If the text ``under'' the overlay is invisible, both before-
5336 and after-strings from this overlay are visible; start and
5337 end position are indistinguishable. */
5338 invisible
= Foverlay_get (overlay
, Qinvisible
);
5339 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5341 /* If overlay has a non-empty before-string, record it. */
5342 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5343 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5345 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5347 /* If overlay has a non-empty after-string, record it. */
5348 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5349 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5351 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5354 /* Process overlays after the overlay center. */
5355 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5357 XSETMISC (overlay
, ov
);
5358 xassert (OVERLAYP (overlay
));
5359 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5360 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5362 if (start
> charpos
)
5365 /* Skip this overlay if it doesn't start or end at IT's current
5367 if (end
!= charpos
&& start
!= charpos
)
5370 /* Skip this overlay if it doesn't apply to IT->w. */
5371 window
= Foverlay_get (overlay
, Qwindow
);
5372 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5375 /* If the text ``under'' the overlay is invisible, it has a zero
5376 dimension, and both before- and after-strings apply. */
5377 invisible
= Foverlay_get (overlay
, Qinvisible
);
5378 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5380 /* If overlay has a non-empty before-string, record it. */
5381 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5382 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5384 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5386 /* If overlay has a non-empty after-string, record it. */
5387 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5388 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5390 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5393 #undef RECORD_OVERLAY_STRING
5397 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5399 /* Record number of overlay strings, and where we computed it. */
5400 it
->n_overlay_strings
= n
;
5401 it
->overlay_strings_charpos
= charpos
;
5403 /* IT->current.overlay_string_index is the number of overlay strings
5404 that have already been consumed by IT. Copy some of the
5405 remaining overlay strings to IT->overlay_strings. */
5407 j
= it
->current
.overlay_string_index
;
5408 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5410 it
->overlay_strings
[i
] = entries
[j
].string
;
5411 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5418 /* Get the first chunk of overlay strings at IT's current buffer
5419 position, or at CHARPOS if that is > 0. Value is non-zero if at
5420 least one overlay string was found. */
5423 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5425 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5426 process. This fills IT->overlay_strings with strings, and sets
5427 IT->n_overlay_strings to the total number of strings to process.
5428 IT->pos.overlay_string_index has to be set temporarily to zero
5429 because load_overlay_strings needs this; it must be set to -1
5430 when no overlay strings are found because a zero value would
5431 indicate a position in the first overlay string. */
5432 it
->current
.overlay_string_index
= 0;
5433 load_overlay_strings (it
, charpos
);
5435 /* If we found overlay strings, set up IT to deliver display
5436 elements from the first one. Otherwise set up IT to deliver
5437 from current_buffer. */
5438 if (it
->n_overlay_strings
)
5440 /* Make sure we know settings in current_buffer, so that we can
5441 restore meaningful values when we're done with the overlay
5444 compute_stop_pos (it
);
5445 xassert (it
->face_id
>= 0);
5447 /* Save IT's settings. They are restored after all overlay
5448 strings have been processed. */
5449 xassert (!compute_stop_p
|| it
->sp
== 0);
5451 /* When called from handle_stop, there might be an empty display
5452 string loaded. In that case, don't bother saving it. */
5453 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5456 /* Set up IT to deliver display elements from the first overlay
5458 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5459 it
->string
= it
->overlay_strings
[0];
5460 it
->from_overlay
= Qnil
;
5461 it
->stop_charpos
= 0;
5462 xassert (STRINGP (it
->string
));
5463 it
->end_charpos
= SCHARS (it
->string
);
5465 it
->base_level_stop
= 0;
5466 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5467 it
->method
= GET_FROM_STRING
;
5468 it
->from_disp_prop_p
= 0;
5470 /* Force paragraph direction to be that of the parent
5472 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5473 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5475 it
->paragraph_embedding
= L2R
;
5477 /* Set up the bidi iterator for this overlay string. */
5480 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5482 it
->bidi_it
.string
.lstring
= it
->string
;
5483 it
->bidi_it
.string
.s
= NULL
;
5484 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5485 it
->bidi_it
.string
.bufpos
= pos
;
5486 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5487 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5488 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5493 it
->current
.overlay_string_index
= -1;
5498 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5501 it
->method
= GET_FROM_BUFFER
;
5503 (void) get_overlay_strings_1 (it
, charpos
, 1);
5507 /* Value is non-zero if we found at least one overlay string. */
5508 return STRINGP (it
->string
);
5513 /***********************************************************************
5514 Saving and restoring state
5515 ***********************************************************************/
5517 /* Save current settings of IT on IT->stack. Called, for example,
5518 before setting up IT for an overlay string, to be able to restore
5519 IT's settings to what they were after the overlay string has been
5520 processed. If POSITION is non-NULL, it is the position to save on
5521 the stack instead of IT->position. */
5524 push_it (struct it
*it
, struct text_pos
*position
)
5526 struct iterator_stack_entry
*p
;
5528 xassert (it
->sp
< IT_STACK_SIZE
);
5529 p
= it
->stack
+ it
->sp
;
5531 p
->stop_charpos
= it
->stop_charpos
;
5532 p
->prev_stop
= it
->prev_stop
;
5533 p
->base_level_stop
= it
->base_level_stop
;
5534 p
->cmp_it
= it
->cmp_it
;
5535 xassert (it
->face_id
>= 0);
5536 p
->face_id
= it
->face_id
;
5537 p
->string
= it
->string
;
5538 p
->method
= it
->method
;
5539 p
->from_overlay
= it
->from_overlay
;
5542 case GET_FROM_IMAGE
:
5543 p
->u
.image
.object
= it
->object
;
5544 p
->u
.image
.image_id
= it
->image_id
;
5545 p
->u
.image
.slice
= it
->slice
;
5547 case GET_FROM_STRETCH
:
5548 p
->u
.stretch
.object
= it
->object
;
5551 p
->position
= position
? *position
: it
->position
;
5552 p
->current
= it
->current
;
5553 p
->end_charpos
= it
->end_charpos
;
5554 p
->string_nchars
= it
->string_nchars
;
5556 p
->multibyte_p
= it
->multibyte_p
;
5557 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5558 p
->space_width
= it
->space_width
;
5559 p
->font_height
= it
->font_height
;
5560 p
->voffset
= it
->voffset
;
5561 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5562 p
->display_ellipsis_p
= 0;
5563 p
->line_wrap
= it
->line_wrap
;
5564 p
->bidi_p
= it
->bidi_p
;
5565 p
->paragraph_embedding
= it
->paragraph_embedding
;
5566 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5569 /* Save the state of the bidi iterator as well. */
5571 bidi_push_it (&it
->bidi_it
);
5575 iterate_out_of_display_property (struct it
*it
)
5577 int buffer_p
= BUFFERP (it
->object
);
5578 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5579 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5581 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5583 /* Maybe initialize paragraph direction. If we are at the beginning
5584 of a new paragraph, next_element_from_buffer may not have a
5585 chance to do that. */
5586 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5587 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5588 /* prev_stop can be zero, so check against BEGV as well. */
5589 while (it
->bidi_it
.charpos
>= bob
5590 && it
->prev_stop
<= it
->bidi_it
.charpos
5591 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5592 && it
->bidi_it
.charpos
< eob
)
5593 bidi_move_to_visually_next (&it
->bidi_it
);
5594 /* Record the stop_pos we just crossed, for when we cross it
5596 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5597 it
->prev_stop
= CHARPOS (it
->position
);
5598 /* If we ended up not where pop_it put us, resync IT's
5599 positional members with the bidi iterator. */
5600 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5601 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5603 it
->current
.pos
= it
->position
;
5605 it
->current
.string_pos
= it
->position
;
5608 /* Restore IT's settings from IT->stack. Called, for example, when no
5609 more overlay strings must be processed, and we return to delivering
5610 display elements from a buffer, or when the end of a string from a
5611 `display' property is reached and we return to delivering display
5612 elements from an overlay string, or from a buffer. */
5615 pop_it (struct it
*it
)
5617 struct iterator_stack_entry
*p
;
5618 int from_display_prop
= it
->from_disp_prop_p
;
5620 xassert (it
->sp
> 0);
5622 p
= it
->stack
+ it
->sp
;
5623 it
->stop_charpos
= p
->stop_charpos
;
5624 it
->prev_stop
= p
->prev_stop
;
5625 it
->base_level_stop
= p
->base_level_stop
;
5626 it
->cmp_it
= p
->cmp_it
;
5627 it
->face_id
= p
->face_id
;
5628 it
->current
= p
->current
;
5629 it
->position
= p
->position
;
5630 it
->string
= p
->string
;
5631 it
->from_overlay
= p
->from_overlay
;
5632 if (NILP (it
->string
))
5633 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5634 it
->method
= p
->method
;
5637 case GET_FROM_IMAGE
:
5638 it
->image_id
= p
->u
.image
.image_id
;
5639 it
->object
= p
->u
.image
.object
;
5640 it
->slice
= p
->u
.image
.slice
;
5642 case GET_FROM_STRETCH
:
5643 it
->object
= p
->u
.stretch
.object
;
5645 case GET_FROM_BUFFER
:
5646 it
->object
= it
->w
->buffer
;
5648 case GET_FROM_STRING
:
5649 it
->object
= it
->string
;
5651 case GET_FROM_DISPLAY_VECTOR
:
5653 it
->method
= GET_FROM_C_STRING
;
5654 else if (STRINGP (it
->string
))
5655 it
->method
= GET_FROM_STRING
;
5658 it
->method
= GET_FROM_BUFFER
;
5659 it
->object
= it
->w
->buffer
;
5662 it
->end_charpos
= p
->end_charpos
;
5663 it
->string_nchars
= p
->string_nchars
;
5665 it
->multibyte_p
= p
->multibyte_p
;
5666 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5667 it
->space_width
= p
->space_width
;
5668 it
->font_height
= p
->font_height
;
5669 it
->voffset
= p
->voffset
;
5670 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5671 it
->line_wrap
= p
->line_wrap
;
5672 it
->bidi_p
= p
->bidi_p
;
5673 it
->paragraph_embedding
= p
->paragraph_embedding
;
5674 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5677 bidi_pop_it (&it
->bidi_it
);
5678 /* Bidi-iterate until we get out of the portion of text, if any,
5679 covered by a `display' text property or by an overlay with
5680 `display' property. (We cannot just jump there, because the
5681 internal coherency of the bidi iterator state can not be
5682 preserved across such jumps.) We also must determine the
5683 paragraph base direction if the overlay we just processed is
5684 at the beginning of a new paragraph. */
5685 if (from_display_prop
5686 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5687 iterate_out_of_display_property (it
);
5689 xassert ((BUFFERP (it
->object
)
5690 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5691 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5692 || (STRINGP (it
->object
)
5693 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5694 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5695 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5701 /***********************************************************************
5703 ***********************************************************************/
5705 /* Set IT's current position to the previous line start. */
5708 back_to_previous_line_start (struct it
*it
)
5710 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5711 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5715 /* Move IT to the next line start.
5717 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5718 we skipped over part of the text (as opposed to moving the iterator
5719 continuously over the text). Otherwise, don't change the value
5722 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5723 iterator on the newline, if it was found.
5725 Newlines may come from buffer text, overlay strings, or strings
5726 displayed via the `display' property. That's the reason we can't
5727 simply use find_next_newline_no_quit.
5729 Note that this function may not skip over invisible text that is so
5730 because of text properties and immediately follows a newline. If
5731 it would, function reseat_at_next_visible_line_start, when called
5732 from set_iterator_to_next, would effectively make invisible
5733 characters following a newline part of the wrong glyph row, which
5734 leads to wrong cursor motion. */
5737 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5738 struct bidi_it
*bidi_it_prev
)
5740 EMACS_INT old_selective
;
5741 int newline_found_p
, n
;
5742 const int MAX_NEWLINE_DISTANCE
= 500;
5744 /* If already on a newline, just consume it to avoid unintended
5745 skipping over invisible text below. */
5746 if (it
->what
== IT_CHARACTER
5748 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5750 if (it
->bidi_p
&& bidi_it_prev
)
5751 *bidi_it_prev
= it
->bidi_it
;
5752 set_iterator_to_next (it
, 0);
5757 /* Don't handle selective display in the following. It's (a)
5758 unnecessary because it's done by the caller, and (b) leads to an
5759 infinite recursion because next_element_from_ellipsis indirectly
5760 calls this function. */
5761 old_selective
= it
->selective
;
5764 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5765 from buffer text. */
5766 for (n
= newline_found_p
= 0;
5767 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5768 n
+= STRINGP (it
->string
) ? 0 : 1)
5770 if (!get_next_display_element (it
))
5772 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5773 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5774 *bidi_it_prev
= it
->bidi_it
;
5775 set_iterator_to_next (it
, 0);
5778 /* If we didn't find a newline near enough, see if we can use a
5780 if (!newline_found_p
)
5782 EMACS_INT start
= IT_CHARPOS (*it
);
5783 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5786 xassert (!STRINGP (it
->string
));
5788 /* If there isn't any `display' property in sight, and no
5789 overlays, we can just use the position of the newline in
5791 if (it
->stop_charpos
>= limit
5792 || ((pos
= Fnext_single_property_change (make_number (start
),
5794 make_number (limit
)),
5796 && next_overlay_change (start
) == ZV
))
5800 IT_CHARPOS (*it
) = limit
;
5801 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5805 struct bidi_it bprev
;
5807 /* Help bidi.c avoid expensive searches for display
5808 properties and overlays, by telling it that there are
5809 none up to `limit'. */
5810 if (it
->bidi_it
.disp_pos
< limit
)
5812 it
->bidi_it
.disp_pos
= limit
;
5813 it
->bidi_it
.disp_prop
= 0;
5816 bprev
= it
->bidi_it
;
5817 bidi_move_to_visually_next (&it
->bidi_it
);
5818 } while (it
->bidi_it
.charpos
!= limit
);
5819 IT_CHARPOS (*it
) = limit
;
5820 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5822 *bidi_it_prev
= bprev
;
5824 *skipped_p
= newline_found_p
= 1;
5828 while (get_next_display_element (it
)
5829 && !newline_found_p
)
5831 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5832 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5833 *bidi_it_prev
= it
->bidi_it
;
5834 set_iterator_to_next (it
, 0);
5839 it
->selective
= old_selective
;
5840 return newline_found_p
;
5844 /* Set IT's current position to the previous visible line start. Skip
5845 invisible text that is so either due to text properties or due to
5846 selective display. Caution: this does not change IT->current_x and
5850 back_to_previous_visible_line_start (struct it
*it
)
5852 while (IT_CHARPOS (*it
) > BEGV
)
5854 back_to_previous_line_start (it
);
5856 if (IT_CHARPOS (*it
) <= BEGV
)
5859 /* If selective > 0, then lines indented more than its value are
5861 if (it
->selective
> 0
5862 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5866 /* Check the newline before point for invisibility. */
5869 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5870 Qinvisible
, it
->window
);
5871 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5875 if (IT_CHARPOS (*it
) <= BEGV
)
5880 void *it2data
= NULL
;
5883 Lisp_Object val
, overlay
;
5885 SAVE_IT (it2
, *it
, it2data
);
5887 /* If newline is part of a composition, continue from start of composition */
5888 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5889 && beg
< IT_CHARPOS (*it
))
5892 /* If newline is replaced by a display property, find start of overlay
5893 or interval and continue search from that point. */
5894 pos
= --IT_CHARPOS (it2
);
5897 bidi_unshelve_cache (NULL
, 0);
5898 it2
.string_from_display_prop_p
= 0;
5899 it2
.from_disp_prop_p
= 0;
5900 if (handle_display_prop (&it2
) == HANDLED_RETURN
5901 && !NILP (val
= get_char_property_and_overlay
5902 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5903 && (OVERLAYP (overlay
)
5904 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5905 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5907 RESTORE_IT (it
, it
, it2data
);
5911 /* Newline is not replaced by anything -- so we are done. */
5912 RESTORE_IT (it
, it
, it2data
);
5918 IT_CHARPOS (*it
) = beg
;
5919 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5923 it
->continuation_lines_width
= 0;
5925 xassert (IT_CHARPOS (*it
) >= BEGV
);
5926 xassert (IT_CHARPOS (*it
) == BEGV
5927 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5932 /* Reseat iterator IT at the previous visible line start. Skip
5933 invisible text that is so either due to text properties or due to
5934 selective display. At the end, update IT's overlay information,
5935 face information etc. */
5938 reseat_at_previous_visible_line_start (struct it
*it
)
5940 back_to_previous_visible_line_start (it
);
5941 reseat (it
, it
->current
.pos
, 1);
5946 /* Reseat iterator IT on the next visible line start in the current
5947 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5948 preceding the line start. Skip over invisible text that is so
5949 because of selective display. Compute faces, overlays etc at the
5950 new position. Note that this function does not skip over text that
5951 is invisible because of text properties. */
5954 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5956 int newline_found_p
, skipped_p
= 0;
5957 struct bidi_it bidi_it_prev
;
5959 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5961 /* Skip over lines that are invisible because they are indented
5962 more than the value of IT->selective. */
5963 if (it
->selective
> 0)
5964 while (IT_CHARPOS (*it
) < ZV
5965 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5968 xassert (IT_BYTEPOS (*it
) == BEGV
5969 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5971 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5974 /* Position on the newline if that's what's requested. */
5975 if (on_newline_p
&& newline_found_p
)
5977 if (STRINGP (it
->string
))
5979 if (IT_STRING_CHARPOS (*it
) > 0)
5983 --IT_STRING_CHARPOS (*it
);
5984 --IT_STRING_BYTEPOS (*it
);
5988 /* We need to restore the bidi iterator to the state
5989 it had on the newline, and resync the IT's
5990 position with that. */
5991 it
->bidi_it
= bidi_it_prev
;
5992 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5993 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5997 else if (IT_CHARPOS (*it
) > BEGV
)
6006 /* We need to restore the bidi iterator to the state it
6007 had on the newline and resync IT with that. */
6008 it
->bidi_it
= bidi_it_prev
;
6009 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6010 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6012 reseat (it
, it
->current
.pos
, 0);
6016 reseat (it
, it
->current
.pos
, 0);
6023 /***********************************************************************
6024 Changing an iterator's position
6025 ***********************************************************************/
6027 /* Change IT's current position to POS in current_buffer. If FORCE_P
6028 is non-zero, always check for text properties at the new position.
6029 Otherwise, text properties are only looked up if POS >=
6030 IT->check_charpos of a property. */
6033 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6035 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6037 reseat_1 (it
, pos
, 0);
6039 /* Determine where to check text properties. Avoid doing it
6040 where possible because text property lookup is very expensive. */
6042 || CHARPOS (pos
) > it
->stop_charpos
6043 || CHARPOS (pos
) < original_pos
)
6047 /* For bidi iteration, we need to prime prev_stop and
6048 base_level_stop with our best estimations. */
6049 /* Implementation note: Of course, POS is not necessarily a
6050 stop position, so assigning prev_pos to it is a lie; we
6051 should have called compute_stop_backwards. However, if
6052 the current buffer does not include any R2L characters,
6053 that call would be a waste of cycles, because the
6054 iterator will never move back, and thus never cross this
6055 "fake" stop position. So we delay that backward search
6056 until the time we really need it, in next_element_from_buffer. */
6057 if (CHARPOS (pos
) != it
->prev_stop
)
6058 it
->prev_stop
= CHARPOS (pos
);
6059 if (CHARPOS (pos
) < it
->base_level_stop
)
6060 it
->base_level_stop
= 0; /* meaning it's unknown */
6066 it
->prev_stop
= it
->base_level_stop
= 0;
6075 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6076 IT->stop_pos to POS, also. */
6079 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6081 /* Don't call this function when scanning a C string. */
6082 xassert (it
->s
== NULL
);
6084 /* POS must be a reasonable value. */
6085 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6087 it
->current
.pos
= it
->position
= pos
;
6088 it
->end_charpos
= ZV
;
6090 it
->current
.dpvec_index
= -1;
6091 it
->current
.overlay_string_index
= -1;
6092 IT_STRING_CHARPOS (*it
) = -1;
6093 IT_STRING_BYTEPOS (*it
) = -1;
6095 it
->method
= GET_FROM_BUFFER
;
6096 it
->object
= it
->w
->buffer
;
6097 it
->area
= TEXT_AREA
;
6098 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6100 it
->string_from_display_prop_p
= 0;
6101 it
->from_disp_prop_p
= 0;
6102 it
->face_before_selective_p
= 0;
6105 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6107 bidi_unshelve_cache (NULL
, 0);
6108 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6109 it
->bidi_it
.string
.s
= NULL
;
6110 it
->bidi_it
.string
.lstring
= Qnil
;
6111 it
->bidi_it
.string
.bufpos
= 0;
6112 it
->bidi_it
.string
.unibyte
= 0;
6117 it
->stop_charpos
= CHARPOS (pos
);
6118 it
->base_level_stop
= CHARPOS (pos
);
6123 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6124 If S is non-null, it is a C string to iterate over. Otherwise,
6125 STRING gives a Lisp string to iterate over.
6127 If PRECISION > 0, don't return more then PRECISION number of
6128 characters from the string.
6130 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6131 characters have been returned. FIELD_WIDTH < 0 means an infinite
6134 MULTIBYTE = 0 means disable processing of multibyte characters,
6135 MULTIBYTE > 0 means enable it,
6136 MULTIBYTE < 0 means use IT->multibyte_p.
6138 IT must be initialized via a prior call to init_iterator before
6139 calling this function. */
6142 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6143 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6146 /* No region in strings. */
6147 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6149 /* No text property checks performed by default, but see below. */
6150 it
->stop_charpos
= -1;
6152 /* Set iterator position and end position. */
6153 memset (&it
->current
, 0, sizeof it
->current
);
6154 it
->current
.overlay_string_index
= -1;
6155 it
->current
.dpvec_index
= -1;
6156 xassert (charpos
>= 0);
6158 /* If STRING is specified, use its multibyteness, otherwise use the
6159 setting of MULTIBYTE, if specified. */
6161 it
->multibyte_p
= multibyte
> 0;
6163 /* Bidirectional reordering of strings is controlled by the default
6164 value of bidi-display-reordering. Don't try to reorder while
6165 loading loadup.el, as the necessary character property tables are
6166 not yet available. */
6169 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6173 xassert (STRINGP (string
));
6174 it
->string
= string
;
6176 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6177 it
->method
= GET_FROM_STRING
;
6178 it
->current
.string_pos
= string_pos (charpos
, string
);
6182 it
->bidi_it
.string
.lstring
= string
;
6183 it
->bidi_it
.string
.s
= NULL
;
6184 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6185 it
->bidi_it
.string
.bufpos
= 0;
6186 it
->bidi_it
.string
.from_disp_str
= 0;
6187 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6188 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6189 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6194 it
->s
= (const unsigned char *) s
;
6197 /* Note that we use IT->current.pos, not it->current.string_pos,
6198 for displaying C strings. */
6199 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6200 if (it
->multibyte_p
)
6202 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6203 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6207 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6208 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6213 it
->bidi_it
.string
.lstring
= Qnil
;
6214 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6215 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6216 it
->bidi_it
.string
.bufpos
= 0;
6217 it
->bidi_it
.string
.from_disp_str
= 0;
6218 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6219 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6222 it
->method
= GET_FROM_C_STRING
;
6225 /* PRECISION > 0 means don't return more than PRECISION characters
6227 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6229 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6231 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6234 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6235 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6236 FIELD_WIDTH < 0 means infinite field width. This is useful for
6237 padding with `-' at the end of a mode line. */
6238 if (field_width
< 0)
6239 field_width
= INFINITY
;
6240 /* Implementation note: We deliberately don't enlarge
6241 it->bidi_it.string.schars here to fit it->end_charpos, because
6242 the bidi iterator cannot produce characters out of thin air. */
6243 if (field_width
> it
->end_charpos
- charpos
)
6244 it
->end_charpos
= charpos
+ field_width
;
6246 /* Use the standard display table for displaying strings. */
6247 if (DISP_TABLE_P (Vstandard_display_table
))
6248 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6250 it
->stop_charpos
= charpos
;
6251 it
->prev_stop
= charpos
;
6252 it
->base_level_stop
= 0;
6255 it
->bidi_it
.first_elt
= 1;
6256 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6257 it
->bidi_it
.disp_pos
= -1;
6259 if (s
== NULL
&& it
->multibyte_p
)
6261 EMACS_INT endpos
= SCHARS (it
->string
);
6262 if (endpos
> it
->end_charpos
)
6263 endpos
= it
->end_charpos
;
6264 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6272 /***********************************************************************
6274 ***********************************************************************/
6276 /* Map enum it_method value to corresponding next_element_from_* function. */
6278 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6280 next_element_from_buffer
,
6281 next_element_from_display_vector
,
6282 next_element_from_string
,
6283 next_element_from_c_string
,
6284 next_element_from_image
,
6285 next_element_from_stretch
6288 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6291 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6292 (possibly with the following characters). */
6294 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6295 ((IT)->cmp_it.id >= 0 \
6296 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6297 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6298 END_CHARPOS, (IT)->w, \
6299 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6303 /* Lookup the char-table Vglyphless_char_display for character C (-1
6304 if we want information for no-font case), and return the display
6305 method symbol. By side-effect, update it->what and
6306 it->glyphless_method. This function is called from
6307 get_next_display_element for each character element, and from
6308 x_produce_glyphs when no suitable font was found. */
6311 lookup_glyphless_char_display (int c
, struct it
*it
)
6313 Lisp_Object glyphless_method
= Qnil
;
6315 if (CHAR_TABLE_P (Vglyphless_char_display
)
6316 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6320 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6321 if (CONSP (glyphless_method
))
6322 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6323 ? XCAR (glyphless_method
)
6324 : XCDR (glyphless_method
);
6327 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6331 if (NILP (glyphless_method
))
6334 /* The default is to display the character by a proper font. */
6336 /* The default for the no-font case is to display an empty box. */
6337 glyphless_method
= Qempty_box
;
6339 if (EQ (glyphless_method
, Qzero_width
))
6342 return glyphless_method
;
6343 /* This method can't be used for the no-font case. */
6344 glyphless_method
= Qempty_box
;
6346 if (EQ (glyphless_method
, Qthin_space
))
6347 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6348 else if (EQ (glyphless_method
, Qempty_box
))
6349 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6350 else if (EQ (glyphless_method
, Qhex_code
))
6351 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6352 else if (STRINGP (glyphless_method
))
6353 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6356 /* Invalid value. We use the default method. */
6357 glyphless_method
= Qnil
;
6360 it
->what
= IT_GLYPHLESS
;
6361 return glyphless_method
;
6364 /* Load IT's display element fields with information about the next
6365 display element from the current position of IT. Value is zero if
6366 end of buffer (or C string) is reached. */
6368 static struct frame
*last_escape_glyph_frame
= NULL
;
6369 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6370 static int last_escape_glyph_merged_face_id
= 0;
6372 struct frame
*last_glyphless_glyph_frame
= NULL
;
6373 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6374 int last_glyphless_glyph_merged_face_id
= 0;
6377 get_next_display_element (struct it
*it
)
6379 /* Non-zero means that we found a display element. Zero means that
6380 we hit the end of what we iterate over. Performance note: the
6381 function pointer `method' used here turns out to be faster than
6382 using a sequence of if-statements. */
6386 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6388 if (it
->what
== IT_CHARACTER
)
6390 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6391 and only if (a) the resolved directionality of that character
6393 /* FIXME: Do we need an exception for characters from display
6395 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6396 it
->c
= bidi_mirror_char (it
->c
);
6397 /* Map via display table or translate control characters.
6398 IT->c, IT->len etc. have been set to the next character by
6399 the function call above. If we have a display table, and it
6400 contains an entry for IT->c, translate it. Don't do this if
6401 IT->c itself comes from a display table, otherwise we could
6402 end up in an infinite recursion. (An alternative could be to
6403 count the recursion depth of this function and signal an
6404 error when a certain maximum depth is reached.) Is it worth
6406 if (success_p
&& it
->dpvec
== NULL
)
6409 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6410 int nonascii_space_p
= 0;
6411 int nonascii_hyphen_p
= 0;
6412 int c
= it
->c
; /* This is the character to display. */
6414 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6416 xassert (SINGLE_BYTE_CHAR_P (c
));
6417 if (unibyte_display_via_language_environment
)
6419 c
= DECODE_CHAR (unibyte
, c
);
6421 c
= BYTE8_TO_CHAR (it
->c
);
6424 c
= BYTE8_TO_CHAR (it
->c
);
6428 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6431 struct Lisp_Vector
*v
= XVECTOR (dv
);
6433 /* Return the first character from the display table
6434 entry, if not empty. If empty, don't display the
6435 current character. */
6438 it
->dpvec_char_len
= it
->len
;
6439 it
->dpvec
= v
->contents
;
6440 it
->dpend
= v
->contents
+ v
->header
.size
;
6441 it
->current
.dpvec_index
= 0;
6442 it
->dpvec_face_id
= -1;
6443 it
->saved_face_id
= it
->face_id
;
6444 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6449 set_iterator_to_next (it
, 0);
6454 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6456 if (it
->what
== IT_GLYPHLESS
)
6458 /* Don't display this character. */
6459 set_iterator_to_next (it
, 0);
6463 /* If `nobreak-char-display' is non-nil, we display
6464 non-ASCII spaces and hyphens specially. */
6465 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6468 nonascii_space_p
= 1;
6469 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6470 nonascii_hyphen_p
= 1;
6473 /* Translate control characters into `\003' or `^C' form.
6474 Control characters coming from a display table entry are
6475 currently not translated because we use IT->dpvec to hold
6476 the translation. This could easily be changed but I
6477 don't believe that it is worth doing.
6479 The characters handled by `nobreak-char-display' must be
6482 Non-printable characters and raw-byte characters are also
6483 translated to octal form. */
6484 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6485 ? (it
->area
!= TEXT_AREA
6486 /* In mode line, treat \n, \t like other crl chars. */
6489 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6490 || (c
!= '\n' && c
!= '\t'))
6492 || nonascii_hyphen_p
6494 || ! CHAR_PRINTABLE_P (c
))))
6496 /* C is a control character, non-ASCII space/hyphen,
6497 raw-byte, or a non-printable character which must be
6498 displayed either as '\003' or as `^C' where the '\\'
6499 and '^' can be defined in the display table. Fill
6500 IT->ctl_chars with glyphs for what we have to
6501 display. Then, set IT->dpvec to these glyphs. */
6505 EMACS_INT lface_id
= 0;
6508 /* Handle control characters with ^. */
6510 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6514 g
= '^'; /* default glyph for Control */
6515 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6517 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6518 && GLYPH_CODE_CHAR_VALID_P (gc
))
6520 g
= GLYPH_CODE_CHAR (gc
);
6521 lface_id
= GLYPH_CODE_FACE (gc
);
6525 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6527 else if (it
->f
== last_escape_glyph_frame
6528 && it
->face_id
== last_escape_glyph_face_id
)
6530 face_id
= last_escape_glyph_merged_face_id
;
6534 /* Merge the escape-glyph face into the current face. */
6535 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6537 last_escape_glyph_frame
= it
->f
;
6538 last_escape_glyph_face_id
= it
->face_id
;
6539 last_escape_glyph_merged_face_id
= face_id
;
6542 XSETINT (it
->ctl_chars
[0], g
);
6543 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6545 goto display_control
;
6548 /* Handle non-ascii space in the mode where it only gets
6551 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6553 /* Merge `nobreak-space' into the current face. */
6554 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6556 XSETINT (it
->ctl_chars
[0], ' ');
6558 goto display_control
;
6561 /* Handle sequences that start with the "escape glyph". */
6563 /* the default escape glyph is \. */
6564 escape_glyph
= '\\';
6567 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6568 && GLYPH_CODE_CHAR_VALID_P (gc
))
6570 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6571 lface_id
= GLYPH_CODE_FACE (gc
);
6575 /* The display table specified a face.
6576 Merge it into face_id and also into escape_glyph. */
6577 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6580 else if (it
->f
== last_escape_glyph_frame
6581 && it
->face_id
== last_escape_glyph_face_id
)
6583 face_id
= last_escape_glyph_merged_face_id
;
6587 /* Merge the escape-glyph face into the current face. */
6588 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6590 last_escape_glyph_frame
= it
->f
;
6591 last_escape_glyph_face_id
= it
->face_id
;
6592 last_escape_glyph_merged_face_id
= face_id
;
6595 /* Draw non-ASCII hyphen with just highlighting: */
6597 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6599 XSETINT (it
->ctl_chars
[0], '-');
6601 goto display_control
;
6604 /* Draw non-ASCII space/hyphen with escape glyph: */
6606 if (nonascii_space_p
|| nonascii_hyphen_p
)
6608 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6609 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6611 goto display_control
;
6618 if (CHAR_BYTE8_P (c
))
6619 /* Display \200 instead of \17777600. */
6620 c
= CHAR_TO_BYTE8 (c
);
6621 len
= sprintf (str
, "%03o", c
);
6623 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6624 for (i
= 0; i
< len
; i
++)
6625 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6630 /* Set up IT->dpvec and return first character from it. */
6631 it
->dpvec_char_len
= it
->len
;
6632 it
->dpvec
= it
->ctl_chars
;
6633 it
->dpend
= it
->dpvec
+ ctl_len
;
6634 it
->current
.dpvec_index
= 0;
6635 it
->dpvec_face_id
= face_id
;
6636 it
->saved_face_id
= it
->face_id
;
6637 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6641 it
->char_to_display
= c
;
6645 it
->char_to_display
= it
->c
;
6649 /* Adjust face id for a multibyte character. There are no multibyte
6650 character in unibyte text. */
6651 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6654 && FRAME_WINDOW_P (it
->f
))
6656 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6658 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6660 /* Automatic composition with glyph-string. */
6661 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6663 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6667 EMACS_INT pos
= (it
->s
? -1
6668 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6669 : IT_CHARPOS (*it
));
6672 if (it
->what
== IT_CHARACTER
)
6673 c
= it
->char_to_display
;
6676 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6680 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6681 /* TAB in a composition means display glyphs with
6682 padding space on the left or right. */
6683 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6686 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6691 /* Is this character the last one of a run of characters with
6692 box? If yes, set IT->end_of_box_run_p to 1. */
6696 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6698 int face_id
= underlying_face_id (it
);
6699 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6703 if (face
->box
== FACE_NO_BOX
)
6705 /* If the box comes from face properties in a
6706 display string, check faces in that string. */
6707 int string_face_id
= face_after_it_pos (it
);
6708 it
->end_of_box_run_p
6709 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6712 /* Otherwise, the box comes from the underlying face.
6713 If this is the last string character displayed, check
6714 the next buffer location. */
6715 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6716 && (it
->current
.overlay_string_index
6717 == it
->n_overlay_strings
- 1))
6721 struct text_pos pos
= it
->current
.pos
;
6722 INC_TEXT_POS (pos
, it
->multibyte_p
);
6724 next_face_id
= face_at_buffer_position
6725 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6726 it
->region_end_charpos
, &ignore
,
6727 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6729 it
->end_of_box_run_p
6730 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6737 int face_id
= face_after_it_pos (it
);
6738 it
->end_of_box_run_p
6739 = (face_id
!= it
->face_id
6740 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6744 /* Value is 0 if end of buffer or string reached. */
6749 /* Move IT to the next display element.
6751 RESEAT_P non-zero means if called on a newline in buffer text,
6752 skip to the next visible line start.
6754 Functions get_next_display_element and set_iterator_to_next are
6755 separate because I find this arrangement easier to handle than a
6756 get_next_display_element function that also increments IT's
6757 position. The way it is we can first look at an iterator's current
6758 display element, decide whether it fits on a line, and if it does,
6759 increment the iterator position. The other way around we probably
6760 would either need a flag indicating whether the iterator has to be
6761 incremented the next time, or we would have to implement a
6762 decrement position function which would not be easy to write. */
6765 set_iterator_to_next (struct it
*it
, int reseat_p
)
6767 /* Reset flags indicating start and end of a sequence of characters
6768 with box. Reset them at the start of this function because
6769 moving the iterator to a new position might set them. */
6770 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6774 case GET_FROM_BUFFER
:
6775 /* The current display element of IT is a character from
6776 current_buffer. Advance in the buffer, and maybe skip over
6777 invisible lines that are so because of selective display. */
6778 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6779 reseat_at_next_visible_line_start (it
, 0);
6780 else if (it
->cmp_it
.id
>= 0)
6782 /* We are currently getting glyphs from a composition. */
6787 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6788 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6789 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6791 it
->cmp_it
.from
= it
->cmp_it
.to
;
6796 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6798 it
->end_charpos
, Qnil
);
6801 else if (! it
->cmp_it
.reversed_p
)
6803 /* Composition created while scanning forward. */
6804 /* Update IT's char/byte positions to point to the first
6805 character of the next grapheme cluster, or to the
6806 character visually after the current composition. */
6807 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6808 bidi_move_to_visually_next (&it
->bidi_it
);
6809 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6810 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6812 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6814 /* Proceed to the next grapheme cluster. */
6815 it
->cmp_it
.from
= it
->cmp_it
.to
;
6819 /* No more grapheme clusters in this composition.
6820 Find the next stop position. */
6821 EMACS_INT stop
= it
->end_charpos
;
6822 if (it
->bidi_it
.scan_dir
< 0)
6823 /* Now we are scanning backward and don't know
6826 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6827 IT_BYTEPOS (*it
), stop
, Qnil
);
6832 /* Composition created while scanning backward. */
6833 /* Update IT's char/byte positions to point to the last
6834 character of the previous grapheme cluster, or the
6835 character visually after the current composition. */
6836 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6837 bidi_move_to_visually_next (&it
->bidi_it
);
6838 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6839 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6840 if (it
->cmp_it
.from
> 0)
6842 /* Proceed to the previous grapheme cluster. */
6843 it
->cmp_it
.to
= it
->cmp_it
.from
;
6847 /* No more grapheme clusters in this composition.
6848 Find the next stop position. */
6849 EMACS_INT stop
= it
->end_charpos
;
6850 if (it
->bidi_it
.scan_dir
< 0)
6851 /* Now we are scanning backward and don't know
6854 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6855 IT_BYTEPOS (*it
), stop
, Qnil
);
6861 xassert (it
->len
!= 0);
6865 IT_BYTEPOS (*it
) += it
->len
;
6866 IT_CHARPOS (*it
) += 1;
6870 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6871 /* If this is a new paragraph, determine its base
6872 direction (a.k.a. its base embedding level). */
6873 if (it
->bidi_it
.new_paragraph
)
6874 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6875 bidi_move_to_visually_next (&it
->bidi_it
);
6876 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6877 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6878 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6880 /* As the scan direction was changed, we must
6881 re-compute the stop position for composition. */
6882 EMACS_INT stop
= it
->end_charpos
;
6883 if (it
->bidi_it
.scan_dir
< 0)
6885 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6886 IT_BYTEPOS (*it
), stop
, Qnil
);
6889 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6893 case GET_FROM_C_STRING
:
6894 /* Current display element of IT is from a C string. */
6896 /* If the string position is beyond string's end, it means
6897 next_element_from_c_string is padding the string with
6898 blanks, in which case we bypass the bidi iterator,
6899 because it cannot deal with such virtual characters. */
6900 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6902 IT_BYTEPOS (*it
) += it
->len
;
6903 IT_CHARPOS (*it
) += 1;
6907 bidi_move_to_visually_next (&it
->bidi_it
);
6908 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6909 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6913 case GET_FROM_DISPLAY_VECTOR
:
6914 /* Current display element of IT is from a display table entry.
6915 Advance in the display table definition. Reset it to null if
6916 end reached, and continue with characters from buffers/
6918 ++it
->current
.dpvec_index
;
6920 /* Restore face of the iterator to what they were before the
6921 display vector entry (these entries may contain faces). */
6922 it
->face_id
= it
->saved_face_id
;
6924 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6926 int recheck_faces
= it
->ellipsis_p
;
6929 it
->method
= GET_FROM_C_STRING
;
6930 else if (STRINGP (it
->string
))
6931 it
->method
= GET_FROM_STRING
;
6934 it
->method
= GET_FROM_BUFFER
;
6935 it
->object
= it
->w
->buffer
;
6939 it
->current
.dpvec_index
= -1;
6941 /* Skip over characters which were displayed via IT->dpvec. */
6942 if (it
->dpvec_char_len
< 0)
6943 reseat_at_next_visible_line_start (it
, 1);
6944 else if (it
->dpvec_char_len
> 0)
6946 if (it
->method
== GET_FROM_STRING
6947 && it
->n_overlay_strings
> 0)
6948 it
->ignore_overlay_strings_at_pos_p
= 1;
6949 it
->len
= it
->dpvec_char_len
;
6950 set_iterator_to_next (it
, reseat_p
);
6953 /* Maybe recheck faces after display vector */
6955 it
->stop_charpos
= IT_CHARPOS (*it
);
6959 case GET_FROM_STRING
:
6960 /* Current display element is a character from a Lisp string. */
6961 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6962 if (it
->cmp_it
.id
>= 0)
6968 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6969 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6970 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6971 it
->cmp_it
.from
= it
->cmp_it
.to
;
6975 composition_compute_stop_pos (&it
->cmp_it
,
6976 IT_STRING_CHARPOS (*it
),
6977 IT_STRING_BYTEPOS (*it
),
6978 it
->end_charpos
, it
->string
);
6981 else if (! it
->cmp_it
.reversed_p
)
6983 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6984 bidi_move_to_visually_next (&it
->bidi_it
);
6985 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6986 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6988 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6989 it
->cmp_it
.from
= it
->cmp_it
.to
;
6992 EMACS_INT stop
= it
->end_charpos
;
6993 if (it
->bidi_it
.scan_dir
< 0)
6995 composition_compute_stop_pos (&it
->cmp_it
,
6996 IT_STRING_CHARPOS (*it
),
6997 IT_STRING_BYTEPOS (*it
), stop
,
7003 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7004 bidi_move_to_visually_next (&it
->bidi_it
);
7005 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7006 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7007 if (it
->cmp_it
.from
> 0)
7008 it
->cmp_it
.to
= it
->cmp_it
.from
;
7011 EMACS_INT stop
= it
->end_charpos
;
7012 if (it
->bidi_it
.scan_dir
< 0)
7014 composition_compute_stop_pos (&it
->cmp_it
,
7015 IT_STRING_CHARPOS (*it
),
7016 IT_STRING_BYTEPOS (*it
), stop
,
7024 /* If the string position is beyond string's end, it
7025 means next_element_from_string is padding the string
7026 with blanks, in which case we bypass the bidi
7027 iterator, because it cannot deal with such virtual
7029 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7031 IT_STRING_BYTEPOS (*it
) += it
->len
;
7032 IT_STRING_CHARPOS (*it
) += 1;
7036 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7038 bidi_move_to_visually_next (&it
->bidi_it
);
7039 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7040 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7041 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7043 EMACS_INT stop
= it
->end_charpos
;
7045 if (it
->bidi_it
.scan_dir
< 0)
7047 composition_compute_stop_pos (&it
->cmp_it
,
7048 IT_STRING_CHARPOS (*it
),
7049 IT_STRING_BYTEPOS (*it
), stop
,
7055 consider_string_end
:
7057 if (it
->current
.overlay_string_index
>= 0)
7059 /* IT->string is an overlay string. Advance to the
7060 next, if there is one. */
7061 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7064 next_overlay_string (it
);
7066 setup_for_ellipsis (it
, 0);
7071 /* IT->string is not an overlay string. If we reached
7072 its end, and there is something on IT->stack, proceed
7073 with what is on the stack. This can be either another
7074 string, this time an overlay string, or a buffer. */
7075 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7079 if (it
->method
== GET_FROM_STRING
)
7080 goto consider_string_end
;
7085 case GET_FROM_IMAGE
:
7086 case GET_FROM_STRETCH
:
7087 /* The position etc with which we have to proceed are on
7088 the stack. The position may be at the end of a string,
7089 if the `display' property takes up the whole string. */
7090 xassert (it
->sp
> 0);
7092 if (it
->method
== GET_FROM_STRING
)
7093 goto consider_string_end
;
7097 /* There are no other methods defined, so this should be a bug. */
7101 xassert (it
->method
!= GET_FROM_STRING
7102 || (STRINGP (it
->string
)
7103 && IT_STRING_CHARPOS (*it
) >= 0));
7106 /* Load IT's display element fields with information about the next
7107 display element which comes from a display table entry or from the
7108 result of translating a control character to one of the forms `^C'
7111 IT->dpvec holds the glyphs to return as characters.
7112 IT->saved_face_id holds the face id before the display vector--it
7113 is restored into IT->face_id in set_iterator_to_next. */
7116 next_element_from_display_vector (struct it
*it
)
7121 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7123 it
->face_id
= it
->saved_face_id
;
7125 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7126 That seemed totally bogus - so I changed it... */
7127 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7129 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7131 it
->c
= GLYPH_CODE_CHAR (gc
);
7132 it
->len
= CHAR_BYTES (it
->c
);
7134 /* The entry may contain a face id to use. Such a face id is
7135 the id of a Lisp face, not a realized face. A face id of
7136 zero means no face is specified. */
7137 if (it
->dpvec_face_id
>= 0)
7138 it
->face_id
= it
->dpvec_face_id
;
7141 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7143 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7148 /* Display table entry is invalid. Return a space. */
7149 it
->c
= ' ', it
->len
= 1;
7151 /* Don't change position and object of the iterator here. They are
7152 still the values of the character that had this display table
7153 entry or was translated, and that's what we want. */
7154 it
->what
= IT_CHARACTER
;
7158 /* Get the first element of string/buffer in the visual order, after
7159 being reseated to a new position in a string or a buffer. */
7161 get_visually_first_element (struct it
*it
)
7163 int string_p
= STRINGP (it
->string
) || it
->s
;
7164 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7165 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7167 if (STRINGP (it
->string
))
7169 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7170 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7174 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7175 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7178 if (it
->bidi_it
.charpos
== eob
)
7180 /* Nothing to do, but reset the FIRST_ELT flag, like
7181 bidi_paragraph_init does, because we are not going to
7183 it
->bidi_it
.first_elt
= 0;
7185 else if (it
->bidi_it
.charpos
== bob
7187 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7188 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7190 /* If we are at the beginning of a line/string, we can produce
7191 the next element right away. */
7192 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7193 bidi_move_to_visually_next (&it
->bidi_it
);
7197 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7199 /* We need to prime the bidi iterator starting at the line's or
7200 string's beginning, before we will be able to produce the
7203 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7206 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7208 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7210 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7213 /* Now return to buffer/string position where we were asked
7214 to get the next display element, and produce that. */
7215 bidi_move_to_visually_next (&it
->bidi_it
);
7217 while (it
->bidi_it
.bytepos
!= orig_bytepos
7218 && it
->bidi_it
.charpos
< eob
);
7221 /* Adjust IT's position information to where we ended up. */
7222 if (STRINGP (it
->string
))
7224 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7225 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7229 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7230 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7233 if (STRINGP (it
->string
) || !it
->s
)
7235 EMACS_INT stop
, charpos
, bytepos
;
7237 if (STRINGP (it
->string
))
7240 stop
= SCHARS (it
->string
);
7241 if (stop
> it
->end_charpos
)
7242 stop
= it
->end_charpos
;
7243 charpos
= IT_STRING_CHARPOS (*it
);
7244 bytepos
= IT_STRING_BYTEPOS (*it
);
7248 stop
= it
->end_charpos
;
7249 charpos
= IT_CHARPOS (*it
);
7250 bytepos
= IT_BYTEPOS (*it
);
7252 if (it
->bidi_it
.scan_dir
< 0)
7254 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7259 /* Load IT with the next display element from Lisp string IT->string.
7260 IT->current.string_pos is the current position within the string.
7261 If IT->current.overlay_string_index >= 0, the Lisp string is an
7265 next_element_from_string (struct it
*it
)
7267 struct text_pos position
;
7269 xassert (STRINGP (it
->string
));
7270 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7271 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7272 position
= it
->current
.string_pos
;
7274 /* With bidi reordering, the character to display might not be the
7275 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7276 that we were reseat()ed to a new string, whose paragraph
7277 direction is not known. */
7278 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7280 get_visually_first_element (it
);
7281 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7284 /* Time to check for invisible text? */
7285 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7287 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7290 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7291 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7293 /* With bidi non-linear iteration, we could find
7294 ourselves far beyond the last computed stop_charpos,
7295 with several other stop positions in between that we
7296 missed. Scan them all now, in buffer's logical
7297 order, until we find and handle the last stop_charpos
7298 that precedes our current position. */
7299 handle_stop_backwards (it
, it
->stop_charpos
);
7300 return GET_NEXT_DISPLAY_ELEMENT (it
);
7306 /* Take note of the stop position we just moved
7307 across, for when we will move back across it. */
7308 it
->prev_stop
= it
->stop_charpos
;
7309 /* If we are at base paragraph embedding level, take
7310 note of the last stop position seen at this
7312 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7313 it
->base_level_stop
= it
->stop_charpos
;
7317 /* Since a handler may have changed IT->method, we must
7319 return GET_NEXT_DISPLAY_ELEMENT (it
);
7323 /* If we are before prev_stop, we may have overstepped
7324 on our way backwards a stop_pos, and if so, we need
7325 to handle that stop_pos. */
7326 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7327 /* We can sometimes back up for reasons that have nothing
7328 to do with bidi reordering. E.g., compositions. The
7329 code below is only needed when we are above the base
7330 embedding level, so test for that explicitly. */
7331 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7333 /* If we lost track of base_level_stop, we have no better
7334 place for handle_stop_backwards to start from than string
7335 beginning. This happens, e.g., when we were reseated to
7336 the previous screenful of text by vertical-motion. */
7337 if (it
->base_level_stop
<= 0
7338 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7339 it
->base_level_stop
= 0;
7340 handle_stop_backwards (it
, it
->base_level_stop
);
7341 return GET_NEXT_DISPLAY_ELEMENT (it
);
7345 if (it
->current
.overlay_string_index
>= 0)
7347 /* Get the next character from an overlay string. In overlay
7348 strings, There is no field width or padding with spaces to
7350 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7355 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7356 IT_STRING_BYTEPOS (*it
),
7357 it
->bidi_it
.scan_dir
< 0
7359 : SCHARS (it
->string
))
7360 && next_element_from_composition (it
))
7364 else if (STRING_MULTIBYTE (it
->string
))
7366 const unsigned char *s
= (SDATA (it
->string
)
7367 + IT_STRING_BYTEPOS (*it
));
7368 it
->c
= string_char_and_length (s
, &it
->len
);
7372 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7378 /* Get the next character from a Lisp string that is not an
7379 overlay string. Such strings come from the mode line, for
7380 example. We may have to pad with spaces, or truncate the
7381 string. See also next_element_from_c_string. */
7382 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7387 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7389 /* Pad with spaces. */
7390 it
->c
= ' ', it
->len
= 1;
7391 CHARPOS (position
) = BYTEPOS (position
) = -1;
7393 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7394 IT_STRING_BYTEPOS (*it
),
7395 it
->bidi_it
.scan_dir
< 0
7397 : it
->string_nchars
)
7398 && next_element_from_composition (it
))
7402 else if (STRING_MULTIBYTE (it
->string
))
7404 const unsigned char *s
= (SDATA (it
->string
)
7405 + IT_STRING_BYTEPOS (*it
));
7406 it
->c
= string_char_and_length (s
, &it
->len
);
7410 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7415 /* Record what we have and where it came from. */
7416 it
->what
= IT_CHARACTER
;
7417 it
->object
= it
->string
;
7418 it
->position
= position
;
7423 /* Load IT with next display element from C string IT->s.
7424 IT->string_nchars is the maximum number of characters to return
7425 from the string. IT->end_charpos may be greater than
7426 IT->string_nchars when this function is called, in which case we
7427 may have to return padding spaces. Value is zero if end of string
7428 reached, including padding spaces. */
7431 next_element_from_c_string (struct it
*it
)
7436 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7437 it
->what
= IT_CHARACTER
;
7438 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7441 /* With bidi reordering, the character to display might not be the
7442 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7443 we were reseated to a new string, whose paragraph direction is
7445 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7446 get_visually_first_element (it
);
7448 /* IT's position can be greater than IT->string_nchars in case a
7449 field width or precision has been specified when the iterator was
7451 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7453 /* End of the game. */
7457 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7459 /* Pad with spaces. */
7460 it
->c
= ' ', it
->len
= 1;
7461 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7463 else if (it
->multibyte_p
)
7464 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7466 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7472 /* Set up IT to return characters from an ellipsis, if appropriate.
7473 The definition of the ellipsis glyphs may come from a display table
7474 entry. This function fills IT with the first glyph from the
7475 ellipsis if an ellipsis is to be displayed. */
7478 next_element_from_ellipsis (struct it
*it
)
7480 if (it
->selective_display_ellipsis_p
)
7481 setup_for_ellipsis (it
, it
->len
);
7484 /* The face at the current position may be different from the
7485 face we find after the invisible text. Remember what it
7486 was in IT->saved_face_id, and signal that it's there by
7487 setting face_before_selective_p. */
7488 it
->saved_face_id
= it
->face_id
;
7489 it
->method
= GET_FROM_BUFFER
;
7490 it
->object
= it
->w
->buffer
;
7491 reseat_at_next_visible_line_start (it
, 1);
7492 it
->face_before_selective_p
= 1;
7495 return GET_NEXT_DISPLAY_ELEMENT (it
);
7499 /* Deliver an image display element. The iterator IT is already
7500 filled with image information (done in handle_display_prop). Value
7505 next_element_from_image (struct it
*it
)
7507 it
->what
= IT_IMAGE
;
7508 it
->ignore_overlay_strings_at_pos_p
= 0;
7513 /* Fill iterator IT with next display element from a stretch glyph
7514 property. IT->object is the value of the text property. Value is
7518 next_element_from_stretch (struct it
*it
)
7520 it
->what
= IT_STRETCH
;
7524 /* Scan backwards from IT's current position until we find a stop
7525 position, or until BEGV. This is called when we find ourself
7526 before both the last known prev_stop and base_level_stop while
7527 reordering bidirectional text. */
7530 compute_stop_pos_backwards (struct it
*it
)
7532 const int SCAN_BACK_LIMIT
= 1000;
7533 struct text_pos pos
;
7534 struct display_pos save_current
= it
->current
;
7535 struct text_pos save_position
= it
->position
;
7536 EMACS_INT charpos
= IT_CHARPOS (*it
);
7537 EMACS_INT where_we_are
= charpos
;
7538 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7539 EMACS_INT save_end_pos
= it
->end_charpos
;
7541 xassert (NILP (it
->string
) && !it
->s
);
7542 xassert (it
->bidi_p
);
7546 it
->end_charpos
= min (charpos
+ 1, ZV
);
7547 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7548 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7549 reseat_1 (it
, pos
, 0);
7550 compute_stop_pos (it
);
7551 /* We must advance forward, right? */
7552 if (it
->stop_charpos
<= charpos
)
7555 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7557 if (it
->stop_charpos
<= where_we_are
)
7558 it
->prev_stop
= it
->stop_charpos
;
7560 it
->prev_stop
= BEGV
;
7562 it
->current
= save_current
;
7563 it
->position
= save_position
;
7564 it
->stop_charpos
= save_stop_pos
;
7565 it
->end_charpos
= save_end_pos
;
7568 /* Scan forward from CHARPOS in the current buffer/string, until we
7569 find a stop position > current IT's position. Then handle the stop
7570 position before that. This is called when we bump into a stop
7571 position while reordering bidirectional text. CHARPOS should be
7572 the last previously processed stop_pos (or BEGV/0, if none were
7573 processed yet) whose position is less that IT's current
7577 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7579 int bufp
= !STRINGP (it
->string
);
7580 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7581 struct display_pos save_current
= it
->current
;
7582 struct text_pos save_position
= it
->position
;
7583 struct text_pos pos1
;
7584 EMACS_INT next_stop
;
7586 /* Scan in strict logical order. */
7587 xassert (it
->bidi_p
);
7591 it
->prev_stop
= charpos
;
7594 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7595 reseat_1 (it
, pos1
, 0);
7598 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7599 compute_stop_pos (it
);
7600 /* We must advance forward, right? */
7601 if (it
->stop_charpos
<= it
->prev_stop
)
7603 charpos
= it
->stop_charpos
;
7605 while (charpos
<= where_we_are
);
7608 it
->current
= save_current
;
7609 it
->position
= save_position
;
7610 next_stop
= it
->stop_charpos
;
7611 it
->stop_charpos
= it
->prev_stop
;
7613 it
->stop_charpos
= next_stop
;
7616 /* Load IT with the next display element from current_buffer. Value
7617 is zero if end of buffer reached. IT->stop_charpos is the next
7618 position at which to stop and check for text properties or buffer
7622 next_element_from_buffer (struct it
*it
)
7626 xassert (IT_CHARPOS (*it
) >= BEGV
);
7627 xassert (NILP (it
->string
) && !it
->s
);
7628 xassert (!it
->bidi_p
7629 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7630 && it
->bidi_it
.string
.s
== NULL
));
7632 /* With bidi reordering, the character to display might not be the
7633 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7634 we were reseat()ed to a new buffer position, which is potentially
7635 a different paragraph. */
7636 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7638 get_visually_first_element (it
);
7639 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7642 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7644 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7646 int overlay_strings_follow_p
;
7648 /* End of the game, except when overlay strings follow that
7649 haven't been returned yet. */
7650 if (it
->overlay_strings_at_end_processed_p
)
7651 overlay_strings_follow_p
= 0;
7654 it
->overlay_strings_at_end_processed_p
= 1;
7655 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7658 if (overlay_strings_follow_p
)
7659 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7663 it
->position
= it
->current
.pos
;
7667 else if (!(!it
->bidi_p
7668 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7669 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7671 /* With bidi non-linear iteration, we could find ourselves
7672 far beyond the last computed stop_charpos, with several
7673 other stop positions in between that we missed. Scan
7674 them all now, in buffer's logical order, until we find
7675 and handle the last stop_charpos that precedes our
7676 current position. */
7677 handle_stop_backwards (it
, it
->stop_charpos
);
7678 return GET_NEXT_DISPLAY_ELEMENT (it
);
7684 /* Take note of the stop position we just moved across,
7685 for when we will move back across it. */
7686 it
->prev_stop
= it
->stop_charpos
;
7687 /* If we are at base paragraph embedding level, take
7688 note of the last stop position seen at this
7690 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7691 it
->base_level_stop
= it
->stop_charpos
;
7694 return GET_NEXT_DISPLAY_ELEMENT (it
);
7698 /* If we are before prev_stop, we may have overstepped on
7699 our way backwards a stop_pos, and if so, we need to
7700 handle that stop_pos. */
7701 && IT_CHARPOS (*it
) < it
->prev_stop
7702 /* We can sometimes back up for reasons that have nothing
7703 to do with bidi reordering. E.g., compositions. The
7704 code below is only needed when we are above the base
7705 embedding level, so test for that explicitly. */
7706 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7708 if (it
->base_level_stop
<= 0
7709 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7711 /* If we lost track of base_level_stop, we need to find
7712 prev_stop by looking backwards. This happens, e.g., when
7713 we were reseated to the previous screenful of text by
7715 it
->base_level_stop
= BEGV
;
7716 compute_stop_pos_backwards (it
);
7717 handle_stop_backwards (it
, it
->prev_stop
);
7720 handle_stop_backwards (it
, it
->base_level_stop
);
7721 return GET_NEXT_DISPLAY_ELEMENT (it
);
7725 /* No face changes, overlays etc. in sight, so just return a
7726 character from current_buffer. */
7730 /* Maybe run the redisplay end trigger hook. Performance note:
7731 This doesn't seem to cost measurable time. */
7732 if (it
->redisplay_end_trigger_charpos
7734 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7735 run_redisplay_end_trigger_hook (it
);
7737 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7738 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7740 && next_element_from_composition (it
))
7745 /* Get the next character, maybe multibyte. */
7746 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7747 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7748 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7750 it
->c
= *p
, it
->len
= 1;
7752 /* Record what we have and where it came from. */
7753 it
->what
= IT_CHARACTER
;
7754 it
->object
= it
->w
->buffer
;
7755 it
->position
= it
->current
.pos
;
7757 /* Normally we return the character found above, except when we
7758 really want to return an ellipsis for selective display. */
7763 /* A value of selective > 0 means hide lines indented more
7764 than that number of columns. */
7765 if (it
->selective
> 0
7766 && IT_CHARPOS (*it
) + 1 < ZV
7767 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7768 IT_BYTEPOS (*it
) + 1,
7771 success_p
= next_element_from_ellipsis (it
);
7772 it
->dpvec_char_len
= -1;
7775 else if (it
->c
== '\r' && it
->selective
== -1)
7777 /* A value of selective == -1 means that everything from the
7778 CR to the end of the line is invisible, with maybe an
7779 ellipsis displayed for it. */
7780 success_p
= next_element_from_ellipsis (it
);
7781 it
->dpvec_char_len
= -1;
7786 /* Value is zero if end of buffer reached. */
7787 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7792 /* Run the redisplay end trigger hook for IT. */
7795 run_redisplay_end_trigger_hook (struct it
*it
)
7797 Lisp_Object args
[3];
7799 /* IT->glyph_row should be non-null, i.e. we should be actually
7800 displaying something, or otherwise we should not run the hook. */
7801 xassert (it
->glyph_row
);
7803 /* Set up hook arguments. */
7804 args
[0] = Qredisplay_end_trigger_functions
;
7805 args
[1] = it
->window
;
7806 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7807 it
->redisplay_end_trigger_charpos
= 0;
7809 /* Since we are *trying* to run these functions, don't try to run
7810 them again, even if they get an error. */
7811 it
->w
->redisplay_end_trigger
= Qnil
;
7812 Frun_hook_with_args (3, args
);
7814 /* Notice if it changed the face of the character we are on. */
7815 handle_face_prop (it
);
7819 /* Deliver a composition display element. Unlike the other
7820 next_element_from_XXX, this function is not registered in the array
7821 get_next_element[]. It is called from next_element_from_buffer and
7822 next_element_from_string when necessary. */
7825 next_element_from_composition (struct it
*it
)
7827 it
->what
= IT_COMPOSITION
;
7828 it
->len
= it
->cmp_it
.nbytes
;
7829 if (STRINGP (it
->string
))
7833 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7834 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7837 it
->position
= it
->current
.string_pos
;
7838 it
->object
= it
->string
;
7839 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7840 IT_STRING_BYTEPOS (*it
), it
->string
);
7846 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7847 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7850 if (it
->bidi_it
.new_paragraph
)
7851 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7852 /* Resync the bidi iterator with IT's new position.
7853 FIXME: this doesn't support bidirectional text. */
7854 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7855 bidi_move_to_visually_next (&it
->bidi_it
);
7859 it
->position
= it
->current
.pos
;
7860 it
->object
= it
->w
->buffer
;
7861 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7862 IT_BYTEPOS (*it
), Qnil
);
7869 /***********************************************************************
7870 Moving an iterator without producing glyphs
7871 ***********************************************************************/
7873 /* Check if iterator is at a position corresponding to a valid buffer
7874 position after some move_it_ call. */
7876 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7877 ((it)->method == GET_FROM_STRING \
7878 ? IT_STRING_CHARPOS (*it) == 0 \
7882 /* Move iterator IT to a specified buffer or X position within one
7883 line on the display without producing glyphs.
7885 OP should be a bit mask including some or all of these bits:
7886 MOVE_TO_X: Stop upon reaching x-position TO_X.
7887 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7888 Regardless of OP's value, stop upon reaching the end of the display line.
7890 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7891 This means, in particular, that TO_X includes window's horizontal
7894 The return value has several possible values that
7895 say what condition caused the scan to stop:
7897 MOVE_POS_MATCH_OR_ZV
7898 - when TO_POS or ZV was reached.
7901 -when TO_X was reached before TO_POS or ZV were reached.
7904 - when we reached the end of the display area and the line must
7908 - when we reached the end of the display area and the line is
7912 - when we stopped at a line end, i.e. a newline or a CR and selective
7915 static enum move_it_result
7916 move_it_in_display_line_to (struct it
*it
,
7917 EMACS_INT to_charpos
, int to_x
,
7918 enum move_operation_enum op
)
7920 enum move_it_result result
= MOVE_UNDEFINED
;
7921 struct glyph_row
*saved_glyph_row
;
7922 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7923 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7924 void *ppos_data
= NULL
;
7926 enum it_method prev_method
= it
->method
;
7927 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7928 int saw_smaller_pos
= prev_pos
< to_charpos
;
7930 /* Don't produce glyphs in produce_glyphs. */
7931 saved_glyph_row
= it
->glyph_row
;
7932 it
->glyph_row
= NULL
;
7934 /* Use wrap_it to save a copy of IT wherever a word wrap could
7935 occur. Use atpos_it to save a copy of IT at the desired buffer
7936 position, if found, so that we can scan ahead and check if the
7937 word later overshoots the window edge. Use atx_it similarly, for
7943 /* Use ppos_it under bidi reordering to save a copy of IT for the
7944 position > CHARPOS that is the closest to CHARPOS. We restore
7945 that position in IT when we have scanned the entire display line
7946 without finding a match for CHARPOS and all the character
7947 positions are greater than CHARPOS. */
7950 SAVE_IT (ppos_it
, *it
, ppos_data
);
7951 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7952 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7953 SAVE_IT (ppos_it
, *it
, ppos_data
);
7956 #define BUFFER_POS_REACHED_P() \
7957 ((op & MOVE_TO_POS) != 0 \
7958 && BUFFERP (it->object) \
7959 && (IT_CHARPOS (*it) == to_charpos \
7961 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7962 && IT_CHARPOS (*it) > to_charpos) \
7963 || (it->what == IT_COMPOSITION \
7964 && ((IT_CHARPOS (*it) > to_charpos \
7965 && to_charpos >= it->cmp_it.charpos) \
7966 || (IT_CHARPOS (*it) < to_charpos \
7967 && to_charpos <= it->cmp_it.charpos)))) \
7968 && (it->method == GET_FROM_BUFFER \
7969 || (it->method == GET_FROM_DISPLAY_VECTOR \
7970 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7972 /* If there's a line-/wrap-prefix, handle it. */
7973 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7974 && it
->current_y
< it
->last_visible_y
)
7975 handle_line_prefix (it
);
7977 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7978 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7982 int x
, i
, ascent
= 0, descent
= 0;
7984 /* Utility macro to reset an iterator with x, ascent, and descent. */
7985 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7986 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7987 (IT)->max_descent = descent)
7989 /* Stop if we move beyond TO_CHARPOS (after an image or a
7990 display string or stretch glyph). */
7991 if ((op
& MOVE_TO_POS
) != 0
7992 && BUFFERP (it
->object
)
7993 && it
->method
== GET_FROM_BUFFER
7995 /* When the iterator is at base embedding level, we
7996 are guaranteed that characters are delivered for
7997 display in strictly increasing order of their
7998 buffer positions. */
7999 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8000 && IT_CHARPOS (*it
) > to_charpos
)
8002 && (prev_method
== GET_FROM_IMAGE
8003 || prev_method
== GET_FROM_STRETCH
8004 || prev_method
== GET_FROM_STRING
)
8005 /* Passed TO_CHARPOS from left to right. */
8006 && ((prev_pos
< to_charpos
8007 && IT_CHARPOS (*it
) > to_charpos
)
8008 /* Passed TO_CHARPOS from right to left. */
8009 || (prev_pos
> to_charpos
8010 && IT_CHARPOS (*it
) < to_charpos
)))))
8012 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8014 result
= MOVE_POS_MATCH_OR_ZV
;
8017 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8018 /* If wrap_it is valid, the current position might be in a
8019 word that is wrapped. So, save the iterator in
8020 atpos_it and continue to see if wrapping happens. */
8021 SAVE_IT (atpos_it
, *it
, atpos_data
);
8024 /* Stop when ZV reached.
8025 We used to stop here when TO_CHARPOS reached as well, but that is
8026 too soon if this glyph does not fit on this line. So we handle it
8027 explicitly below. */
8028 if (!get_next_display_element (it
))
8030 result
= MOVE_POS_MATCH_OR_ZV
;
8034 if (it
->line_wrap
== TRUNCATE
)
8036 if (BUFFER_POS_REACHED_P ())
8038 result
= MOVE_POS_MATCH_OR_ZV
;
8044 if (it
->line_wrap
== WORD_WRAP
)
8046 if (IT_DISPLAYING_WHITESPACE (it
))
8050 /* We have reached a glyph that follows one or more
8051 whitespace characters. If the position is
8052 already found, we are done. */
8053 if (atpos_it
.sp
>= 0)
8055 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8056 result
= MOVE_POS_MATCH_OR_ZV
;
8061 RESTORE_IT (it
, &atx_it
, atx_data
);
8062 result
= MOVE_X_REACHED
;
8065 /* Otherwise, we can wrap here. */
8066 SAVE_IT (wrap_it
, *it
, wrap_data
);
8072 /* Remember the line height for the current line, in case
8073 the next element doesn't fit on the line. */
8074 ascent
= it
->max_ascent
;
8075 descent
= it
->max_descent
;
8077 /* The call to produce_glyphs will get the metrics of the
8078 display element IT is loaded with. Record the x-position
8079 before this display element, in case it doesn't fit on the
8083 PRODUCE_GLYPHS (it
);
8085 if (it
->area
!= TEXT_AREA
)
8087 prev_method
= it
->method
;
8088 if (it
->method
== GET_FROM_BUFFER
)
8089 prev_pos
= IT_CHARPOS (*it
);
8090 set_iterator_to_next (it
, 1);
8091 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8092 SET_TEXT_POS (this_line_min_pos
,
8093 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8095 && (op
& MOVE_TO_POS
)
8096 && IT_CHARPOS (*it
) > to_charpos
8097 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8098 SAVE_IT (ppos_it
, *it
, ppos_data
);
8102 /* The number of glyphs we get back in IT->nglyphs will normally
8103 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8104 character on a terminal frame, or (iii) a line end. For the
8105 second case, IT->nglyphs - 1 padding glyphs will be present.
8106 (On X frames, there is only one glyph produced for a
8107 composite character.)
8109 The behavior implemented below means, for continuation lines,
8110 that as many spaces of a TAB as fit on the current line are
8111 displayed there. For terminal frames, as many glyphs of a
8112 multi-glyph character are displayed in the current line, too.
8113 This is what the old redisplay code did, and we keep it that
8114 way. Under X, the whole shape of a complex character must
8115 fit on the line or it will be completely displayed in the
8118 Note that both for tabs and padding glyphs, all glyphs have
8122 /* More than one glyph or glyph doesn't fit on line. All
8123 glyphs have the same width. */
8124 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8126 int x_before_this_char
= x
;
8127 int hpos_before_this_char
= it
->hpos
;
8129 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8131 new_x
= x
+ single_glyph_width
;
8133 /* We want to leave anything reaching TO_X to the caller. */
8134 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8136 if (BUFFER_POS_REACHED_P ())
8138 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8139 goto buffer_pos_reached
;
8140 if (atpos_it
.sp
< 0)
8142 SAVE_IT (atpos_it
, *it
, atpos_data
);
8143 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8148 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8151 result
= MOVE_X_REACHED
;
8156 SAVE_IT (atx_it
, *it
, atx_data
);
8157 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8162 if (/* Lines are continued. */
8163 it
->line_wrap
!= TRUNCATE
8164 && (/* And glyph doesn't fit on the line. */
8165 new_x
> it
->last_visible_x
8166 /* Or it fits exactly and we're on a window
8168 || (new_x
== it
->last_visible_x
8169 && FRAME_WINDOW_P (it
->f
))))
8171 if (/* IT->hpos == 0 means the very first glyph
8172 doesn't fit on the line, e.g. a wide image. */
8174 || (new_x
== it
->last_visible_x
8175 && FRAME_WINDOW_P (it
->f
)))
8178 it
->current_x
= new_x
;
8180 /* The character's last glyph just barely fits
8182 if (i
== it
->nglyphs
- 1)
8184 /* If this is the destination position,
8185 return a position *before* it in this row,
8186 now that we know it fits in this row. */
8187 if (BUFFER_POS_REACHED_P ())
8189 if (it
->line_wrap
!= WORD_WRAP
8192 it
->hpos
= hpos_before_this_char
;
8193 it
->current_x
= x_before_this_char
;
8194 result
= MOVE_POS_MATCH_OR_ZV
;
8197 if (it
->line_wrap
== WORD_WRAP
8200 SAVE_IT (atpos_it
, *it
, atpos_data
);
8201 atpos_it
.current_x
= x_before_this_char
;
8202 atpos_it
.hpos
= hpos_before_this_char
;
8206 prev_method
= it
->method
;
8207 if (it
->method
== GET_FROM_BUFFER
)
8208 prev_pos
= IT_CHARPOS (*it
);
8209 set_iterator_to_next (it
, 1);
8210 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8211 SET_TEXT_POS (this_line_min_pos
,
8212 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8213 /* On graphical terminals, newlines may
8214 "overflow" into the fringe if
8215 overflow-newline-into-fringe is non-nil.
8216 On text-only terminals, newlines may
8217 overflow into the last glyph on the
8219 if (!FRAME_WINDOW_P (it
->f
)
8220 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8222 if (!get_next_display_element (it
))
8224 result
= MOVE_POS_MATCH_OR_ZV
;
8227 if (BUFFER_POS_REACHED_P ())
8229 if (ITERATOR_AT_END_OF_LINE_P (it
))
8230 result
= MOVE_POS_MATCH_OR_ZV
;
8232 result
= MOVE_LINE_CONTINUED
;
8235 if (ITERATOR_AT_END_OF_LINE_P (it
))
8237 result
= MOVE_NEWLINE_OR_CR
;
8244 IT_RESET_X_ASCENT_DESCENT (it
);
8246 if (wrap_it
.sp
>= 0)
8248 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8253 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8255 result
= MOVE_LINE_CONTINUED
;
8259 if (BUFFER_POS_REACHED_P ())
8261 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8262 goto buffer_pos_reached
;
8263 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8265 SAVE_IT (atpos_it
, *it
, atpos_data
);
8266 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8270 if (new_x
> it
->first_visible_x
)
8272 /* Glyph is visible. Increment number of glyphs that
8273 would be displayed. */
8278 if (result
!= MOVE_UNDEFINED
)
8281 else if (BUFFER_POS_REACHED_P ())
8284 IT_RESET_X_ASCENT_DESCENT (it
);
8285 result
= MOVE_POS_MATCH_OR_ZV
;
8288 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8290 /* Stop when TO_X specified and reached. This check is
8291 necessary here because of lines consisting of a line end,
8292 only. The line end will not produce any glyphs and we
8293 would never get MOVE_X_REACHED. */
8294 xassert (it
->nglyphs
== 0);
8295 result
= MOVE_X_REACHED
;
8299 /* Is this a line end? If yes, we're done. */
8300 if (ITERATOR_AT_END_OF_LINE_P (it
))
8302 /* If we are past TO_CHARPOS, but never saw any character
8303 positions smaller than TO_CHARPOS, return
8304 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8306 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8308 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8310 if (IT_CHARPOS (ppos_it
) < ZV
)
8312 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8313 result
= MOVE_POS_MATCH_OR_ZV
;
8316 goto buffer_pos_reached
;
8318 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8319 && IT_CHARPOS (*it
) > to_charpos
)
8320 goto buffer_pos_reached
;
8322 result
= MOVE_NEWLINE_OR_CR
;
8325 result
= MOVE_NEWLINE_OR_CR
;
8329 prev_method
= it
->method
;
8330 if (it
->method
== GET_FROM_BUFFER
)
8331 prev_pos
= IT_CHARPOS (*it
);
8332 /* The current display element has been consumed. Advance
8334 set_iterator_to_next (it
, 1);
8335 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8336 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8337 if (IT_CHARPOS (*it
) < to_charpos
)
8338 saw_smaller_pos
= 1;
8340 && (op
& MOVE_TO_POS
)
8341 && IT_CHARPOS (*it
) >= to_charpos
8342 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8343 SAVE_IT (ppos_it
, *it
, ppos_data
);
8345 /* Stop if lines are truncated and IT's current x-position is
8346 past the right edge of the window now. */
8347 if (it
->line_wrap
== TRUNCATE
8348 && it
->current_x
>= it
->last_visible_x
)
8350 if (!FRAME_WINDOW_P (it
->f
)
8351 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8355 if ((at_eob_p
= !get_next_display_element (it
))
8356 || BUFFER_POS_REACHED_P ()
8357 /* If we are past TO_CHARPOS, but never saw any
8358 character positions smaller than TO_CHARPOS,
8359 return MOVE_POS_MATCH_OR_ZV, like the
8360 unidirectional display did. */
8361 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8363 && IT_CHARPOS (*it
) > to_charpos
))
8366 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8367 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8368 result
= MOVE_POS_MATCH_OR_ZV
;
8371 if (ITERATOR_AT_END_OF_LINE_P (it
))
8373 result
= MOVE_NEWLINE_OR_CR
;
8377 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8379 && IT_CHARPOS (*it
) > to_charpos
)
8381 if (IT_CHARPOS (ppos_it
) < ZV
)
8382 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8383 result
= MOVE_POS_MATCH_OR_ZV
;
8386 result
= MOVE_LINE_TRUNCATED
;
8389 #undef IT_RESET_X_ASCENT_DESCENT
8392 #undef BUFFER_POS_REACHED_P
8394 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8395 restore the saved iterator. */
8396 if (atpos_it
.sp
>= 0)
8397 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8398 else if (atx_it
.sp
>= 0)
8399 RESTORE_IT (it
, &atx_it
, atx_data
);
8404 bidi_unshelve_cache (atpos_data
, 1);
8406 bidi_unshelve_cache (atx_data
, 1);
8408 bidi_unshelve_cache (wrap_data
, 1);
8410 bidi_unshelve_cache (ppos_data
, 1);
8412 /* Restore the iterator settings altered at the beginning of this
8414 it
->glyph_row
= saved_glyph_row
;
8418 /* For external use. */
8420 move_it_in_display_line (struct it
*it
,
8421 EMACS_INT to_charpos
, int to_x
,
8422 enum move_operation_enum op
)
8424 if (it
->line_wrap
== WORD_WRAP
8425 && (op
& MOVE_TO_X
))
8428 void *save_data
= NULL
;
8431 SAVE_IT (save_it
, *it
, save_data
);
8432 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8433 /* When word-wrap is on, TO_X may lie past the end
8434 of a wrapped line. Then it->current is the
8435 character on the next line, so backtrack to the
8436 space before the wrap point. */
8437 if (skip
== MOVE_LINE_CONTINUED
)
8439 int prev_x
= max (it
->current_x
- 1, 0);
8440 RESTORE_IT (it
, &save_it
, save_data
);
8441 move_it_in_display_line_to
8442 (it
, -1, prev_x
, MOVE_TO_X
);
8445 bidi_unshelve_cache (save_data
, 1);
8448 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8452 /* Move IT forward until it satisfies one or more of the criteria in
8453 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8455 OP is a bit-mask that specifies where to stop, and in particular,
8456 which of those four position arguments makes a difference. See the
8457 description of enum move_operation_enum.
8459 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8460 screen line, this function will set IT to the next position that is
8461 displayed to the right of TO_CHARPOS on the screen. */
8464 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8466 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8467 int line_height
, line_start_x
= 0, reached
= 0;
8468 void *backup_data
= NULL
;
8472 if (op
& MOVE_TO_VPOS
)
8474 /* If no TO_CHARPOS and no TO_X specified, stop at the
8475 start of the line TO_VPOS. */
8476 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8478 if (it
->vpos
== to_vpos
)
8484 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8488 /* TO_VPOS >= 0 means stop at TO_X in the line at
8489 TO_VPOS, or at TO_POS, whichever comes first. */
8490 if (it
->vpos
== to_vpos
)
8496 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8498 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8503 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8505 /* We have reached TO_X but not in the line we want. */
8506 skip
= move_it_in_display_line_to (it
, to_charpos
,
8508 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8516 else if (op
& MOVE_TO_Y
)
8518 struct it it_backup
;
8520 if (it
->line_wrap
== WORD_WRAP
)
8521 SAVE_IT (it_backup
, *it
, backup_data
);
8523 /* TO_Y specified means stop at TO_X in the line containing
8524 TO_Y---or at TO_CHARPOS if this is reached first. The
8525 problem is that we can't really tell whether the line
8526 contains TO_Y before we have completely scanned it, and
8527 this may skip past TO_X. What we do is to first scan to
8530 If TO_X is not specified, use a TO_X of zero. The reason
8531 is to make the outcome of this function more predictable.
8532 If we didn't use TO_X == 0, we would stop at the end of
8533 the line which is probably not what a caller would expect
8535 skip
= move_it_in_display_line_to
8536 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8537 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8539 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8540 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8542 else if (skip
== MOVE_X_REACHED
)
8544 /* If TO_X was reached, we want to know whether TO_Y is
8545 in the line. We know this is the case if the already
8546 scanned glyphs make the line tall enough. Otherwise,
8547 we must check by scanning the rest of the line. */
8548 line_height
= it
->max_ascent
+ it
->max_descent
;
8549 if (to_y
>= it
->current_y
8550 && to_y
< it
->current_y
+ line_height
)
8555 SAVE_IT (it_backup
, *it
, backup_data
);
8556 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8557 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8559 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8560 line_height
= it
->max_ascent
+ it
->max_descent
;
8561 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8563 if (to_y
>= it
->current_y
8564 && to_y
< it
->current_y
+ line_height
)
8566 /* If TO_Y is in this line and TO_X was reached
8567 above, we scanned too far. We have to restore
8568 IT's settings to the ones before skipping. */
8569 RESTORE_IT (it
, &it_backup
, backup_data
);
8575 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8581 /* Check whether TO_Y is in this line. */
8582 line_height
= it
->max_ascent
+ it
->max_descent
;
8583 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8585 if (to_y
>= it
->current_y
8586 && to_y
< it
->current_y
+ line_height
)
8588 /* When word-wrap is on, TO_X may lie past the end
8589 of a wrapped line. Then it->current is the
8590 character on the next line, so backtrack to the
8591 space before the wrap point. */
8592 if (skip
== MOVE_LINE_CONTINUED
8593 && it
->line_wrap
== WORD_WRAP
)
8595 int prev_x
= max (it
->current_x
- 1, 0);
8596 RESTORE_IT (it
, &it_backup
, backup_data
);
8597 skip
= move_it_in_display_line_to
8598 (it
, -1, prev_x
, MOVE_TO_X
);
8607 else if (BUFFERP (it
->object
)
8608 && (it
->method
== GET_FROM_BUFFER
8609 || it
->method
== GET_FROM_STRETCH
)
8610 && IT_CHARPOS (*it
) >= to_charpos
8611 /* Under bidi iteration, a call to set_iterator_to_next
8612 can scan far beyond to_charpos if the initial
8613 portion of the next line needs to be reordered. In
8614 that case, give move_it_in_display_line_to another
8617 && it
->bidi_it
.scan_dir
== -1))
8618 skip
= MOVE_POS_MATCH_OR_ZV
;
8620 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8624 case MOVE_POS_MATCH_OR_ZV
:
8628 case MOVE_NEWLINE_OR_CR
:
8629 set_iterator_to_next (it
, 1);
8630 it
->continuation_lines_width
= 0;
8633 case MOVE_LINE_TRUNCATED
:
8634 it
->continuation_lines_width
= 0;
8635 reseat_at_next_visible_line_start (it
, 0);
8636 if ((op
& MOVE_TO_POS
) != 0
8637 && IT_CHARPOS (*it
) > to_charpos
)
8644 case MOVE_LINE_CONTINUED
:
8645 /* For continued lines ending in a tab, some of the glyphs
8646 associated with the tab are displayed on the current
8647 line. Since it->current_x does not include these glyphs,
8648 we use it->last_visible_x instead. */
8651 it
->continuation_lines_width
+= it
->last_visible_x
;
8652 /* When moving by vpos, ensure that the iterator really
8653 advances to the next line (bug#847, bug#969). Fixme:
8654 do we need to do this in other circumstances? */
8655 if (it
->current_x
!= it
->last_visible_x
8656 && (op
& MOVE_TO_VPOS
)
8657 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8659 line_start_x
= it
->current_x
+ it
->pixel_width
8660 - it
->last_visible_x
;
8661 set_iterator_to_next (it
, 0);
8665 it
->continuation_lines_width
+= it
->current_x
;
8672 /* Reset/increment for the next run. */
8673 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8674 it
->current_x
= line_start_x
;
8677 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8679 last_height
= it
->max_ascent
+ it
->max_descent
;
8680 last_max_ascent
= it
->max_ascent
;
8681 it
->max_ascent
= it
->max_descent
= 0;
8686 /* On text terminals, we may stop at the end of a line in the middle
8687 of a multi-character glyph. If the glyph itself is continued,
8688 i.e. it is actually displayed on the next line, don't treat this
8689 stopping point as valid; move to the next line instead (unless
8690 that brings us offscreen). */
8691 if (!FRAME_WINDOW_P (it
->f
)
8693 && IT_CHARPOS (*it
) == to_charpos
8694 && it
->what
== IT_CHARACTER
8696 && it
->line_wrap
== WINDOW_WRAP
8697 && it
->current_x
== it
->last_visible_x
- 1
8700 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8702 it
->continuation_lines_width
+= it
->current_x
;
8703 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8704 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8706 last_height
= it
->max_ascent
+ it
->max_descent
;
8707 last_max_ascent
= it
->max_ascent
;
8711 bidi_unshelve_cache (backup_data
, 1);
8713 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8717 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8719 If DY > 0, move IT backward at least that many pixels. DY = 0
8720 means move IT backward to the preceding line start or BEGV. This
8721 function may move over more than DY pixels if IT->current_y - DY
8722 ends up in the middle of a line; in this case IT->current_y will be
8723 set to the top of the line moved to. */
8726 move_it_vertically_backward (struct it
*it
, int dy
)
8730 void *it2data
= NULL
, *it3data
= NULL
;
8731 EMACS_INT start_pos
;
8736 start_pos
= IT_CHARPOS (*it
);
8738 /* Estimate how many newlines we must move back. */
8739 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8741 /* Set the iterator's position that many lines back. */
8742 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8743 back_to_previous_visible_line_start (it
);
8745 /* Reseat the iterator here. When moving backward, we don't want
8746 reseat to skip forward over invisible text, set up the iterator
8747 to deliver from overlay strings at the new position etc. So,
8748 use reseat_1 here. */
8749 reseat_1 (it
, it
->current
.pos
, 1);
8751 /* We are now surely at a line start. */
8752 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8753 reordering is in effect. */
8754 it
->continuation_lines_width
= 0;
8756 /* Move forward and see what y-distance we moved. First move to the
8757 start of the next line so that we get its height. We need this
8758 height to be able to tell whether we reached the specified
8760 SAVE_IT (it2
, *it
, it2data
);
8761 it2
.max_ascent
= it2
.max_descent
= 0;
8764 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8765 MOVE_TO_POS
| MOVE_TO_VPOS
);
8767 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8768 /* If we are in a display string which starts at START_POS,
8769 and that display string includes a newline, and we are
8770 right after that newline (i.e. at the beginning of a
8771 display line), exit the loop, because otherwise we will
8772 infloop, since move_it_to will see that it is already at
8773 START_POS and will not move. */
8774 || (it2
.method
== GET_FROM_STRING
8775 && IT_CHARPOS (it2
) == start_pos
8776 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8777 xassert (IT_CHARPOS (*it
) >= BEGV
);
8778 SAVE_IT (it3
, it2
, it3data
);
8780 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8781 xassert (IT_CHARPOS (*it
) >= BEGV
);
8782 /* H is the actual vertical distance from the position in *IT
8783 and the starting position. */
8784 h
= it2
.current_y
- it
->current_y
;
8785 /* NLINES is the distance in number of lines. */
8786 nlines
= it2
.vpos
- it
->vpos
;
8788 /* Correct IT's y and vpos position
8789 so that they are relative to the starting point. */
8795 /* DY == 0 means move to the start of the screen line. The
8796 value of nlines is > 0 if continuation lines were involved,
8797 or if the original IT position was at start of a line. */
8798 RESTORE_IT (it
, it
, it2data
);
8800 move_it_by_lines (it
, nlines
);
8801 /* The above code moves us to some position NLINES down,
8802 usually to its first glyph (leftmost in an L2R line), but
8803 that's not necessarily the start of the line, under bidi
8804 reordering. We want to get to the character position
8805 that is immediately after the newline of the previous
8808 && !it
->continuation_lines_width
8809 && !STRINGP (it
->string
)
8810 && IT_CHARPOS (*it
) > BEGV
8811 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8814 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8816 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8818 bidi_unshelve_cache (it3data
, 1);
8822 /* The y-position we try to reach, relative to *IT.
8823 Note that H has been subtracted in front of the if-statement. */
8824 int target_y
= it
->current_y
+ h
- dy
;
8825 int y0
= it3
.current_y
;
8829 RESTORE_IT (&it3
, &it3
, it3data
);
8830 y1
= line_bottom_y (&it3
);
8831 line_height
= y1
- y0
;
8832 RESTORE_IT (it
, it
, it2data
);
8833 /* If we did not reach target_y, try to move further backward if
8834 we can. If we moved too far backward, try to move forward. */
8835 if (target_y
< it
->current_y
8836 /* This is heuristic. In a window that's 3 lines high, with
8837 a line height of 13 pixels each, recentering with point
8838 on the bottom line will try to move -39/2 = 19 pixels
8839 backward. Try to avoid moving into the first line. */
8840 && (it
->current_y
- target_y
8841 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8842 && IT_CHARPOS (*it
) > BEGV
)
8844 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8845 target_y
- it
->current_y
));
8846 dy
= it
->current_y
- target_y
;
8847 goto move_further_back
;
8849 else if (target_y
>= it
->current_y
+ line_height
8850 && IT_CHARPOS (*it
) < ZV
)
8852 /* Should move forward by at least one line, maybe more.
8854 Note: Calling move_it_by_lines can be expensive on
8855 terminal frames, where compute_motion is used (via
8856 vmotion) to do the job, when there are very long lines
8857 and truncate-lines is nil. That's the reason for
8858 treating terminal frames specially here. */
8860 if (!FRAME_WINDOW_P (it
->f
))
8861 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8866 move_it_by_lines (it
, 1);
8868 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8875 /* Move IT by a specified amount of pixel lines DY. DY negative means
8876 move backwards. DY = 0 means move to start of screen line. At the
8877 end, IT will be on the start of a screen line. */
8880 move_it_vertically (struct it
*it
, int dy
)
8883 move_it_vertically_backward (it
, -dy
);
8886 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8887 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8888 MOVE_TO_POS
| MOVE_TO_Y
);
8889 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8891 /* If buffer ends in ZV without a newline, move to the start of
8892 the line to satisfy the post-condition. */
8893 if (IT_CHARPOS (*it
) == ZV
8895 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8896 move_it_by_lines (it
, 0);
8901 /* Move iterator IT past the end of the text line it is in. */
8904 move_it_past_eol (struct it
*it
)
8906 enum move_it_result rc
;
8908 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8909 if (rc
== MOVE_NEWLINE_OR_CR
)
8910 set_iterator_to_next (it
, 0);
8914 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8915 negative means move up. DVPOS == 0 means move to the start of the
8918 Optimization idea: If we would know that IT->f doesn't use
8919 a face with proportional font, we could be faster for
8920 truncate-lines nil. */
8923 move_it_by_lines (struct it
*it
, int dvpos
)
8926 /* The commented-out optimization uses vmotion on terminals. This
8927 gives bad results, because elements like it->what, on which
8928 callers such as pos_visible_p rely, aren't updated. */
8929 /* struct position pos;
8930 if (!FRAME_WINDOW_P (it->f))
8932 struct text_pos textpos;
8934 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8935 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8936 reseat (it, textpos, 1);
8937 it->vpos += pos.vpos;
8938 it->current_y += pos.vpos;
8944 /* DVPOS == 0 means move to the start of the screen line. */
8945 move_it_vertically_backward (it
, 0);
8946 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8947 /* Let next call to line_bottom_y calculate real line height */
8952 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8953 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8954 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8959 void *it2data
= NULL
;
8960 EMACS_INT start_charpos
, i
;
8962 /* Start at the beginning of the screen line containing IT's
8963 position. This may actually move vertically backwards,
8964 in case of overlays, so adjust dvpos accordingly. */
8966 move_it_vertically_backward (it
, 0);
8969 /* Go back -DVPOS visible lines and reseat the iterator there. */
8970 start_charpos
= IT_CHARPOS (*it
);
8971 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8972 back_to_previous_visible_line_start (it
);
8973 reseat (it
, it
->current
.pos
, 1);
8975 /* Move further back if we end up in a string or an image. */
8976 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8978 /* First try to move to start of display line. */
8980 move_it_vertically_backward (it
, 0);
8982 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8984 /* If start of line is still in string or image,
8985 move further back. */
8986 back_to_previous_visible_line_start (it
);
8987 reseat (it
, it
->current
.pos
, 1);
8991 it
->current_x
= it
->hpos
= 0;
8993 /* Above call may have moved too far if continuation lines
8994 are involved. Scan forward and see if it did. */
8995 SAVE_IT (it2
, *it
, it2data
);
8996 it2
.vpos
= it2
.current_y
= 0;
8997 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8998 it
->vpos
-= it2
.vpos
;
8999 it
->current_y
-= it2
.current_y
;
9000 it
->current_x
= it
->hpos
= 0;
9002 /* If we moved too far back, move IT some lines forward. */
9003 if (it2
.vpos
> -dvpos
)
9005 int delta
= it2
.vpos
+ dvpos
;
9007 RESTORE_IT (&it2
, &it2
, it2data
);
9008 SAVE_IT (it2
, *it
, it2data
);
9009 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9010 /* Move back again if we got too far ahead. */
9011 if (IT_CHARPOS (*it
) >= start_charpos
)
9012 RESTORE_IT (it
, &it2
, it2data
);
9014 bidi_unshelve_cache (it2data
, 1);
9017 RESTORE_IT (it
, it
, it2data
);
9021 /* Return 1 if IT points into the middle of a display vector. */
9024 in_display_vector_p (struct it
*it
)
9026 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9027 && it
->current
.dpvec_index
> 0
9028 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9032 /***********************************************************************
9034 ***********************************************************************/
9037 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9041 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9043 Lisp_Object args
[3];
9044 Lisp_Object msg
, fmt
;
9047 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9050 /* Do nothing if called asynchronously. Inserting text into
9051 a buffer may call after-change-functions and alike and
9052 that would means running Lisp asynchronously. */
9053 if (handling_signal
)
9057 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9059 args
[0] = fmt
= build_string (format
);
9062 msg
= Fformat (3, args
);
9064 len
= SBYTES (msg
) + 1;
9065 SAFE_ALLOCA (buffer
, char *, len
);
9066 memcpy (buffer
, SDATA (msg
), len
);
9068 message_dolog (buffer
, len
- 1, 1, 0);
9075 /* Output a newline in the *Messages* buffer if "needs" one. */
9078 message_log_maybe_newline (void)
9080 if (message_log_need_newline
)
9081 message_dolog ("", 0, 1, 0);
9085 /* Add a string M of length NBYTES to the message log, optionally
9086 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9087 nonzero, means interpret the contents of M as multibyte. This
9088 function calls low-level routines in order to bypass text property
9089 hooks, etc. which might not be safe to run.
9091 This may GC (insert may run before/after change hooks),
9092 so the buffer M must NOT point to a Lisp string. */
9095 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9097 const unsigned char *msg
= (const unsigned char *) m
;
9099 if (!NILP (Vmemory_full
))
9102 if (!NILP (Vmessage_log_max
))
9104 struct buffer
*oldbuf
;
9105 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9106 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9107 EMACS_INT point_at_end
= 0;
9108 EMACS_INT zv_at_end
= 0;
9109 Lisp_Object old_deactivate_mark
, tem
;
9110 struct gcpro gcpro1
;
9112 old_deactivate_mark
= Vdeactivate_mark
;
9113 oldbuf
= current_buffer
;
9114 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9115 BVAR (current_buffer
, undo_list
) = Qt
;
9117 oldpoint
= message_dolog_marker1
;
9118 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9119 oldbegv
= message_dolog_marker2
;
9120 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9121 oldzv
= message_dolog_marker3
;
9122 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9123 GCPRO1 (old_deactivate_mark
);
9131 BEGV_BYTE
= BEG_BYTE
;
9134 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9136 /* Insert the string--maybe converting multibyte to single byte
9137 or vice versa, so that all the text fits the buffer. */
9139 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9145 /* Convert a multibyte string to single-byte
9146 for the *Message* buffer. */
9147 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9149 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9150 work
[0] = (ASCII_CHAR_P (c
)
9152 : multibyte_char_to_unibyte (c
));
9153 insert_1_both (work
, 1, 1, 1, 0, 0);
9156 else if (! multibyte
9157 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9161 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9162 /* Convert a single-byte string to multibyte
9163 for the *Message* buffer. */
9164 for (i
= 0; i
< nbytes
; i
++)
9167 MAKE_CHAR_MULTIBYTE (c
);
9168 char_bytes
= CHAR_STRING (c
, str
);
9169 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9173 insert_1 (m
, nbytes
, 1, 0, 0);
9177 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9179 insert_1 ("\n", 1, 1, 0, 0);
9181 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9183 this_bol_byte
= PT_BYTE
;
9185 /* See if this line duplicates the previous one.
9186 If so, combine duplicates. */
9189 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9191 prev_bol_byte
= PT_BYTE
;
9193 dups
= message_log_check_duplicate (prev_bol_byte
,
9197 del_range_both (prev_bol
, prev_bol_byte
,
9198 this_bol
, this_bol_byte
, 0);
9201 char dupstr
[sizeof " [ times]"
9202 + INT_STRLEN_BOUND (printmax_t
)];
9205 /* If you change this format, don't forget to also
9206 change message_log_check_duplicate. */
9207 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9208 duplen
= strlen (dupstr
);
9209 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9210 insert_1 (dupstr
, duplen
, 1, 0, 1);
9215 /* If we have more than the desired maximum number of lines
9216 in the *Messages* buffer now, delete the oldest ones.
9217 This is safe because we don't have undo in this buffer. */
9219 if (NATNUMP (Vmessage_log_max
))
9221 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9222 -XFASTINT (Vmessage_log_max
) - 1, 0);
9223 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9226 BEGV
= XMARKER (oldbegv
)->charpos
;
9227 BEGV_BYTE
= marker_byte_position (oldbegv
);
9236 ZV
= XMARKER (oldzv
)->charpos
;
9237 ZV_BYTE
= marker_byte_position (oldzv
);
9241 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9243 /* We can't do Fgoto_char (oldpoint) because it will run some
9245 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9246 XMARKER (oldpoint
)->bytepos
);
9249 unchain_marker (XMARKER (oldpoint
));
9250 unchain_marker (XMARKER (oldbegv
));
9251 unchain_marker (XMARKER (oldzv
));
9253 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9254 set_buffer_internal (oldbuf
);
9256 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9257 message_log_need_newline
= !nlflag
;
9258 Vdeactivate_mark
= old_deactivate_mark
;
9263 /* We are at the end of the buffer after just having inserted a newline.
9264 (Note: We depend on the fact we won't be crossing the gap.)
9265 Check to see if the most recent message looks a lot like the previous one.
9266 Return 0 if different, 1 if the new one should just replace it, or a
9267 value N > 1 if we should also append " [N times]". */
9270 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9273 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9275 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9276 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9278 for (i
= 0; i
< len
; i
++)
9280 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9288 if (*p1
++ == ' ' && *p1
++ == '[')
9291 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9292 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9299 /* Display an echo area message M with a specified length of NBYTES
9300 bytes. The string may include null characters. If M is 0, clear
9301 out any existing message, and let the mini-buffer text show
9304 This may GC, so the buffer M must NOT point to a Lisp string. */
9307 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9309 /* First flush out any partial line written with print. */
9310 message_log_maybe_newline ();
9312 message_dolog (m
, nbytes
, 1, multibyte
);
9313 message2_nolog (m
, nbytes
, multibyte
);
9317 /* The non-logging counterpart of message2. */
9320 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9322 struct frame
*sf
= SELECTED_FRAME ();
9323 message_enable_multibyte
= multibyte
;
9325 if (FRAME_INITIAL_P (sf
))
9327 if (noninteractive_need_newline
)
9328 putc ('\n', stderr
);
9329 noninteractive_need_newline
= 0;
9331 fwrite (m
, nbytes
, 1, stderr
);
9332 if (cursor_in_echo_area
== 0)
9333 fprintf (stderr
, "\n");
9336 /* A null message buffer means that the frame hasn't really been
9337 initialized yet. Error messages get reported properly by
9338 cmd_error, so this must be just an informative message; toss it. */
9339 else if (INTERACTIVE
9340 && sf
->glyphs_initialized_p
9341 && FRAME_MESSAGE_BUF (sf
))
9343 Lisp_Object mini_window
;
9346 /* Get the frame containing the mini-buffer
9347 that the selected frame is using. */
9348 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9349 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9351 FRAME_SAMPLE_VISIBILITY (f
);
9352 if (FRAME_VISIBLE_P (sf
)
9353 && ! FRAME_VISIBLE_P (f
))
9354 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9358 set_message (m
, Qnil
, nbytes
, multibyte
);
9359 if (minibuffer_auto_raise
)
9360 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9363 clear_message (1, 1);
9365 do_pending_window_change (0);
9366 echo_area_display (1);
9367 do_pending_window_change (0);
9368 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9369 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9374 /* Display an echo area message M with a specified length of NBYTES
9375 bytes. The string may include null characters. If M is not a
9376 string, clear out any existing message, and let the mini-buffer
9379 This function cancels echoing. */
9382 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9384 struct gcpro gcpro1
;
9387 clear_message (1,1);
9390 /* First flush out any partial line written with print. */
9391 message_log_maybe_newline ();
9397 SAFE_ALLOCA (buffer
, char *, nbytes
);
9398 memcpy (buffer
, SDATA (m
), nbytes
);
9399 message_dolog (buffer
, nbytes
, 1, multibyte
);
9402 message3_nolog (m
, nbytes
, multibyte
);
9408 /* The non-logging version of message3.
9409 This does not cancel echoing, because it is used for echoing.
9410 Perhaps we need to make a separate function for echoing
9411 and make this cancel echoing. */
9414 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9416 struct frame
*sf
= SELECTED_FRAME ();
9417 message_enable_multibyte
= multibyte
;
9419 if (FRAME_INITIAL_P (sf
))
9421 if (noninteractive_need_newline
)
9422 putc ('\n', stderr
);
9423 noninteractive_need_newline
= 0;
9425 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9426 if (cursor_in_echo_area
== 0)
9427 fprintf (stderr
, "\n");
9430 /* A null message buffer means that the frame hasn't really been
9431 initialized yet. Error messages get reported properly by
9432 cmd_error, so this must be just an informative message; toss it. */
9433 else if (INTERACTIVE
9434 && sf
->glyphs_initialized_p
9435 && FRAME_MESSAGE_BUF (sf
))
9437 Lisp_Object mini_window
;
9441 /* Get the frame containing the mini-buffer
9442 that the selected frame is using. */
9443 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9444 frame
= XWINDOW (mini_window
)->frame
;
9447 FRAME_SAMPLE_VISIBILITY (f
);
9448 if (FRAME_VISIBLE_P (sf
)
9449 && !FRAME_VISIBLE_P (f
))
9450 Fmake_frame_visible (frame
);
9452 if (STRINGP (m
) && SCHARS (m
) > 0)
9454 set_message (NULL
, m
, nbytes
, multibyte
);
9455 if (minibuffer_auto_raise
)
9456 Fraise_frame (frame
);
9457 /* Assume we are not echoing.
9458 (If we are, echo_now will override this.) */
9459 echo_message_buffer
= Qnil
;
9462 clear_message (1, 1);
9464 do_pending_window_change (0);
9465 echo_area_display (1);
9466 do_pending_window_change (0);
9467 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9468 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9473 /* Display a null-terminated echo area message M. If M is 0, clear
9474 out any existing message, and let the mini-buffer text show through.
9476 The buffer M must continue to exist until after the echo area gets
9477 cleared or some other message gets displayed there. Do not pass
9478 text that is stored in a Lisp string. Do not pass text in a buffer
9479 that was alloca'd. */
9482 message1 (const char *m
)
9484 message2 (m
, (m
? strlen (m
) : 0), 0);
9488 /* The non-logging counterpart of message1. */
9491 message1_nolog (const char *m
)
9493 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9496 /* Display a message M which contains a single %s
9497 which gets replaced with STRING. */
9500 message_with_string (const char *m
, Lisp_Object string
, int log
)
9502 CHECK_STRING (string
);
9508 if (noninteractive_need_newline
)
9509 putc ('\n', stderr
);
9510 noninteractive_need_newline
= 0;
9511 fprintf (stderr
, m
, SDATA (string
));
9512 if (!cursor_in_echo_area
)
9513 fprintf (stderr
, "\n");
9517 else if (INTERACTIVE
)
9519 /* The frame whose minibuffer we're going to display the message on.
9520 It may be larger than the selected frame, so we need
9521 to use its buffer, not the selected frame's buffer. */
9522 Lisp_Object mini_window
;
9523 struct frame
*f
, *sf
= SELECTED_FRAME ();
9525 /* Get the frame containing the minibuffer
9526 that the selected frame is using. */
9527 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9528 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9530 /* A null message buffer means that the frame hasn't really been
9531 initialized yet. Error messages get reported properly by
9532 cmd_error, so this must be just an informative message; toss it. */
9533 if (FRAME_MESSAGE_BUF (f
))
9535 Lisp_Object args
[2], msg
;
9536 struct gcpro gcpro1
, gcpro2
;
9538 args
[0] = build_string (m
);
9539 args
[1] = msg
= string
;
9540 GCPRO2 (args
[0], msg
);
9543 msg
= Fformat (2, args
);
9546 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9548 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9552 /* Print should start at the beginning of the message
9553 buffer next time. */
9554 message_buf_print
= 0;
9560 /* Dump an informative message to the minibuf. If M is 0, clear out
9561 any existing message, and let the mini-buffer text show through. */
9564 vmessage (const char *m
, va_list ap
)
9570 if (noninteractive_need_newline
)
9571 putc ('\n', stderr
);
9572 noninteractive_need_newline
= 0;
9573 vfprintf (stderr
, m
, ap
);
9574 if (cursor_in_echo_area
== 0)
9575 fprintf (stderr
, "\n");
9579 else if (INTERACTIVE
)
9581 /* The frame whose mini-buffer we're going to display the message
9582 on. It may be larger than the selected frame, so we need to
9583 use its buffer, not the selected frame's buffer. */
9584 Lisp_Object mini_window
;
9585 struct frame
*f
, *sf
= SELECTED_FRAME ();
9587 /* Get the frame containing the mini-buffer
9588 that the selected frame is using. */
9589 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9590 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9592 /* A null message buffer means that the frame hasn't really been
9593 initialized yet. Error messages get reported properly by
9594 cmd_error, so this must be just an informative message; toss
9596 if (FRAME_MESSAGE_BUF (f
))
9602 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9603 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9605 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9610 /* Print should start at the beginning of the message
9611 buffer next time. */
9612 message_buf_print
= 0;
9618 message (const char *m
, ...)
9628 /* The non-logging version of message. */
9631 message_nolog (const char *m
, ...)
9633 Lisp_Object old_log_max
;
9636 old_log_max
= Vmessage_log_max
;
9637 Vmessage_log_max
= Qnil
;
9639 Vmessage_log_max
= old_log_max
;
9645 /* Display the current message in the current mini-buffer. This is
9646 only called from error handlers in process.c, and is not time
9650 update_echo_area (void)
9652 if (!NILP (echo_area_buffer
[0]))
9655 string
= Fcurrent_message ();
9656 message3 (string
, SBYTES (string
),
9657 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9662 /* Make sure echo area buffers in `echo_buffers' are live.
9663 If they aren't, make new ones. */
9666 ensure_echo_area_buffers (void)
9670 for (i
= 0; i
< 2; ++i
)
9671 if (!BUFFERP (echo_buffer
[i
])
9672 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9675 Lisp_Object old_buffer
;
9678 old_buffer
= echo_buffer
[i
];
9679 sprintf (name
, " *Echo Area %d*", i
);
9680 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9681 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9682 /* to force word wrap in echo area -
9683 it was decided to postpone this*/
9684 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9686 for (j
= 0; j
< 2; ++j
)
9687 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9688 echo_area_buffer
[j
] = echo_buffer
[i
];
9693 /* Call FN with args A1..A4 with either the current or last displayed
9694 echo_area_buffer as current buffer.
9696 WHICH zero means use the current message buffer
9697 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9698 from echo_buffer[] and clear it.
9700 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9701 suitable buffer from echo_buffer[] and clear it.
9703 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9704 that the current message becomes the last displayed one, make
9705 choose a suitable buffer for echo_area_buffer[0], and clear it.
9707 Value is what FN returns. */
9710 with_echo_area_buffer (struct window
*w
, int which
,
9711 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9712 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9715 int this_one
, the_other
, clear_buffer_p
, rc
;
9716 int count
= SPECPDL_INDEX ();
9718 /* If buffers aren't live, make new ones. */
9719 ensure_echo_area_buffers ();
9724 this_one
= 0, the_other
= 1;
9726 this_one
= 1, the_other
= 0;
9729 this_one
= 0, the_other
= 1;
9732 /* We need a fresh one in case the current echo buffer equals
9733 the one containing the last displayed echo area message. */
9734 if (!NILP (echo_area_buffer
[this_one
])
9735 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9736 echo_area_buffer
[this_one
] = Qnil
;
9739 /* Choose a suitable buffer from echo_buffer[] is we don't
9741 if (NILP (echo_area_buffer
[this_one
]))
9743 echo_area_buffer
[this_one
]
9744 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9745 ? echo_buffer
[the_other
]
9746 : echo_buffer
[this_one
]);
9750 buffer
= echo_area_buffer
[this_one
];
9752 /* Don't get confused by reusing the buffer used for echoing
9753 for a different purpose. */
9754 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9757 record_unwind_protect (unwind_with_echo_area_buffer
,
9758 with_echo_area_buffer_unwind_data (w
));
9760 /* Make the echo area buffer current. Note that for display
9761 purposes, it is not necessary that the displayed window's buffer
9762 == current_buffer, except for text property lookup. So, let's
9763 only set that buffer temporarily here without doing a full
9764 Fset_window_buffer. We must also change w->pointm, though,
9765 because otherwise an assertions in unshow_buffer fails, and Emacs
9767 set_buffer_internal_1 (XBUFFER (buffer
));
9771 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9774 BVAR (current_buffer
, undo_list
) = Qt
;
9775 BVAR (current_buffer
, read_only
) = Qnil
;
9776 specbind (Qinhibit_read_only
, Qt
);
9777 specbind (Qinhibit_modification_hooks
, Qt
);
9779 if (clear_buffer_p
&& Z
> BEG
)
9782 xassert (BEGV
>= BEG
);
9783 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9785 rc
= fn (a1
, a2
, a3
, a4
);
9787 xassert (BEGV
>= BEG
);
9788 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9790 unbind_to (count
, Qnil
);
9795 /* Save state that should be preserved around the call to the function
9796 FN called in with_echo_area_buffer. */
9799 with_echo_area_buffer_unwind_data (struct window
*w
)
9802 Lisp_Object vector
, tmp
;
9804 /* Reduce consing by keeping one vector in
9805 Vwith_echo_area_save_vector. */
9806 vector
= Vwith_echo_area_save_vector
;
9807 Vwith_echo_area_save_vector
= Qnil
;
9810 vector
= Fmake_vector (make_number (7), Qnil
);
9812 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9813 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9814 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9818 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9819 ASET (vector
, i
, w
->buffer
); ++i
;
9820 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9821 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9826 for (; i
< end
; ++i
)
9827 ASET (vector
, i
, Qnil
);
9830 xassert (i
== ASIZE (vector
));
9835 /* Restore global state from VECTOR which was created by
9836 with_echo_area_buffer_unwind_data. */
9839 unwind_with_echo_area_buffer (Lisp_Object vector
)
9841 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9842 Vdeactivate_mark
= AREF (vector
, 1);
9843 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9845 if (WINDOWP (AREF (vector
, 3)))
9848 Lisp_Object buffer
, charpos
, bytepos
;
9850 w
= XWINDOW (AREF (vector
, 3));
9851 buffer
= AREF (vector
, 4);
9852 charpos
= AREF (vector
, 5);
9853 bytepos
= AREF (vector
, 6);
9856 set_marker_both (w
->pointm
, buffer
,
9857 XFASTINT (charpos
), XFASTINT (bytepos
));
9860 Vwith_echo_area_save_vector
= vector
;
9865 /* Set up the echo area for use by print functions. MULTIBYTE_P
9866 non-zero means we will print multibyte. */
9869 setup_echo_area_for_printing (int multibyte_p
)
9871 /* If we can't find an echo area any more, exit. */
9872 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9875 ensure_echo_area_buffers ();
9877 if (!message_buf_print
)
9879 /* A message has been output since the last time we printed.
9880 Choose a fresh echo area buffer. */
9881 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9882 echo_area_buffer
[0] = echo_buffer
[1];
9884 echo_area_buffer
[0] = echo_buffer
[0];
9886 /* Switch to that buffer and clear it. */
9887 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9888 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9892 int count
= SPECPDL_INDEX ();
9893 specbind (Qinhibit_read_only
, Qt
);
9894 /* Note that undo recording is always disabled. */
9896 unbind_to (count
, Qnil
);
9898 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9900 /* Set up the buffer for the multibyteness we need. */
9902 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9903 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9905 /* Raise the frame containing the echo area. */
9906 if (minibuffer_auto_raise
)
9908 struct frame
*sf
= SELECTED_FRAME ();
9909 Lisp_Object mini_window
;
9910 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9911 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9914 message_log_maybe_newline ();
9915 message_buf_print
= 1;
9919 if (NILP (echo_area_buffer
[0]))
9921 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9922 echo_area_buffer
[0] = echo_buffer
[1];
9924 echo_area_buffer
[0] = echo_buffer
[0];
9927 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9929 /* Someone switched buffers between print requests. */
9930 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9931 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9937 /* Display an echo area message in window W. Value is non-zero if W's
9938 height is changed. If display_last_displayed_message_p is
9939 non-zero, display the message that was last displayed, otherwise
9940 display the current message. */
9943 display_echo_area (struct window
*w
)
9945 int i
, no_message_p
, window_height_changed_p
, count
;
9947 /* Temporarily disable garbage collections while displaying the echo
9948 area. This is done because a GC can print a message itself.
9949 That message would modify the echo area buffer's contents while a
9950 redisplay of the buffer is going on, and seriously confuse
9952 count
= inhibit_garbage_collection ();
9954 /* If there is no message, we must call display_echo_area_1
9955 nevertheless because it resizes the window. But we will have to
9956 reset the echo_area_buffer in question to nil at the end because
9957 with_echo_area_buffer will sets it to an empty buffer. */
9958 i
= display_last_displayed_message_p
? 1 : 0;
9959 no_message_p
= NILP (echo_area_buffer
[i
]);
9961 window_height_changed_p
9962 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9963 display_echo_area_1
,
9964 (intptr_t) w
, Qnil
, 0, 0);
9967 echo_area_buffer
[i
] = Qnil
;
9969 unbind_to (count
, Qnil
);
9970 return window_height_changed_p
;
9974 /* Helper for display_echo_area. Display the current buffer which
9975 contains the current echo area message in window W, a mini-window,
9976 a pointer to which is passed in A1. A2..A4 are currently not used.
9977 Change the height of W so that all of the message is displayed.
9978 Value is non-zero if height of W was changed. */
9981 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9984 struct window
*w
= (struct window
*) i1
;
9986 struct text_pos start
;
9987 int window_height_changed_p
= 0;
9989 /* Do this before displaying, so that we have a large enough glyph
9990 matrix for the display. If we can't get enough space for the
9991 whole text, display the last N lines. That works by setting w->start. */
9992 window_height_changed_p
= resize_mini_window (w
, 0);
9994 /* Use the starting position chosen by resize_mini_window. */
9995 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9998 clear_glyph_matrix (w
->desired_matrix
);
9999 XSETWINDOW (window
, w
);
10000 try_window (window
, start
, 0);
10002 return window_height_changed_p
;
10006 /* Resize the echo area window to exactly the size needed for the
10007 currently displayed message, if there is one. If a mini-buffer
10008 is active, don't shrink it. */
10011 resize_echo_area_exactly (void)
10013 if (BUFFERP (echo_area_buffer
[0])
10014 && WINDOWP (echo_area_window
))
10016 struct window
*w
= XWINDOW (echo_area_window
);
10018 Lisp_Object resize_exactly
;
10020 if (minibuf_level
== 0)
10021 resize_exactly
= Qt
;
10023 resize_exactly
= Qnil
;
10025 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10026 (intptr_t) w
, resize_exactly
,
10030 ++windows_or_buffers_changed
;
10031 ++update_mode_lines
;
10032 redisplay_internal ();
10038 /* Callback function for with_echo_area_buffer, when used from
10039 resize_echo_area_exactly. A1 contains a pointer to the window to
10040 resize, EXACTLY non-nil means resize the mini-window exactly to the
10041 size of the text displayed. A3 and A4 are not used. Value is what
10042 resize_mini_window returns. */
10045 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10048 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10052 /* Resize mini-window W to fit the size of its contents. EXACT_P
10053 means size the window exactly to the size needed. Otherwise, it's
10054 only enlarged until W's buffer is empty.
10056 Set W->start to the right place to begin display. If the whole
10057 contents fit, start at the beginning. Otherwise, start so as
10058 to make the end of the contents appear. This is particularly
10059 important for y-or-n-p, but seems desirable generally.
10061 Value is non-zero if the window height has been changed. */
10064 resize_mini_window (struct window
*w
, int exact_p
)
10066 struct frame
*f
= XFRAME (w
->frame
);
10067 int window_height_changed_p
= 0;
10069 xassert (MINI_WINDOW_P (w
));
10071 /* By default, start display at the beginning. */
10072 set_marker_both (w
->start
, w
->buffer
,
10073 BUF_BEGV (XBUFFER (w
->buffer
)),
10074 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10076 /* Don't resize windows while redisplaying a window; it would
10077 confuse redisplay functions when the size of the window they are
10078 displaying changes from under them. Such a resizing can happen,
10079 for instance, when which-func prints a long message while
10080 we are running fontification-functions. We're running these
10081 functions with safe_call which binds inhibit-redisplay to t. */
10082 if (!NILP (Vinhibit_redisplay
))
10085 /* Nil means don't try to resize. */
10086 if (NILP (Vresize_mini_windows
)
10087 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10090 if (!FRAME_MINIBUF_ONLY_P (f
))
10093 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10094 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10095 int height
, max_height
;
10096 int unit
= FRAME_LINE_HEIGHT (f
);
10097 struct text_pos start
;
10098 struct buffer
*old_current_buffer
= NULL
;
10100 if (current_buffer
!= XBUFFER (w
->buffer
))
10102 old_current_buffer
= current_buffer
;
10103 set_buffer_internal (XBUFFER (w
->buffer
));
10106 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10108 /* Compute the max. number of lines specified by the user. */
10109 if (FLOATP (Vmax_mini_window_height
))
10110 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10111 else if (INTEGERP (Vmax_mini_window_height
))
10112 max_height
= XINT (Vmax_mini_window_height
);
10114 max_height
= total_height
/ 4;
10116 /* Correct that max. height if it's bogus. */
10117 max_height
= max (1, max_height
);
10118 max_height
= min (total_height
, max_height
);
10120 /* Find out the height of the text in the window. */
10121 if (it
.line_wrap
== TRUNCATE
)
10126 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10127 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10128 height
= it
.current_y
+ last_height
;
10130 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10131 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10132 height
= (height
+ unit
- 1) / unit
;
10135 /* Compute a suitable window start. */
10136 if (height
> max_height
)
10138 height
= max_height
;
10139 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10140 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10141 start
= it
.current
.pos
;
10144 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10145 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10147 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10149 /* Let it grow only, until we display an empty message, in which
10150 case the window shrinks again. */
10151 if (height
> WINDOW_TOTAL_LINES (w
))
10153 int old_height
= WINDOW_TOTAL_LINES (w
);
10154 freeze_window_starts (f
, 1);
10155 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10156 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10158 else if (height
< WINDOW_TOTAL_LINES (w
)
10159 && (exact_p
|| BEGV
== ZV
))
10161 int old_height
= WINDOW_TOTAL_LINES (w
);
10162 freeze_window_starts (f
, 0);
10163 shrink_mini_window (w
);
10164 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10169 /* Always resize to exact size needed. */
10170 if (height
> WINDOW_TOTAL_LINES (w
))
10172 int old_height
= WINDOW_TOTAL_LINES (w
);
10173 freeze_window_starts (f
, 1);
10174 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10175 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10177 else if (height
< WINDOW_TOTAL_LINES (w
))
10179 int old_height
= WINDOW_TOTAL_LINES (w
);
10180 freeze_window_starts (f
, 0);
10181 shrink_mini_window (w
);
10185 freeze_window_starts (f
, 1);
10186 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10189 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10193 if (old_current_buffer
)
10194 set_buffer_internal (old_current_buffer
);
10197 return window_height_changed_p
;
10201 /* Value is the current message, a string, or nil if there is no
10202 current message. */
10205 current_message (void)
10209 if (!BUFFERP (echo_area_buffer
[0]))
10213 with_echo_area_buffer (0, 0, current_message_1
,
10214 (intptr_t) &msg
, Qnil
, 0, 0);
10216 echo_area_buffer
[0] = Qnil
;
10224 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10227 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10230 *msg
= make_buffer_string (BEG
, Z
, 1);
10237 /* Push the current message on Vmessage_stack for later restoration
10238 by restore_message. Value is non-zero if the current message isn't
10239 empty. This is a relatively infrequent operation, so it's not
10240 worth optimizing. */
10243 push_message (void)
10246 msg
= current_message ();
10247 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10248 return STRINGP (msg
);
10252 /* Restore message display from the top of Vmessage_stack. */
10255 restore_message (void)
10259 xassert (CONSP (Vmessage_stack
));
10260 msg
= XCAR (Vmessage_stack
);
10262 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10264 message3_nolog (msg
, 0, 0);
10268 /* Handler for record_unwind_protect calling pop_message. */
10271 pop_message_unwind (Lisp_Object dummy
)
10277 /* Pop the top-most entry off Vmessage_stack. */
10282 xassert (CONSP (Vmessage_stack
));
10283 Vmessage_stack
= XCDR (Vmessage_stack
);
10287 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10288 exits. If the stack is not empty, we have a missing pop_message
10292 check_message_stack (void)
10294 if (!NILP (Vmessage_stack
))
10299 /* Truncate to NCHARS what will be displayed in the echo area the next
10300 time we display it---but don't redisplay it now. */
10303 truncate_echo_area (EMACS_INT nchars
)
10306 echo_area_buffer
[0] = Qnil
;
10307 /* A null message buffer means that the frame hasn't really been
10308 initialized yet. Error messages get reported properly by
10309 cmd_error, so this must be just an informative message; toss it. */
10310 else if (!noninteractive
10312 && !NILP (echo_area_buffer
[0]))
10314 struct frame
*sf
= SELECTED_FRAME ();
10315 if (FRAME_MESSAGE_BUF (sf
))
10316 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10321 /* Helper function for truncate_echo_area. Truncate the current
10322 message to at most NCHARS characters. */
10325 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10327 if (BEG
+ nchars
< Z
)
10328 del_range (BEG
+ nchars
, Z
);
10330 echo_area_buffer
[0] = Qnil
;
10335 /* Set the current message to a substring of S or STRING.
10337 If STRING is a Lisp string, set the message to the first NBYTES
10338 bytes from STRING. NBYTES zero means use the whole string. If
10339 STRING is multibyte, the message will be displayed multibyte.
10341 If S is not null, set the message to the first LEN bytes of S. LEN
10342 zero means use the whole string. MULTIBYTE_P non-zero means S is
10343 multibyte. Display the message multibyte in that case.
10345 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10346 to t before calling set_message_1 (which calls insert).
10350 set_message (const char *s
, Lisp_Object string
,
10351 EMACS_INT nbytes
, int multibyte_p
)
10353 message_enable_multibyte
10354 = ((s
&& multibyte_p
)
10355 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10357 with_echo_area_buffer (0, -1, set_message_1
,
10358 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10359 message_buf_print
= 0;
10360 help_echo_showing_p
= 0;
10364 /* Helper function for set_message. Arguments have the same meaning
10365 as there, with A1 corresponding to S and A2 corresponding to STRING
10366 This function is called with the echo area buffer being
10370 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10373 const char *s
= (const char *) i1
;
10374 const unsigned char *msg
= (const unsigned char *) s
;
10375 Lisp_Object string
= a2
;
10377 /* Change multibyteness of the echo buffer appropriately. */
10378 if (message_enable_multibyte
10379 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10380 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10382 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10383 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10384 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10386 /* Insert new message at BEG. */
10387 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10389 if (STRINGP (string
))
10394 nbytes
= SBYTES (string
);
10395 nchars
= string_byte_to_char (string
, nbytes
);
10397 /* This function takes care of single/multibyte conversion. We
10398 just have to ensure that the echo area buffer has the right
10399 setting of enable_multibyte_characters. */
10400 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10405 nbytes
= strlen (s
);
10407 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10409 /* Convert from multi-byte to single-byte. */
10414 /* Convert a multibyte string to single-byte. */
10415 for (i
= 0; i
< nbytes
; i
+= n
)
10417 c
= string_char_and_length (msg
+ i
, &n
);
10418 work
[0] = (ASCII_CHAR_P (c
)
10420 : multibyte_char_to_unibyte (c
));
10421 insert_1_both (work
, 1, 1, 1, 0, 0);
10424 else if (!multibyte_p
10425 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10427 /* Convert from single-byte to multi-byte. */
10430 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10432 /* Convert a single-byte string to multibyte. */
10433 for (i
= 0; i
< nbytes
; i
++)
10436 MAKE_CHAR_MULTIBYTE (c
);
10437 n
= CHAR_STRING (c
, str
);
10438 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10442 insert_1 (s
, nbytes
, 1, 0, 0);
10449 /* Clear messages. CURRENT_P non-zero means clear the current
10450 message. LAST_DISPLAYED_P non-zero means clear the message
10454 clear_message (int current_p
, int last_displayed_p
)
10458 echo_area_buffer
[0] = Qnil
;
10459 message_cleared_p
= 1;
10462 if (last_displayed_p
)
10463 echo_area_buffer
[1] = Qnil
;
10465 message_buf_print
= 0;
10468 /* Clear garbaged frames.
10470 This function is used where the old redisplay called
10471 redraw_garbaged_frames which in turn called redraw_frame which in
10472 turn called clear_frame. The call to clear_frame was a source of
10473 flickering. I believe a clear_frame is not necessary. It should
10474 suffice in the new redisplay to invalidate all current matrices,
10475 and ensure a complete redisplay of all windows. */
10478 clear_garbaged_frames (void)
10480 if (frame_garbaged
)
10482 Lisp_Object tail
, frame
;
10483 int changed_count
= 0;
10485 FOR_EACH_FRAME (tail
, frame
)
10487 struct frame
*f
= XFRAME (frame
);
10489 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10493 Fredraw_frame (frame
);
10494 f
->force_flush_display_p
= 1;
10496 clear_current_matrices (f
);
10503 frame_garbaged
= 0;
10505 ++windows_or_buffers_changed
;
10510 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10511 is non-zero update selected_frame. Value is non-zero if the
10512 mini-windows height has been changed. */
10515 echo_area_display (int update_frame_p
)
10517 Lisp_Object mini_window
;
10520 int window_height_changed_p
= 0;
10521 struct frame
*sf
= SELECTED_FRAME ();
10523 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10524 w
= XWINDOW (mini_window
);
10525 f
= XFRAME (WINDOW_FRAME (w
));
10527 /* Don't display if frame is invisible or not yet initialized. */
10528 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10531 #ifdef HAVE_WINDOW_SYSTEM
10532 /* When Emacs starts, selected_frame may be the initial terminal
10533 frame. If we let this through, a message would be displayed on
10535 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10537 #endif /* HAVE_WINDOW_SYSTEM */
10539 /* Redraw garbaged frames. */
10540 if (frame_garbaged
)
10541 clear_garbaged_frames ();
10543 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10545 echo_area_window
= mini_window
;
10546 window_height_changed_p
= display_echo_area (w
);
10547 w
->must_be_updated_p
= 1;
10549 /* Update the display, unless called from redisplay_internal.
10550 Also don't update the screen during redisplay itself. The
10551 update will happen at the end of redisplay, and an update
10552 here could cause confusion. */
10553 if (update_frame_p
&& !redisplaying_p
)
10557 /* If the display update has been interrupted by pending
10558 input, update mode lines in the frame. Due to the
10559 pending input, it might have been that redisplay hasn't
10560 been called, so that mode lines above the echo area are
10561 garbaged. This looks odd, so we prevent it here. */
10562 if (!display_completed
)
10563 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10565 if (window_height_changed_p
10566 /* Don't do this if Emacs is shutting down. Redisplay
10567 needs to run hooks. */
10568 && !NILP (Vrun_hooks
))
10570 /* Must update other windows. Likewise as in other
10571 cases, don't let this update be interrupted by
10573 int count
= SPECPDL_INDEX ();
10574 specbind (Qredisplay_dont_pause
, Qt
);
10575 windows_or_buffers_changed
= 1;
10576 redisplay_internal ();
10577 unbind_to (count
, Qnil
);
10579 else if (FRAME_WINDOW_P (f
) && n
== 0)
10581 /* Window configuration is the same as before.
10582 Can do with a display update of the echo area,
10583 unless we displayed some mode lines. */
10584 update_single_window (w
, 1);
10585 FRAME_RIF (f
)->flush_display (f
);
10588 update_frame (f
, 1, 1);
10590 /* If cursor is in the echo area, make sure that the next
10591 redisplay displays the minibuffer, so that the cursor will
10592 be replaced with what the minibuffer wants. */
10593 if (cursor_in_echo_area
)
10594 ++windows_or_buffers_changed
;
10597 else if (!EQ (mini_window
, selected_window
))
10598 windows_or_buffers_changed
++;
10600 /* Last displayed message is now the current message. */
10601 echo_area_buffer
[1] = echo_area_buffer
[0];
10602 /* Inform read_char that we're not echoing. */
10603 echo_message_buffer
= Qnil
;
10605 /* Prevent redisplay optimization in redisplay_internal by resetting
10606 this_line_start_pos. This is done because the mini-buffer now
10607 displays the message instead of its buffer text. */
10608 if (EQ (mini_window
, selected_window
))
10609 CHARPOS (this_line_start_pos
) = 0;
10611 return window_height_changed_p
;
10616 /***********************************************************************
10617 Mode Lines and Frame Titles
10618 ***********************************************************************/
10620 /* A buffer for constructing non-propertized mode-line strings and
10621 frame titles in it; allocated from the heap in init_xdisp and
10622 resized as needed in store_mode_line_noprop_char. */
10624 static char *mode_line_noprop_buf
;
10626 /* The buffer's end, and a current output position in it. */
10628 static char *mode_line_noprop_buf_end
;
10629 static char *mode_line_noprop_ptr
;
10631 #define MODE_LINE_NOPROP_LEN(start) \
10632 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10635 MODE_LINE_DISPLAY
= 0,
10639 } mode_line_target
;
10641 /* Alist that caches the results of :propertize.
10642 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10643 static Lisp_Object mode_line_proptrans_alist
;
10645 /* List of strings making up the mode-line. */
10646 static Lisp_Object mode_line_string_list
;
10648 /* Base face property when building propertized mode line string. */
10649 static Lisp_Object mode_line_string_face
;
10650 static Lisp_Object mode_line_string_face_prop
;
10653 /* Unwind data for mode line strings */
10655 static Lisp_Object Vmode_line_unwind_vector
;
10658 format_mode_line_unwind_data (struct buffer
*obuf
,
10660 int save_proptrans
)
10662 Lisp_Object vector
, tmp
;
10664 /* Reduce consing by keeping one vector in
10665 Vwith_echo_area_save_vector. */
10666 vector
= Vmode_line_unwind_vector
;
10667 Vmode_line_unwind_vector
= Qnil
;
10670 vector
= Fmake_vector (make_number (8), Qnil
);
10672 ASET (vector
, 0, make_number (mode_line_target
));
10673 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10674 ASET (vector
, 2, mode_line_string_list
);
10675 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10676 ASET (vector
, 4, mode_line_string_face
);
10677 ASET (vector
, 5, mode_line_string_face_prop
);
10680 XSETBUFFER (tmp
, obuf
);
10683 ASET (vector
, 6, tmp
);
10684 ASET (vector
, 7, owin
);
10690 unwind_format_mode_line (Lisp_Object vector
)
10692 mode_line_target
= XINT (AREF (vector
, 0));
10693 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10694 mode_line_string_list
= AREF (vector
, 2);
10695 if (! EQ (AREF (vector
, 3), Qt
))
10696 mode_line_proptrans_alist
= AREF (vector
, 3);
10697 mode_line_string_face
= AREF (vector
, 4);
10698 mode_line_string_face_prop
= AREF (vector
, 5);
10700 if (!NILP (AREF (vector
, 7)))
10701 /* Select window before buffer, since it may change the buffer. */
10702 Fselect_window (AREF (vector
, 7), Qt
);
10704 if (!NILP (AREF (vector
, 6)))
10706 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10707 ASET (vector
, 6, Qnil
);
10710 Vmode_line_unwind_vector
= vector
;
10715 /* Store a single character C for the frame title in mode_line_noprop_buf.
10716 Re-allocate mode_line_noprop_buf if necessary. */
10719 store_mode_line_noprop_char (char c
)
10721 /* If output position has reached the end of the allocated buffer,
10722 increase the buffer's size. */
10723 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10725 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10726 ptrdiff_t size
= len
;
10727 mode_line_noprop_buf
=
10728 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10729 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10730 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10733 *mode_line_noprop_ptr
++ = c
;
10737 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10738 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10739 characters that yield more columns than PRECISION; PRECISION <= 0
10740 means copy the whole string. Pad with spaces until FIELD_WIDTH
10741 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10742 pad. Called from display_mode_element when it is used to build a
10746 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10748 const unsigned char *str
= (const unsigned char *) string
;
10750 EMACS_INT dummy
, nbytes
;
10752 /* Copy at most PRECISION chars from STR. */
10753 nbytes
= strlen (string
);
10754 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10756 store_mode_line_noprop_char (*str
++);
10758 /* Fill up with spaces until FIELD_WIDTH reached. */
10759 while (field_width
> 0
10760 && n
< field_width
)
10762 store_mode_line_noprop_char (' ');
10769 /***********************************************************************
10771 ***********************************************************************/
10773 #ifdef HAVE_WINDOW_SYSTEM
10775 /* Set the title of FRAME, if it has changed. The title format is
10776 Vicon_title_format if FRAME is iconified, otherwise it is
10777 frame_title_format. */
10780 x_consider_frame_title (Lisp_Object frame
)
10782 struct frame
*f
= XFRAME (frame
);
10784 if (FRAME_WINDOW_P (f
)
10785 || FRAME_MINIBUF_ONLY_P (f
)
10786 || f
->explicit_name
)
10788 /* Do we have more than one visible frame on this X display? */
10791 ptrdiff_t title_start
;
10795 int count
= SPECPDL_INDEX ();
10797 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10799 Lisp_Object other_frame
= XCAR (tail
);
10800 struct frame
*tf
= XFRAME (other_frame
);
10803 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10804 && !FRAME_MINIBUF_ONLY_P (tf
)
10805 && !EQ (other_frame
, tip_frame
)
10806 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10810 /* Set global variable indicating that multiple frames exist. */
10811 multiple_frames
= CONSP (tail
);
10813 /* Switch to the buffer of selected window of the frame. Set up
10814 mode_line_target so that display_mode_element will output into
10815 mode_line_noprop_buf; then display the title. */
10816 record_unwind_protect (unwind_format_mode_line
,
10817 format_mode_line_unwind_data
10818 (current_buffer
, selected_window
, 0));
10820 Fselect_window (f
->selected_window
, Qt
);
10821 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10822 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10824 mode_line_target
= MODE_LINE_TITLE
;
10825 title_start
= MODE_LINE_NOPROP_LEN (0);
10826 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10827 NULL
, DEFAULT_FACE_ID
);
10828 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10829 len
= MODE_LINE_NOPROP_LEN (title_start
);
10830 title
= mode_line_noprop_buf
+ title_start
;
10831 unbind_to (count
, Qnil
);
10833 /* Set the title only if it's changed. This avoids consing in
10834 the common case where it hasn't. (If it turns out that we've
10835 already wasted too much time by walking through the list with
10836 display_mode_element, then we might need to optimize at a
10837 higher level than this.) */
10838 if (! STRINGP (f
->name
)
10839 || SBYTES (f
->name
) != len
10840 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10841 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10845 #endif /* not HAVE_WINDOW_SYSTEM */
10850 /***********************************************************************
10852 ***********************************************************************/
10855 /* Prepare for redisplay by updating menu-bar item lists when
10856 appropriate. This can call eval. */
10859 prepare_menu_bars (void)
10862 struct gcpro gcpro1
, gcpro2
;
10864 Lisp_Object tooltip_frame
;
10866 #ifdef HAVE_WINDOW_SYSTEM
10867 tooltip_frame
= tip_frame
;
10869 tooltip_frame
= Qnil
;
10872 /* Update all frame titles based on their buffer names, etc. We do
10873 this before the menu bars so that the buffer-menu will show the
10874 up-to-date frame titles. */
10875 #ifdef HAVE_WINDOW_SYSTEM
10876 if (windows_or_buffers_changed
|| update_mode_lines
)
10878 Lisp_Object tail
, frame
;
10880 FOR_EACH_FRAME (tail
, frame
)
10882 f
= XFRAME (frame
);
10883 if (!EQ (frame
, tooltip_frame
)
10884 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10885 x_consider_frame_title (frame
);
10888 #endif /* HAVE_WINDOW_SYSTEM */
10890 /* Update the menu bar item lists, if appropriate. This has to be
10891 done before any actual redisplay or generation of display lines. */
10892 all_windows
= (update_mode_lines
10893 || buffer_shared
> 1
10894 || windows_or_buffers_changed
);
10897 Lisp_Object tail
, frame
;
10898 int count
= SPECPDL_INDEX ();
10899 /* 1 means that update_menu_bar has run its hooks
10900 so any further calls to update_menu_bar shouldn't do so again. */
10901 int menu_bar_hooks_run
= 0;
10903 record_unwind_save_match_data ();
10905 FOR_EACH_FRAME (tail
, frame
)
10907 f
= XFRAME (frame
);
10909 /* Ignore tooltip frame. */
10910 if (EQ (frame
, tooltip_frame
))
10913 /* If a window on this frame changed size, report that to
10914 the user and clear the size-change flag. */
10915 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10917 Lisp_Object functions
;
10919 /* Clear flag first in case we get an error below. */
10920 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10921 functions
= Vwindow_size_change_functions
;
10922 GCPRO2 (tail
, functions
);
10924 while (CONSP (functions
))
10926 if (!EQ (XCAR (functions
), Qt
))
10927 call1 (XCAR (functions
), frame
);
10928 functions
= XCDR (functions
);
10934 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10935 #ifdef HAVE_WINDOW_SYSTEM
10936 update_tool_bar (f
, 0);
10939 if (windows_or_buffers_changed
10941 ns_set_doc_edited (f
, Fbuffer_modified_p
10942 (XWINDOW (f
->selected_window
)->buffer
));
10947 unbind_to (count
, Qnil
);
10951 struct frame
*sf
= SELECTED_FRAME ();
10952 update_menu_bar (sf
, 1, 0);
10953 #ifdef HAVE_WINDOW_SYSTEM
10954 update_tool_bar (sf
, 1);
10960 /* Update the menu bar item list for frame F. This has to be done
10961 before we start to fill in any display lines, because it can call
10964 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10966 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10967 already ran the menu bar hooks for this redisplay, so there
10968 is no need to run them again. The return value is the
10969 updated value of this flag, to pass to the next call. */
10972 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10974 Lisp_Object window
;
10975 register struct window
*w
;
10977 /* If called recursively during a menu update, do nothing. This can
10978 happen when, for instance, an activate-menubar-hook causes a
10980 if (inhibit_menubar_update
)
10983 window
= FRAME_SELECTED_WINDOW (f
);
10984 w
= XWINDOW (window
);
10986 if (FRAME_WINDOW_P (f
)
10988 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10989 || defined (HAVE_NS) || defined (USE_GTK)
10990 FRAME_EXTERNAL_MENU_BAR (f
)
10992 FRAME_MENU_BAR_LINES (f
) > 0
10994 : FRAME_MENU_BAR_LINES (f
) > 0)
10996 /* If the user has switched buffers or windows, we need to
10997 recompute to reflect the new bindings. But we'll
10998 recompute when update_mode_lines is set too; that means
10999 that people can use force-mode-line-update to request
11000 that the menu bar be recomputed. The adverse effect on
11001 the rest of the redisplay algorithm is about the same as
11002 windows_or_buffers_changed anyway. */
11003 if (windows_or_buffers_changed
11004 /* This used to test w->update_mode_line, but we believe
11005 there is no need to recompute the menu in that case. */
11006 || update_mode_lines
11007 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11008 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11009 != !NILP (w
->last_had_star
))
11010 || ((!NILP (Vtransient_mark_mode
)
11011 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11012 != !NILP (w
->region_showing
)))
11014 struct buffer
*prev
= current_buffer
;
11015 int count
= SPECPDL_INDEX ();
11017 specbind (Qinhibit_menubar_update
, Qt
);
11019 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11020 if (save_match_data
)
11021 record_unwind_save_match_data ();
11022 if (NILP (Voverriding_local_map_menu_flag
))
11024 specbind (Qoverriding_terminal_local_map
, Qnil
);
11025 specbind (Qoverriding_local_map
, Qnil
);
11030 /* Run the Lucid hook. */
11031 safe_run_hooks (Qactivate_menubar_hook
);
11033 /* If it has changed current-menubar from previous value,
11034 really recompute the menu-bar from the value. */
11035 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11036 call0 (Qrecompute_lucid_menubar
);
11038 safe_run_hooks (Qmenu_bar_update_hook
);
11043 XSETFRAME (Vmenu_updating_frame
, f
);
11044 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11046 /* Redisplay the menu bar in case we changed it. */
11047 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11048 || defined (HAVE_NS) || defined (USE_GTK)
11049 if (FRAME_WINDOW_P (f
))
11051 #if defined (HAVE_NS)
11052 /* All frames on Mac OS share the same menubar. So only
11053 the selected frame should be allowed to set it. */
11054 if (f
== SELECTED_FRAME ())
11056 set_frame_menubar (f
, 0, 0);
11059 /* On a terminal screen, the menu bar is an ordinary screen
11060 line, and this makes it get updated. */
11061 w
->update_mode_line
= Qt
;
11062 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11063 /* In the non-toolkit version, the menu bar is an ordinary screen
11064 line, and this makes it get updated. */
11065 w
->update_mode_line
= Qt
;
11066 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11068 unbind_to (count
, Qnil
);
11069 set_buffer_internal_1 (prev
);
11078 /***********************************************************************
11080 ***********************************************************************/
11082 #ifdef HAVE_WINDOW_SYSTEM
11085 Nominal cursor position -- where to draw output.
11086 HPOS and VPOS are window relative glyph matrix coordinates.
11087 X and Y are window relative pixel coordinates. */
11089 struct cursor_pos output_cursor
;
11093 Set the global variable output_cursor to CURSOR. All cursor
11094 positions are relative to updated_window. */
11097 set_output_cursor (struct cursor_pos
*cursor
)
11099 output_cursor
.hpos
= cursor
->hpos
;
11100 output_cursor
.vpos
= cursor
->vpos
;
11101 output_cursor
.x
= cursor
->x
;
11102 output_cursor
.y
= cursor
->y
;
11107 Set a nominal cursor position.
11109 HPOS and VPOS are column/row positions in a window glyph matrix. X
11110 and Y are window text area relative pixel positions.
11112 If this is done during an update, updated_window will contain the
11113 window that is being updated and the position is the future output
11114 cursor position for that window. If updated_window is null, use
11115 selected_window and display the cursor at the given position. */
11118 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11122 /* If updated_window is not set, work on selected_window. */
11123 if (updated_window
)
11124 w
= updated_window
;
11126 w
= XWINDOW (selected_window
);
11128 /* Set the output cursor. */
11129 output_cursor
.hpos
= hpos
;
11130 output_cursor
.vpos
= vpos
;
11131 output_cursor
.x
= x
;
11132 output_cursor
.y
= y
;
11134 /* If not called as part of an update, really display the cursor.
11135 This will also set the cursor position of W. */
11136 if (updated_window
== NULL
)
11139 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11140 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11141 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11146 #endif /* HAVE_WINDOW_SYSTEM */
11149 /***********************************************************************
11151 ***********************************************************************/
11153 #ifdef HAVE_WINDOW_SYSTEM
11155 /* Where the mouse was last time we reported a mouse event. */
11157 FRAME_PTR last_mouse_frame
;
11159 /* Tool-bar item index of the item on which a mouse button was pressed
11162 int last_tool_bar_item
;
11166 update_tool_bar_unwind (Lisp_Object frame
)
11168 selected_frame
= frame
;
11172 /* Update the tool-bar item list for frame F. This has to be done
11173 before we start to fill in any display lines. Called from
11174 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11175 and restore it here. */
11178 update_tool_bar (struct frame
*f
, int save_match_data
)
11180 #if defined (USE_GTK) || defined (HAVE_NS)
11181 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11183 int do_update
= WINDOWP (f
->tool_bar_window
)
11184 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11189 Lisp_Object window
;
11192 window
= FRAME_SELECTED_WINDOW (f
);
11193 w
= XWINDOW (window
);
11195 /* If the user has switched buffers or windows, we need to
11196 recompute to reflect the new bindings. But we'll
11197 recompute when update_mode_lines is set too; that means
11198 that people can use force-mode-line-update to request
11199 that the menu bar be recomputed. The adverse effect on
11200 the rest of the redisplay algorithm is about the same as
11201 windows_or_buffers_changed anyway. */
11202 if (windows_or_buffers_changed
11203 || !NILP (w
->update_mode_line
)
11204 || update_mode_lines
11205 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11206 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11207 != !NILP (w
->last_had_star
))
11208 || ((!NILP (Vtransient_mark_mode
)
11209 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11210 != !NILP (w
->region_showing
)))
11212 struct buffer
*prev
= current_buffer
;
11213 int count
= SPECPDL_INDEX ();
11214 Lisp_Object frame
, new_tool_bar
;
11215 int new_n_tool_bar
;
11216 struct gcpro gcpro1
;
11218 /* Set current_buffer to the buffer of the selected
11219 window of the frame, so that we get the right local
11221 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11223 /* Save match data, if we must. */
11224 if (save_match_data
)
11225 record_unwind_save_match_data ();
11227 /* Make sure that we don't accidentally use bogus keymaps. */
11228 if (NILP (Voverriding_local_map_menu_flag
))
11230 specbind (Qoverriding_terminal_local_map
, Qnil
);
11231 specbind (Qoverriding_local_map
, Qnil
);
11234 GCPRO1 (new_tool_bar
);
11236 /* We must temporarily set the selected frame to this frame
11237 before calling tool_bar_items, because the calculation of
11238 the tool-bar keymap uses the selected frame (see
11239 `tool-bar-make-keymap' in tool-bar.el). */
11240 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11241 XSETFRAME (frame
, f
);
11242 selected_frame
= frame
;
11244 /* Build desired tool-bar items from keymaps. */
11245 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11248 /* Redisplay the tool-bar if we changed it. */
11249 if (new_n_tool_bar
!= f
->n_tool_bar_items
11250 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11252 /* Redisplay that happens asynchronously due to an expose event
11253 may access f->tool_bar_items. Make sure we update both
11254 variables within BLOCK_INPUT so no such event interrupts. */
11256 f
->tool_bar_items
= new_tool_bar
;
11257 f
->n_tool_bar_items
= new_n_tool_bar
;
11258 w
->update_mode_line
= Qt
;
11264 unbind_to (count
, Qnil
);
11265 set_buffer_internal_1 (prev
);
11271 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11272 F's desired tool-bar contents. F->tool_bar_items must have
11273 been set up previously by calling prepare_menu_bars. */
11276 build_desired_tool_bar_string (struct frame
*f
)
11278 int i
, size
, size_needed
;
11279 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11280 Lisp_Object image
, plist
, props
;
11282 image
= plist
= props
= Qnil
;
11283 GCPRO3 (image
, plist
, props
);
11285 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11286 Otherwise, make a new string. */
11288 /* The size of the string we might be able to reuse. */
11289 size
= (STRINGP (f
->desired_tool_bar_string
)
11290 ? SCHARS (f
->desired_tool_bar_string
)
11293 /* We need one space in the string for each image. */
11294 size_needed
= f
->n_tool_bar_items
;
11296 /* Reuse f->desired_tool_bar_string, if possible. */
11297 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11298 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11299 make_number (' '));
11302 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11303 Fremove_text_properties (make_number (0), make_number (size
),
11304 props
, f
->desired_tool_bar_string
);
11307 /* Put a `display' property on the string for the images to display,
11308 put a `menu_item' property on tool-bar items with a value that
11309 is the index of the item in F's tool-bar item vector. */
11310 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11312 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11314 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11315 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11316 int hmargin
, vmargin
, relief
, idx
, end
;
11318 /* If image is a vector, choose the image according to the
11320 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11321 if (VECTORP (image
))
11325 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11326 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11329 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11330 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11332 xassert (ASIZE (image
) >= idx
);
11333 image
= AREF (image
, idx
);
11338 /* Ignore invalid image specifications. */
11339 if (!valid_image_p (image
))
11342 /* Display the tool-bar button pressed, or depressed. */
11343 plist
= Fcopy_sequence (XCDR (image
));
11345 /* Compute margin and relief to draw. */
11346 relief
= (tool_bar_button_relief
>= 0
11347 ? tool_bar_button_relief
11348 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11349 hmargin
= vmargin
= relief
;
11351 if (INTEGERP (Vtool_bar_button_margin
)
11352 && XINT (Vtool_bar_button_margin
) > 0)
11354 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11355 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11357 else if (CONSP (Vtool_bar_button_margin
))
11359 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11360 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11361 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11363 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11364 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11365 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11368 if (auto_raise_tool_bar_buttons_p
)
11370 /* Add a `:relief' property to the image spec if the item is
11374 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11381 /* If image is selected, display it pressed, i.e. with a
11382 negative relief. If it's not selected, display it with a
11384 plist
= Fplist_put (plist
, QCrelief
,
11386 ? make_number (-relief
)
11387 : make_number (relief
)));
11392 /* Put a margin around the image. */
11393 if (hmargin
|| vmargin
)
11395 if (hmargin
== vmargin
)
11396 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11398 plist
= Fplist_put (plist
, QCmargin
,
11399 Fcons (make_number (hmargin
),
11400 make_number (vmargin
)));
11403 /* If button is not enabled, and we don't have special images
11404 for the disabled state, make the image appear disabled by
11405 applying an appropriate algorithm to it. */
11406 if (!enabled_p
&& idx
< 0)
11407 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11409 /* Put a `display' text property on the string for the image to
11410 display. Put a `menu-item' property on the string that gives
11411 the start of this item's properties in the tool-bar items
11413 image
= Fcons (Qimage
, plist
);
11414 props
= list4 (Qdisplay
, image
,
11415 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11417 /* Let the last image hide all remaining spaces in the tool bar
11418 string. The string can be longer than needed when we reuse a
11419 previous string. */
11420 if (i
+ 1 == f
->n_tool_bar_items
)
11421 end
= SCHARS (f
->desired_tool_bar_string
);
11424 Fadd_text_properties (make_number (i
), make_number (end
),
11425 props
, f
->desired_tool_bar_string
);
11433 /* Display one line of the tool-bar of frame IT->f.
11435 HEIGHT specifies the desired height of the tool-bar line.
11436 If the actual height of the glyph row is less than HEIGHT, the
11437 row's height is increased to HEIGHT, and the icons are centered
11438 vertically in the new height.
11440 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11441 count a final empty row in case the tool-bar width exactly matches
11446 display_tool_bar_line (struct it
*it
, int height
)
11448 struct glyph_row
*row
= it
->glyph_row
;
11449 int max_x
= it
->last_visible_x
;
11450 struct glyph
*last
;
11452 prepare_desired_row (row
);
11453 row
->y
= it
->current_y
;
11455 /* Note that this isn't made use of if the face hasn't a box,
11456 so there's no need to check the face here. */
11457 it
->start_of_box_run_p
= 1;
11459 while (it
->current_x
< max_x
)
11461 int x
, n_glyphs_before
, i
, nglyphs
;
11462 struct it it_before
;
11464 /* Get the next display element. */
11465 if (!get_next_display_element (it
))
11467 /* Don't count empty row if we are counting needed tool-bar lines. */
11468 if (height
< 0 && !it
->hpos
)
11473 /* Produce glyphs. */
11474 n_glyphs_before
= row
->used
[TEXT_AREA
];
11477 PRODUCE_GLYPHS (it
);
11479 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11481 x
= it_before
.current_x
;
11482 while (i
< nglyphs
)
11484 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11486 if (x
+ glyph
->pixel_width
> max_x
)
11488 /* Glyph doesn't fit on line. Backtrack. */
11489 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11491 /* If this is the only glyph on this line, it will never fit on the
11492 tool-bar, so skip it. But ensure there is at least one glyph,
11493 so we don't accidentally disable the tool-bar. */
11494 if (n_glyphs_before
== 0
11495 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11501 x
+= glyph
->pixel_width
;
11505 /* Stop at line end. */
11506 if (ITERATOR_AT_END_OF_LINE_P (it
))
11509 set_iterator_to_next (it
, 1);
11514 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11516 /* Use default face for the border below the tool bar.
11518 FIXME: When auto-resize-tool-bars is grow-only, there is
11519 no additional border below the possibly empty tool-bar lines.
11520 So to make the extra empty lines look "normal", we have to
11521 use the tool-bar face for the border too. */
11522 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11523 it
->face_id
= DEFAULT_FACE_ID
;
11525 extend_face_to_end_of_line (it
);
11526 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11527 last
->right_box_line_p
= 1;
11528 if (last
== row
->glyphs
[TEXT_AREA
])
11529 last
->left_box_line_p
= 1;
11531 /* Make line the desired height and center it vertically. */
11532 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11534 /* Don't add more than one line height. */
11535 height
%= FRAME_LINE_HEIGHT (it
->f
);
11536 it
->max_ascent
+= height
/ 2;
11537 it
->max_descent
+= (height
+ 1) / 2;
11540 compute_line_metrics (it
);
11542 /* If line is empty, make it occupy the rest of the tool-bar. */
11543 if (!row
->displays_text_p
)
11545 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11546 row
->visible_height
= row
->height
;
11547 row
->ascent
= row
->phys_ascent
= 0;
11548 row
->extra_line_spacing
= 0;
11551 row
->full_width_p
= 1;
11552 row
->continued_p
= 0;
11553 row
->truncated_on_left_p
= 0;
11554 row
->truncated_on_right_p
= 0;
11556 it
->current_x
= it
->hpos
= 0;
11557 it
->current_y
+= row
->height
;
11563 /* Max tool-bar height. */
11565 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11566 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11568 /* Value is the number of screen lines needed to make all tool-bar
11569 items of frame F visible. The number of actual rows needed is
11570 returned in *N_ROWS if non-NULL. */
11573 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11575 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11577 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11578 the desired matrix, so use (unused) mode-line row as temporary row to
11579 avoid destroying the first tool-bar row. */
11580 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11582 /* Initialize an iterator for iteration over
11583 F->desired_tool_bar_string in the tool-bar window of frame F. */
11584 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11585 it
.first_visible_x
= 0;
11586 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11587 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11588 it
.paragraph_embedding
= L2R
;
11590 while (!ITERATOR_AT_END_P (&it
))
11592 clear_glyph_row (temp_row
);
11593 it
.glyph_row
= temp_row
;
11594 display_tool_bar_line (&it
, -1);
11596 clear_glyph_row (temp_row
);
11598 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11600 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11602 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11606 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11608 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11609 (Lisp_Object frame
)
11616 frame
= selected_frame
;
11618 CHECK_FRAME (frame
);
11619 f
= XFRAME (frame
);
11621 if (WINDOWP (f
->tool_bar_window
)
11622 && (w
= XWINDOW (f
->tool_bar_window
),
11623 WINDOW_TOTAL_LINES (w
) > 0))
11625 update_tool_bar (f
, 1);
11626 if (f
->n_tool_bar_items
)
11628 build_desired_tool_bar_string (f
);
11629 nlines
= tool_bar_lines_needed (f
, NULL
);
11633 return make_number (nlines
);
11637 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11638 height should be changed. */
11641 redisplay_tool_bar (struct frame
*f
)
11645 struct glyph_row
*row
;
11647 #if defined (USE_GTK) || defined (HAVE_NS)
11648 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11649 update_frame_tool_bar (f
);
11653 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11654 do anything. This means you must start with tool-bar-lines
11655 non-zero to get the auto-sizing effect. Or in other words, you
11656 can turn off tool-bars by specifying tool-bar-lines zero. */
11657 if (!WINDOWP (f
->tool_bar_window
)
11658 || (w
= XWINDOW (f
->tool_bar_window
),
11659 WINDOW_TOTAL_LINES (w
) == 0))
11662 /* Set up an iterator for the tool-bar window. */
11663 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11664 it
.first_visible_x
= 0;
11665 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11666 row
= it
.glyph_row
;
11668 /* Build a string that represents the contents of the tool-bar. */
11669 build_desired_tool_bar_string (f
);
11670 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11671 /* FIXME: This should be controlled by a user option. But it
11672 doesn't make sense to have an R2L tool bar if the menu bar cannot
11673 be drawn also R2L, and making the menu bar R2L is tricky due
11674 toolkit-specific code that implements it. If an R2L tool bar is
11675 ever supported, display_tool_bar_line should also be augmented to
11676 call unproduce_glyphs like display_line and display_string
11678 it
.paragraph_embedding
= L2R
;
11680 if (f
->n_tool_bar_rows
== 0)
11684 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11685 nlines
!= WINDOW_TOTAL_LINES (w
)))
11688 int old_height
= WINDOW_TOTAL_LINES (w
);
11690 XSETFRAME (frame
, f
);
11691 Fmodify_frame_parameters (frame
,
11692 Fcons (Fcons (Qtool_bar_lines
,
11693 make_number (nlines
)),
11695 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11697 clear_glyph_matrix (w
->desired_matrix
);
11698 fonts_changed_p
= 1;
11704 /* Display as many lines as needed to display all tool-bar items. */
11706 if (f
->n_tool_bar_rows
> 0)
11708 int border
, rows
, height
, extra
;
11710 if (INTEGERP (Vtool_bar_border
))
11711 border
= XINT (Vtool_bar_border
);
11712 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11713 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11714 else if (EQ (Vtool_bar_border
, Qborder_width
))
11715 border
= f
->border_width
;
11721 rows
= f
->n_tool_bar_rows
;
11722 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11723 extra
= it
.last_visible_y
- border
- height
* rows
;
11725 while (it
.current_y
< it
.last_visible_y
)
11728 if (extra
> 0 && rows
-- > 0)
11730 h
= (extra
+ rows
- 1) / rows
;
11733 display_tool_bar_line (&it
, height
+ h
);
11738 while (it
.current_y
< it
.last_visible_y
)
11739 display_tool_bar_line (&it
, 0);
11742 /* It doesn't make much sense to try scrolling in the tool-bar
11743 window, so don't do it. */
11744 w
->desired_matrix
->no_scrolling_p
= 1;
11745 w
->must_be_updated_p
= 1;
11747 if (!NILP (Vauto_resize_tool_bars
))
11749 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11750 int change_height_p
= 0;
11752 /* If we couldn't display everything, change the tool-bar's
11753 height if there is room for more. */
11754 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11755 && it
.current_y
< max_tool_bar_height
)
11756 change_height_p
= 1;
11758 row
= it
.glyph_row
- 1;
11760 /* If there are blank lines at the end, except for a partially
11761 visible blank line at the end that is smaller than
11762 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11763 if (!row
->displays_text_p
11764 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11765 change_height_p
= 1;
11767 /* If row displays tool-bar items, but is partially visible,
11768 change the tool-bar's height. */
11769 if (row
->displays_text_p
11770 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11771 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11772 change_height_p
= 1;
11774 /* Resize windows as needed by changing the `tool-bar-lines'
11775 frame parameter. */
11776 if (change_height_p
)
11779 int old_height
= WINDOW_TOTAL_LINES (w
);
11781 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11783 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11784 && !f
->minimize_tool_bar_window_p
)
11785 ? (nlines
> old_height
)
11786 : (nlines
!= old_height
));
11787 f
->minimize_tool_bar_window_p
= 0;
11789 if (change_height_p
)
11791 XSETFRAME (frame
, f
);
11792 Fmodify_frame_parameters (frame
,
11793 Fcons (Fcons (Qtool_bar_lines
,
11794 make_number (nlines
)),
11796 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11798 clear_glyph_matrix (w
->desired_matrix
);
11799 f
->n_tool_bar_rows
= nrows
;
11800 fonts_changed_p
= 1;
11807 f
->minimize_tool_bar_window_p
= 0;
11812 /* Get information about the tool-bar item which is displayed in GLYPH
11813 on frame F. Return in *PROP_IDX the index where tool-bar item
11814 properties start in F->tool_bar_items. Value is zero if
11815 GLYPH doesn't display a tool-bar item. */
11818 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11824 /* This function can be called asynchronously, which means we must
11825 exclude any possibility that Fget_text_property signals an
11827 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11828 charpos
= max (0, charpos
);
11830 /* Get the text property `menu-item' at pos. The value of that
11831 property is the start index of this item's properties in
11832 F->tool_bar_items. */
11833 prop
= Fget_text_property (make_number (charpos
),
11834 Qmenu_item
, f
->current_tool_bar_string
);
11835 if (INTEGERP (prop
))
11837 *prop_idx
= XINT (prop
);
11847 /* Get information about the tool-bar item at position X/Y on frame F.
11848 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11849 the current matrix of the tool-bar window of F, or NULL if not
11850 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11851 item in F->tool_bar_items. Value is
11853 -1 if X/Y is not on a tool-bar item
11854 0 if X/Y is on the same item that was highlighted before.
11858 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11859 int *hpos
, int *vpos
, int *prop_idx
)
11861 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11862 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11865 /* Find the glyph under X/Y. */
11866 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11867 if (*glyph
== NULL
)
11870 /* Get the start of this tool-bar item's properties in
11871 f->tool_bar_items. */
11872 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11875 /* Is mouse on the highlighted item? */
11876 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11877 && *vpos
>= hlinfo
->mouse_face_beg_row
11878 && *vpos
<= hlinfo
->mouse_face_end_row
11879 && (*vpos
> hlinfo
->mouse_face_beg_row
11880 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11881 && (*vpos
< hlinfo
->mouse_face_end_row
11882 || *hpos
< hlinfo
->mouse_face_end_col
11883 || hlinfo
->mouse_face_past_end
))
11891 Handle mouse button event on the tool-bar of frame F, at
11892 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11893 0 for button release. MODIFIERS is event modifiers for button
11897 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11898 unsigned int modifiers
)
11900 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11901 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11902 int hpos
, vpos
, prop_idx
;
11903 struct glyph
*glyph
;
11904 Lisp_Object enabled_p
;
11906 /* If not on the highlighted tool-bar item, return. */
11907 frame_to_window_pixel_xy (w
, &x
, &y
);
11908 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11911 /* If item is disabled, do nothing. */
11912 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11913 if (NILP (enabled_p
))
11918 /* Show item in pressed state. */
11919 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11920 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11921 last_tool_bar_item
= prop_idx
;
11925 Lisp_Object key
, frame
;
11926 struct input_event event
;
11927 EVENT_INIT (event
);
11929 /* Show item in released state. */
11930 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11931 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11933 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11935 XSETFRAME (frame
, f
);
11936 event
.kind
= TOOL_BAR_EVENT
;
11937 event
.frame_or_window
= frame
;
11939 kbd_buffer_store_event (&event
);
11941 event
.kind
= TOOL_BAR_EVENT
;
11942 event
.frame_or_window
= frame
;
11944 event
.modifiers
= modifiers
;
11945 kbd_buffer_store_event (&event
);
11946 last_tool_bar_item
= -1;
11951 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11952 tool-bar window-relative coordinates X/Y. Called from
11953 note_mouse_highlight. */
11956 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11958 Lisp_Object window
= f
->tool_bar_window
;
11959 struct window
*w
= XWINDOW (window
);
11960 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11961 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11963 struct glyph
*glyph
;
11964 struct glyph_row
*row
;
11966 Lisp_Object enabled_p
;
11968 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11969 int mouse_down_p
, rc
;
11971 /* Function note_mouse_highlight is called with negative X/Y
11972 values when mouse moves outside of the frame. */
11973 if (x
<= 0 || y
<= 0)
11975 clear_mouse_face (hlinfo
);
11979 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11982 /* Not on tool-bar item. */
11983 clear_mouse_face (hlinfo
);
11987 /* On same tool-bar item as before. */
11988 goto set_help_echo
;
11990 clear_mouse_face (hlinfo
);
11992 /* Mouse is down, but on different tool-bar item? */
11993 mouse_down_p
= (dpyinfo
->grabbed
11994 && f
== last_mouse_frame
11995 && FRAME_LIVE_P (f
));
11997 && last_tool_bar_item
!= prop_idx
)
12000 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12001 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12003 /* If tool-bar item is not enabled, don't highlight it. */
12004 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12005 if (!NILP (enabled_p
))
12007 /* Compute the x-position of the glyph. In front and past the
12008 image is a space. We include this in the highlighted area. */
12009 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12010 for (i
= x
= 0; i
< hpos
; ++i
)
12011 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12013 /* Record this as the current active region. */
12014 hlinfo
->mouse_face_beg_col
= hpos
;
12015 hlinfo
->mouse_face_beg_row
= vpos
;
12016 hlinfo
->mouse_face_beg_x
= x
;
12017 hlinfo
->mouse_face_beg_y
= row
->y
;
12018 hlinfo
->mouse_face_past_end
= 0;
12020 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12021 hlinfo
->mouse_face_end_row
= vpos
;
12022 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12023 hlinfo
->mouse_face_end_y
= row
->y
;
12024 hlinfo
->mouse_face_window
= window
;
12025 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12027 /* Display it as active. */
12028 show_mouse_face (hlinfo
, draw
);
12029 hlinfo
->mouse_face_image_state
= draw
;
12034 /* Set help_echo_string to a help string to display for this tool-bar item.
12035 XTread_socket does the rest. */
12036 help_echo_object
= help_echo_window
= Qnil
;
12037 help_echo_pos
= -1;
12038 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12039 if (NILP (help_echo_string
))
12040 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12043 #endif /* HAVE_WINDOW_SYSTEM */
12047 /************************************************************************
12048 Horizontal scrolling
12049 ************************************************************************/
12051 static int hscroll_window_tree (Lisp_Object
);
12052 static int hscroll_windows (Lisp_Object
);
12054 /* For all leaf windows in the window tree rooted at WINDOW, set their
12055 hscroll value so that PT is (i) visible in the window, and (ii) so
12056 that it is not within a certain margin at the window's left and
12057 right border. Value is non-zero if any window's hscroll has been
12061 hscroll_window_tree (Lisp_Object window
)
12063 int hscrolled_p
= 0;
12064 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12065 int hscroll_step_abs
= 0;
12066 double hscroll_step_rel
= 0;
12068 if (hscroll_relative_p
)
12070 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12071 if (hscroll_step_rel
< 0)
12073 hscroll_relative_p
= 0;
12074 hscroll_step_abs
= 0;
12077 else if (INTEGERP (Vhscroll_step
))
12079 hscroll_step_abs
= XINT (Vhscroll_step
);
12080 if (hscroll_step_abs
< 0)
12081 hscroll_step_abs
= 0;
12084 hscroll_step_abs
= 0;
12086 while (WINDOWP (window
))
12088 struct window
*w
= XWINDOW (window
);
12090 if (WINDOWP (w
->hchild
))
12091 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12092 else if (WINDOWP (w
->vchild
))
12093 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12094 else if (w
->cursor
.vpos
>= 0)
12097 int text_area_width
;
12098 struct glyph_row
*current_cursor_row
12099 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12100 struct glyph_row
*desired_cursor_row
12101 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12102 struct glyph_row
*cursor_row
12103 = (desired_cursor_row
->enabled_p
12104 ? desired_cursor_row
12105 : current_cursor_row
);
12106 int row_r2l_p
= cursor_row
->reversed_p
;
12108 text_area_width
= window_box_width (w
, TEXT_AREA
);
12110 /* Scroll when cursor is inside this scroll margin. */
12111 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12113 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12114 /* For left-to-right rows, hscroll when cursor is either
12115 (i) inside the right hscroll margin, or (ii) if it is
12116 inside the left margin and the window is already
12119 && ((XFASTINT (w
->hscroll
)
12120 && w
->cursor
.x
<= h_margin
)
12121 || (cursor_row
->enabled_p
12122 && cursor_row
->truncated_on_right_p
12123 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12124 /* For right-to-left rows, the logic is similar,
12125 except that rules for scrolling to left and right
12126 are reversed. E.g., if cursor.x <= h_margin, we
12127 need to hscroll "to the right" unconditionally,
12128 and that will scroll the screen to the left so as
12129 to reveal the next portion of the row. */
12131 && ((cursor_row
->enabled_p
12132 /* FIXME: It is confusing to set the
12133 truncated_on_right_p flag when R2L rows
12134 are actually truncated on the left. */
12135 && cursor_row
->truncated_on_right_p
12136 && w
->cursor
.x
<= h_margin
)
12137 || (XFASTINT (w
->hscroll
)
12138 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12142 struct buffer
*saved_current_buffer
;
12146 /* Find point in a display of infinite width. */
12147 saved_current_buffer
= current_buffer
;
12148 current_buffer
= XBUFFER (w
->buffer
);
12150 if (w
== XWINDOW (selected_window
))
12154 pt
= marker_position (w
->pointm
);
12155 pt
= max (BEGV
, pt
);
12159 /* Move iterator to pt starting at cursor_row->start in
12160 a line with infinite width. */
12161 init_to_row_start (&it
, w
, cursor_row
);
12162 it
.last_visible_x
= INFINITY
;
12163 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12164 current_buffer
= saved_current_buffer
;
12166 /* Position cursor in window. */
12167 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12168 hscroll
= max (0, (it
.current_x
12169 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12170 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12171 : (text_area_width
/ 2))))
12172 / FRAME_COLUMN_WIDTH (it
.f
);
12173 else if ((!row_r2l_p
12174 && w
->cursor
.x
>= text_area_width
- h_margin
)
12175 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12177 if (hscroll_relative_p
)
12178 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12181 wanted_x
= text_area_width
12182 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12185 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12189 if (hscroll_relative_p
)
12190 wanted_x
= text_area_width
* hscroll_step_rel
12193 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12196 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12198 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12200 /* Don't prevent redisplay optimizations if hscroll
12201 hasn't changed, as it will unnecessarily slow down
12203 if (XFASTINT (w
->hscroll
) != hscroll
)
12205 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12206 w
->hscroll
= make_number (hscroll
);
12215 /* Value is non-zero if hscroll of any leaf window has been changed. */
12216 return hscrolled_p
;
12220 /* Set hscroll so that cursor is visible and not inside horizontal
12221 scroll margins for all windows in the tree rooted at WINDOW. See
12222 also hscroll_window_tree above. Value is non-zero if any window's
12223 hscroll has been changed. If it has, desired matrices on the frame
12224 of WINDOW are cleared. */
12227 hscroll_windows (Lisp_Object window
)
12229 int hscrolled_p
= hscroll_window_tree (window
);
12231 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12232 return hscrolled_p
;
12237 /************************************************************************
12239 ************************************************************************/
12241 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12242 to a non-zero value. This is sometimes handy to have in a debugger
12247 /* First and last unchanged row for try_window_id. */
12249 static int debug_first_unchanged_at_end_vpos
;
12250 static int debug_last_unchanged_at_beg_vpos
;
12252 /* Delta vpos and y. */
12254 static int debug_dvpos
, debug_dy
;
12256 /* Delta in characters and bytes for try_window_id. */
12258 static EMACS_INT debug_delta
, debug_delta_bytes
;
12260 /* Values of window_end_pos and window_end_vpos at the end of
12263 static EMACS_INT debug_end_vpos
;
12265 /* Append a string to W->desired_matrix->method. FMT is a printf
12266 format string. If trace_redisplay_p is non-zero also printf the
12267 resulting string to stderr. */
12269 static void debug_method_add (struct window
*, char const *, ...)
12270 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12273 debug_method_add (struct window
*w
, char const *fmt
, ...)
12276 char *method
= w
->desired_matrix
->method
;
12277 int len
= strlen (method
);
12278 int size
= sizeof w
->desired_matrix
->method
;
12279 int remaining
= size
- len
- 1;
12282 va_start (ap
, fmt
);
12283 vsprintf (buffer
, fmt
, ap
);
12285 if (len
&& remaining
)
12288 --remaining
, ++len
;
12291 strncpy (method
+ len
, buffer
, remaining
);
12293 if (trace_redisplay_p
)
12294 fprintf (stderr
, "%p (%s): %s\n",
12296 ((BUFFERP (w
->buffer
)
12297 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12298 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12303 #endif /* GLYPH_DEBUG */
12306 /* Value is non-zero if all changes in window W, which displays
12307 current_buffer, are in the text between START and END. START is a
12308 buffer position, END is given as a distance from Z. Used in
12309 redisplay_internal for display optimization. */
12312 text_outside_line_unchanged_p (struct window
*w
,
12313 EMACS_INT start
, EMACS_INT end
)
12315 int unchanged_p
= 1;
12317 /* If text or overlays have changed, see where. */
12318 if (XFASTINT (w
->last_modified
) < MODIFF
12319 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12321 /* Gap in the line? */
12322 if (GPT
< start
|| Z
- GPT
< end
)
12325 /* Changes start in front of the line, or end after it? */
12327 && (BEG_UNCHANGED
< start
- 1
12328 || END_UNCHANGED
< end
))
12331 /* If selective display, can't optimize if changes start at the
12332 beginning of the line. */
12334 && INTEGERP (BVAR (current_buffer
, selective_display
))
12335 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12336 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12339 /* If there are overlays at the start or end of the line, these
12340 may have overlay strings with newlines in them. A change at
12341 START, for instance, may actually concern the display of such
12342 overlay strings as well, and they are displayed on different
12343 lines. So, quickly rule out this case. (For the future, it
12344 might be desirable to implement something more telling than
12345 just BEG/END_UNCHANGED.) */
12348 if (BEG
+ BEG_UNCHANGED
== start
12349 && overlay_touches_p (start
))
12351 if (END_UNCHANGED
== end
12352 && overlay_touches_p (Z
- end
))
12356 /* Under bidi reordering, adding or deleting a character in the
12357 beginning of a paragraph, before the first strong directional
12358 character, can change the base direction of the paragraph (unless
12359 the buffer specifies a fixed paragraph direction), which will
12360 require to redisplay the whole paragraph. It might be worthwhile
12361 to find the paragraph limits and widen the range of redisplayed
12362 lines to that, but for now just give up this optimization. */
12363 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12364 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12368 return unchanged_p
;
12372 /* Do a frame update, taking possible shortcuts into account. This is
12373 the main external entry point for redisplay.
12375 If the last redisplay displayed an echo area message and that message
12376 is no longer requested, we clear the echo area or bring back the
12377 mini-buffer if that is in use. */
12382 redisplay_internal ();
12387 overlay_arrow_string_or_property (Lisp_Object var
)
12391 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12394 return Voverlay_arrow_string
;
12397 /* Return 1 if there are any overlay-arrows in current_buffer. */
12399 overlay_arrow_in_current_buffer_p (void)
12403 for (vlist
= Voverlay_arrow_variable_list
;
12405 vlist
= XCDR (vlist
))
12407 Lisp_Object var
= XCAR (vlist
);
12410 if (!SYMBOLP (var
))
12412 val
= find_symbol_value (var
);
12414 && current_buffer
== XMARKER (val
)->buffer
)
12421 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12425 overlay_arrows_changed_p (void)
12429 for (vlist
= Voverlay_arrow_variable_list
;
12431 vlist
= XCDR (vlist
))
12433 Lisp_Object var
= XCAR (vlist
);
12434 Lisp_Object val
, pstr
;
12436 if (!SYMBOLP (var
))
12438 val
= find_symbol_value (var
);
12439 if (!MARKERP (val
))
12441 if (! EQ (COERCE_MARKER (val
),
12442 Fget (var
, Qlast_arrow_position
))
12443 || ! (pstr
= overlay_arrow_string_or_property (var
),
12444 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12450 /* Mark overlay arrows to be updated on next redisplay. */
12453 update_overlay_arrows (int up_to_date
)
12457 for (vlist
= Voverlay_arrow_variable_list
;
12459 vlist
= XCDR (vlist
))
12461 Lisp_Object var
= XCAR (vlist
);
12463 if (!SYMBOLP (var
))
12466 if (up_to_date
> 0)
12468 Lisp_Object val
= find_symbol_value (var
);
12469 Fput (var
, Qlast_arrow_position
,
12470 COERCE_MARKER (val
));
12471 Fput (var
, Qlast_arrow_string
,
12472 overlay_arrow_string_or_property (var
));
12474 else if (up_to_date
< 0
12475 || !NILP (Fget (var
, Qlast_arrow_position
)))
12477 Fput (var
, Qlast_arrow_position
, Qt
);
12478 Fput (var
, Qlast_arrow_string
, Qt
);
12484 /* Return overlay arrow string to display at row.
12485 Return integer (bitmap number) for arrow bitmap in left fringe.
12486 Return nil if no overlay arrow. */
12489 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12493 for (vlist
= Voverlay_arrow_variable_list
;
12495 vlist
= XCDR (vlist
))
12497 Lisp_Object var
= XCAR (vlist
);
12500 if (!SYMBOLP (var
))
12503 val
= find_symbol_value (var
);
12506 && current_buffer
== XMARKER (val
)->buffer
12507 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12509 if (FRAME_WINDOW_P (it
->f
)
12510 /* FIXME: if ROW->reversed_p is set, this should test
12511 the right fringe, not the left one. */
12512 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12514 #ifdef HAVE_WINDOW_SYSTEM
12515 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12518 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12519 return make_number (fringe_bitmap
);
12522 return make_number (-1); /* Use default arrow bitmap */
12524 return overlay_arrow_string_or_property (var
);
12531 /* Return 1 if point moved out of or into a composition. Otherwise
12532 return 0. PREV_BUF and PREV_PT are the last point buffer and
12533 position. BUF and PT are the current point buffer and position. */
12536 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12537 struct buffer
*buf
, EMACS_INT pt
)
12539 EMACS_INT start
, end
;
12541 Lisp_Object buffer
;
12543 XSETBUFFER (buffer
, buf
);
12544 /* Check a composition at the last point if point moved within the
12546 if (prev_buf
== buf
)
12549 /* Point didn't move. */
12552 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12553 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12554 && COMPOSITION_VALID_P (start
, end
, prop
)
12555 && start
< prev_pt
&& end
> prev_pt
)
12556 /* The last point was within the composition. Return 1 iff
12557 point moved out of the composition. */
12558 return (pt
<= start
|| pt
>= end
);
12561 /* Check a composition at the current point. */
12562 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12563 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12564 && COMPOSITION_VALID_P (start
, end
, prop
)
12565 && start
< pt
&& end
> pt
);
12569 /* Reconsider the setting of B->clip_changed which is displayed
12573 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12575 if (b
->clip_changed
12576 && !NILP (w
->window_end_valid
)
12577 && w
->current_matrix
->buffer
== b
12578 && w
->current_matrix
->zv
== BUF_ZV (b
)
12579 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12580 b
->clip_changed
= 0;
12582 /* If display wasn't paused, and W is not a tool bar window, see if
12583 point has been moved into or out of a composition. In that case,
12584 we set b->clip_changed to 1 to force updating the screen. If
12585 b->clip_changed has already been set to 1, we can skip this
12587 if (!b
->clip_changed
12588 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12592 if (w
== XWINDOW (selected_window
))
12595 pt
= marker_position (w
->pointm
);
12597 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12598 || pt
!= XINT (w
->last_point
))
12599 && check_point_in_composition (w
->current_matrix
->buffer
,
12600 XINT (w
->last_point
),
12601 XBUFFER (w
->buffer
), pt
))
12602 b
->clip_changed
= 1;
12607 /* Select FRAME to forward the values of frame-local variables into C
12608 variables so that the redisplay routines can access those values
12612 select_frame_for_redisplay (Lisp_Object frame
)
12614 Lisp_Object tail
, tem
;
12615 Lisp_Object old
= selected_frame
;
12616 struct Lisp_Symbol
*sym
;
12618 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12620 selected_frame
= frame
;
12623 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12624 if (CONSP (XCAR (tail
))
12625 && (tem
= XCAR (XCAR (tail
)),
12627 && (sym
= indirect_variable (XSYMBOL (tem
)),
12628 sym
->redirect
== SYMBOL_LOCALIZED
)
12629 && sym
->val
.blv
->frame_local
)
12630 /* Use find_symbol_value rather than Fsymbol_value
12631 to avoid an error if it is void. */
12632 find_symbol_value (tem
);
12633 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12637 #define STOP_POLLING \
12638 do { if (! polling_stopped_here) stop_polling (); \
12639 polling_stopped_here = 1; } while (0)
12641 #define RESUME_POLLING \
12642 do { if (polling_stopped_here) start_polling (); \
12643 polling_stopped_here = 0; } while (0)
12646 /* Perhaps in the future avoid recentering windows if it
12647 is not necessary; currently that causes some problems. */
12650 redisplay_internal (void)
12652 struct window
*w
= XWINDOW (selected_window
);
12656 int must_finish
= 0;
12657 struct text_pos tlbufpos
, tlendpos
;
12658 int number_of_visible_frames
;
12661 int polling_stopped_here
= 0;
12662 Lisp_Object old_frame
= selected_frame
;
12664 /* Non-zero means redisplay has to consider all windows on all
12665 frames. Zero means, only selected_window is considered. */
12666 int consider_all_windows_p
;
12668 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12670 /* No redisplay if running in batch mode or frame is not yet fully
12671 initialized, or redisplay is explicitly turned off by setting
12672 Vinhibit_redisplay. */
12673 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12674 || !NILP (Vinhibit_redisplay
))
12677 /* Don't examine these until after testing Vinhibit_redisplay.
12678 When Emacs is shutting down, perhaps because its connection to
12679 X has dropped, we should not look at them at all. */
12680 fr
= XFRAME (w
->frame
);
12681 sf
= SELECTED_FRAME ();
12683 if (!fr
->glyphs_initialized_p
)
12686 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12687 if (popup_activated ())
12691 /* I don't think this happens but let's be paranoid. */
12692 if (redisplaying_p
)
12695 /* Record a function that resets redisplaying_p to its old value
12696 when we leave this function. */
12697 count
= SPECPDL_INDEX ();
12698 record_unwind_protect (unwind_redisplay
,
12699 Fcons (make_number (redisplaying_p
), selected_frame
));
12701 specbind (Qinhibit_free_realized_faces
, Qnil
);
12704 Lisp_Object tail
, frame
;
12706 FOR_EACH_FRAME (tail
, frame
)
12708 struct frame
*f
= XFRAME (frame
);
12709 f
->already_hscrolled_p
= 0;
12714 /* Remember the currently selected window. */
12717 if (!EQ (old_frame
, selected_frame
)
12718 && FRAME_LIVE_P (XFRAME (old_frame
)))
12719 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12720 selected_frame and selected_window to be temporarily out-of-sync so
12721 when we come back here via `goto retry', we need to resync because we
12722 may need to run Elisp code (via prepare_menu_bars). */
12723 select_frame_for_redisplay (old_frame
);
12726 reconsider_clip_changes (w
, current_buffer
);
12727 last_escape_glyph_frame
= NULL
;
12728 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12729 last_glyphless_glyph_frame
= NULL
;
12730 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12732 /* If new fonts have been loaded that make a glyph matrix adjustment
12733 necessary, do it. */
12734 if (fonts_changed_p
)
12736 adjust_glyphs (NULL
);
12737 ++windows_or_buffers_changed
;
12738 fonts_changed_p
= 0;
12741 /* If face_change_count is non-zero, init_iterator will free all
12742 realized faces, which includes the faces referenced from current
12743 matrices. So, we can't reuse current matrices in this case. */
12744 if (face_change_count
)
12745 ++windows_or_buffers_changed
;
12747 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12748 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12750 /* Since frames on a single ASCII terminal share the same
12751 display area, displaying a different frame means redisplay
12752 the whole thing. */
12753 windows_or_buffers_changed
++;
12754 SET_FRAME_GARBAGED (sf
);
12756 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12758 FRAME_TTY (sf
)->previous_frame
= sf
;
12761 /* Set the visible flags for all frames. Do this before checking
12762 for resized or garbaged frames; they want to know if their frames
12763 are visible. See the comment in frame.h for
12764 FRAME_SAMPLE_VISIBILITY. */
12766 Lisp_Object tail
, frame
;
12768 number_of_visible_frames
= 0;
12770 FOR_EACH_FRAME (tail
, frame
)
12772 struct frame
*f
= XFRAME (frame
);
12774 FRAME_SAMPLE_VISIBILITY (f
);
12775 if (FRAME_VISIBLE_P (f
))
12776 ++number_of_visible_frames
;
12777 clear_desired_matrices (f
);
12781 /* Notice any pending interrupt request to change frame size. */
12782 do_pending_window_change (1);
12784 /* do_pending_window_change could change the selected_window due to
12785 frame resizing which makes the selected window too small. */
12786 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12789 reconsider_clip_changes (w
, current_buffer
);
12792 /* Clear frames marked as garbaged. */
12793 if (frame_garbaged
)
12794 clear_garbaged_frames ();
12796 /* Build menubar and tool-bar items. */
12797 if (NILP (Vmemory_full
))
12798 prepare_menu_bars ();
12800 if (windows_or_buffers_changed
)
12801 update_mode_lines
++;
12803 /* Detect case that we need to write or remove a star in the mode line. */
12804 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12806 w
->update_mode_line
= Qt
;
12807 if (buffer_shared
> 1)
12808 update_mode_lines
++;
12811 /* Avoid invocation of point motion hooks by `current_column' below. */
12812 count1
= SPECPDL_INDEX ();
12813 specbind (Qinhibit_point_motion_hooks
, Qt
);
12815 /* If %c is in the mode line, update it if needed. */
12816 if (!NILP (w
->column_number_displayed
)
12817 /* This alternative quickly identifies a common case
12818 where no change is needed. */
12819 && !(PT
== XFASTINT (w
->last_point
)
12820 && XFASTINT (w
->last_modified
) >= MODIFF
12821 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12822 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12823 w
->update_mode_line
= Qt
;
12825 unbind_to (count1
, Qnil
);
12827 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12829 /* The variable buffer_shared is set in redisplay_window and
12830 indicates that we redisplay a buffer in different windows. See
12832 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12833 || cursor_type_changed
);
12835 /* If specs for an arrow have changed, do thorough redisplay
12836 to ensure we remove any arrow that should no longer exist. */
12837 if (overlay_arrows_changed_p ())
12838 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12840 /* Normally the message* functions will have already displayed and
12841 updated the echo area, but the frame may have been trashed, or
12842 the update may have been preempted, so display the echo area
12843 again here. Checking message_cleared_p captures the case that
12844 the echo area should be cleared. */
12845 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12846 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12847 || (message_cleared_p
12848 && minibuf_level
== 0
12849 /* If the mini-window is currently selected, this means the
12850 echo-area doesn't show through. */
12851 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12853 int window_height_changed_p
= echo_area_display (0);
12856 /* If we don't display the current message, don't clear the
12857 message_cleared_p flag, because, if we did, we wouldn't clear
12858 the echo area in the next redisplay which doesn't preserve
12860 if (!display_last_displayed_message_p
)
12861 message_cleared_p
= 0;
12863 if (fonts_changed_p
)
12865 else if (window_height_changed_p
)
12867 consider_all_windows_p
= 1;
12868 ++update_mode_lines
;
12869 ++windows_or_buffers_changed
;
12871 /* If window configuration was changed, frames may have been
12872 marked garbaged. Clear them or we will experience
12873 surprises wrt scrolling. */
12874 if (frame_garbaged
)
12875 clear_garbaged_frames ();
12878 else if (EQ (selected_window
, minibuf_window
)
12879 && (current_buffer
->clip_changed
12880 || XFASTINT (w
->last_modified
) < MODIFF
12881 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12882 && resize_mini_window (w
, 0))
12884 /* Resized active mini-window to fit the size of what it is
12885 showing if its contents might have changed. */
12887 /* FIXME: this causes all frames to be updated, which seems unnecessary
12888 since only the current frame needs to be considered. This function needs
12889 to be rewritten with two variables, consider_all_windows and
12890 consider_all_frames. */
12891 consider_all_windows_p
= 1;
12892 ++windows_or_buffers_changed
;
12893 ++update_mode_lines
;
12895 /* If window configuration was changed, frames may have been
12896 marked garbaged. Clear them or we will experience
12897 surprises wrt scrolling. */
12898 if (frame_garbaged
)
12899 clear_garbaged_frames ();
12903 /* If showing the region, and mark has changed, we must redisplay
12904 the whole window. The assignment to this_line_start_pos prevents
12905 the optimization directly below this if-statement. */
12906 if (((!NILP (Vtransient_mark_mode
)
12907 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12908 != !NILP (w
->region_showing
))
12909 || (!NILP (w
->region_showing
)
12910 && !EQ (w
->region_showing
,
12911 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12912 CHARPOS (this_line_start_pos
) = 0;
12914 /* Optimize the case that only the line containing the cursor in the
12915 selected window has changed. Variables starting with this_ are
12916 set in display_line and record information about the line
12917 containing the cursor. */
12918 tlbufpos
= this_line_start_pos
;
12919 tlendpos
= this_line_end_pos
;
12920 if (!consider_all_windows_p
12921 && CHARPOS (tlbufpos
) > 0
12922 && NILP (w
->update_mode_line
)
12923 && !current_buffer
->clip_changed
12924 && !current_buffer
->prevent_redisplay_optimizations_p
12925 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12926 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12927 /* Make sure recorded data applies to current buffer, etc. */
12928 && this_line_buffer
== current_buffer
12929 && current_buffer
== XBUFFER (w
->buffer
)
12930 && NILP (w
->force_start
)
12931 && NILP (w
->optional_new_start
)
12932 /* Point must be on the line that we have info recorded about. */
12933 && PT
>= CHARPOS (tlbufpos
)
12934 && PT
<= Z
- CHARPOS (tlendpos
)
12935 /* All text outside that line, including its final newline,
12936 must be unchanged. */
12937 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12938 CHARPOS (tlendpos
)))
12940 if (CHARPOS (tlbufpos
) > BEGV
12941 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12942 && (CHARPOS (tlbufpos
) == ZV
12943 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12944 /* Former continuation line has disappeared by becoming empty. */
12946 else if (XFASTINT (w
->last_modified
) < MODIFF
12947 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12948 || MINI_WINDOW_P (w
))
12950 /* We have to handle the case of continuation around a
12951 wide-column character (see the comment in indent.c around
12954 For instance, in the following case:
12956 -------- Insert --------
12957 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12958 J_I_ ==> J_I_ `^^' are cursors.
12962 As we have to redraw the line above, we cannot use this
12966 int line_height_before
= this_line_pixel_height
;
12968 /* Note that start_display will handle the case that the
12969 line starting at tlbufpos is a continuation line. */
12970 start_display (&it
, w
, tlbufpos
);
12972 /* Implementation note: It this still necessary? */
12973 if (it
.current_x
!= this_line_start_x
)
12976 TRACE ((stderr
, "trying display optimization 1\n"));
12977 w
->cursor
.vpos
= -1;
12978 overlay_arrow_seen
= 0;
12979 it
.vpos
= this_line_vpos
;
12980 it
.current_y
= this_line_y
;
12981 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12982 display_line (&it
);
12984 /* If line contains point, is not continued,
12985 and ends at same distance from eob as before, we win. */
12986 if (w
->cursor
.vpos
>= 0
12987 /* Line is not continued, otherwise this_line_start_pos
12988 would have been set to 0 in display_line. */
12989 && CHARPOS (this_line_start_pos
)
12990 /* Line ends as before. */
12991 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12992 /* Line has same height as before. Otherwise other lines
12993 would have to be shifted up or down. */
12994 && this_line_pixel_height
== line_height_before
)
12996 /* If this is not the window's last line, we must adjust
12997 the charstarts of the lines below. */
12998 if (it
.current_y
< it
.last_visible_y
)
13000 struct glyph_row
*row
13001 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13002 EMACS_INT delta
, delta_bytes
;
13004 /* We used to distinguish between two cases here,
13005 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13006 when the line ends in a newline or the end of the
13007 buffer's accessible portion. But both cases did
13008 the same, so they were collapsed. */
13010 - CHARPOS (tlendpos
)
13011 - MATRIX_ROW_START_CHARPOS (row
));
13012 delta_bytes
= (Z_BYTE
13013 - BYTEPOS (tlendpos
)
13014 - MATRIX_ROW_START_BYTEPOS (row
));
13016 increment_matrix_positions (w
->current_matrix
,
13017 this_line_vpos
+ 1,
13018 w
->current_matrix
->nrows
,
13019 delta
, delta_bytes
);
13022 /* If this row displays text now but previously didn't,
13023 or vice versa, w->window_end_vpos may have to be
13025 if ((it
.glyph_row
- 1)->displays_text_p
)
13027 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13028 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13030 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13031 && this_line_vpos
> 0)
13032 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13033 w
->window_end_valid
= Qnil
;
13035 /* Update hint: No need to try to scroll in update_window. */
13036 w
->desired_matrix
->no_scrolling_p
= 1;
13039 *w
->desired_matrix
->method
= 0;
13040 debug_method_add (w
, "optimization 1");
13042 #ifdef HAVE_WINDOW_SYSTEM
13043 update_window_fringes (w
, 0);
13050 else if (/* Cursor position hasn't changed. */
13051 PT
== XFASTINT (w
->last_point
)
13052 /* Make sure the cursor was last displayed
13053 in this window. Otherwise we have to reposition it. */
13054 && 0 <= w
->cursor
.vpos
13055 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13059 do_pending_window_change (1);
13060 /* If selected_window changed, redisplay again. */
13061 if (WINDOWP (selected_window
)
13062 && (w
= XWINDOW (selected_window
)) != sw
)
13065 /* We used to always goto end_of_redisplay here, but this
13066 isn't enough if we have a blinking cursor. */
13067 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13068 goto end_of_redisplay
;
13072 /* If highlighting the region, or if the cursor is in the echo area,
13073 then we can't just move the cursor. */
13074 else if (! (!NILP (Vtransient_mark_mode
)
13075 && !NILP (BVAR (current_buffer
, mark_active
)))
13076 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13077 || highlight_nonselected_windows
)
13078 && NILP (w
->region_showing
)
13079 && NILP (Vshow_trailing_whitespace
)
13080 && !cursor_in_echo_area
)
13083 struct glyph_row
*row
;
13085 /* Skip from tlbufpos to PT and see where it is. Note that
13086 PT may be in invisible text. If so, we will end at the
13087 next visible position. */
13088 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13089 NULL
, DEFAULT_FACE_ID
);
13090 it
.current_x
= this_line_start_x
;
13091 it
.current_y
= this_line_y
;
13092 it
.vpos
= this_line_vpos
;
13094 /* The call to move_it_to stops in front of PT, but
13095 moves over before-strings. */
13096 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13098 if (it
.vpos
== this_line_vpos
13099 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13102 xassert (this_line_vpos
== it
.vpos
);
13103 xassert (this_line_y
== it
.current_y
);
13104 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13106 *w
->desired_matrix
->method
= 0;
13107 debug_method_add (w
, "optimization 3");
13116 /* Text changed drastically or point moved off of line. */
13117 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13120 CHARPOS (this_line_start_pos
) = 0;
13121 consider_all_windows_p
|= buffer_shared
> 1;
13122 ++clear_face_cache_count
;
13123 #ifdef HAVE_WINDOW_SYSTEM
13124 ++clear_image_cache_count
;
13127 /* Build desired matrices, and update the display. If
13128 consider_all_windows_p is non-zero, do it for all windows on all
13129 frames. Otherwise do it for selected_window, only. */
13131 if (consider_all_windows_p
)
13133 Lisp_Object tail
, frame
;
13135 FOR_EACH_FRAME (tail
, frame
)
13136 XFRAME (frame
)->updated_p
= 0;
13138 /* Recompute # windows showing selected buffer. This will be
13139 incremented each time such a window is displayed. */
13142 FOR_EACH_FRAME (tail
, frame
)
13144 struct frame
*f
= XFRAME (frame
);
13146 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13148 if (! EQ (frame
, selected_frame
))
13149 /* Select the frame, for the sake of frame-local
13151 select_frame_for_redisplay (frame
);
13153 /* Mark all the scroll bars to be removed; we'll redeem
13154 the ones we want when we redisplay their windows. */
13155 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13156 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13158 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13159 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13161 /* The X error handler may have deleted that frame. */
13162 if (!FRAME_LIVE_P (f
))
13165 /* Any scroll bars which redisplay_windows should have
13166 nuked should now go away. */
13167 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13168 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13170 /* If fonts changed, display again. */
13171 /* ??? rms: I suspect it is a mistake to jump all the way
13172 back to retry here. It should just retry this frame. */
13173 if (fonts_changed_p
)
13176 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13178 /* See if we have to hscroll. */
13179 if (!f
->already_hscrolled_p
)
13181 f
->already_hscrolled_p
= 1;
13182 if (hscroll_windows (f
->root_window
))
13186 /* Prevent various kinds of signals during display
13187 update. stdio is not robust about handling
13188 signals, which can cause an apparent I/O
13190 if (interrupt_input
)
13191 unrequest_sigio ();
13194 /* Update the display. */
13195 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13196 pending
|= update_frame (f
, 0, 0);
13202 if (!EQ (old_frame
, selected_frame
)
13203 && FRAME_LIVE_P (XFRAME (old_frame
)))
13204 /* We played a bit fast-and-loose above and allowed selected_frame
13205 and selected_window to be temporarily out-of-sync but let's make
13206 sure this stays contained. */
13207 select_frame_for_redisplay (old_frame
);
13208 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13212 /* Do the mark_window_display_accurate after all windows have
13213 been redisplayed because this call resets flags in buffers
13214 which are needed for proper redisplay. */
13215 FOR_EACH_FRAME (tail
, frame
)
13217 struct frame
*f
= XFRAME (frame
);
13220 mark_window_display_accurate (f
->root_window
, 1);
13221 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13222 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13227 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13229 Lisp_Object mini_window
;
13230 struct frame
*mini_frame
;
13232 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13233 /* Use list_of_error, not Qerror, so that
13234 we catch only errors and don't run the debugger. */
13235 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13237 redisplay_window_error
);
13239 /* Compare desired and current matrices, perform output. */
13242 /* If fonts changed, display again. */
13243 if (fonts_changed_p
)
13246 /* Prevent various kinds of signals during display update.
13247 stdio is not robust about handling signals,
13248 which can cause an apparent I/O error. */
13249 if (interrupt_input
)
13250 unrequest_sigio ();
13253 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13255 if (hscroll_windows (selected_window
))
13258 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13259 pending
= update_frame (sf
, 0, 0);
13262 /* We may have called echo_area_display at the top of this
13263 function. If the echo area is on another frame, that may
13264 have put text on a frame other than the selected one, so the
13265 above call to update_frame would not have caught it. Catch
13267 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13268 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13270 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13272 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13273 pending
|= update_frame (mini_frame
, 0, 0);
13274 if (!pending
&& hscroll_windows (mini_window
))
13279 /* If display was paused because of pending input, make sure we do a
13280 thorough update the next time. */
13283 /* Prevent the optimization at the beginning of
13284 redisplay_internal that tries a single-line update of the
13285 line containing the cursor in the selected window. */
13286 CHARPOS (this_line_start_pos
) = 0;
13288 /* Let the overlay arrow be updated the next time. */
13289 update_overlay_arrows (0);
13291 /* If we pause after scrolling, some rows in the current
13292 matrices of some windows are not valid. */
13293 if (!WINDOW_FULL_WIDTH_P (w
)
13294 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13295 update_mode_lines
= 1;
13299 if (!consider_all_windows_p
)
13301 /* This has already been done above if
13302 consider_all_windows_p is set. */
13303 mark_window_display_accurate_1 (w
, 1);
13305 /* Say overlay arrows are up to date. */
13306 update_overlay_arrows (1);
13308 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13309 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13312 update_mode_lines
= 0;
13313 windows_or_buffers_changed
= 0;
13314 cursor_type_changed
= 0;
13317 /* Start SIGIO interrupts coming again. Having them off during the
13318 code above makes it less likely one will discard output, but not
13319 impossible, since there might be stuff in the system buffer here.
13320 But it is much hairier to try to do anything about that. */
13321 if (interrupt_input
)
13325 /* If a frame has become visible which was not before, redisplay
13326 again, so that we display it. Expose events for such a frame
13327 (which it gets when becoming visible) don't call the parts of
13328 redisplay constructing glyphs, so simply exposing a frame won't
13329 display anything in this case. So, we have to display these
13330 frames here explicitly. */
13333 Lisp_Object tail
, frame
;
13336 FOR_EACH_FRAME (tail
, frame
)
13338 int this_is_visible
= 0;
13340 if (XFRAME (frame
)->visible
)
13341 this_is_visible
= 1;
13342 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13343 if (XFRAME (frame
)->visible
)
13344 this_is_visible
= 1;
13346 if (this_is_visible
)
13350 if (new_count
!= number_of_visible_frames
)
13351 windows_or_buffers_changed
++;
13354 /* Change frame size now if a change is pending. */
13355 do_pending_window_change (1);
13357 /* If we just did a pending size change, or have additional
13358 visible frames, or selected_window changed, redisplay again. */
13359 if ((windows_or_buffers_changed
&& !pending
)
13360 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13363 /* Clear the face and image caches.
13365 We used to do this only if consider_all_windows_p. But the cache
13366 needs to be cleared if a timer creates images in the current
13367 buffer (e.g. the test case in Bug#6230). */
13369 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13371 clear_face_cache (0);
13372 clear_face_cache_count
= 0;
13375 #ifdef HAVE_WINDOW_SYSTEM
13376 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13378 clear_image_caches (Qnil
);
13379 clear_image_cache_count
= 0;
13381 #endif /* HAVE_WINDOW_SYSTEM */
13384 unbind_to (count
, Qnil
);
13389 /* Redisplay, but leave alone any recent echo area message unless
13390 another message has been requested in its place.
13392 This is useful in situations where you need to redisplay but no
13393 user action has occurred, making it inappropriate for the message
13394 area to be cleared. See tracking_off and
13395 wait_reading_process_output for examples of these situations.
13397 FROM_WHERE is an integer saying from where this function was
13398 called. This is useful for debugging. */
13401 redisplay_preserve_echo_area (int from_where
)
13403 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13405 if (!NILP (echo_area_buffer
[1]))
13407 /* We have a previously displayed message, but no current
13408 message. Redisplay the previous message. */
13409 display_last_displayed_message_p
= 1;
13410 redisplay_internal ();
13411 display_last_displayed_message_p
= 0;
13414 redisplay_internal ();
13416 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13417 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13418 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13422 /* Function registered with record_unwind_protect in
13423 redisplay_internal. Reset redisplaying_p to the value it had
13424 before redisplay_internal was called, and clear
13425 prevent_freeing_realized_faces_p. It also selects the previously
13426 selected frame, unless it has been deleted (by an X connection
13427 failure during redisplay, for example). */
13430 unwind_redisplay (Lisp_Object val
)
13432 Lisp_Object old_redisplaying_p
, old_frame
;
13434 old_redisplaying_p
= XCAR (val
);
13435 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13436 old_frame
= XCDR (val
);
13437 if (! EQ (old_frame
, selected_frame
)
13438 && FRAME_LIVE_P (XFRAME (old_frame
)))
13439 select_frame_for_redisplay (old_frame
);
13444 /* Mark the display of window W as accurate or inaccurate. If
13445 ACCURATE_P is non-zero mark display of W as accurate. If
13446 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13447 redisplay_internal is called. */
13450 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13452 if (BUFFERP (w
->buffer
))
13454 struct buffer
*b
= XBUFFER (w
->buffer
);
13457 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13458 w
->last_overlay_modified
13459 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13461 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13465 b
->clip_changed
= 0;
13466 b
->prevent_redisplay_optimizations_p
= 0;
13468 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13469 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13470 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13471 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13473 w
->current_matrix
->buffer
= b
;
13474 w
->current_matrix
->begv
= BUF_BEGV (b
);
13475 w
->current_matrix
->zv
= BUF_ZV (b
);
13477 w
->last_cursor
= w
->cursor
;
13478 w
->last_cursor_off_p
= w
->cursor_off_p
;
13480 if (w
== XWINDOW (selected_window
))
13481 w
->last_point
= make_number (BUF_PT (b
));
13483 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13489 w
->window_end_valid
= w
->buffer
;
13490 w
->update_mode_line
= Qnil
;
13495 /* Mark the display of windows in the window tree rooted at WINDOW as
13496 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13497 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13498 be redisplayed the next time redisplay_internal is called. */
13501 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13505 for (; !NILP (window
); window
= w
->next
)
13507 w
= XWINDOW (window
);
13508 mark_window_display_accurate_1 (w
, accurate_p
);
13510 if (!NILP (w
->vchild
))
13511 mark_window_display_accurate (w
->vchild
, accurate_p
);
13512 if (!NILP (w
->hchild
))
13513 mark_window_display_accurate (w
->hchild
, accurate_p
);
13518 update_overlay_arrows (1);
13522 /* Force a thorough redisplay the next time by setting
13523 last_arrow_position and last_arrow_string to t, which is
13524 unequal to any useful value of Voverlay_arrow_... */
13525 update_overlay_arrows (-1);
13530 /* Return value in display table DP (Lisp_Char_Table *) for character
13531 C. Since a display table doesn't have any parent, we don't have to
13532 follow parent. Do not call this function directly but use the
13533 macro DISP_CHAR_VECTOR. */
13536 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13540 if (ASCII_CHAR_P (c
))
13543 if (SUB_CHAR_TABLE_P (val
))
13544 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13550 XSETCHAR_TABLE (table
, dp
);
13551 val
= char_table_ref (table
, c
);
13560 /***********************************************************************
13562 ***********************************************************************/
13564 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13567 redisplay_windows (Lisp_Object window
)
13569 while (!NILP (window
))
13571 struct window
*w
= XWINDOW (window
);
13573 if (!NILP (w
->hchild
))
13574 redisplay_windows (w
->hchild
);
13575 else if (!NILP (w
->vchild
))
13576 redisplay_windows (w
->vchild
);
13577 else if (!NILP (w
->buffer
))
13579 displayed_buffer
= XBUFFER (w
->buffer
);
13580 /* Use list_of_error, not Qerror, so that
13581 we catch only errors and don't run the debugger. */
13582 internal_condition_case_1 (redisplay_window_0
, window
,
13584 redisplay_window_error
);
13592 redisplay_window_error (Lisp_Object ignore
)
13594 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13599 redisplay_window_0 (Lisp_Object window
)
13601 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13602 redisplay_window (window
, 0);
13607 redisplay_window_1 (Lisp_Object window
)
13609 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13610 redisplay_window (window
, 1);
13615 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13616 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13617 which positions recorded in ROW differ from current buffer
13620 Return 0 if cursor is not on this row, 1 otherwise. */
13623 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13624 struct glyph_matrix
*matrix
,
13625 EMACS_INT delta
, EMACS_INT delta_bytes
,
13628 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13629 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13630 struct glyph
*cursor
= NULL
;
13631 /* The last known character position in row. */
13632 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13634 EMACS_INT pt_old
= PT
- delta
;
13635 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13636 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13637 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13638 /* A glyph beyond the edge of TEXT_AREA which we should never
13640 struct glyph
*glyphs_end
= end
;
13641 /* Non-zero means we've found a match for cursor position, but that
13642 glyph has the avoid_cursor_p flag set. */
13643 int match_with_avoid_cursor
= 0;
13644 /* Non-zero means we've seen at least one glyph that came from a
13646 int string_seen
= 0;
13647 /* Largest and smalles buffer positions seen so far during scan of
13649 EMACS_INT bpos_max
= pos_before
;
13650 EMACS_INT bpos_min
= pos_after
;
13651 /* Last buffer position covered by an overlay string with an integer
13652 `cursor' property. */
13653 EMACS_INT bpos_covered
= 0;
13654 /* Non-zero means the display string on which to display the cursor
13655 comes from a text property, not from an overlay. */
13656 int string_from_text_prop
= 0;
13658 /* Skip over glyphs not having an object at the start and the end of
13659 the row. These are special glyphs like truncation marks on
13660 terminal frames. */
13661 if (row
->displays_text_p
)
13663 if (!row
->reversed_p
)
13666 && INTEGERP (glyph
->object
)
13667 && glyph
->charpos
< 0)
13669 x
+= glyph
->pixel_width
;
13673 && INTEGERP ((end
- 1)->object
)
13674 /* CHARPOS is zero for blanks and stretch glyphs
13675 inserted by extend_face_to_end_of_line. */
13676 && (end
- 1)->charpos
<= 0)
13678 glyph_before
= glyph
- 1;
13685 /* If the glyph row is reversed, we need to process it from back
13686 to front, so swap the edge pointers. */
13687 glyphs_end
= end
= glyph
- 1;
13688 glyph
+= row
->used
[TEXT_AREA
] - 1;
13690 while (glyph
> end
+ 1
13691 && INTEGERP (glyph
->object
)
13692 && glyph
->charpos
< 0)
13695 x
-= glyph
->pixel_width
;
13697 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13699 /* By default, in reversed rows we put the cursor on the
13700 rightmost (first in the reading order) glyph. */
13701 for (g
= end
+ 1; g
< glyph
; g
++)
13702 x
+= g
->pixel_width
;
13704 && INTEGERP ((end
+ 1)->object
)
13705 && (end
+ 1)->charpos
<= 0)
13707 glyph_before
= glyph
+ 1;
13711 else if (row
->reversed_p
)
13713 /* In R2L rows that don't display text, put the cursor on the
13714 rightmost glyph. Case in point: an empty last line that is
13715 part of an R2L paragraph. */
13717 /* Avoid placing the cursor on the last glyph of the row, where
13718 on terminal frames we hold the vertical border between
13719 adjacent windows. */
13720 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13721 && !WINDOW_RIGHTMOST_P (w
)
13722 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13724 x
= -1; /* will be computed below, at label compute_x */
13727 /* Step 1: Try to find the glyph whose character position
13728 corresponds to point. If that's not possible, find 2 glyphs
13729 whose character positions are the closest to point, one before
13730 point, the other after it. */
13731 if (!row
->reversed_p
)
13732 while (/* not marched to end of glyph row */
13734 /* glyph was not inserted by redisplay for internal purposes */
13735 && !INTEGERP (glyph
->object
))
13737 if (BUFFERP (glyph
->object
))
13739 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13741 if (glyph
->charpos
> bpos_max
)
13742 bpos_max
= glyph
->charpos
;
13743 if (glyph
->charpos
< bpos_min
)
13744 bpos_min
= glyph
->charpos
;
13745 if (!glyph
->avoid_cursor_p
)
13747 /* If we hit point, we've found the glyph on which to
13748 display the cursor. */
13751 match_with_avoid_cursor
= 0;
13754 /* See if we've found a better approximation to
13755 POS_BEFORE or to POS_AFTER. Note that we want the
13756 first (leftmost) glyph of all those that are the
13757 closest from below, and the last (rightmost) of all
13758 those from above. */
13759 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13761 pos_before
= glyph
->charpos
;
13762 glyph_before
= glyph
;
13764 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13766 pos_after
= glyph
->charpos
;
13767 glyph_after
= glyph
;
13770 else if (dpos
== 0)
13771 match_with_avoid_cursor
= 1;
13773 else if (STRINGP (glyph
->object
))
13775 Lisp_Object chprop
;
13776 EMACS_INT glyph_pos
= glyph
->charpos
;
13778 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13780 if (INTEGERP (chprop
))
13782 bpos_covered
= bpos_max
+ XINT (chprop
);
13783 /* If the `cursor' property covers buffer positions up
13784 to and including point, we should display cursor on
13785 this glyph. Note that overlays and text properties
13786 with string values stop bidi reordering, so every
13787 buffer position to the left of the string is always
13788 smaller than any position to the right of the
13789 string. Therefore, if a `cursor' property on one
13790 of the string's characters has an integer value, we
13791 will break out of the loop below _before_ we get to
13792 the position match above. IOW, integer values of
13793 the `cursor' property override the "exact match for
13794 point" strategy of positioning the cursor. */
13795 /* Implementation note: bpos_max == pt_old when, e.g.,
13796 we are in an empty line, where bpos_max is set to
13797 MATRIX_ROW_START_CHARPOS, see above. */
13798 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13807 x
+= glyph
->pixel_width
;
13810 else if (glyph
> end
) /* row is reversed */
13811 while (!INTEGERP (glyph
->object
))
13813 if (BUFFERP (glyph
->object
))
13815 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13817 if (glyph
->charpos
> bpos_max
)
13818 bpos_max
= glyph
->charpos
;
13819 if (glyph
->charpos
< bpos_min
)
13820 bpos_min
= glyph
->charpos
;
13821 if (!glyph
->avoid_cursor_p
)
13825 match_with_avoid_cursor
= 0;
13828 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13830 pos_before
= glyph
->charpos
;
13831 glyph_before
= glyph
;
13833 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13835 pos_after
= glyph
->charpos
;
13836 glyph_after
= glyph
;
13839 else if (dpos
== 0)
13840 match_with_avoid_cursor
= 1;
13842 else if (STRINGP (glyph
->object
))
13844 Lisp_Object chprop
;
13845 EMACS_INT glyph_pos
= glyph
->charpos
;
13847 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13849 if (INTEGERP (chprop
))
13851 bpos_covered
= bpos_max
+ XINT (chprop
);
13852 /* If the `cursor' property covers buffer positions up
13853 to and including point, we should display cursor on
13855 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13864 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13866 x
--; /* can't use any pixel_width */
13869 x
-= glyph
->pixel_width
;
13872 /* Step 2: If we didn't find an exact match for point, we need to
13873 look for a proper place to put the cursor among glyphs between
13874 GLYPH_BEFORE and GLYPH_AFTER. */
13875 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13876 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13877 && bpos_covered
< pt_old
)
13879 /* An empty line has a single glyph whose OBJECT is zero and
13880 whose CHARPOS is the position of a newline on that line.
13881 Note that on a TTY, there are more glyphs after that, which
13882 were produced by extend_face_to_end_of_line, but their
13883 CHARPOS is zero or negative. */
13885 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13886 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13888 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13890 EMACS_INT ellipsis_pos
;
13892 /* Scan back over the ellipsis glyphs. */
13893 if (!row
->reversed_p
)
13895 ellipsis_pos
= (glyph
- 1)->charpos
;
13896 while (glyph
> row
->glyphs
[TEXT_AREA
]
13897 && (glyph
- 1)->charpos
== ellipsis_pos
)
13898 glyph
--, x
-= glyph
->pixel_width
;
13899 /* That loop always goes one position too far, including
13900 the glyph before the ellipsis. So scan forward over
13902 x
+= glyph
->pixel_width
;
13905 else /* row is reversed */
13907 ellipsis_pos
= (glyph
+ 1)->charpos
;
13908 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13909 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13910 glyph
++, x
+= glyph
->pixel_width
;
13911 x
-= glyph
->pixel_width
;
13915 else if (match_with_avoid_cursor
)
13917 cursor
= glyph_after
;
13920 else if (string_seen
)
13922 int incr
= row
->reversed_p
? -1 : +1;
13924 /* Need to find the glyph that came out of a string which is
13925 present at point. That glyph is somewhere between
13926 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13927 positioned between POS_BEFORE and POS_AFTER in the
13929 struct glyph
*start
, *stop
;
13930 EMACS_INT pos
= pos_before
;
13934 /* If the row ends in a newline from a display string,
13935 reordering could have moved the glyphs belonging to the
13936 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13937 in this case we extend the search to the last glyph in
13938 the row that was not inserted by redisplay. */
13939 if (row
->ends_in_newline_from_string_p
)
13942 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13945 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13946 correspond to POS_BEFORE and POS_AFTER, respectively. We
13947 need START and STOP in the order that corresponds to the
13948 row's direction as given by its reversed_p flag. If the
13949 directionality of characters between POS_BEFORE and
13950 POS_AFTER is the opposite of the row's base direction,
13951 these characters will have been reordered for display,
13952 and we need to reverse START and STOP. */
13953 if (!row
->reversed_p
)
13955 start
= min (glyph_before
, glyph_after
);
13956 stop
= max (glyph_before
, glyph_after
);
13960 start
= max (glyph_before
, glyph_after
);
13961 stop
= min (glyph_before
, glyph_after
);
13963 for (glyph
= start
+ incr
;
13964 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13967 /* Any glyphs that come from the buffer are here because
13968 of bidi reordering. Skip them, and only pay
13969 attention to glyphs that came from some string. */
13970 if (STRINGP (glyph
->object
))
13974 /* If the display property covers the newline, we
13975 need to search for it one position farther. */
13976 EMACS_INT lim
= pos_after
13977 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13979 string_from_text_prop
= 0;
13980 str
= glyph
->object
;
13981 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13982 if (tem
== 0 /* from overlay */
13985 /* If the string from which this glyph came is
13986 found in the buffer at point, then we've
13987 found the glyph we've been looking for. If
13988 it comes from an overlay (tem == 0), and it
13989 has the `cursor' property on one of its
13990 glyphs, record that glyph as a candidate for
13991 displaying the cursor. (As in the
13992 unidirectional version, we will display the
13993 cursor on the last candidate we find.) */
13994 if (tem
== 0 || tem
== pt_old
)
13996 /* The glyphs from this string could have
13997 been reordered. Find the one with the
13998 smallest string position. Or there could
13999 be a character in the string with the
14000 `cursor' property, which means display
14001 cursor on that character's glyph. */
14002 EMACS_INT strpos
= glyph
->charpos
;
14007 string_from_text_prop
= 1;
14010 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14011 && EQ (glyph
->object
, str
);
14015 EMACS_INT gpos
= glyph
->charpos
;
14017 cprop
= Fget_char_property (make_number (gpos
),
14025 if (tem
&& glyph
->charpos
< strpos
)
14027 strpos
= glyph
->charpos
;
14036 pos
= tem
+ 1; /* don't find previous instances */
14038 /* This string is not what we want; skip all of the
14039 glyphs that came from it. */
14040 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14041 && EQ (glyph
->object
, str
))
14048 /* If we reached the end of the line, and END was from a string,
14049 the cursor is not on this line. */
14051 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14052 && STRINGP (end
->object
)
14053 && row
->continued_p
)
14056 /* A truncated row may not include PT among its character positions.
14057 Setting the cursor inside the scroll margin will trigger
14058 recalculation of hscroll in hscroll_window_tree. But if a
14059 display string covers point, defer to the string-handling
14060 code below to figure this out. */
14061 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14063 cursor
= glyph_before
;
14066 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14067 /* Zero-width characters produce no glyphs. */
14069 && (row
->reversed_p
14070 ? glyph_after
> glyphs_end
14071 : glyph_after
< glyphs_end
)))
14073 cursor
= glyph_after
;
14079 if (cursor
!= NULL
)
14085 /* Need to compute x that corresponds to GLYPH. */
14086 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14088 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14090 x
+= g
->pixel_width
;
14094 /* ROW could be part of a continued line, which, under bidi
14095 reordering, might have other rows whose start and end charpos
14096 occlude point. Only set w->cursor if we found a better
14097 approximation to the cursor position than we have from previously
14098 examined candidate rows belonging to the same continued line. */
14099 if (/* we already have a candidate row */
14100 w
->cursor
.vpos
>= 0
14101 /* that candidate is not the row we are processing */
14102 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14103 /* Make sure cursor.vpos specifies a row whose start and end
14104 charpos occlude point, and it is valid candidate for being a
14105 cursor-row. This is because some callers of this function
14106 leave cursor.vpos at the row where the cursor was displayed
14107 during the last redisplay cycle. */
14108 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14109 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14110 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14113 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14115 /* Don't consider glyphs that are outside TEXT_AREA. */
14116 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14118 /* Keep the candidate whose buffer position is the closest to
14119 point or has the `cursor' property. */
14120 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14121 w
->cursor
.hpos
>= 0
14122 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14123 && ((BUFFERP (g1
->object
)
14124 && (g1
->charpos
== pt_old
/* an exact match always wins */
14125 || (BUFFERP (glyph
->object
)
14126 && eabs (g1
->charpos
- pt_old
)
14127 < eabs (glyph
->charpos
- pt_old
))))
14128 /* previous candidate is a glyph from a string that has
14129 a non-nil `cursor' property */
14130 || (STRINGP (g1
->object
)
14131 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14132 Qcursor
, g1
->object
))
14133 /* previous candidate is from the same display
14134 string as this one, and the display string
14135 came from a text property */
14136 || (EQ (g1
->object
, glyph
->object
)
14137 && string_from_text_prop
)
14138 /* this candidate is from newline and its
14139 position is not an exact match */
14140 || (INTEGERP (glyph
->object
)
14141 && glyph
->charpos
!= pt_old
)))))
14143 /* If this candidate gives an exact match, use that. */
14144 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14145 /* If this candidate is a glyph created for the
14146 terminating newline of a line, and point is on that
14147 newline, it wins because it's an exact match. */
14148 || (!row
->continued_p
14149 && INTEGERP (glyph
->object
)
14150 && glyph
->charpos
== 0
14151 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14152 /* Otherwise, keep the candidate that comes from a row
14153 spanning less buffer positions. This may win when one or
14154 both candidate positions are on glyphs that came from
14155 display strings, for which we cannot compare buffer
14157 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14158 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14159 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14162 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14164 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14165 w
->cursor
.y
= row
->y
+ dy
;
14167 if (w
== XWINDOW (selected_window
))
14169 if (!row
->continued_p
14170 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14173 this_line_buffer
= XBUFFER (w
->buffer
);
14175 CHARPOS (this_line_start_pos
)
14176 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14177 BYTEPOS (this_line_start_pos
)
14178 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14180 CHARPOS (this_line_end_pos
)
14181 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14182 BYTEPOS (this_line_end_pos
)
14183 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14185 this_line_y
= w
->cursor
.y
;
14186 this_line_pixel_height
= row
->height
;
14187 this_line_vpos
= w
->cursor
.vpos
;
14188 this_line_start_x
= row
->x
;
14191 CHARPOS (this_line_start_pos
) = 0;
14198 /* Run window scroll functions, if any, for WINDOW with new window
14199 start STARTP. Sets the window start of WINDOW to that position.
14201 We assume that the window's buffer is really current. */
14203 static inline struct text_pos
14204 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14206 struct window
*w
= XWINDOW (window
);
14207 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14209 if (current_buffer
!= XBUFFER (w
->buffer
))
14212 if (!NILP (Vwindow_scroll_functions
))
14214 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14215 make_number (CHARPOS (startp
)));
14216 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14217 /* In case the hook functions switch buffers. */
14218 if (current_buffer
!= XBUFFER (w
->buffer
))
14219 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14226 /* Make sure the line containing the cursor is fully visible.
14227 A value of 1 means there is nothing to be done.
14228 (Either the line is fully visible, or it cannot be made so,
14229 or we cannot tell.)
14231 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14232 is higher than window.
14234 A value of 0 means the caller should do scrolling
14235 as if point had gone off the screen. */
14238 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14240 struct glyph_matrix
*matrix
;
14241 struct glyph_row
*row
;
14244 if (!make_cursor_line_fully_visible_p
)
14247 /* It's not always possible to find the cursor, e.g, when a window
14248 is full of overlay strings. Don't do anything in that case. */
14249 if (w
->cursor
.vpos
< 0)
14252 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14253 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14255 /* If the cursor row is not partially visible, there's nothing to do. */
14256 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14259 /* If the row the cursor is in is taller than the window's height,
14260 it's not clear what to do, so do nothing. */
14261 window_height
= window_box_height (w
);
14262 if (row
->height
>= window_height
)
14264 if (!force_p
|| MINI_WINDOW_P (w
)
14265 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14272 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14273 non-zero means only WINDOW is redisplayed in redisplay_internal.
14274 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14275 in redisplay_window to bring a partially visible line into view in
14276 the case that only the cursor has moved.
14278 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14279 last screen line's vertical height extends past the end of the screen.
14283 1 if scrolling succeeded
14285 0 if scrolling didn't find point.
14287 -1 if new fonts have been loaded so that we must interrupt
14288 redisplay, adjust glyph matrices, and try again. */
14294 SCROLLING_NEED_LARGER_MATRICES
14297 /* If scroll-conservatively is more than this, never recenter.
14299 If you change this, don't forget to update the doc string of
14300 `scroll-conservatively' and the Emacs manual. */
14301 #define SCROLL_LIMIT 100
14304 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14305 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14306 int temp_scroll_step
, int last_line_misfit
)
14308 struct window
*w
= XWINDOW (window
);
14309 struct frame
*f
= XFRAME (w
->frame
);
14310 struct text_pos pos
, startp
;
14312 int this_scroll_margin
, scroll_max
, rc
, height
;
14313 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14314 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14315 Lisp_Object aggressive
;
14316 /* We will never try scrolling more than this number of lines. */
14317 int scroll_limit
= SCROLL_LIMIT
;
14320 debug_method_add (w
, "try_scrolling");
14323 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14325 /* Compute scroll margin height in pixels. We scroll when point is
14326 within this distance from the top or bottom of the window. */
14327 if (scroll_margin
> 0)
14328 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14329 * FRAME_LINE_HEIGHT (f
);
14331 this_scroll_margin
= 0;
14333 /* Force arg_scroll_conservatively to have a reasonable value, to
14334 avoid scrolling too far away with slow move_it_* functions. Note
14335 that the user can supply scroll-conservatively equal to
14336 `most-positive-fixnum', which can be larger than INT_MAX. */
14337 if (arg_scroll_conservatively
> scroll_limit
)
14339 arg_scroll_conservatively
= scroll_limit
+ 1;
14340 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14342 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14343 /* Compute how much we should try to scroll maximally to bring
14344 point into view. */
14345 scroll_max
= (max (scroll_step
,
14346 max (arg_scroll_conservatively
, temp_scroll_step
))
14347 * FRAME_LINE_HEIGHT (f
));
14348 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14349 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14350 /* We're trying to scroll because of aggressive scrolling but no
14351 scroll_step is set. Choose an arbitrary one. */
14352 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14358 /* Decide whether to scroll down. */
14359 if (PT
> CHARPOS (startp
))
14361 int scroll_margin_y
;
14363 /* Compute the pixel ypos of the scroll margin, then move IT to
14364 either that ypos or PT, whichever comes first. */
14365 start_display (&it
, w
, startp
);
14366 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14367 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14368 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14369 (MOVE_TO_POS
| MOVE_TO_Y
));
14371 if (PT
> CHARPOS (it
.current
.pos
))
14373 int y0
= line_bottom_y (&it
);
14374 /* Compute how many pixels below window bottom to stop searching
14375 for PT. This avoids costly search for PT that is far away if
14376 the user limited scrolling by a small number of lines, but
14377 always finds PT if scroll_conservatively is set to a large
14378 number, such as most-positive-fixnum. */
14379 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14380 int y_to_move
= it
.last_visible_y
+ slack
;
14382 /* Compute the distance from the scroll margin to PT or to
14383 the scroll limit, whichever comes first. This should
14384 include the height of the cursor line, to make that line
14386 move_it_to (&it
, PT
, -1, y_to_move
,
14387 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14388 dy
= line_bottom_y (&it
) - y0
;
14390 if (dy
> scroll_max
)
14391 return SCROLLING_FAILED
;
14400 /* Point is in or below the bottom scroll margin, so move the
14401 window start down. If scrolling conservatively, move it just
14402 enough down to make point visible. If scroll_step is set,
14403 move it down by scroll_step. */
14404 if (arg_scroll_conservatively
)
14406 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14407 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14408 else if (scroll_step
|| temp_scroll_step
)
14409 amount_to_scroll
= scroll_max
;
14412 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14413 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14414 if (NUMBERP (aggressive
))
14416 double float_amount
= XFLOATINT (aggressive
) * height
;
14417 amount_to_scroll
= float_amount
;
14418 if (amount_to_scroll
== 0 && float_amount
> 0)
14419 amount_to_scroll
= 1;
14420 /* Don't let point enter the scroll margin near top of
14422 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14423 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14427 if (amount_to_scroll
<= 0)
14428 return SCROLLING_FAILED
;
14430 start_display (&it
, w
, startp
);
14431 if (arg_scroll_conservatively
<= scroll_limit
)
14432 move_it_vertically (&it
, amount_to_scroll
);
14435 /* Extra precision for users who set scroll-conservatively
14436 to a large number: make sure the amount we scroll
14437 the window start is never less than amount_to_scroll,
14438 which was computed as distance from window bottom to
14439 point. This matters when lines at window top and lines
14440 below window bottom have different height. */
14442 void *it1data
= NULL
;
14443 /* We use a temporary it1 because line_bottom_y can modify
14444 its argument, if it moves one line down; see there. */
14447 SAVE_IT (it1
, it
, it1data
);
14448 start_y
= line_bottom_y (&it1
);
14450 RESTORE_IT (&it
, &it
, it1data
);
14451 move_it_by_lines (&it
, 1);
14452 SAVE_IT (it1
, it
, it1data
);
14453 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14456 /* If STARTP is unchanged, move it down another screen line. */
14457 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14458 move_it_by_lines (&it
, 1);
14459 startp
= it
.current
.pos
;
14463 struct text_pos scroll_margin_pos
= startp
;
14465 /* See if point is inside the scroll margin at the top of the
14467 if (this_scroll_margin
)
14469 start_display (&it
, w
, startp
);
14470 move_it_vertically (&it
, this_scroll_margin
);
14471 scroll_margin_pos
= it
.current
.pos
;
14474 if (PT
< CHARPOS (scroll_margin_pos
))
14476 /* Point is in the scroll margin at the top of the window or
14477 above what is displayed in the window. */
14480 /* Compute the vertical distance from PT to the scroll
14481 margin position. Move as far as scroll_max allows, or
14482 one screenful, or 10 screen lines, whichever is largest.
14483 Give up if distance is greater than scroll_max. */
14484 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14485 start_display (&it
, w
, pos
);
14487 y_to_move
= max (it
.last_visible_y
,
14488 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14489 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14491 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14492 dy
= it
.current_y
- y0
;
14493 if (dy
> scroll_max
)
14494 return SCROLLING_FAILED
;
14496 /* Compute new window start. */
14497 start_display (&it
, w
, startp
);
14499 if (arg_scroll_conservatively
)
14500 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14501 max (scroll_step
, temp_scroll_step
));
14502 else if (scroll_step
|| temp_scroll_step
)
14503 amount_to_scroll
= scroll_max
;
14506 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14507 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14508 if (NUMBERP (aggressive
))
14510 double float_amount
= XFLOATINT (aggressive
) * height
;
14511 amount_to_scroll
= float_amount
;
14512 if (amount_to_scroll
== 0 && float_amount
> 0)
14513 amount_to_scroll
= 1;
14514 amount_to_scroll
-=
14515 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14516 /* Don't let point enter the scroll margin near
14517 bottom of the window. */
14518 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14519 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14523 if (amount_to_scroll
<= 0)
14524 return SCROLLING_FAILED
;
14526 move_it_vertically_backward (&it
, amount_to_scroll
);
14527 startp
= it
.current
.pos
;
14531 /* Run window scroll functions. */
14532 startp
= run_window_scroll_functions (window
, startp
);
14534 /* Display the window. Give up if new fonts are loaded, or if point
14536 if (!try_window (window
, startp
, 0))
14537 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14538 else if (w
->cursor
.vpos
< 0)
14540 clear_glyph_matrix (w
->desired_matrix
);
14541 rc
= SCROLLING_FAILED
;
14545 /* Maybe forget recorded base line for line number display. */
14546 if (!just_this_one_p
14547 || current_buffer
->clip_changed
14548 || BEG_UNCHANGED
< CHARPOS (startp
))
14549 w
->base_line_number
= Qnil
;
14551 /* If cursor ends up on a partially visible line,
14552 treat that as being off the bottom of the screen. */
14553 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14554 /* It's possible that the cursor is on the first line of the
14555 buffer, which is partially obscured due to a vscroll
14556 (Bug#7537). In that case, avoid looping forever . */
14557 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14559 clear_glyph_matrix (w
->desired_matrix
);
14560 ++extra_scroll_margin_lines
;
14563 rc
= SCROLLING_SUCCESS
;
14570 /* Compute a suitable window start for window W if display of W starts
14571 on a continuation line. Value is non-zero if a new window start
14574 The new window start will be computed, based on W's width, starting
14575 from the start of the continued line. It is the start of the
14576 screen line with the minimum distance from the old start W->start. */
14579 compute_window_start_on_continuation_line (struct window
*w
)
14581 struct text_pos pos
, start_pos
;
14582 int window_start_changed_p
= 0;
14584 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14586 /* If window start is on a continuation line... Window start may be
14587 < BEGV in case there's invisible text at the start of the
14588 buffer (M-x rmail, for example). */
14589 if (CHARPOS (start_pos
) > BEGV
14590 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14593 struct glyph_row
*row
;
14595 /* Handle the case that the window start is out of range. */
14596 if (CHARPOS (start_pos
) < BEGV
)
14597 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14598 else if (CHARPOS (start_pos
) > ZV
)
14599 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14601 /* Find the start of the continued line. This should be fast
14602 because scan_buffer is fast (newline cache). */
14603 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14604 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14605 row
, DEFAULT_FACE_ID
);
14606 reseat_at_previous_visible_line_start (&it
);
14608 /* If the line start is "too far" away from the window start,
14609 say it takes too much time to compute a new window start. */
14610 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14611 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14613 int min_distance
, distance
;
14615 /* Move forward by display lines to find the new window
14616 start. If window width was enlarged, the new start can
14617 be expected to be > the old start. If window width was
14618 decreased, the new window start will be < the old start.
14619 So, we're looking for the display line start with the
14620 minimum distance from the old window start. */
14621 pos
= it
.current
.pos
;
14622 min_distance
= INFINITY
;
14623 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14624 distance
< min_distance
)
14626 min_distance
= distance
;
14627 pos
= it
.current
.pos
;
14628 move_it_by_lines (&it
, 1);
14631 /* Set the window start there. */
14632 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14633 window_start_changed_p
= 1;
14637 return window_start_changed_p
;
14641 /* Try cursor movement in case text has not changed in window WINDOW,
14642 with window start STARTP. Value is
14644 CURSOR_MOVEMENT_SUCCESS if successful
14646 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14648 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14649 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14650 we want to scroll as if scroll-step were set to 1. See the code.
14652 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14653 which case we have to abort this redisplay, and adjust matrices
14658 CURSOR_MOVEMENT_SUCCESS
,
14659 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14660 CURSOR_MOVEMENT_MUST_SCROLL
,
14661 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14665 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14667 struct window
*w
= XWINDOW (window
);
14668 struct frame
*f
= XFRAME (w
->frame
);
14669 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14672 if (inhibit_try_cursor_movement
)
14676 /* Handle case where text has not changed, only point, and it has
14677 not moved off the frame. */
14678 if (/* Point may be in this window. */
14679 PT
>= CHARPOS (startp
)
14680 /* Selective display hasn't changed. */
14681 && !current_buffer
->clip_changed
14682 /* Function force-mode-line-update is used to force a thorough
14683 redisplay. It sets either windows_or_buffers_changed or
14684 update_mode_lines. So don't take a shortcut here for these
14686 && !update_mode_lines
14687 && !windows_or_buffers_changed
14688 && !cursor_type_changed
14689 /* Can't use this case if highlighting a region. When a
14690 region exists, cursor movement has to do more than just
14692 && !(!NILP (Vtransient_mark_mode
)
14693 && !NILP (BVAR (current_buffer
, mark_active
)))
14694 && NILP (w
->region_showing
)
14695 && NILP (Vshow_trailing_whitespace
)
14696 /* Right after splitting windows, last_point may be nil. */
14697 && INTEGERP (w
->last_point
)
14698 /* This code is not used for mini-buffer for the sake of the case
14699 of redisplaying to replace an echo area message; since in
14700 that case the mini-buffer contents per se are usually
14701 unchanged. This code is of no real use in the mini-buffer
14702 since the handling of this_line_start_pos, etc., in redisplay
14703 handles the same cases. */
14704 && !EQ (window
, minibuf_window
)
14705 /* When splitting windows or for new windows, it happens that
14706 redisplay is called with a nil window_end_vpos or one being
14707 larger than the window. This should really be fixed in
14708 window.c. I don't have this on my list, now, so we do
14709 approximately the same as the old redisplay code. --gerd. */
14710 && INTEGERP (w
->window_end_vpos
)
14711 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14712 && (FRAME_WINDOW_P (f
)
14713 || !overlay_arrow_in_current_buffer_p ()))
14715 int this_scroll_margin
, top_scroll_margin
;
14716 struct glyph_row
*row
= NULL
;
14719 debug_method_add (w
, "cursor movement");
14722 /* Scroll if point within this distance from the top or bottom
14723 of the window. This is a pixel value. */
14724 if (scroll_margin
> 0)
14726 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14727 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14730 this_scroll_margin
= 0;
14732 top_scroll_margin
= this_scroll_margin
;
14733 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14734 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14736 /* Start with the row the cursor was displayed during the last
14737 not paused redisplay. Give up if that row is not valid. */
14738 if (w
->last_cursor
.vpos
< 0
14739 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14740 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14743 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14744 if (row
->mode_line_p
)
14746 if (!row
->enabled_p
)
14747 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14750 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14752 int scroll_p
= 0, must_scroll
= 0;
14753 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14755 if (PT
> XFASTINT (w
->last_point
))
14757 /* Point has moved forward. */
14758 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14759 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14761 xassert (row
->enabled_p
);
14765 /* If the end position of a row equals the start
14766 position of the next row, and PT is at that position,
14767 we would rather display cursor in the next line. */
14768 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14769 && MATRIX_ROW_END_CHARPOS (row
) == PT
14770 && row
< w
->current_matrix
->rows
14771 + w
->current_matrix
->nrows
- 1
14772 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14773 && !cursor_row_p (row
))
14776 /* If within the scroll margin, scroll. Note that
14777 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14778 the next line would be drawn, and that
14779 this_scroll_margin can be zero. */
14780 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14781 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14782 /* Line is completely visible last line in window
14783 and PT is to be set in the next line. */
14784 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14785 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14786 && !row
->ends_at_zv_p
14787 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14790 else if (PT
< XFASTINT (w
->last_point
))
14792 /* Cursor has to be moved backward. Note that PT >=
14793 CHARPOS (startp) because of the outer if-statement. */
14794 while (!row
->mode_line_p
14795 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14796 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14797 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14798 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14799 row
> w
->current_matrix
->rows
14800 && (row
-1)->ends_in_newline_from_string_p
))))
14801 && (row
->y
> top_scroll_margin
14802 || CHARPOS (startp
) == BEGV
))
14804 xassert (row
->enabled_p
);
14808 /* Consider the following case: Window starts at BEGV,
14809 there is invisible, intangible text at BEGV, so that
14810 display starts at some point START > BEGV. It can
14811 happen that we are called with PT somewhere between
14812 BEGV and START. Try to handle that case. */
14813 if (row
< w
->current_matrix
->rows
14814 || row
->mode_line_p
)
14816 row
= w
->current_matrix
->rows
;
14817 if (row
->mode_line_p
)
14821 /* Due to newlines in overlay strings, we may have to
14822 skip forward over overlay strings. */
14823 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14824 && MATRIX_ROW_END_CHARPOS (row
) == PT
14825 && !cursor_row_p (row
))
14828 /* If within the scroll margin, scroll. */
14829 if (row
->y
< top_scroll_margin
14830 && CHARPOS (startp
) != BEGV
)
14835 /* Cursor did not move. So don't scroll even if cursor line
14836 is partially visible, as it was so before. */
14837 rc
= CURSOR_MOVEMENT_SUCCESS
;
14840 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14841 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14843 /* if PT is not in the glyph row, give up. */
14844 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14847 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14848 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14850 /* If rows are bidi-reordered and point moved, back up
14851 until we find a row that does not belong to a
14852 continuation line. This is because we must consider
14853 all rows of a continued line as candidates for the
14854 new cursor positioning, since row start and end
14855 positions change non-linearly with vertical position
14857 /* FIXME: Revisit this when glyph ``spilling'' in
14858 continuation lines' rows is implemented for
14859 bidi-reordered rows. */
14860 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14862 /* If we hit the beginning of the displayed portion
14863 without finding the first row of a continued
14865 if (row
<= w
->current_matrix
->rows
)
14867 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14870 xassert (row
->enabled_p
);
14876 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14877 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14878 && make_cursor_line_fully_visible_p
)
14880 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14881 && !row
->ends_at_zv_p
14882 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14883 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14884 else if (row
->height
> window_box_height (w
))
14886 /* If we end up in a partially visible line, let's
14887 make it fully visible, except when it's taller
14888 than the window, in which case we can't do much
14891 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14895 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14896 if (!cursor_row_fully_visible_p (w
, 0, 1))
14897 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14899 rc
= CURSOR_MOVEMENT_SUCCESS
;
14903 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14904 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14905 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14907 /* With bidi-reordered rows, there could be more than
14908 one candidate row whose start and end positions
14909 occlude point. We need to let set_cursor_from_row
14910 find the best candidate. */
14911 /* FIXME: Revisit this when glyph ``spilling'' in
14912 continuation lines' rows is implemented for
14913 bidi-reordered rows. */
14918 int at_zv_p
= 0, exact_match_p
= 0;
14920 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14921 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14922 && cursor_row_p (row
))
14923 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14925 /* As soon as we've found the exact match for point,
14926 or the first suitable row whose ends_at_zv_p flag
14927 is set, we are done. */
14929 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14931 && w
->cursor
.hpos
>= 0
14932 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14935 struct glyph_row
*candidate
=
14936 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14938 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14939 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14942 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14943 || (INTEGERP (g
->object
)
14944 && (g
->charpos
== PT
14945 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14947 if (rv
&& (at_zv_p
|| exact_match_p
))
14949 rc
= CURSOR_MOVEMENT_SUCCESS
;
14952 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14956 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14957 || row
->continued_p
)
14958 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14959 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14960 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14961 /* If we didn't find any candidate rows, or exited the
14962 loop before all the candidates were examined, signal
14963 to the caller that this method failed. */
14964 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14966 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14967 && !row
->continued_p
))
14968 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14970 rc
= CURSOR_MOVEMENT_SUCCESS
;
14976 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14978 rc
= CURSOR_MOVEMENT_SUCCESS
;
14983 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14984 && MATRIX_ROW_START_CHARPOS (row
) == PT
14985 && cursor_row_p (row
));
14993 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14997 set_vertical_scroll_bar (struct window
*w
)
14999 EMACS_INT start
, end
, whole
;
15001 /* Calculate the start and end positions for the current window.
15002 At some point, it would be nice to choose between scrollbars
15003 which reflect the whole buffer size, with special markers
15004 indicating narrowing, and scrollbars which reflect only the
15007 Note that mini-buffers sometimes aren't displaying any text. */
15008 if (!MINI_WINDOW_P (w
)
15009 || (w
== XWINDOW (minibuf_window
)
15010 && NILP (echo_area_buffer
[0])))
15012 struct buffer
*buf
= XBUFFER (w
->buffer
);
15013 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15014 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15015 /* I don't think this is guaranteed to be right. For the
15016 moment, we'll pretend it is. */
15017 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15021 if (whole
< (end
- start
))
15022 whole
= end
- start
;
15025 start
= end
= whole
= 0;
15027 /* Indicate what this scroll bar ought to be displaying now. */
15028 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15029 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15030 (w
, end
- start
, whole
, start
);
15034 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15035 selected_window is redisplayed.
15037 We can return without actually redisplaying the window if
15038 fonts_changed_p is nonzero. In that case, redisplay_internal will
15042 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15044 struct window
*w
= XWINDOW (window
);
15045 struct frame
*f
= XFRAME (w
->frame
);
15046 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15047 struct buffer
*old
= current_buffer
;
15048 struct text_pos lpoint
, opoint
, startp
;
15049 int update_mode_line
;
15052 /* Record it now because it's overwritten. */
15053 int current_matrix_up_to_date_p
= 0;
15054 int used_current_matrix_p
= 0;
15055 /* This is less strict than current_matrix_up_to_date_p.
15056 It indicates that the buffer contents and narrowing are unchanged. */
15057 int buffer_unchanged_p
= 0;
15058 int temp_scroll_step
= 0;
15059 int count
= SPECPDL_INDEX ();
15061 int centering_position
= -1;
15062 int last_line_misfit
= 0;
15063 EMACS_INT beg_unchanged
, end_unchanged
;
15065 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15068 /* W must be a leaf window here. */
15069 xassert (!NILP (w
->buffer
));
15071 *w
->desired_matrix
->method
= 0;
15075 reconsider_clip_changes (w
, buffer
);
15077 /* Has the mode line to be updated? */
15078 update_mode_line
= (!NILP (w
->update_mode_line
)
15079 || update_mode_lines
15080 || buffer
->clip_changed
15081 || buffer
->prevent_redisplay_optimizations_p
);
15083 if (MINI_WINDOW_P (w
))
15085 if (w
== XWINDOW (echo_area_window
)
15086 && !NILP (echo_area_buffer
[0]))
15088 if (update_mode_line
)
15089 /* We may have to update a tty frame's menu bar or a
15090 tool-bar. Example `M-x C-h C-h C-g'. */
15091 goto finish_menu_bars
;
15093 /* We've already displayed the echo area glyphs in this window. */
15094 goto finish_scroll_bars
;
15096 else if ((w
!= XWINDOW (minibuf_window
)
15097 || minibuf_level
== 0)
15098 /* When buffer is nonempty, redisplay window normally. */
15099 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15100 /* Quail displays non-mini buffers in minibuffer window.
15101 In that case, redisplay the window normally. */
15102 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15104 /* W is a mini-buffer window, but it's not active, so clear
15106 int yb
= window_text_bottom_y (w
);
15107 struct glyph_row
*row
;
15110 for (y
= 0, row
= w
->desired_matrix
->rows
;
15112 y
+= row
->height
, ++row
)
15113 blank_row (w
, row
, y
);
15114 goto finish_scroll_bars
;
15117 clear_glyph_matrix (w
->desired_matrix
);
15120 /* Otherwise set up data on this window; select its buffer and point
15122 /* Really select the buffer, for the sake of buffer-local
15124 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15126 current_matrix_up_to_date_p
15127 = (!NILP (w
->window_end_valid
)
15128 && !current_buffer
->clip_changed
15129 && !current_buffer
->prevent_redisplay_optimizations_p
15130 && XFASTINT (w
->last_modified
) >= MODIFF
15131 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15133 /* Run the window-bottom-change-functions
15134 if it is possible that the text on the screen has changed
15135 (either due to modification of the text, or any other reason). */
15136 if (!current_matrix_up_to_date_p
15137 && !NILP (Vwindow_text_change_functions
))
15139 safe_run_hooks (Qwindow_text_change_functions
);
15143 beg_unchanged
= BEG_UNCHANGED
;
15144 end_unchanged
= END_UNCHANGED
;
15146 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15148 specbind (Qinhibit_point_motion_hooks
, Qt
);
15151 = (!NILP (w
->window_end_valid
)
15152 && !current_buffer
->clip_changed
15153 && XFASTINT (w
->last_modified
) >= MODIFF
15154 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15156 /* When windows_or_buffers_changed is non-zero, we can't rely on
15157 the window end being valid, so set it to nil there. */
15158 if (windows_or_buffers_changed
)
15160 /* If window starts on a continuation line, maybe adjust the
15161 window start in case the window's width changed. */
15162 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15163 compute_window_start_on_continuation_line (w
);
15165 w
->window_end_valid
= Qnil
;
15168 /* Some sanity checks. */
15169 CHECK_WINDOW_END (w
);
15170 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15172 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15175 /* If %c is in mode line, update it if needed. */
15176 if (!NILP (w
->column_number_displayed
)
15177 /* This alternative quickly identifies a common case
15178 where no change is needed. */
15179 && !(PT
== XFASTINT (w
->last_point
)
15180 && XFASTINT (w
->last_modified
) >= MODIFF
15181 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15182 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15183 update_mode_line
= 1;
15185 /* Count number of windows showing the selected buffer. An indirect
15186 buffer counts as its base buffer. */
15187 if (!just_this_one_p
)
15189 struct buffer
*current_base
, *window_base
;
15190 current_base
= current_buffer
;
15191 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15192 if (current_base
->base_buffer
)
15193 current_base
= current_base
->base_buffer
;
15194 if (window_base
->base_buffer
)
15195 window_base
= window_base
->base_buffer
;
15196 if (current_base
== window_base
)
15200 /* Point refers normally to the selected window. For any other
15201 window, set up appropriate value. */
15202 if (!EQ (window
, selected_window
))
15204 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15205 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15209 new_pt_byte
= BEGV_BYTE
;
15210 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15212 else if (new_pt
> (ZV
- 1))
15215 new_pt_byte
= ZV_BYTE
;
15216 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15219 /* We don't use SET_PT so that the point-motion hooks don't run. */
15220 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15223 /* If any of the character widths specified in the display table
15224 have changed, invalidate the width run cache. It's true that
15225 this may be a bit late to catch such changes, but the rest of
15226 redisplay goes (non-fatally) haywire when the display table is
15227 changed, so why should we worry about doing any better? */
15228 if (current_buffer
->width_run_cache
)
15230 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15232 if (! disptab_matches_widthtab (disptab
,
15233 XVECTOR (BVAR (current_buffer
, width_table
))))
15235 invalidate_region_cache (current_buffer
,
15236 current_buffer
->width_run_cache
,
15238 recompute_width_table (current_buffer
, disptab
);
15242 /* If window-start is screwed up, choose a new one. */
15243 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15246 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15248 /* If someone specified a new starting point but did not insist,
15249 check whether it can be used. */
15250 if (!NILP (w
->optional_new_start
)
15251 && CHARPOS (startp
) >= BEGV
15252 && CHARPOS (startp
) <= ZV
)
15254 w
->optional_new_start
= Qnil
;
15255 start_display (&it
, w
, startp
);
15256 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15257 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15258 if (IT_CHARPOS (it
) == PT
)
15259 w
->force_start
= Qt
;
15260 /* IT may overshoot PT if text at PT is invisible. */
15261 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15262 w
->force_start
= Qt
;
15267 /* Handle case where place to start displaying has been specified,
15268 unless the specified location is outside the accessible range. */
15269 if (!NILP (w
->force_start
)
15270 || w
->frozen_window_start_p
)
15272 /* We set this later on if we have to adjust point. */
15275 w
->force_start
= Qnil
;
15277 w
->window_end_valid
= Qnil
;
15279 /* Forget any recorded base line for line number display. */
15280 if (!buffer_unchanged_p
)
15281 w
->base_line_number
= Qnil
;
15283 /* Redisplay the mode line. Select the buffer properly for that.
15284 Also, run the hook window-scroll-functions
15285 because we have scrolled. */
15286 /* Note, we do this after clearing force_start because
15287 if there's an error, it is better to forget about force_start
15288 than to get into an infinite loop calling the hook functions
15289 and having them get more errors. */
15290 if (!update_mode_line
15291 || ! NILP (Vwindow_scroll_functions
))
15293 update_mode_line
= 1;
15294 w
->update_mode_line
= Qt
;
15295 startp
= run_window_scroll_functions (window
, startp
);
15298 w
->last_modified
= make_number (0);
15299 w
->last_overlay_modified
= make_number (0);
15300 if (CHARPOS (startp
) < BEGV
)
15301 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15302 else if (CHARPOS (startp
) > ZV
)
15303 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15305 /* Redisplay, then check if cursor has been set during the
15306 redisplay. Give up if new fonts were loaded. */
15307 /* We used to issue a CHECK_MARGINS argument to try_window here,
15308 but this causes scrolling to fail when point begins inside
15309 the scroll margin (bug#148) -- cyd */
15310 if (!try_window (window
, startp
, 0))
15312 w
->force_start
= Qt
;
15313 clear_glyph_matrix (w
->desired_matrix
);
15314 goto need_larger_matrices
;
15317 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15319 /* If point does not appear, try to move point so it does
15320 appear. The desired matrix has been built above, so we
15321 can use it here. */
15322 new_vpos
= window_box_height (w
) / 2;
15325 if (!cursor_row_fully_visible_p (w
, 0, 0))
15327 /* Point does appear, but on a line partly visible at end of window.
15328 Move it back to a fully-visible line. */
15329 new_vpos
= window_box_height (w
);
15332 /* If we need to move point for either of the above reasons,
15333 now actually do it. */
15336 struct glyph_row
*row
;
15338 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15339 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15342 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15343 MATRIX_ROW_START_BYTEPOS (row
));
15345 if (w
!= XWINDOW (selected_window
))
15346 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15347 else if (current_buffer
== old
)
15348 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15350 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15352 /* If we are highlighting the region, then we just changed
15353 the region, so redisplay to show it. */
15354 if (!NILP (Vtransient_mark_mode
)
15355 && !NILP (BVAR (current_buffer
, mark_active
)))
15357 clear_glyph_matrix (w
->desired_matrix
);
15358 if (!try_window (window
, startp
, 0))
15359 goto need_larger_matrices
;
15364 debug_method_add (w
, "forced window start");
15369 /* Handle case where text has not changed, only point, and it has
15370 not moved off the frame, and we are not retrying after hscroll.
15371 (current_matrix_up_to_date_p is nonzero when retrying.) */
15372 if (current_matrix_up_to_date_p
15373 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15374 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15378 case CURSOR_MOVEMENT_SUCCESS
:
15379 used_current_matrix_p
= 1;
15382 case CURSOR_MOVEMENT_MUST_SCROLL
:
15383 goto try_to_scroll
;
15389 /* If current starting point was originally the beginning of a line
15390 but no longer is, find a new starting point. */
15391 else if (!NILP (w
->start_at_line_beg
)
15392 && !(CHARPOS (startp
) <= BEGV
15393 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15396 debug_method_add (w
, "recenter 1");
15401 /* Try scrolling with try_window_id. Value is > 0 if update has
15402 been done, it is -1 if we know that the same window start will
15403 not work. It is 0 if unsuccessful for some other reason. */
15404 else if ((tem
= try_window_id (w
)) != 0)
15407 debug_method_add (w
, "try_window_id %d", tem
);
15410 if (fonts_changed_p
)
15411 goto need_larger_matrices
;
15415 /* Otherwise try_window_id has returned -1 which means that we
15416 don't want the alternative below this comment to execute. */
15418 else if (CHARPOS (startp
) >= BEGV
15419 && CHARPOS (startp
) <= ZV
15420 && PT
>= CHARPOS (startp
)
15421 && (CHARPOS (startp
) < ZV
15422 /* Avoid starting at end of buffer. */
15423 || CHARPOS (startp
) == BEGV
15424 || (XFASTINT (w
->last_modified
) >= MODIFF
15425 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15427 int d1
, d2
, d3
, d4
, d5
, d6
;
15429 /* If first window line is a continuation line, and window start
15430 is inside the modified region, but the first change is before
15431 current window start, we must select a new window start.
15433 However, if this is the result of a down-mouse event (e.g. by
15434 extending the mouse-drag-overlay), we don't want to select a
15435 new window start, since that would change the position under
15436 the mouse, resulting in an unwanted mouse-movement rather
15437 than a simple mouse-click. */
15438 if (NILP (w
->start_at_line_beg
)
15439 && NILP (do_mouse_tracking
)
15440 && CHARPOS (startp
) > BEGV
15441 && CHARPOS (startp
) > BEG
+ beg_unchanged
15442 && CHARPOS (startp
) <= Z
- end_unchanged
15443 /* Even if w->start_at_line_beg is nil, a new window may
15444 start at a line_beg, since that's how set_buffer_window
15445 sets it. So, we need to check the return value of
15446 compute_window_start_on_continuation_line. (See also
15448 && XMARKER (w
->start
)->buffer
== current_buffer
15449 && compute_window_start_on_continuation_line (w
)
15450 /* It doesn't make sense to force the window start like we
15451 do at label force_start if it is already known that point
15452 will not be visible in the resulting window, because
15453 doing so will move point from its correct position
15454 instead of scrolling the window to bring point into view.
15456 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15458 w
->force_start
= Qt
;
15459 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15464 debug_method_add (w
, "same window start");
15467 /* Try to redisplay starting at same place as before.
15468 If point has not moved off frame, accept the results. */
15469 if (!current_matrix_up_to_date_p
15470 /* Don't use try_window_reusing_current_matrix in this case
15471 because a window scroll function can have changed the
15473 || !NILP (Vwindow_scroll_functions
)
15474 || MINI_WINDOW_P (w
)
15475 || !(used_current_matrix_p
15476 = try_window_reusing_current_matrix (w
)))
15478 IF_DEBUG (debug_method_add (w
, "1"));
15479 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15480 /* -1 means we need to scroll.
15481 0 means we need new matrices, but fonts_changed_p
15482 is set in that case, so we will detect it below. */
15483 goto try_to_scroll
;
15486 if (fonts_changed_p
)
15487 goto need_larger_matrices
;
15489 if (w
->cursor
.vpos
>= 0)
15491 if (!just_this_one_p
15492 || current_buffer
->clip_changed
15493 || BEG_UNCHANGED
< CHARPOS (startp
))
15494 /* Forget any recorded base line for line number display. */
15495 w
->base_line_number
= Qnil
;
15497 if (!cursor_row_fully_visible_p (w
, 1, 0))
15499 clear_glyph_matrix (w
->desired_matrix
);
15500 last_line_misfit
= 1;
15502 /* Drop through and scroll. */
15507 clear_glyph_matrix (w
->desired_matrix
);
15512 w
->last_modified
= make_number (0);
15513 w
->last_overlay_modified
= make_number (0);
15515 /* Redisplay the mode line. Select the buffer properly for that. */
15516 if (!update_mode_line
)
15518 update_mode_line
= 1;
15519 w
->update_mode_line
= Qt
;
15522 /* Try to scroll by specified few lines. */
15523 if ((scroll_conservatively
15524 || emacs_scroll_step
15525 || temp_scroll_step
15526 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15527 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15528 && CHARPOS (startp
) >= BEGV
15529 && CHARPOS (startp
) <= ZV
)
15531 /* The function returns -1 if new fonts were loaded, 1 if
15532 successful, 0 if not successful. */
15533 int ss
= try_scrolling (window
, just_this_one_p
,
15534 scroll_conservatively
,
15536 temp_scroll_step
, last_line_misfit
);
15539 case SCROLLING_SUCCESS
:
15542 case SCROLLING_NEED_LARGER_MATRICES
:
15543 goto need_larger_matrices
;
15545 case SCROLLING_FAILED
:
15553 /* Finally, just choose a place to start which positions point
15554 according to user preferences. */
15559 debug_method_add (w
, "recenter");
15562 /* w->vscroll = 0; */
15564 /* Forget any previously recorded base line for line number display. */
15565 if (!buffer_unchanged_p
)
15566 w
->base_line_number
= Qnil
;
15568 /* Determine the window start relative to point. */
15569 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15570 it
.current_y
= it
.last_visible_y
;
15571 if (centering_position
< 0)
15575 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15577 EMACS_INT margin_pos
= CHARPOS (startp
);
15578 Lisp_Object aggressive
;
15581 /* If there is a scroll margin at the top of the window, find
15582 its character position. */
15584 /* Cannot call start_display if startp is not in the
15585 accessible region of the buffer. This can happen when we
15586 have just switched to a different buffer and/or changed
15587 its restriction. In that case, startp is initialized to
15588 the character position 1 (BEG) because we did not yet
15589 have chance to display the buffer even once. */
15590 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15593 void *it1data
= NULL
;
15595 SAVE_IT (it1
, it
, it1data
);
15596 start_display (&it1
, w
, startp
);
15597 move_it_vertically (&it1
, margin
);
15598 margin_pos
= IT_CHARPOS (it1
);
15599 RESTORE_IT (&it
, &it
, it1data
);
15601 scrolling_up
= PT
> margin_pos
;
15604 ? BVAR (current_buffer
, scroll_up_aggressively
)
15605 : BVAR (current_buffer
, scroll_down_aggressively
);
15607 if (!MINI_WINDOW_P (w
)
15608 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15612 /* Setting scroll-conservatively overrides
15613 scroll-*-aggressively. */
15614 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15616 double float_amount
= XFLOATINT (aggressive
);
15618 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15619 if (pt_offset
== 0 && float_amount
> 0)
15621 if (pt_offset
&& margin
> 0)
15624 /* Compute how much to move the window start backward from
15625 point so that point will be displayed where the user
15629 centering_position
= it
.last_visible_y
;
15631 centering_position
-= pt_offset
;
15632 centering_position
-=
15633 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15634 + WINDOW_HEADER_LINE_HEIGHT (w
);
15635 /* Don't let point enter the scroll margin near top of
15637 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15638 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15641 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15644 /* Set the window start half the height of the window backward
15646 centering_position
= window_box_height (w
) / 2;
15648 move_it_vertically_backward (&it
, centering_position
);
15650 xassert (IT_CHARPOS (it
) >= BEGV
);
15652 /* The function move_it_vertically_backward may move over more
15653 than the specified y-distance. If it->w is small, e.g. a
15654 mini-buffer window, we may end up in front of the window's
15655 display area. Start displaying at the start of the line
15656 containing PT in this case. */
15657 if (it
.current_y
<= 0)
15659 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15660 move_it_vertically_backward (&it
, 0);
15664 it
.current_x
= it
.hpos
= 0;
15666 /* Set the window start position here explicitly, to avoid an
15667 infinite loop in case the functions in window-scroll-functions
15669 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15671 /* Run scroll hooks. */
15672 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15674 /* Redisplay the window. */
15675 if (!current_matrix_up_to_date_p
15676 || windows_or_buffers_changed
15677 || cursor_type_changed
15678 /* Don't use try_window_reusing_current_matrix in this case
15679 because it can have changed the buffer. */
15680 || !NILP (Vwindow_scroll_functions
)
15681 || !just_this_one_p
15682 || MINI_WINDOW_P (w
)
15683 || !(used_current_matrix_p
15684 = try_window_reusing_current_matrix (w
)))
15685 try_window (window
, startp
, 0);
15687 /* If new fonts have been loaded (due to fontsets), give up. We
15688 have to start a new redisplay since we need to re-adjust glyph
15690 if (fonts_changed_p
)
15691 goto need_larger_matrices
;
15693 /* If cursor did not appear assume that the middle of the window is
15694 in the first line of the window. Do it again with the next line.
15695 (Imagine a window of height 100, displaying two lines of height
15696 60. Moving back 50 from it->last_visible_y will end in the first
15698 if (w
->cursor
.vpos
< 0)
15700 if (!NILP (w
->window_end_valid
)
15701 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15703 clear_glyph_matrix (w
->desired_matrix
);
15704 move_it_by_lines (&it
, 1);
15705 try_window (window
, it
.current
.pos
, 0);
15707 else if (PT
< IT_CHARPOS (it
))
15709 clear_glyph_matrix (w
->desired_matrix
);
15710 move_it_by_lines (&it
, -1);
15711 try_window (window
, it
.current
.pos
, 0);
15715 /* Not much we can do about it. */
15719 /* Consider the following case: Window starts at BEGV, there is
15720 invisible, intangible text at BEGV, so that display starts at
15721 some point START > BEGV. It can happen that we are called with
15722 PT somewhere between BEGV and START. Try to handle that case. */
15723 if (w
->cursor
.vpos
< 0)
15725 struct glyph_row
*row
= w
->current_matrix
->rows
;
15726 if (row
->mode_line_p
)
15728 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15731 if (!cursor_row_fully_visible_p (w
, 0, 0))
15733 /* If vscroll is enabled, disable it and try again. */
15737 clear_glyph_matrix (w
->desired_matrix
);
15741 /* Users who set scroll-conservatively to a large number want
15742 point just above/below the scroll margin. If we ended up
15743 with point's row partially visible, move the window start to
15744 make that row fully visible and out of the margin. */
15745 if (scroll_conservatively
> SCROLL_LIMIT
)
15749 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15751 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15753 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15754 clear_glyph_matrix (w
->desired_matrix
);
15755 if (1 == try_window (window
, it
.current
.pos
,
15756 TRY_WINDOW_CHECK_MARGINS
))
15760 /* If centering point failed to make the whole line visible,
15761 put point at the top instead. That has to make the whole line
15762 visible, if it can be done. */
15763 if (centering_position
== 0)
15766 clear_glyph_matrix (w
->desired_matrix
);
15767 centering_position
= 0;
15773 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15774 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15775 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15778 /* Display the mode line, if we must. */
15779 if ((update_mode_line
15780 /* If window not full width, must redo its mode line
15781 if (a) the window to its side is being redone and
15782 (b) we do a frame-based redisplay. This is a consequence
15783 of how inverted lines are drawn in frame-based redisplay. */
15784 || (!just_this_one_p
15785 && !FRAME_WINDOW_P (f
)
15786 && !WINDOW_FULL_WIDTH_P (w
))
15787 /* Line number to display. */
15788 || INTEGERP (w
->base_line_pos
)
15789 /* Column number is displayed and different from the one displayed. */
15790 || (!NILP (w
->column_number_displayed
)
15791 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15792 /* This means that the window has a mode line. */
15793 && (WINDOW_WANTS_MODELINE_P (w
)
15794 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15796 display_mode_lines (w
);
15798 /* If mode line height has changed, arrange for a thorough
15799 immediate redisplay using the correct mode line height. */
15800 if (WINDOW_WANTS_MODELINE_P (w
)
15801 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15803 fonts_changed_p
= 1;
15804 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15805 = DESIRED_MODE_LINE_HEIGHT (w
);
15808 /* If header line height has changed, arrange for a thorough
15809 immediate redisplay using the correct header line height. */
15810 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15811 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15813 fonts_changed_p
= 1;
15814 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15815 = DESIRED_HEADER_LINE_HEIGHT (w
);
15818 if (fonts_changed_p
)
15819 goto need_larger_matrices
;
15822 if (!line_number_displayed
15823 && !BUFFERP (w
->base_line_pos
))
15825 w
->base_line_pos
= Qnil
;
15826 w
->base_line_number
= Qnil
;
15831 /* When we reach a frame's selected window, redo the frame's menu bar. */
15832 if (update_mode_line
15833 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15835 int redisplay_menu_p
= 0;
15837 if (FRAME_WINDOW_P (f
))
15839 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15840 || defined (HAVE_NS) || defined (USE_GTK)
15841 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15843 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15847 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15849 if (redisplay_menu_p
)
15850 display_menu_bar (w
);
15852 #ifdef HAVE_WINDOW_SYSTEM
15853 if (FRAME_WINDOW_P (f
))
15855 #if defined (USE_GTK) || defined (HAVE_NS)
15856 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15857 redisplay_tool_bar (f
);
15859 if (WINDOWP (f
->tool_bar_window
)
15860 && (FRAME_TOOL_BAR_LINES (f
) > 0
15861 || !NILP (Vauto_resize_tool_bars
))
15862 && redisplay_tool_bar (f
))
15863 ignore_mouse_drag_p
= 1;
15869 #ifdef HAVE_WINDOW_SYSTEM
15870 if (FRAME_WINDOW_P (f
)
15871 && update_window_fringes (w
, (just_this_one_p
15872 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15873 || w
->pseudo_window_p
)))
15877 if (draw_window_fringes (w
, 1))
15878 x_draw_vertical_border (w
);
15882 #endif /* HAVE_WINDOW_SYSTEM */
15884 /* We go to this label, with fonts_changed_p nonzero,
15885 if it is necessary to try again using larger glyph matrices.
15886 We have to redeem the scroll bar even in this case,
15887 because the loop in redisplay_internal expects that. */
15888 need_larger_matrices
:
15890 finish_scroll_bars
:
15892 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15894 /* Set the thumb's position and size. */
15895 set_vertical_scroll_bar (w
);
15897 /* Note that we actually used the scroll bar attached to this
15898 window, so it shouldn't be deleted at the end of redisplay. */
15899 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15900 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15903 /* Restore current_buffer and value of point in it. The window
15904 update may have changed the buffer, so first make sure `opoint'
15905 is still valid (Bug#6177). */
15906 if (CHARPOS (opoint
) < BEGV
)
15907 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15908 else if (CHARPOS (opoint
) > ZV
)
15909 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15911 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15913 set_buffer_internal_1 (old
);
15914 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15915 shorter. This can be caused by log truncation in *Messages*. */
15916 if (CHARPOS (lpoint
) <= ZV
)
15917 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15919 unbind_to (count
, Qnil
);
15923 /* Build the complete desired matrix of WINDOW with a window start
15924 buffer position POS.
15926 Value is 1 if successful. It is zero if fonts were loaded during
15927 redisplay which makes re-adjusting glyph matrices necessary, and -1
15928 if point would appear in the scroll margins.
15929 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15930 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15934 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15936 struct window
*w
= XWINDOW (window
);
15938 struct glyph_row
*last_text_row
= NULL
;
15939 struct frame
*f
= XFRAME (w
->frame
);
15941 /* Make POS the new window start. */
15942 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15944 /* Mark cursor position as unknown. No overlay arrow seen. */
15945 w
->cursor
.vpos
= -1;
15946 overlay_arrow_seen
= 0;
15948 /* Initialize iterator and info to start at POS. */
15949 start_display (&it
, w
, pos
);
15951 /* Display all lines of W. */
15952 while (it
.current_y
< it
.last_visible_y
)
15954 if (display_line (&it
))
15955 last_text_row
= it
.glyph_row
- 1;
15956 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15960 /* Don't let the cursor end in the scroll margins. */
15961 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15962 && !MINI_WINDOW_P (w
))
15964 int this_scroll_margin
;
15966 if (scroll_margin
> 0)
15968 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15969 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15972 this_scroll_margin
= 0;
15974 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15975 && w
->cursor
.y
< this_scroll_margin
15976 && CHARPOS (pos
) > BEGV
15977 && IT_CHARPOS (it
) < ZV
)
15978 /* rms: considering make_cursor_line_fully_visible_p here
15979 seems to give wrong results. We don't want to recenter
15980 when the last line is partly visible, we want to allow
15981 that case to be handled in the usual way. */
15982 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15984 w
->cursor
.vpos
= -1;
15985 clear_glyph_matrix (w
->desired_matrix
);
15990 /* If bottom moved off end of frame, change mode line percentage. */
15991 if (XFASTINT (w
->window_end_pos
) <= 0
15992 && Z
!= IT_CHARPOS (it
))
15993 w
->update_mode_line
= Qt
;
15995 /* Set window_end_pos to the offset of the last character displayed
15996 on the window from the end of current_buffer. Set
15997 window_end_vpos to its row number. */
16000 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16001 w
->window_end_bytepos
16002 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16004 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16006 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16007 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16008 ->displays_text_p
);
16012 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16013 w
->window_end_pos
= make_number (Z
- ZV
);
16014 w
->window_end_vpos
= make_number (0);
16017 /* But that is not valid info until redisplay finishes. */
16018 w
->window_end_valid
= Qnil
;
16024 /************************************************************************
16025 Window redisplay reusing current matrix when buffer has not changed
16026 ************************************************************************/
16028 /* Try redisplay of window W showing an unchanged buffer with a
16029 different window start than the last time it was displayed by
16030 reusing its current matrix. Value is non-zero if successful.
16031 W->start is the new window start. */
16034 try_window_reusing_current_matrix (struct window
*w
)
16036 struct frame
*f
= XFRAME (w
->frame
);
16037 struct glyph_row
*bottom_row
;
16040 struct text_pos start
, new_start
;
16041 int nrows_scrolled
, i
;
16042 struct glyph_row
*last_text_row
;
16043 struct glyph_row
*last_reused_text_row
;
16044 struct glyph_row
*start_row
;
16045 int start_vpos
, min_y
, max_y
;
16048 if (inhibit_try_window_reusing
)
16052 if (/* This function doesn't handle terminal frames. */
16053 !FRAME_WINDOW_P (f
)
16054 /* Don't try to reuse the display if windows have been split
16056 || windows_or_buffers_changed
16057 || cursor_type_changed
)
16060 /* Can't do this if region may have changed. */
16061 if ((!NILP (Vtransient_mark_mode
)
16062 && !NILP (BVAR (current_buffer
, mark_active
)))
16063 || !NILP (w
->region_showing
)
16064 || !NILP (Vshow_trailing_whitespace
))
16067 /* If top-line visibility has changed, give up. */
16068 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16069 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16072 /* Give up if old or new display is scrolled vertically. We could
16073 make this function handle this, but right now it doesn't. */
16074 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16075 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16078 /* The variable new_start now holds the new window start. The old
16079 start `start' can be determined from the current matrix. */
16080 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16081 start
= start_row
->minpos
;
16082 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16084 /* Clear the desired matrix for the display below. */
16085 clear_glyph_matrix (w
->desired_matrix
);
16087 if (CHARPOS (new_start
) <= CHARPOS (start
))
16089 /* Don't use this method if the display starts with an ellipsis
16090 displayed for invisible text. It's not easy to handle that case
16091 below, and it's certainly not worth the effort since this is
16092 not a frequent case. */
16093 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16096 IF_DEBUG (debug_method_add (w
, "twu1"));
16098 /* Display up to a row that can be reused. The variable
16099 last_text_row is set to the last row displayed that displays
16100 text. Note that it.vpos == 0 if or if not there is a
16101 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16102 start_display (&it
, w
, new_start
);
16103 w
->cursor
.vpos
= -1;
16104 last_text_row
= last_reused_text_row
= NULL
;
16106 while (it
.current_y
< it
.last_visible_y
16107 && !fonts_changed_p
)
16109 /* If we have reached into the characters in the START row,
16110 that means the line boundaries have changed. So we
16111 can't start copying with the row START. Maybe it will
16112 work to start copying with the following row. */
16113 while (IT_CHARPOS (it
) > CHARPOS (start
))
16115 /* Advance to the next row as the "start". */
16117 start
= start_row
->minpos
;
16118 /* If there are no more rows to try, or just one, give up. */
16119 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16120 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16121 || CHARPOS (start
) == ZV
)
16123 clear_glyph_matrix (w
->desired_matrix
);
16127 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16129 /* If we have reached alignment, we can copy the rest of the
16131 if (IT_CHARPOS (it
) == CHARPOS (start
)
16132 /* Don't accept "alignment" inside a display vector,
16133 since start_row could have started in the middle of
16134 that same display vector (thus their character
16135 positions match), and we have no way of telling if
16136 that is the case. */
16137 && it
.current
.dpvec_index
< 0)
16140 if (display_line (&it
))
16141 last_text_row
= it
.glyph_row
- 1;
16145 /* A value of current_y < last_visible_y means that we stopped
16146 at the previous window start, which in turn means that we
16147 have at least one reusable row. */
16148 if (it
.current_y
< it
.last_visible_y
)
16150 struct glyph_row
*row
;
16152 /* IT.vpos always starts from 0; it counts text lines. */
16153 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16155 /* Find PT if not already found in the lines displayed. */
16156 if (w
->cursor
.vpos
< 0)
16158 int dy
= it
.current_y
- start_row
->y
;
16160 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16161 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16163 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16164 dy
, nrows_scrolled
);
16167 clear_glyph_matrix (w
->desired_matrix
);
16172 /* Scroll the display. Do it before the current matrix is
16173 changed. The problem here is that update has not yet
16174 run, i.e. part of the current matrix is not up to date.
16175 scroll_run_hook will clear the cursor, and use the
16176 current matrix to get the height of the row the cursor is
16178 run
.current_y
= start_row
->y
;
16179 run
.desired_y
= it
.current_y
;
16180 run
.height
= it
.last_visible_y
- it
.current_y
;
16182 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16185 FRAME_RIF (f
)->update_window_begin_hook (w
);
16186 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16187 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16188 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16192 /* Shift current matrix down by nrows_scrolled lines. */
16193 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16194 rotate_matrix (w
->current_matrix
,
16196 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16199 /* Disable lines that must be updated. */
16200 for (i
= 0; i
< nrows_scrolled
; ++i
)
16201 (start_row
+ i
)->enabled_p
= 0;
16203 /* Re-compute Y positions. */
16204 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16205 max_y
= it
.last_visible_y
;
16206 for (row
= start_row
+ nrows_scrolled
;
16210 row
->y
= it
.current_y
;
16211 row
->visible_height
= row
->height
;
16213 if (row
->y
< min_y
)
16214 row
->visible_height
-= min_y
- row
->y
;
16215 if (row
->y
+ row
->height
> max_y
)
16216 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16217 if (row
->fringe_bitmap_periodic_p
)
16218 row
->redraw_fringe_bitmaps_p
= 1;
16220 it
.current_y
+= row
->height
;
16222 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16223 last_reused_text_row
= row
;
16224 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16228 /* Disable lines in the current matrix which are now
16229 below the window. */
16230 for (++row
; row
< bottom_row
; ++row
)
16231 row
->enabled_p
= row
->mode_line_p
= 0;
16234 /* Update window_end_pos etc.; last_reused_text_row is the last
16235 reused row from the current matrix containing text, if any.
16236 The value of last_text_row is the last displayed line
16237 containing text. */
16238 if (last_reused_text_row
)
16240 w
->window_end_bytepos
16241 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16243 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16245 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16246 w
->current_matrix
));
16248 else if (last_text_row
)
16250 w
->window_end_bytepos
16251 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16253 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16255 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16259 /* This window must be completely empty. */
16260 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16261 w
->window_end_pos
= make_number (Z
- ZV
);
16262 w
->window_end_vpos
= make_number (0);
16264 w
->window_end_valid
= Qnil
;
16266 /* Update hint: don't try scrolling again in update_window. */
16267 w
->desired_matrix
->no_scrolling_p
= 1;
16270 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16274 else if (CHARPOS (new_start
) > CHARPOS (start
))
16276 struct glyph_row
*pt_row
, *row
;
16277 struct glyph_row
*first_reusable_row
;
16278 struct glyph_row
*first_row_to_display
;
16280 int yb
= window_text_bottom_y (w
);
16282 /* Find the row starting at new_start, if there is one. Don't
16283 reuse a partially visible line at the end. */
16284 first_reusable_row
= start_row
;
16285 while (first_reusable_row
->enabled_p
16286 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16287 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16288 < CHARPOS (new_start
)))
16289 ++first_reusable_row
;
16291 /* Give up if there is no row to reuse. */
16292 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16293 || !first_reusable_row
->enabled_p
16294 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16295 != CHARPOS (new_start
)))
16298 /* We can reuse fully visible rows beginning with
16299 first_reusable_row to the end of the window. Set
16300 first_row_to_display to the first row that cannot be reused.
16301 Set pt_row to the row containing point, if there is any. */
16303 for (first_row_to_display
= first_reusable_row
;
16304 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16305 ++first_row_to_display
)
16307 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16308 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16309 pt_row
= first_row_to_display
;
16312 /* Start displaying at the start of first_row_to_display. */
16313 xassert (first_row_to_display
->y
< yb
);
16314 init_to_row_start (&it
, w
, first_row_to_display
);
16316 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16318 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16320 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16321 + WINDOW_HEADER_LINE_HEIGHT (w
));
16323 /* Display lines beginning with first_row_to_display in the
16324 desired matrix. Set last_text_row to the last row displayed
16325 that displays text. */
16326 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16327 if (pt_row
== NULL
)
16328 w
->cursor
.vpos
= -1;
16329 last_text_row
= NULL
;
16330 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16331 if (display_line (&it
))
16332 last_text_row
= it
.glyph_row
- 1;
16334 /* If point is in a reused row, adjust y and vpos of the cursor
16338 w
->cursor
.vpos
-= nrows_scrolled
;
16339 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16342 /* Give up if point isn't in a row displayed or reused. (This
16343 also handles the case where w->cursor.vpos < nrows_scrolled
16344 after the calls to display_line, which can happen with scroll
16345 margins. See bug#1295.) */
16346 if (w
->cursor
.vpos
< 0)
16348 clear_glyph_matrix (w
->desired_matrix
);
16352 /* Scroll the display. */
16353 run
.current_y
= first_reusable_row
->y
;
16354 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16355 run
.height
= it
.last_visible_y
- run
.current_y
;
16356 dy
= run
.current_y
- run
.desired_y
;
16361 FRAME_RIF (f
)->update_window_begin_hook (w
);
16362 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16363 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16364 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16368 /* Adjust Y positions of reused rows. */
16369 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16370 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16371 max_y
= it
.last_visible_y
;
16372 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16375 row
->visible_height
= row
->height
;
16376 if (row
->y
< min_y
)
16377 row
->visible_height
-= min_y
- row
->y
;
16378 if (row
->y
+ row
->height
> max_y
)
16379 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16380 if (row
->fringe_bitmap_periodic_p
)
16381 row
->redraw_fringe_bitmaps_p
= 1;
16384 /* Scroll the current matrix. */
16385 xassert (nrows_scrolled
> 0);
16386 rotate_matrix (w
->current_matrix
,
16388 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16391 /* Disable rows not reused. */
16392 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16393 row
->enabled_p
= 0;
16395 /* Point may have moved to a different line, so we cannot assume that
16396 the previous cursor position is valid; locate the correct row. */
16399 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16400 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16404 w
->cursor
.y
= row
->y
;
16406 if (row
< bottom_row
)
16408 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16409 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16411 /* Can't use this optimization with bidi-reordered glyph
16412 rows, unless cursor is already at point. */
16413 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16415 if (!(w
->cursor
.hpos
>= 0
16416 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16417 && BUFFERP (glyph
->object
)
16418 && glyph
->charpos
== PT
))
16423 && (!BUFFERP (glyph
->object
)
16424 || glyph
->charpos
< PT
);
16428 w
->cursor
.x
+= glyph
->pixel_width
;
16433 /* Adjust window end. A null value of last_text_row means that
16434 the window end is in reused rows which in turn means that
16435 only its vpos can have changed. */
16438 w
->window_end_bytepos
16439 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16441 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16443 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16448 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16451 w
->window_end_valid
= Qnil
;
16452 w
->desired_matrix
->no_scrolling_p
= 1;
16455 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16465 /************************************************************************
16466 Window redisplay reusing current matrix when buffer has changed
16467 ************************************************************************/
16469 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16470 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16471 EMACS_INT
*, EMACS_INT
*);
16472 static struct glyph_row
*
16473 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16474 struct glyph_row
*);
16477 /* Return the last row in MATRIX displaying text. If row START is
16478 non-null, start searching with that row. IT gives the dimensions
16479 of the display. Value is null if matrix is empty; otherwise it is
16480 a pointer to the row found. */
16482 static struct glyph_row
*
16483 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16484 struct glyph_row
*start
)
16486 struct glyph_row
*row
, *row_found
;
16488 /* Set row_found to the last row in IT->w's current matrix
16489 displaying text. The loop looks funny but think of partially
16492 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16493 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16495 xassert (row
->enabled_p
);
16497 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16506 /* Return the last row in the current matrix of W that is not affected
16507 by changes at the start of current_buffer that occurred since W's
16508 current matrix was built. Value is null if no such row exists.
16510 BEG_UNCHANGED us the number of characters unchanged at the start of
16511 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16512 first changed character in current_buffer. Characters at positions <
16513 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16514 when the current matrix was built. */
16516 static struct glyph_row
*
16517 find_last_unchanged_at_beg_row (struct window
*w
)
16519 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16520 struct glyph_row
*row
;
16521 struct glyph_row
*row_found
= NULL
;
16522 int yb
= window_text_bottom_y (w
);
16524 /* Find the last row displaying unchanged text. */
16525 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16526 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16527 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16530 if (/* If row ends before first_changed_pos, it is unchanged,
16531 except in some case. */
16532 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16533 /* When row ends in ZV and we write at ZV it is not
16535 && !row
->ends_at_zv_p
16536 /* When first_changed_pos is the end of a continued line,
16537 row is not unchanged because it may be no longer
16539 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16540 && (row
->continued_p
16541 || row
->exact_window_width_line_p
)))
16544 /* Stop if last visible row. */
16545 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16553 /* Find the first glyph row in the current matrix of W that is not
16554 affected by changes at the end of current_buffer since the
16555 time W's current matrix was built.
16557 Return in *DELTA the number of chars by which buffer positions in
16558 unchanged text at the end of current_buffer must be adjusted.
16560 Return in *DELTA_BYTES the corresponding number of bytes.
16562 Value is null if no such row exists, i.e. all rows are affected by
16565 static struct glyph_row
*
16566 find_first_unchanged_at_end_row (struct window
*w
,
16567 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16569 struct glyph_row
*row
;
16570 struct glyph_row
*row_found
= NULL
;
16572 *delta
= *delta_bytes
= 0;
16574 /* Display must not have been paused, otherwise the current matrix
16575 is not up to date. */
16576 eassert (!NILP (w
->window_end_valid
));
16578 /* A value of window_end_pos >= END_UNCHANGED means that the window
16579 end is in the range of changed text. If so, there is no
16580 unchanged row at the end of W's current matrix. */
16581 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16584 /* Set row to the last row in W's current matrix displaying text. */
16585 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16587 /* If matrix is entirely empty, no unchanged row exists. */
16588 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16590 /* The value of row is the last glyph row in the matrix having a
16591 meaningful buffer position in it. The end position of row
16592 corresponds to window_end_pos. This allows us to translate
16593 buffer positions in the current matrix to current buffer
16594 positions for characters not in changed text. */
16596 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16597 EMACS_INT Z_BYTE_old
=
16598 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16599 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16600 struct glyph_row
*first_text_row
16601 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16603 *delta
= Z
- Z_old
;
16604 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16606 /* Set last_unchanged_pos to the buffer position of the last
16607 character in the buffer that has not been changed. Z is the
16608 index + 1 of the last character in current_buffer, i.e. by
16609 subtracting END_UNCHANGED we get the index of the last
16610 unchanged character, and we have to add BEG to get its buffer
16612 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16613 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16615 /* Search backward from ROW for a row displaying a line that
16616 starts at a minimum position >= last_unchanged_pos_old. */
16617 for (; row
> first_text_row
; --row
)
16619 /* This used to abort, but it can happen.
16620 It is ok to just stop the search instead here. KFS. */
16621 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16624 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16629 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16635 /* Make sure that glyph rows in the current matrix of window W
16636 reference the same glyph memory as corresponding rows in the
16637 frame's frame matrix. This function is called after scrolling W's
16638 current matrix on a terminal frame in try_window_id and
16639 try_window_reusing_current_matrix. */
16642 sync_frame_with_window_matrix_rows (struct window
*w
)
16644 struct frame
*f
= XFRAME (w
->frame
);
16645 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16647 /* Preconditions: W must be a leaf window and full-width. Its frame
16648 must have a frame matrix. */
16649 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16650 xassert (WINDOW_FULL_WIDTH_P (w
));
16651 xassert (!FRAME_WINDOW_P (f
));
16653 /* If W is a full-width window, glyph pointers in W's current matrix
16654 have, by definition, to be the same as glyph pointers in the
16655 corresponding frame matrix. Note that frame matrices have no
16656 marginal areas (see build_frame_matrix). */
16657 window_row
= w
->current_matrix
->rows
;
16658 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16659 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16660 while (window_row
< window_row_end
)
16662 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16663 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16665 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16666 frame_row
->glyphs
[TEXT_AREA
] = start
;
16667 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16668 frame_row
->glyphs
[LAST_AREA
] = end
;
16670 /* Disable frame rows whose corresponding window rows have
16671 been disabled in try_window_id. */
16672 if (!window_row
->enabled_p
)
16673 frame_row
->enabled_p
= 0;
16675 ++window_row
, ++frame_row
;
16680 /* Find the glyph row in window W containing CHARPOS. Consider all
16681 rows between START and END (not inclusive). END null means search
16682 all rows to the end of the display area of W. Value is the row
16683 containing CHARPOS or null. */
16686 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16687 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16689 struct glyph_row
*row
= start
;
16690 struct glyph_row
*best_row
= NULL
;
16691 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16694 /* If we happen to start on a header-line, skip that. */
16695 if (row
->mode_line_p
)
16698 if ((end
&& row
>= end
) || !row
->enabled_p
)
16701 last_y
= window_text_bottom_y (w
) - dy
;
16705 /* Give up if we have gone too far. */
16706 if (end
&& row
>= end
)
16708 /* This formerly returned if they were equal.
16709 I think that both quantities are of a "last plus one" type;
16710 if so, when they are equal, the row is within the screen. -- rms. */
16711 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16714 /* If it is in this row, return this row. */
16715 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16716 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16717 /* The end position of a row equals the start
16718 position of the next row. If CHARPOS is there, we
16719 would rather display it in the next line, except
16720 when this line ends in ZV. */
16721 && !row
->ends_at_zv_p
16722 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16723 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16727 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16728 || (!best_row
&& !row
->continued_p
))
16730 /* In bidi-reordered rows, there could be several rows
16731 occluding point, all of them belonging to the same
16732 continued line. We need to find the row which fits
16733 CHARPOS the best. */
16734 for (g
= row
->glyphs
[TEXT_AREA
];
16735 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16738 if (!STRINGP (g
->object
))
16740 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16742 mindif
= eabs (g
->charpos
- charpos
);
16744 /* Exact match always wins. */
16751 else if (best_row
&& !row
->continued_p
)
16758 /* Try to redisplay window W by reusing its existing display. W's
16759 current matrix must be up to date when this function is called,
16760 i.e. window_end_valid must not be nil.
16764 1 if display has been updated
16765 0 if otherwise unsuccessful
16766 -1 if redisplay with same window start is known not to succeed
16768 The following steps are performed:
16770 1. Find the last row in the current matrix of W that is not
16771 affected by changes at the start of current_buffer. If no such row
16774 2. Find the first row in W's current matrix that is not affected by
16775 changes at the end of current_buffer. Maybe there is no such row.
16777 3. Display lines beginning with the row + 1 found in step 1 to the
16778 row found in step 2 or, if step 2 didn't find a row, to the end of
16781 4. If cursor is not known to appear on the window, give up.
16783 5. If display stopped at the row found in step 2, scroll the
16784 display and current matrix as needed.
16786 6. Maybe display some lines at the end of W, if we must. This can
16787 happen under various circumstances, like a partially visible line
16788 becoming fully visible, or because newly displayed lines are displayed
16789 in smaller font sizes.
16791 7. Update W's window end information. */
16794 try_window_id (struct window
*w
)
16796 struct frame
*f
= XFRAME (w
->frame
);
16797 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16798 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16799 struct glyph_row
*last_unchanged_at_beg_row
;
16800 struct glyph_row
*first_unchanged_at_end_row
;
16801 struct glyph_row
*row
;
16802 struct glyph_row
*bottom_row
;
16805 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16807 struct text_pos start_pos
;
16809 int first_unchanged_at_end_vpos
= 0;
16810 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16811 struct text_pos start
;
16812 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16815 if (inhibit_try_window_id
)
16819 /* This is handy for debugging. */
16821 #define GIVE_UP(X) \
16823 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16827 #define GIVE_UP(X) return 0
16830 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16832 /* Don't use this for mini-windows because these can show
16833 messages and mini-buffers, and we don't handle that here. */
16834 if (MINI_WINDOW_P (w
))
16837 /* This flag is used to prevent redisplay optimizations. */
16838 if (windows_or_buffers_changed
|| cursor_type_changed
)
16841 /* Verify that narrowing has not changed.
16842 Also verify that we were not told to prevent redisplay optimizations.
16843 It would be nice to further
16844 reduce the number of cases where this prevents try_window_id. */
16845 if (current_buffer
->clip_changed
16846 || current_buffer
->prevent_redisplay_optimizations_p
)
16849 /* Window must either use window-based redisplay or be full width. */
16850 if (!FRAME_WINDOW_P (f
)
16851 && (!FRAME_LINE_INS_DEL_OK (f
)
16852 || !WINDOW_FULL_WIDTH_P (w
)))
16855 /* Give up if point is known NOT to appear in W. */
16856 if (PT
< CHARPOS (start
))
16859 /* Another way to prevent redisplay optimizations. */
16860 if (XFASTINT (w
->last_modified
) == 0)
16863 /* Verify that window is not hscrolled. */
16864 if (XFASTINT (w
->hscroll
) != 0)
16867 /* Verify that display wasn't paused. */
16868 if (NILP (w
->window_end_valid
))
16871 /* Can't use this if highlighting a region because a cursor movement
16872 will do more than just set the cursor. */
16873 if (!NILP (Vtransient_mark_mode
)
16874 && !NILP (BVAR (current_buffer
, mark_active
)))
16877 /* Likewise if highlighting trailing whitespace. */
16878 if (!NILP (Vshow_trailing_whitespace
))
16881 /* Likewise if showing a region. */
16882 if (!NILP (w
->region_showing
))
16885 /* Can't use this if overlay arrow position and/or string have
16887 if (overlay_arrows_changed_p ())
16890 /* When word-wrap is on, adding a space to the first word of a
16891 wrapped line can change the wrap position, altering the line
16892 above it. It might be worthwhile to handle this more
16893 intelligently, but for now just redisplay from scratch. */
16894 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16897 /* Under bidi reordering, adding or deleting a character in the
16898 beginning of a paragraph, before the first strong directional
16899 character, can change the base direction of the paragraph (unless
16900 the buffer specifies a fixed paragraph direction), which will
16901 require to redisplay the whole paragraph. It might be worthwhile
16902 to find the paragraph limits and widen the range of redisplayed
16903 lines to that, but for now just give up this optimization and
16904 redisplay from scratch. */
16905 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16906 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16909 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16910 only if buffer has really changed. The reason is that the gap is
16911 initially at Z for freshly visited files. The code below would
16912 set end_unchanged to 0 in that case. */
16913 if (MODIFF
> SAVE_MODIFF
16914 /* This seems to happen sometimes after saving a buffer. */
16915 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16917 if (GPT
- BEG
< BEG_UNCHANGED
)
16918 BEG_UNCHANGED
= GPT
- BEG
;
16919 if (Z
- GPT
< END_UNCHANGED
)
16920 END_UNCHANGED
= Z
- GPT
;
16923 /* The position of the first and last character that has been changed. */
16924 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16925 last_changed_charpos
= Z
- END_UNCHANGED
;
16927 /* If window starts after a line end, and the last change is in
16928 front of that newline, then changes don't affect the display.
16929 This case happens with stealth-fontification. Note that although
16930 the display is unchanged, glyph positions in the matrix have to
16931 be adjusted, of course. */
16932 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16933 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16934 && ((last_changed_charpos
< CHARPOS (start
)
16935 && CHARPOS (start
) == BEGV
)
16936 || (last_changed_charpos
< CHARPOS (start
) - 1
16937 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16939 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16940 struct glyph_row
*r0
;
16942 /* Compute how many chars/bytes have been added to or removed
16943 from the buffer. */
16944 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16945 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16946 Z_delta
= Z
- Z_old
;
16947 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16949 /* Give up if PT is not in the window. Note that it already has
16950 been checked at the start of try_window_id that PT is not in
16951 front of the window start. */
16952 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16955 /* If window start is unchanged, we can reuse the whole matrix
16956 as is, after adjusting glyph positions. No need to compute
16957 the window end again, since its offset from Z hasn't changed. */
16958 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16959 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16960 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16961 /* PT must not be in a partially visible line. */
16962 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16963 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16965 /* Adjust positions in the glyph matrix. */
16966 if (Z_delta
|| Z_delta_bytes
)
16968 struct glyph_row
*r1
16969 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16970 increment_matrix_positions (w
->current_matrix
,
16971 MATRIX_ROW_VPOS (r0
, current_matrix
),
16972 MATRIX_ROW_VPOS (r1
, current_matrix
),
16973 Z_delta
, Z_delta_bytes
);
16976 /* Set the cursor. */
16977 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16979 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16986 /* Handle the case that changes are all below what is displayed in
16987 the window, and that PT is in the window. This shortcut cannot
16988 be taken if ZV is visible in the window, and text has been added
16989 there that is visible in the window. */
16990 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16991 /* ZV is not visible in the window, or there are no
16992 changes at ZV, actually. */
16993 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16994 || first_changed_charpos
== last_changed_charpos
))
16996 struct glyph_row
*r0
;
16998 /* Give up if PT is not in the window. Note that it already has
16999 been checked at the start of try_window_id that PT is not in
17000 front of the window start. */
17001 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17004 /* If window start is unchanged, we can reuse the whole matrix
17005 as is, without changing glyph positions since no text has
17006 been added/removed in front of the window end. */
17007 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17008 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17009 /* PT must not be in a partially visible line. */
17010 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17011 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17013 /* We have to compute the window end anew since text
17014 could have been added/removed after it. */
17016 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17017 w
->window_end_bytepos
17018 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17020 /* Set the cursor. */
17021 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17023 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17030 /* Give up if window start is in the changed area.
17032 The condition used to read
17034 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17036 but why that was tested escapes me at the moment. */
17037 if (CHARPOS (start
) >= first_changed_charpos
17038 && CHARPOS (start
) <= last_changed_charpos
)
17041 /* Check that window start agrees with the start of the first glyph
17042 row in its current matrix. Check this after we know the window
17043 start is not in changed text, otherwise positions would not be
17045 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17046 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17049 /* Give up if the window ends in strings. Overlay strings
17050 at the end are difficult to handle, so don't try. */
17051 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17052 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17055 /* Compute the position at which we have to start displaying new
17056 lines. Some of the lines at the top of the window might be
17057 reusable because they are not displaying changed text. Find the
17058 last row in W's current matrix not affected by changes at the
17059 start of current_buffer. Value is null if changes start in the
17060 first line of window. */
17061 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17062 if (last_unchanged_at_beg_row
)
17064 /* Avoid starting to display in the middle of a character, a TAB
17065 for instance. This is easier than to set up the iterator
17066 exactly, and it's not a frequent case, so the additional
17067 effort wouldn't really pay off. */
17068 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17069 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17070 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17071 --last_unchanged_at_beg_row
;
17073 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17076 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17078 start_pos
= it
.current
.pos
;
17080 /* Start displaying new lines in the desired matrix at the same
17081 vpos we would use in the current matrix, i.e. below
17082 last_unchanged_at_beg_row. */
17083 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17085 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17086 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17088 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17092 /* There are no reusable lines at the start of the window.
17093 Start displaying in the first text line. */
17094 start_display (&it
, w
, start
);
17095 it
.vpos
= it
.first_vpos
;
17096 start_pos
= it
.current
.pos
;
17099 /* Find the first row that is not affected by changes at the end of
17100 the buffer. Value will be null if there is no unchanged row, in
17101 which case we must redisplay to the end of the window. delta
17102 will be set to the value by which buffer positions beginning with
17103 first_unchanged_at_end_row have to be adjusted due to text
17105 first_unchanged_at_end_row
17106 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17107 IF_DEBUG (debug_delta
= delta
);
17108 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17110 /* Set stop_pos to the buffer position up to which we will have to
17111 display new lines. If first_unchanged_at_end_row != NULL, this
17112 is the buffer position of the start of the line displayed in that
17113 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17114 that we don't stop at a buffer position. */
17116 if (first_unchanged_at_end_row
)
17118 xassert (last_unchanged_at_beg_row
== NULL
17119 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17121 /* If this is a continuation line, move forward to the next one
17122 that isn't. Changes in lines above affect this line.
17123 Caution: this may move first_unchanged_at_end_row to a row
17124 not displaying text. */
17125 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17126 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17127 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17128 < it
.last_visible_y
))
17129 ++first_unchanged_at_end_row
;
17131 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17132 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17133 >= it
.last_visible_y
))
17134 first_unchanged_at_end_row
= NULL
;
17137 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17139 first_unchanged_at_end_vpos
17140 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17141 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17144 else if (last_unchanged_at_beg_row
== NULL
)
17150 /* Either there is no unchanged row at the end, or the one we have
17151 now displays text. This is a necessary condition for the window
17152 end pos calculation at the end of this function. */
17153 xassert (first_unchanged_at_end_row
== NULL
17154 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17156 debug_last_unchanged_at_beg_vpos
17157 = (last_unchanged_at_beg_row
17158 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17160 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17162 #endif /* GLYPH_DEBUG != 0 */
17165 /* Display new lines. Set last_text_row to the last new line
17166 displayed which has text on it, i.e. might end up as being the
17167 line where the window_end_vpos is. */
17168 w
->cursor
.vpos
= -1;
17169 last_text_row
= NULL
;
17170 overlay_arrow_seen
= 0;
17171 while (it
.current_y
< it
.last_visible_y
17172 && !fonts_changed_p
17173 && (first_unchanged_at_end_row
== NULL
17174 || IT_CHARPOS (it
) < stop_pos
))
17176 if (display_line (&it
))
17177 last_text_row
= it
.glyph_row
- 1;
17180 if (fonts_changed_p
)
17184 /* Compute differences in buffer positions, y-positions etc. for
17185 lines reused at the bottom of the window. Compute what we can
17187 if (first_unchanged_at_end_row
17188 /* No lines reused because we displayed everything up to the
17189 bottom of the window. */
17190 && it
.current_y
< it
.last_visible_y
)
17193 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17195 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17196 run
.current_y
= first_unchanged_at_end_row
->y
;
17197 run
.desired_y
= run
.current_y
+ dy
;
17198 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17202 delta
= delta_bytes
= dvpos
= dy
17203 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17204 first_unchanged_at_end_row
= NULL
;
17206 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17209 /* Find the cursor if not already found. We have to decide whether
17210 PT will appear on this window (it sometimes doesn't, but this is
17211 not a very frequent case.) This decision has to be made before
17212 the current matrix is altered. A value of cursor.vpos < 0 means
17213 that PT is either in one of the lines beginning at
17214 first_unchanged_at_end_row or below the window. Don't care for
17215 lines that might be displayed later at the window end; as
17216 mentioned, this is not a frequent case. */
17217 if (w
->cursor
.vpos
< 0)
17219 /* Cursor in unchanged rows at the top? */
17220 if (PT
< CHARPOS (start_pos
)
17221 && last_unchanged_at_beg_row
)
17223 row
= row_containing_pos (w
, PT
,
17224 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17225 last_unchanged_at_beg_row
+ 1, 0);
17227 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17230 /* Start from first_unchanged_at_end_row looking for PT. */
17231 else if (first_unchanged_at_end_row
)
17233 row
= row_containing_pos (w
, PT
- delta
,
17234 first_unchanged_at_end_row
, NULL
, 0);
17236 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17237 delta_bytes
, dy
, dvpos
);
17240 /* Give up if cursor was not found. */
17241 if (w
->cursor
.vpos
< 0)
17243 clear_glyph_matrix (w
->desired_matrix
);
17248 /* Don't let the cursor end in the scroll margins. */
17250 int this_scroll_margin
, cursor_height
;
17252 this_scroll_margin
=
17253 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17254 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17255 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17257 if ((w
->cursor
.y
< this_scroll_margin
17258 && CHARPOS (start
) > BEGV
)
17259 /* Old redisplay didn't take scroll margin into account at the bottom,
17260 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17261 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17262 ? cursor_height
+ this_scroll_margin
17263 : 1)) > it
.last_visible_y
)
17265 w
->cursor
.vpos
= -1;
17266 clear_glyph_matrix (w
->desired_matrix
);
17271 /* Scroll the display. Do it before changing the current matrix so
17272 that xterm.c doesn't get confused about where the cursor glyph is
17274 if (dy
&& run
.height
)
17278 if (FRAME_WINDOW_P (f
))
17280 FRAME_RIF (f
)->update_window_begin_hook (w
);
17281 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17282 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17283 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17287 /* Terminal frame. In this case, dvpos gives the number of
17288 lines to scroll by; dvpos < 0 means scroll up. */
17290 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17291 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17292 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17293 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17294 + window_internal_height (w
));
17296 #if defined (HAVE_GPM) || defined (MSDOS)
17297 x_clear_window_mouse_face (w
);
17299 /* Perform the operation on the screen. */
17302 /* Scroll last_unchanged_at_beg_row to the end of the
17303 window down dvpos lines. */
17304 set_terminal_window (f
, end
);
17306 /* On dumb terminals delete dvpos lines at the end
17307 before inserting dvpos empty lines. */
17308 if (!FRAME_SCROLL_REGION_OK (f
))
17309 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17311 /* Insert dvpos empty lines in front of
17312 last_unchanged_at_beg_row. */
17313 ins_del_lines (f
, from
, dvpos
);
17315 else if (dvpos
< 0)
17317 /* Scroll up last_unchanged_at_beg_vpos to the end of
17318 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17319 set_terminal_window (f
, end
);
17321 /* Delete dvpos lines in front of
17322 last_unchanged_at_beg_vpos. ins_del_lines will set
17323 the cursor to the given vpos and emit |dvpos| delete
17325 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17327 /* On a dumb terminal insert dvpos empty lines at the
17329 if (!FRAME_SCROLL_REGION_OK (f
))
17330 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17333 set_terminal_window (f
, 0);
17339 /* Shift reused rows of the current matrix to the right position.
17340 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17342 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17343 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17346 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17347 bottom_vpos
, dvpos
);
17348 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17351 else if (dvpos
> 0)
17353 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17354 bottom_vpos
, dvpos
);
17355 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17356 first_unchanged_at_end_vpos
+ dvpos
, 0);
17359 /* For frame-based redisplay, make sure that current frame and window
17360 matrix are in sync with respect to glyph memory. */
17361 if (!FRAME_WINDOW_P (f
))
17362 sync_frame_with_window_matrix_rows (w
);
17364 /* Adjust buffer positions in reused rows. */
17365 if (delta
|| delta_bytes
)
17366 increment_matrix_positions (current_matrix
,
17367 first_unchanged_at_end_vpos
+ dvpos
,
17368 bottom_vpos
, delta
, delta_bytes
);
17370 /* Adjust Y positions. */
17372 shift_glyph_matrix (w
, current_matrix
,
17373 first_unchanged_at_end_vpos
+ dvpos
,
17376 if (first_unchanged_at_end_row
)
17378 first_unchanged_at_end_row
+= dvpos
;
17379 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17380 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17381 first_unchanged_at_end_row
= NULL
;
17384 /* If scrolling up, there may be some lines to display at the end of
17386 last_text_row_at_end
= NULL
;
17389 /* Scrolling up can leave for example a partially visible line
17390 at the end of the window to be redisplayed. */
17391 /* Set last_row to the glyph row in the current matrix where the
17392 window end line is found. It has been moved up or down in
17393 the matrix by dvpos. */
17394 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17395 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17397 /* If last_row is the window end line, it should display text. */
17398 xassert (last_row
->displays_text_p
);
17400 /* If window end line was partially visible before, begin
17401 displaying at that line. Otherwise begin displaying with the
17402 line following it. */
17403 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17405 init_to_row_start (&it
, w
, last_row
);
17406 it
.vpos
= last_vpos
;
17407 it
.current_y
= last_row
->y
;
17411 init_to_row_end (&it
, w
, last_row
);
17412 it
.vpos
= 1 + last_vpos
;
17413 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17417 /* We may start in a continuation line. If so, we have to
17418 get the right continuation_lines_width and current_x. */
17419 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17420 it
.hpos
= it
.current_x
= 0;
17422 /* Display the rest of the lines at the window end. */
17423 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17424 while (it
.current_y
< it
.last_visible_y
17425 && !fonts_changed_p
)
17427 /* Is it always sure that the display agrees with lines in
17428 the current matrix? I don't think so, so we mark rows
17429 displayed invalid in the current matrix by setting their
17430 enabled_p flag to zero. */
17431 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17432 if (display_line (&it
))
17433 last_text_row_at_end
= it
.glyph_row
- 1;
17437 /* Update window_end_pos and window_end_vpos. */
17438 if (first_unchanged_at_end_row
17439 && !last_text_row_at_end
)
17441 /* Window end line if one of the preserved rows from the current
17442 matrix. Set row to the last row displaying text in current
17443 matrix starting at first_unchanged_at_end_row, after
17445 xassert (first_unchanged_at_end_row
->displays_text_p
);
17446 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17447 first_unchanged_at_end_row
);
17448 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17450 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17451 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17453 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17454 xassert (w
->window_end_bytepos
>= 0);
17455 IF_DEBUG (debug_method_add (w
, "A"));
17457 else if (last_text_row_at_end
)
17460 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17461 w
->window_end_bytepos
17462 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17464 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17465 xassert (w
->window_end_bytepos
>= 0);
17466 IF_DEBUG (debug_method_add (w
, "B"));
17468 else if (last_text_row
)
17470 /* We have displayed either to the end of the window or at the
17471 end of the window, i.e. the last row with text is to be found
17472 in the desired matrix. */
17474 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17475 w
->window_end_bytepos
17476 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17478 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17479 xassert (w
->window_end_bytepos
>= 0);
17481 else if (first_unchanged_at_end_row
== NULL
17482 && last_text_row
== NULL
17483 && last_text_row_at_end
== NULL
)
17485 /* Displayed to end of window, but no line containing text was
17486 displayed. Lines were deleted at the end of the window. */
17487 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17488 int vpos
= XFASTINT (w
->window_end_vpos
);
17489 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17490 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17493 row
== NULL
&& vpos
>= first_vpos
;
17494 --vpos
, --current_row
, --desired_row
)
17496 if (desired_row
->enabled_p
)
17498 if (desired_row
->displays_text_p
)
17501 else if (current_row
->displays_text_p
)
17505 xassert (row
!= NULL
);
17506 w
->window_end_vpos
= make_number (vpos
+ 1);
17507 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17508 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17509 xassert (w
->window_end_bytepos
>= 0);
17510 IF_DEBUG (debug_method_add (w
, "C"));
17515 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17516 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17518 /* Record that display has not been completed. */
17519 w
->window_end_valid
= Qnil
;
17520 w
->desired_matrix
->no_scrolling_p
= 1;
17528 /***********************************************************************
17529 More debugging support
17530 ***********************************************************************/
17534 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17535 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17536 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17539 /* Dump the contents of glyph matrix MATRIX on stderr.
17541 GLYPHS 0 means don't show glyph contents.
17542 GLYPHS 1 means show glyphs in short form
17543 GLYPHS > 1 means show glyphs in long form. */
17546 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17549 for (i
= 0; i
< matrix
->nrows
; ++i
)
17550 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17554 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17555 the glyph row and area where the glyph comes from. */
17558 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17560 if (glyph
->type
== CHAR_GLYPH
)
17563 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17564 glyph
- row
->glyphs
[TEXT_AREA
],
17567 (BUFFERP (glyph
->object
)
17569 : (STRINGP (glyph
->object
)
17572 glyph
->pixel_width
,
17574 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17578 glyph
->left_box_line_p
,
17579 glyph
->right_box_line_p
);
17581 else if (glyph
->type
== STRETCH_GLYPH
)
17584 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17585 glyph
- row
->glyphs
[TEXT_AREA
],
17588 (BUFFERP (glyph
->object
)
17590 : (STRINGP (glyph
->object
)
17593 glyph
->pixel_width
,
17597 glyph
->left_box_line_p
,
17598 glyph
->right_box_line_p
);
17600 else if (glyph
->type
== IMAGE_GLYPH
)
17603 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17604 glyph
- row
->glyphs
[TEXT_AREA
],
17607 (BUFFERP (glyph
->object
)
17609 : (STRINGP (glyph
->object
)
17612 glyph
->pixel_width
,
17616 glyph
->left_box_line_p
,
17617 glyph
->right_box_line_p
);
17619 else if (glyph
->type
== COMPOSITE_GLYPH
)
17622 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17623 glyph
- row
->glyphs
[TEXT_AREA
],
17626 (BUFFERP (glyph
->object
)
17628 : (STRINGP (glyph
->object
)
17631 glyph
->pixel_width
,
17633 if (glyph
->u
.cmp
.automatic
)
17636 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17637 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17639 glyph
->left_box_line_p
,
17640 glyph
->right_box_line_p
);
17645 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17646 GLYPHS 0 means don't show glyph contents.
17647 GLYPHS 1 means show glyphs in short form
17648 GLYPHS > 1 means show glyphs in long form. */
17651 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17655 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17656 fprintf (stderr
, "======================================================================\n");
17658 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17659 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17661 MATRIX_ROW_START_CHARPOS (row
),
17662 MATRIX_ROW_END_CHARPOS (row
),
17663 row
->used
[TEXT_AREA
],
17664 row
->contains_overlapping_glyphs_p
,
17666 row
->truncated_on_left_p
,
17667 row
->truncated_on_right_p
,
17669 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17670 row
->displays_text_p
,
17673 row
->ends_in_middle_of_char_p
,
17674 row
->starts_in_middle_of_char_p
,
17680 row
->visible_height
,
17683 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17684 row
->end
.overlay_string_index
,
17685 row
->continuation_lines_width
);
17686 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17687 CHARPOS (row
->start
.string_pos
),
17688 CHARPOS (row
->end
.string_pos
));
17689 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17690 row
->end
.dpvec_index
);
17697 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17699 struct glyph
*glyph
= row
->glyphs
[area
];
17700 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17702 /* Glyph for a line end in text. */
17703 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17706 if (glyph
< glyph_end
)
17707 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17709 for (; glyph
< glyph_end
; ++glyph
)
17710 dump_glyph (row
, glyph
, area
);
17713 else if (glyphs
== 1)
17717 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17719 char *s
= (char *) alloca (row
->used
[area
] + 1);
17722 for (i
= 0; i
< row
->used
[area
]; ++i
)
17724 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17725 if (glyph
->type
== CHAR_GLYPH
17726 && glyph
->u
.ch
< 0x80
17727 && glyph
->u
.ch
>= ' ')
17728 s
[i
] = glyph
->u
.ch
;
17734 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17740 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17741 Sdump_glyph_matrix
, 0, 1, "p",
17742 doc
: /* Dump the current matrix of the selected window to stderr.
17743 Shows contents of glyph row structures. With non-nil
17744 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17745 glyphs in short form, otherwise show glyphs in long form. */)
17746 (Lisp_Object glyphs
)
17748 struct window
*w
= XWINDOW (selected_window
);
17749 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17751 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17752 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17753 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17754 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17755 fprintf (stderr
, "=============================================\n");
17756 dump_glyph_matrix (w
->current_matrix
,
17757 NILP (glyphs
) ? 0 : XINT (glyphs
));
17762 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17763 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17766 struct frame
*f
= XFRAME (selected_frame
);
17767 dump_glyph_matrix (f
->current_matrix
, 1);
17772 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17773 doc
: /* Dump glyph row ROW to stderr.
17774 GLYPH 0 means don't dump glyphs.
17775 GLYPH 1 means dump glyphs in short form.
17776 GLYPH > 1 or omitted means dump glyphs in long form. */)
17777 (Lisp_Object row
, Lisp_Object glyphs
)
17779 struct glyph_matrix
*matrix
;
17782 CHECK_NUMBER (row
);
17783 matrix
= XWINDOW (selected_window
)->current_matrix
;
17785 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17786 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17788 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17793 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17794 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17795 GLYPH 0 means don't dump glyphs.
17796 GLYPH 1 means dump glyphs in short form.
17797 GLYPH > 1 or omitted means dump glyphs in long form. */)
17798 (Lisp_Object row
, Lisp_Object glyphs
)
17800 struct frame
*sf
= SELECTED_FRAME ();
17801 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17804 CHECK_NUMBER (row
);
17806 if (vpos
>= 0 && vpos
< m
->nrows
)
17807 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17808 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17813 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17814 doc
: /* Toggle tracing of redisplay.
17815 With ARG, turn tracing on if and only if ARG is positive. */)
17819 trace_redisplay_p
= !trace_redisplay_p
;
17822 arg
= Fprefix_numeric_value (arg
);
17823 trace_redisplay_p
= XINT (arg
) > 0;
17830 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17831 doc
: /* Like `format', but print result to stderr.
17832 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17833 (ptrdiff_t nargs
, Lisp_Object
*args
)
17835 Lisp_Object s
= Fformat (nargs
, args
);
17836 fprintf (stderr
, "%s", SDATA (s
));
17840 #endif /* GLYPH_DEBUG */
17844 /***********************************************************************
17845 Building Desired Matrix Rows
17846 ***********************************************************************/
17848 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17849 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17851 static struct glyph_row
*
17852 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17854 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17855 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17856 struct buffer
*old
= current_buffer
;
17857 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17858 int arrow_len
= SCHARS (overlay_arrow_string
);
17859 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17860 const unsigned char *p
;
17863 int n_glyphs_before
;
17865 set_buffer_temp (buffer
);
17866 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17867 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17868 SET_TEXT_POS (it
.position
, 0, 0);
17870 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17872 while (p
< arrow_end
)
17874 Lisp_Object face
, ilisp
;
17876 /* Get the next character. */
17878 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17881 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17882 if (! ASCII_CHAR_P (it
.c
))
17883 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17887 /* Get its face. */
17888 ilisp
= make_number (p
- arrow_string
);
17889 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17890 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17892 /* Compute its width, get its glyphs. */
17893 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17894 SET_TEXT_POS (it
.position
, -1, -1);
17895 PRODUCE_GLYPHS (&it
);
17897 /* If this character doesn't fit any more in the line, we have
17898 to remove some glyphs. */
17899 if (it
.current_x
> it
.last_visible_x
)
17901 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17906 set_buffer_temp (old
);
17907 return it
.glyph_row
;
17911 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17912 glyphs are only inserted for terminal frames since we can't really
17913 win with truncation glyphs when partially visible glyphs are
17914 involved. Which glyphs to insert is determined by
17915 produce_special_glyphs. */
17918 insert_left_trunc_glyphs (struct it
*it
)
17920 struct it truncate_it
;
17921 struct glyph
*from
, *end
, *to
, *toend
;
17923 xassert (!FRAME_WINDOW_P (it
->f
));
17925 /* Get the truncation glyphs. */
17927 truncate_it
.current_x
= 0;
17928 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17929 truncate_it
.glyph_row
= &scratch_glyph_row
;
17930 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17931 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17932 truncate_it
.object
= make_number (0);
17933 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17935 /* Overwrite glyphs from IT with truncation glyphs. */
17936 if (!it
->glyph_row
->reversed_p
)
17938 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17939 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17940 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17941 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17946 /* There may be padding glyphs left over. Overwrite them too. */
17947 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17949 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17955 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17959 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17960 that back to front. */
17961 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17962 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17963 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17964 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17966 while (from
>= end
&& to
>= toend
)
17968 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17971 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17972 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17973 while (from
>= end
&& to
>= toend
)
17978 /* Need to free some room before prepending additional
17980 int move_by
= from
- end
+ 1;
17981 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17982 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17984 for ( ; g
>= g0
; g
--)
17986 while (from
>= end
)
17988 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17993 /* Compute the hash code for ROW. */
17995 row_hash (struct glyph_row
*row
)
17998 unsigned hashval
= 0;
18000 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18001 for (k
= 0; k
< row
->used
[area
]; ++k
)
18002 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18003 + row
->glyphs
[area
][k
].u
.val
18004 + row
->glyphs
[area
][k
].face_id
18005 + row
->glyphs
[area
][k
].padding_p
18006 + (row
->glyphs
[area
][k
].type
<< 2));
18011 /* Compute the pixel height and width of IT->glyph_row.
18013 Most of the time, ascent and height of a display line will be equal
18014 to the max_ascent and max_height values of the display iterator
18015 structure. This is not the case if
18017 1. We hit ZV without displaying anything. In this case, max_ascent
18018 and max_height will be zero.
18020 2. We have some glyphs that don't contribute to the line height.
18021 (The glyph row flag contributes_to_line_height_p is for future
18022 pixmap extensions).
18024 The first case is easily covered by using default values because in
18025 these cases, the line height does not really matter, except that it
18026 must not be zero. */
18029 compute_line_metrics (struct it
*it
)
18031 struct glyph_row
*row
= it
->glyph_row
;
18033 if (FRAME_WINDOW_P (it
->f
))
18035 int i
, min_y
, max_y
;
18037 /* The line may consist of one space only, that was added to
18038 place the cursor on it. If so, the row's height hasn't been
18040 if (row
->height
== 0)
18042 if (it
->max_ascent
+ it
->max_descent
== 0)
18043 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18044 row
->ascent
= it
->max_ascent
;
18045 row
->height
= it
->max_ascent
+ it
->max_descent
;
18046 row
->phys_ascent
= it
->max_phys_ascent
;
18047 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18048 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18051 /* Compute the width of this line. */
18052 row
->pixel_width
= row
->x
;
18053 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18054 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18056 xassert (row
->pixel_width
>= 0);
18057 xassert (row
->ascent
>= 0 && row
->height
> 0);
18059 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18060 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18062 /* If first line's physical ascent is larger than its logical
18063 ascent, use the physical ascent, and make the row taller.
18064 This makes accented characters fully visible. */
18065 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18066 && row
->phys_ascent
> row
->ascent
)
18068 row
->height
+= row
->phys_ascent
- row
->ascent
;
18069 row
->ascent
= row
->phys_ascent
;
18072 /* Compute how much of the line is visible. */
18073 row
->visible_height
= row
->height
;
18075 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18076 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18078 if (row
->y
< min_y
)
18079 row
->visible_height
-= min_y
- row
->y
;
18080 if (row
->y
+ row
->height
> max_y
)
18081 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18085 row
->pixel_width
= row
->used
[TEXT_AREA
];
18086 if (row
->continued_p
)
18087 row
->pixel_width
-= it
->continuation_pixel_width
;
18088 else if (row
->truncated_on_right_p
)
18089 row
->pixel_width
-= it
->truncation_pixel_width
;
18090 row
->ascent
= row
->phys_ascent
= 0;
18091 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18092 row
->extra_line_spacing
= 0;
18095 /* Compute a hash code for this row. */
18096 row
->hash
= row_hash (row
);
18098 it
->max_ascent
= it
->max_descent
= 0;
18099 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18103 /* Append one space to the glyph row of iterator IT if doing a
18104 window-based redisplay. The space has the same face as
18105 IT->face_id. Value is non-zero if a space was added.
18107 This function is called to make sure that there is always one glyph
18108 at the end of a glyph row that the cursor can be set on under
18109 window-systems. (If there weren't such a glyph we would not know
18110 how wide and tall a box cursor should be displayed).
18112 At the same time this space let's a nicely handle clearing to the
18113 end of the line if the row ends in italic text. */
18116 append_space_for_newline (struct it
*it
, int default_face_p
)
18118 if (FRAME_WINDOW_P (it
->f
))
18120 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18122 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18123 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18125 /* Save some values that must not be changed.
18126 Must save IT->c and IT->len because otherwise
18127 ITERATOR_AT_END_P wouldn't work anymore after
18128 append_space_for_newline has been called. */
18129 enum display_element_type saved_what
= it
->what
;
18130 int saved_c
= it
->c
, saved_len
= it
->len
;
18131 int saved_char_to_display
= it
->char_to_display
;
18132 int saved_x
= it
->current_x
;
18133 int saved_face_id
= it
->face_id
;
18134 struct text_pos saved_pos
;
18135 Lisp_Object saved_object
;
18138 saved_object
= it
->object
;
18139 saved_pos
= it
->position
;
18141 it
->what
= IT_CHARACTER
;
18142 memset (&it
->position
, 0, sizeof it
->position
);
18143 it
->object
= make_number (0);
18144 it
->c
= it
->char_to_display
= ' ';
18147 if (default_face_p
)
18148 it
->face_id
= DEFAULT_FACE_ID
;
18149 else if (it
->face_before_selective_p
)
18150 it
->face_id
= it
->saved_face_id
;
18151 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18152 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18154 PRODUCE_GLYPHS (it
);
18156 it
->override_ascent
= -1;
18157 it
->constrain_row_ascent_descent_p
= 0;
18158 it
->current_x
= saved_x
;
18159 it
->object
= saved_object
;
18160 it
->position
= saved_pos
;
18161 it
->what
= saved_what
;
18162 it
->face_id
= saved_face_id
;
18163 it
->len
= saved_len
;
18165 it
->char_to_display
= saved_char_to_display
;
18174 /* Extend the face of the last glyph in the text area of IT->glyph_row
18175 to the end of the display line. Called from display_line. If the
18176 glyph row is empty, add a space glyph to it so that we know the
18177 face to draw. Set the glyph row flag fill_line_p. If the glyph
18178 row is R2L, prepend a stretch glyph to cover the empty space to the
18179 left of the leftmost glyph. */
18182 extend_face_to_end_of_line (struct it
*it
)
18185 struct frame
*f
= it
->f
;
18187 /* If line is already filled, do nothing. Non window-system frames
18188 get a grace of one more ``pixel'' because their characters are
18189 1-``pixel'' wide, so they hit the equality too early. This grace
18190 is needed only for R2L rows that are not continued, to produce
18191 one extra blank where we could display the cursor. */
18192 if (it
->current_x
>= it
->last_visible_x
18193 + (!FRAME_WINDOW_P (f
)
18194 && it
->glyph_row
->reversed_p
18195 && !it
->glyph_row
->continued_p
))
18198 /* Face extension extends the background and box of IT->face_id
18199 to the end of the line. If the background equals the background
18200 of the frame, we don't have to do anything. */
18201 if (it
->face_before_selective_p
)
18202 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18204 face
= FACE_FROM_ID (f
, it
->face_id
);
18206 if (FRAME_WINDOW_P (f
)
18207 && it
->glyph_row
->displays_text_p
18208 && face
->box
== FACE_NO_BOX
18209 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18211 && !it
->glyph_row
->reversed_p
)
18214 /* Set the glyph row flag indicating that the face of the last glyph
18215 in the text area has to be drawn to the end of the text area. */
18216 it
->glyph_row
->fill_line_p
= 1;
18218 /* If current character of IT is not ASCII, make sure we have the
18219 ASCII face. This will be automatically undone the next time
18220 get_next_display_element returns a multibyte character. Note
18221 that the character will always be single byte in unibyte
18223 if (!ASCII_CHAR_P (it
->c
))
18225 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18228 if (FRAME_WINDOW_P (f
))
18230 /* If the row is empty, add a space with the current face of IT,
18231 so that we know which face to draw. */
18232 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18234 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18235 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18236 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18238 #ifdef HAVE_WINDOW_SYSTEM
18239 if (it
->glyph_row
->reversed_p
)
18241 /* Prepend a stretch glyph to the row, such that the
18242 rightmost glyph will be drawn flushed all the way to the
18243 right margin of the window. The stretch glyph that will
18244 occupy the empty space, if any, to the left of the
18246 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18247 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18248 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18250 int row_width
, stretch_ascent
, stretch_width
;
18251 struct text_pos saved_pos
;
18252 int saved_face_id
, saved_avoid_cursor
;
18254 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18255 row_width
+= g
->pixel_width
;
18256 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18257 if (stretch_width
> 0)
18260 (((it
->ascent
+ it
->descent
)
18261 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18262 saved_pos
= it
->position
;
18263 memset (&it
->position
, 0, sizeof it
->position
);
18264 saved_avoid_cursor
= it
->avoid_cursor_p
;
18265 it
->avoid_cursor_p
= 1;
18266 saved_face_id
= it
->face_id
;
18267 /* The last row's stretch glyph should get the default
18268 face, to avoid painting the rest of the window with
18269 the region face, if the region ends at ZV. */
18270 if (it
->glyph_row
->ends_at_zv_p
)
18271 it
->face_id
= DEFAULT_FACE_ID
;
18273 it
->face_id
= face
->id
;
18274 append_stretch_glyph (it
, make_number (0), stretch_width
,
18275 it
->ascent
+ it
->descent
, stretch_ascent
);
18276 it
->position
= saved_pos
;
18277 it
->avoid_cursor_p
= saved_avoid_cursor
;
18278 it
->face_id
= saved_face_id
;
18281 #endif /* HAVE_WINDOW_SYSTEM */
18285 /* Save some values that must not be changed. */
18286 int saved_x
= it
->current_x
;
18287 struct text_pos saved_pos
;
18288 Lisp_Object saved_object
;
18289 enum display_element_type saved_what
= it
->what
;
18290 int saved_face_id
= it
->face_id
;
18292 saved_object
= it
->object
;
18293 saved_pos
= it
->position
;
18295 it
->what
= IT_CHARACTER
;
18296 memset (&it
->position
, 0, sizeof it
->position
);
18297 it
->object
= make_number (0);
18298 it
->c
= it
->char_to_display
= ' ';
18300 /* The last row's blank glyphs should get the default face, to
18301 avoid painting the rest of the window with the region face,
18302 if the region ends at ZV. */
18303 if (it
->glyph_row
->ends_at_zv_p
)
18304 it
->face_id
= DEFAULT_FACE_ID
;
18306 it
->face_id
= face
->id
;
18308 PRODUCE_GLYPHS (it
);
18310 while (it
->current_x
<= it
->last_visible_x
)
18311 PRODUCE_GLYPHS (it
);
18313 /* Don't count these blanks really. It would let us insert a left
18314 truncation glyph below and make us set the cursor on them, maybe. */
18315 it
->current_x
= saved_x
;
18316 it
->object
= saved_object
;
18317 it
->position
= saved_pos
;
18318 it
->what
= saved_what
;
18319 it
->face_id
= saved_face_id
;
18324 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18325 trailing whitespace. */
18328 trailing_whitespace_p (EMACS_INT charpos
)
18330 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18333 while (bytepos
< ZV_BYTE
18334 && (c
= FETCH_CHAR (bytepos
),
18335 c
== ' ' || c
== '\t'))
18338 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18340 if (bytepos
!= PT_BYTE
)
18347 /* Highlight trailing whitespace, if any, in ROW. */
18350 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18352 int used
= row
->used
[TEXT_AREA
];
18356 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18357 struct glyph
*glyph
= start
+ used
- 1;
18359 if (row
->reversed_p
)
18361 /* Right-to-left rows need to be processed in the opposite
18362 direction, so swap the edge pointers. */
18364 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18367 /* Skip over glyphs inserted to display the cursor at the
18368 end of a line, for extending the face of the last glyph
18369 to the end of the line on terminals, and for truncation
18370 and continuation glyphs. */
18371 if (!row
->reversed_p
)
18373 while (glyph
>= start
18374 && glyph
->type
== CHAR_GLYPH
18375 && INTEGERP (glyph
->object
))
18380 while (glyph
<= start
18381 && glyph
->type
== CHAR_GLYPH
18382 && INTEGERP (glyph
->object
))
18386 /* If last glyph is a space or stretch, and it's trailing
18387 whitespace, set the face of all trailing whitespace glyphs in
18388 IT->glyph_row to `trailing-whitespace'. */
18389 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18390 && BUFFERP (glyph
->object
)
18391 && (glyph
->type
== STRETCH_GLYPH
18392 || (glyph
->type
== CHAR_GLYPH
18393 && glyph
->u
.ch
== ' '))
18394 && trailing_whitespace_p (glyph
->charpos
))
18396 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18400 if (!row
->reversed_p
)
18402 while (glyph
>= start
18403 && BUFFERP (glyph
->object
)
18404 && (glyph
->type
== STRETCH_GLYPH
18405 || (glyph
->type
== CHAR_GLYPH
18406 && glyph
->u
.ch
== ' ')))
18407 (glyph
--)->face_id
= face_id
;
18411 while (glyph
<= start
18412 && BUFFERP (glyph
->object
)
18413 && (glyph
->type
== STRETCH_GLYPH
18414 || (glyph
->type
== CHAR_GLYPH
18415 && glyph
->u
.ch
== ' ')))
18416 (glyph
++)->face_id
= face_id
;
18423 /* Value is non-zero if glyph row ROW should be
18424 used to hold the cursor. */
18427 cursor_row_p (struct glyph_row
*row
)
18431 if (PT
== CHARPOS (row
->end
.pos
)
18432 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18434 /* Suppose the row ends on a string.
18435 Unless the row is continued, that means it ends on a newline
18436 in the string. If it's anything other than a display string
18437 (e.g. a before-string from an overlay), we don't want the
18438 cursor there. (This heuristic seems to give the optimal
18439 behavior for the various types of multi-line strings.) */
18440 if (CHARPOS (row
->end
.string_pos
) >= 0)
18442 if (row
->continued_p
)
18446 /* Check for `display' property. */
18447 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18448 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18449 struct glyph
*glyph
;
18452 for (glyph
= end
; glyph
>= beg
; --glyph
)
18453 if (STRINGP (glyph
->object
))
18456 = Fget_char_property (make_number (PT
),
18460 && display_prop_string_p (prop
, glyph
->object
));
18465 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18467 /* If the row ends in middle of a real character,
18468 and the line is continued, we want the cursor here.
18469 That's because CHARPOS (ROW->end.pos) would equal
18470 PT if PT is before the character. */
18471 if (!row
->ends_in_ellipsis_p
)
18472 result
= row
->continued_p
;
18474 /* If the row ends in an ellipsis, then
18475 CHARPOS (ROW->end.pos) will equal point after the
18476 invisible text. We want that position to be displayed
18477 after the ellipsis. */
18480 /* If the row ends at ZV, display the cursor at the end of that
18481 row instead of at the start of the row below. */
18482 else if (row
->ends_at_zv_p
)
18493 /* Push the property PROP so that it will be rendered at the current
18494 position in IT. Return 1 if PROP was successfully pushed, 0
18495 otherwise. Called from handle_line_prefix to handle the
18496 `line-prefix' and `wrap-prefix' properties. */
18499 push_display_prop (struct it
*it
, Lisp_Object prop
)
18501 struct text_pos pos
=
18502 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18504 xassert (it
->method
== GET_FROM_BUFFER
18505 || it
->method
== GET_FROM_DISPLAY_VECTOR
18506 || it
->method
== GET_FROM_STRING
);
18508 /* We need to save the current buffer/string position, so it will be
18509 restored by pop_it, because iterate_out_of_display_property
18510 depends on that being set correctly, but some situations leave
18511 it->position not yet set when this function is called. */
18512 push_it (it
, &pos
);
18514 if (STRINGP (prop
))
18516 if (SCHARS (prop
) == 0)
18523 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18524 it
->current
.overlay_string_index
= -1;
18525 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18526 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18527 it
->method
= GET_FROM_STRING
;
18528 it
->stop_charpos
= 0;
18530 it
->base_level_stop
= 0;
18532 /* Force paragraph direction to be that of the parent
18534 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18535 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18537 it
->paragraph_embedding
= L2R
;
18539 /* Set up the bidi iterator for this display string. */
18542 it
->bidi_it
.string
.lstring
= it
->string
;
18543 it
->bidi_it
.string
.s
= NULL
;
18544 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18545 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18546 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18547 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18548 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18551 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18553 it
->method
= GET_FROM_STRETCH
;
18556 #ifdef HAVE_WINDOW_SYSTEM
18557 else if (IMAGEP (prop
))
18559 it
->what
= IT_IMAGE
;
18560 it
->image_id
= lookup_image (it
->f
, prop
);
18561 it
->method
= GET_FROM_IMAGE
;
18563 #endif /* HAVE_WINDOW_SYSTEM */
18566 pop_it (it
); /* bogus display property, give up */
18573 /* Return the character-property PROP at the current position in IT. */
18576 get_it_property (struct it
*it
, Lisp_Object prop
)
18578 Lisp_Object position
;
18580 if (STRINGP (it
->object
))
18581 position
= make_number (IT_STRING_CHARPOS (*it
));
18582 else if (BUFFERP (it
->object
))
18583 position
= make_number (IT_CHARPOS (*it
));
18587 return Fget_char_property (position
, prop
, it
->object
);
18590 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18593 handle_line_prefix (struct it
*it
)
18595 Lisp_Object prefix
;
18597 if (it
->continuation_lines_width
> 0)
18599 prefix
= get_it_property (it
, Qwrap_prefix
);
18601 prefix
= Vwrap_prefix
;
18605 prefix
= get_it_property (it
, Qline_prefix
);
18607 prefix
= Vline_prefix
;
18609 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18611 /* If the prefix is wider than the window, and we try to wrap
18612 it, it would acquire its own wrap prefix, and so on till the
18613 iterator stack overflows. So, don't wrap the prefix. */
18614 it
->line_wrap
= TRUNCATE
;
18615 it
->avoid_cursor_p
= 1;
18621 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18622 only for R2L lines from display_line and display_string, when they
18623 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18624 the line/string needs to be continued on the next glyph row. */
18626 unproduce_glyphs (struct it
*it
, int n
)
18628 struct glyph
*glyph
, *end
;
18630 xassert (it
->glyph_row
);
18631 xassert (it
->glyph_row
->reversed_p
);
18632 xassert (it
->area
== TEXT_AREA
);
18633 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18635 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18636 n
= it
->glyph_row
->used
[TEXT_AREA
];
18637 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18638 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18639 for ( ; glyph
< end
; glyph
++)
18640 glyph
[-n
] = *glyph
;
18643 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18644 and ROW->maxpos. */
18646 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18647 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18648 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18650 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18651 lines' rows is implemented for bidi-reordered rows. */
18653 /* ROW->minpos is the value of min_pos, the minimal buffer position
18654 we have in ROW, or ROW->start.pos if that is smaller. */
18655 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18656 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18658 /* We didn't find buffer positions smaller than ROW->start, or
18659 didn't find _any_ valid buffer positions in any of the glyphs,
18660 so we must trust the iterator's computed positions. */
18661 row
->minpos
= row
->start
.pos
;
18664 max_pos
= CHARPOS (it
->current
.pos
);
18665 max_bpos
= BYTEPOS (it
->current
.pos
);
18668 /* Here are the various use-cases for ending the row, and the
18669 corresponding values for ROW->maxpos:
18671 Line ends in a newline from buffer eol_pos + 1
18672 Line is continued from buffer max_pos + 1
18673 Line is truncated on right it->current.pos
18674 Line ends in a newline from string max_pos + 1(*)
18675 (*) + 1 only when line ends in a forward scan
18676 Line is continued from string max_pos
18677 Line is continued from display vector max_pos
18678 Line is entirely from a string min_pos == max_pos
18679 Line is entirely from a display vector min_pos == max_pos
18680 Line that ends at ZV ZV
18682 If you discover other use-cases, please add them here as
18684 if (row
->ends_at_zv_p
)
18685 row
->maxpos
= it
->current
.pos
;
18686 else if (row
->used
[TEXT_AREA
])
18688 int seen_this_string
= 0;
18689 struct glyph_row
*r1
= row
- 1;
18691 /* Did we see the same display string on the previous row? */
18692 if (STRINGP (it
->object
)
18693 /* this is not the first row */
18694 && row
> it
->w
->desired_matrix
->rows
18695 /* previous row is not the header line */
18696 && !r1
->mode_line_p
18697 /* previous row also ends in a newline from a string */
18698 && r1
->ends_in_newline_from_string_p
)
18700 struct glyph
*start
, *end
;
18702 /* Search for the last glyph of the previous row that came
18703 from buffer or string. Depending on whether the row is
18704 L2R or R2L, we need to process it front to back or the
18705 other way round. */
18706 if (!r1
->reversed_p
)
18708 start
= r1
->glyphs
[TEXT_AREA
];
18709 end
= start
+ r1
->used
[TEXT_AREA
];
18710 /* Glyphs inserted by redisplay have an integer (zero)
18711 as their object. */
18713 && INTEGERP ((end
- 1)->object
)
18714 && (end
- 1)->charpos
<= 0)
18718 if (EQ ((end
- 1)->object
, it
->object
))
18719 seen_this_string
= 1;
18722 /* If all the glyphs of the previous row were inserted
18723 by redisplay, it means the previous row was
18724 produced from a single newline, which is only
18725 possible if that newline came from the same string
18726 as the one which produced this ROW. */
18727 seen_this_string
= 1;
18731 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18732 start
= end
+ r1
->used
[TEXT_AREA
];
18734 && INTEGERP ((end
+ 1)->object
)
18735 && (end
+ 1)->charpos
<= 0)
18739 if (EQ ((end
+ 1)->object
, it
->object
))
18740 seen_this_string
= 1;
18743 seen_this_string
= 1;
18746 /* Take note of each display string that covers a newline only
18747 once, the first time we see it. This is for when a display
18748 string includes more than one newline in it. */
18749 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18751 /* If we were scanning the buffer forward when we displayed
18752 the string, we want to account for at least one buffer
18753 position that belongs to this row (position covered by
18754 the display string), so that cursor positioning will
18755 consider this row as a candidate when point is at the end
18756 of the visual line represented by this row. This is not
18757 required when scanning back, because max_pos will already
18758 have a much larger value. */
18759 if (CHARPOS (row
->end
.pos
) > max_pos
)
18760 INC_BOTH (max_pos
, max_bpos
);
18761 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18763 else if (CHARPOS (it
->eol_pos
) > 0)
18764 SET_TEXT_POS (row
->maxpos
,
18765 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18766 else if (row
->continued_p
)
18768 /* If max_pos is different from IT's current position, it
18769 means IT->method does not belong to the display element
18770 at max_pos. However, it also means that the display
18771 element at max_pos was displayed in its entirety on this
18772 line, which is equivalent to saying that the next line
18773 starts at the next buffer position. */
18774 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18775 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18778 INC_BOTH (max_pos
, max_bpos
);
18779 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18782 else if (row
->truncated_on_right_p
)
18783 /* display_line already called reseat_at_next_visible_line_start,
18784 which puts the iterator at the beginning of the next line, in
18785 the logical order. */
18786 row
->maxpos
= it
->current
.pos
;
18787 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18788 /* A line that is entirely from a string/image/stretch... */
18789 row
->maxpos
= row
->minpos
;
18794 row
->maxpos
= it
->current
.pos
;
18797 /* Construct the glyph row IT->glyph_row in the desired matrix of
18798 IT->w from text at the current position of IT. See dispextern.h
18799 for an overview of struct it. Value is non-zero if
18800 IT->glyph_row displays text, as opposed to a line displaying ZV
18804 display_line (struct it
*it
)
18806 struct glyph_row
*row
= it
->glyph_row
;
18807 Lisp_Object overlay_arrow_string
;
18809 void *wrap_data
= NULL
;
18810 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18811 int wrap_row_used
= -1;
18812 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18813 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18814 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18815 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18816 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18818 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18819 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18821 /* We always start displaying at hpos zero even if hscrolled. */
18822 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18824 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18825 >= it
->w
->desired_matrix
->nrows
)
18827 it
->w
->nrows_scale_factor
++;
18828 fonts_changed_p
= 1;
18832 /* Is IT->w showing the region? */
18833 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18835 /* Clear the result glyph row and enable it. */
18836 prepare_desired_row (row
);
18838 row
->y
= it
->current_y
;
18839 row
->start
= it
->start
;
18840 row
->continuation_lines_width
= it
->continuation_lines_width
;
18841 row
->displays_text_p
= 1;
18842 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18843 it
->starts_in_middle_of_char_p
= 0;
18845 /* Arrange the overlays nicely for our purposes. Usually, we call
18846 display_line on only one line at a time, in which case this
18847 can't really hurt too much, or we call it on lines which appear
18848 one after another in the buffer, in which case all calls to
18849 recenter_overlay_lists but the first will be pretty cheap. */
18850 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18852 /* Move over display elements that are not visible because we are
18853 hscrolled. This may stop at an x-position < IT->first_visible_x
18854 if the first glyph is partially visible or if we hit a line end. */
18855 if (it
->current_x
< it
->first_visible_x
)
18857 this_line_min_pos
= row
->start
.pos
;
18858 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18859 MOVE_TO_POS
| MOVE_TO_X
);
18860 /* Record the smallest positions seen while we moved over
18861 display elements that are not visible. This is needed by
18862 redisplay_internal for optimizing the case where the cursor
18863 stays inside the same line. The rest of this function only
18864 considers positions that are actually displayed, so
18865 RECORD_MAX_MIN_POS will not otherwise record positions that
18866 are hscrolled to the left of the left edge of the window. */
18867 min_pos
= CHARPOS (this_line_min_pos
);
18868 min_bpos
= BYTEPOS (this_line_min_pos
);
18872 /* We only do this when not calling `move_it_in_display_line_to'
18873 above, because move_it_in_display_line_to calls
18874 handle_line_prefix itself. */
18875 handle_line_prefix (it
);
18878 /* Get the initial row height. This is either the height of the
18879 text hscrolled, if there is any, or zero. */
18880 row
->ascent
= it
->max_ascent
;
18881 row
->height
= it
->max_ascent
+ it
->max_descent
;
18882 row
->phys_ascent
= it
->max_phys_ascent
;
18883 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18884 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18886 /* Utility macro to record max and min buffer positions seen until now. */
18887 #define RECORD_MAX_MIN_POS(IT) \
18890 int composition_p = !STRINGP ((IT)->string) \
18891 && ((IT)->what == IT_COMPOSITION); \
18892 EMACS_INT current_pos = \
18893 composition_p ? (IT)->cmp_it.charpos \
18894 : IT_CHARPOS (*(IT)); \
18895 EMACS_INT current_bpos = \
18896 composition_p ? CHAR_TO_BYTE (current_pos) \
18897 : IT_BYTEPOS (*(IT)); \
18898 if (current_pos < min_pos) \
18900 min_pos = current_pos; \
18901 min_bpos = current_bpos; \
18903 if (IT_CHARPOS (*it) > max_pos) \
18905 max_pos = IT_CHARPOS (*it); \
18906 max_bpos = IT_BYTEPOS (*it); \
18911 /* Loop generating characters. The loop is left with IT on the next
18912 character to display. */
18915 int n_glyphs_before
, hpos_before
, x_before
;
18917 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18919 /* Retrieve the next thing to display. Value is zero if end of
18921 if (!get_next_display_element (it
))
18923 /* Maybe add a space at the end of this line that is used to
18924 display the cursor there under X. Set the charpos of the
18925 first glyph of blank lines not corresponding to any text
18927 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18928 row
->exact_window_width_line_p
= 1;
18929 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18930 || row
->used
[TEXT_AREA
] == 0)
18932 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18933 row
->displays_text_p
= 0;
18935 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18936 && (!MINI_WINDOW_P (it
->w
)
18937 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18938 row
->indicate_empty_line_p
= 1;
18941 it
->continuation_lines_width
= 0;
18942 row
->ends_at_zv_p
= 1;
18943 /* A row that displays right-to-left text must always have
18944 its last face extended all the way to the end of line,
18945 even if this row ends in ZV, because we still write to
18946 the screen left to right. */
18947 if (row
->reversed_p
)
18948 extend_face_to_end_of_line (it
);
18952 /* Now, get the metrics of what we want to display. This also
18953 generates glyphs in `row' (which is IT->glyph_row). */
18954 n_glyphs_before
= row
->used
[TEXT_AREA
];
18957 /* Remember the line height so far in case the next element doesn't
18958 fit on the line. */
18959 if (it
->line_wrap
!= TRUNCATE
)
18961 ascent
= it
->max_ascent
;
18962 descent
= it
->max_descent
;
18963 phys_ascent
= it
->max_phys_ascent
;
18964 phys_descent
= it
->max_phys_descent
;
18966 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18968 if (IT_DISPLAYING_WHITESPACE (it
))
18972 SAVE_IT (wrap_it
, *it
, wrap_data
);
18974 wrap_row_used
= row
->used
[TEXT_AREA
];
18975 wrap_row_ascent
= row
->ascent
;
18976 wrap_row_height
= row
->height
;
18977 wrap_row_phys_ascent
= row
->phys_ascent
;
18978 wrap_row_phys_height
= row
->phys_height
;
18979 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18980 wrap_row_min_pos
= min_pos
;
18981 wrap_row_min_bpos
= min_bpos
;
18982 wrap_row_max_pos
= max_pos
;
18983 wrap_row_max_bpos
= max_bpos
;
18989 PRODUCE_GLYPHS (it
);
18991 /* If this display element was in marginal areas, continue with
18993 if (it
->area
!= TEXT_AREA
)
18995 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18996 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18997 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18998 row
->phys_height
= max (row
->phys_height
,
18999 it
->max_phys_ascent
+ it
->max_phys_descent
);
19000 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19001 it
->max_extra_line_spacing
);
19002 set_iterator_to_next (it
, 1);
19006 /* Does the display element fit on the line? If we truncate
19007 lines, we should draw past the right edge of the window. If
19008 we don't truncate, we want to stop so that we can display the
19009 continuation glyph before the right margin. If lines are
19010 continued, there are two possible strategies for characters
19011 resulting in more than 1 glyph (e.g. tabs): Display as many
19012 glyphs as possible in this line and leave the rest for the
19013 continuation line, or display the whole element in the next
19014 line. Original redisplay did the former, so we do it also. */
19015 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19016 hpos_before
= it
->hpos
;
19019 if (/* Not a newline. */
19021 /* Glyphs produced fit entirely in the line. */
19022 && it
->current_x
< it
->last_visible_x
)
19024 it
->hpos
+= nglyphs
;
19025 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19026 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19027 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19028 row
->phys_height
= max (row
->phys_height
,
19029 it
->max_phys_ascent
+ it
->max_phys_descent
);
19030 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19031 it
->max_extra_line_spacing
);
19032 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19033 row
->x
= x
- it
->first_visible_x
;
19034 /* Record the maximum and minimum buffer positions seen so
19035 far in glyphs that will be displayed by this row. */
19037 RECORD_MAX_MIN_POS (it
);
19042 struct glyph
*glyph
;
19044 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19046 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19047 new_x
= x
+ glyph
->pixel_width
;
19049 if (/* Lines are continued. */
19050 it
->line_wrap
!= TRUNCATE
19051 && (/* Glyph doesn't fit on the line. */
19052 new_x
> it
->last_visible_x
19053 /* Or it fits exactly on a window system frame. */
19054 || (new_x
== it
->last_visible_x
19055 && FRAME_WINDOW_P (it
->f
))))
19057 /* End of a continued line. */
19060 || (new_x
== it
->last_visible_x
19061 && FRAME_WINDOW_P (it
->f
)))
19063 /* Current glyph is the only one on the line or
19064 fits exactly on the line. We must continue
19065 the line because we can't draw the cursor
19066 after the glyph. */
19067 row
->continued_p
= 1;
19068 it
->current_x
= new_x
;
19069 it
->continuation_lines_width
+= new_x
;
19071 if (i
== nglyphs
- 1)
19073 /* If line-wrap is on, check if a previous
19074 wrap point was found. */
19075 if (wrap_row_used
> 0
19076 /* Even if there is a previous wrap
19077 point, continue the line here as
19078 usual, if (i) the previous character
19079 was a space or tab AND (ii) the
19080 current character is not. */
19082 || IT_DISPLAYING_WHITESPACE (it
)))
19085 /* Record the maximum and minimum buffer
19086 positions seen so far in glyphs that will be
19087 displayed by this row. */
19089 RECORD_MAX_MIN_POS (it
);
19090 set_iterator_to_next (it
, 1);
19091 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19093 if (!get_next_display_element (it
))
19095 row
->exact_window_width_line_p
= 1;
19096 it
->continuation_lines_width
= 0;
19097 row
->continued_p
= 0;
19098 row
->ends_at_zv_p
= 1;
19100 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19102 row
->continued_p
= 0;
19103 row
->exact_window_width_line_p
= 1;
19107 else if (it
->bidi_p
)
19108 RECORD_MAX_MIN_POS (it
);
19110 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19111 && !FRAME_WINDOW_P (it
->f
))
19113 /* A padding glyph that doesn't fit on this line.
19114 This means the whole character doesn't fit
19116 if (row
->reversed_p
)
19117 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19118 - n_glyphs_before
);
19119 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19121 /* Fill the rest of the row with continuation
19122 glyphs like in 20.x. */
19123 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19124 < row
->glyphs
[1 + TEXT_AREA
])
19125 produce_special_glyphs (it
, IT_CONTINUATION
);
19127 row
->continued_p
= 1;
19128 it
->current_x
= x_before
;
19129 it
->continuation_lines_width
+= x_before
;
19131 /* Restore the height to what it was before the
19132 element not fitting on the line. */
19133 it
->max_ascent
= ascent
;
19134 it
->max_descent
= descent
;
19135 it
->max_phys_ascent
= phys_ascent
;
19136 it
->max_phys_descent
= phys_descent
;
19138 else if (wrap_row_used
> 0)
19141 if (row
->reversed_p
)
19142 unproduce_glyphs (it
,
19143 row
->used
[TEXT_AREA
] - wrap_row_used
);
19144 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19145 it
->continuation_lines_width
+= wrap_x
;
19146 row
->used
[TEXT_AREA
] = wrap_row_used
;
19147 row
->ascent
= wrap_row_ascent
;
19148 row
->height
= wrap_row_height
;
19149 row
->phys_ascent
= wrap_row_phys_ascent
;
19150 row
->phys_height
= wrap_row_phys_height
;
19151 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19152 min_pos
= wrap_row_min_pos
;
19153 min_bpos
= wrap_row_min_bpos
;
19154 max_pos
= wrap_row_max_pos
;
19155 max_bpos
= wrap_row_max_bpos
;
19156 row
->continued_p
= 1;
19157 row
->ends_at_zv_p
= 0;
19158 row
->exact_window_width_line_p
= 0;
19159 it
->continuation_lines_width
+= x
;
19161 /* Make sure that a non-default face is extended
19162 up to the right margin of the window. */
19163 extend_face_to_end_of_line (it
);
19165 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19167 /* A TAB that extends past the right edge of the
19168 window. This produces a single glyph on
19169 window system frames. We leave the glyph in
19170 this row and let it fill the row, but don't
19171 consume the TAB. */
19172 it
->continuation_lines_width
+= it
->last_visible_x
;
19173 row
->ends_in_middle_of_char_p
= 1;
19174 row
->continued_p
= 1;
19175 glyph
->pixel_width
= it
->last_visible_x
- x
;
19176 it
->starts_in_middle_of_char_p
= 1;
19180 /* Something other than a TAB that draws past
19181 the right edge of the window. Restore
19182 positions to values before the element. */
19183 if (row
->reversed_p
)
19184 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19185 - (n_glyphs_before
+ i
));
19186 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19188 /* Display continuation glyphs. */
19189 if (!FRAME_WINDOW_P (it
->f
))
19190 produce_special_glyphs (it
, IT_CONTINUATION
);
19191 row
->continued_p
= 1;
19193 it
->current_x
= x_before
;
19194 it
->continuation_lines_width
+= x
;
19195 extend_face_to_end_of_line (it
);
19197 if (nglyphs
> 1 && i
> 0)
19199 row
->ends_in_middle_of_char_p
= 1;
19200 it
->starts_in_middle_of_char_p
= 1;
19203 /* Restore the height to what it was before the
19204 element not fitting on the line. */
19205 it
->max_ascent
= ascent
;
19206 it
->max_descent
= descent
;
19207 it
->max_phys_ascent
= phys_ascent
;
19208 it
->max_phys_descent
= phys_descent
;
19213 else if (new_x
> it
->first_visible_x
)
19215 /* Increment number of glyphs actually displayed. */
19218 /* Record the maximum and minimum buffer positions
19219 seen so far in glyphs that will be displayed by
19222 RECORD_MAX_MIN_POS (it
);
19224 if (x
< it
->first_visible_x
)
19225 /* Glyph is partially visible, i.e. row starts at
19226 negative X position. */
19227 row
->x
= x
- it
->first_visible_x
;
19231 /* Glyph is completely off the left margin of the
19232 window. This should not happen because of the
19233 move_it_in_display_line at the start of this
19234 function, unless the text display area of the
19235 window is empty. */
19236 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19239 /* Even if this display element produced no glyphs at all,
19240 we want to record its position. */
19241 if (it
->bidi_p
&& nglyphs
== 0)
19242 RECORD_MAX_MIN_POS (it
);
19244 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19245 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19246 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19247 row
->phys_height
= max (row
->phys_height
,
19248 it
->max_phys_ascent
+ it
->max_phys_descent
);
19249 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19250 it
->max_extra_line_spacing
);
19252 /* End of this display line if row is continued. */
19253 if (row
->continued_p
|| row
->ends_at_zv_p
)
19258 /* Is this a line end? If yes, we're also done, after making
19259 sure that a non-default face is extended up to the right
19260 margin of the window. */
19261 if (ITERATOR_AT_END_OF_LINE_P (it
))
19263 int used_before
= row
->used
[TEXT_AREA
];
19265 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19267 /* Add a space at the end of the line that is used to
19268 display the cursor there. */
19269 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19270 append_space_for_newline (it
, 0);
19272 /* Extend the face to the end of the line. */
19273 extend_face_to_end_of_line (it
);
19275 /* Make sure we have the position. */
19276 if (used_before
== 0)
19277 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19279 /* Record the position of the newline, for use in
19281 it
->eol_pos
= it
->current
.pos
;
19283 /* Consume the line end. This skips over invisible lines. */
19284 set_iterator_to_next (it
, 1);
19285 it
->continuation_lines_width
= 0;
19289 /* Proceed with next display element. Note that this skips
19290 over lines invisible because of selective display. */
19291 set_iterator_to_next (it
, 1);
19293 /* If we truncate lines, we are done when the last displayed
19294 glyphs reach past the right margin of the window. */
19295 if (it
->line_wrap
== TRUNCATE
19296 && (FRAME_WINDOW_P (it
->f
)
19297 ? (it
->current_x
>= it
->last_visible_x
)
19298 : (it
->current_x
> it
->last_visible_x
)))
19300 /* Maybe add truncation glyphs. */
19301 if (!FRAME_WINDOW_P (it
->f
))
19305 if (!row
->reversed_p
)
19307 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19308 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19313 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19314 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19316 /* Remove any padding glyphs at the front of ROW, to
19317 make room for the truncation glyphs we will be
19318 adding below. The loop below always inserts at
19319 least one truncation glyph, so also remove the
19320 last glyph added to ROW. */
19321 unproduce_glyphs (it
, i
+ 1);
19322 /* Adjust i for the loop below. */
19323 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19326 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19328 row
->used
[TEXT_AREA
] = i
;
19329 produce_special_glyphs (it
, IT_TRUNCATION
);
19332 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19334 /* Don't truncate if we can overflow newline into fringe. */
19335 if (!get_next_display_element (it
))
19337 it
->continuation_lines_width
= 0;
19338 row
->ends_at_zv_p
= 1;
19339 row
->exact_window_width_line_p
= 1;
19342 if (ITERATOR_AT_END_OF_LINE_P (it
))
19344 row
->exact_window_width_line_p
= 1;
19345 goto at_end_of_line
;
19349 row
->truncated_on_right_p
= 1;
19350 it
->continuation_lines_width
= 0;
19351 reseat_at_next_visible_line_start (it
, 0);
19352 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19353 it
->hpos
= hpos_before
;
19354 it
->current_x
= x_before
;
19360 bidi_unshelve_cache (wrap_data
, 1);
19362 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19363 at the left window margin. */
19364 if (it
->first_visible_x
19365 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19367 if (!FRAME_WINDOW_P (it
->f
))
19368 insert_left_trunc_glyphs (it
);
19369 row
->truncated_on_left_p
= 1;
19372 /* Remember the position at which this line ends.
19374 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19375 cannot be before the call to find_row_edges below, since that is
19376 where these positions are determined. */
19377 row
->end
= it
->current
;
19380 row
->minpos
= row
->start
.pos
;
19381 row
->maxpos
= row
->end
.pos
;
19385 /* ROW->minpos and ROW->maxpos must be the smallest and
19386 `1 + the largest' buffer positions in ROW. But if ROW was
19387 bidi-reordered, these two positions can be anywhere in the
19388 row, so we must determine them now. */
19389 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19392 /* If the start of this line is the overlay arrow-position, then
19393 mark this glyph row as the one containing the overlay arrow.
19394 This is clearly a mess with variable size fonts. It would be
19395 better to let it be displayed like cursors under X. */
19396 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19397 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19398 !NILP (overlay_arrow_string
)))
19400 /* Overlay arrow in window redisplay is a fringe bitmap. */
19401 if (STRINGP (overlay_arrow_string
))
19403 struct glyph_row
*arrow_row
19404 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19405 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19406 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19407 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19408 struct glyph
*p2
, *end
;
19410 /* Copy the arrow glyphs. */
19411 while (glyph
< arrow_end
)
19414 /* Throw away padding glyphs. */
19416 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19417 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19423 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19428 xassert (INTEGERP (overlay_arrow_string
));
19429 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19431 overlay_arrow_seen
= 1;
19434 /* Highlight trailing whitespace. */
19435 if (!NILP (Vshow_trailing_whitespace
))
19436 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19438 /* Compute pixel dimensions of this line. */
19439 compute_line_metrics (it
);
19441 /* Implementation note: No changes in the glyphs of ROW or in their
19442 faces can be done past this point, because compute_line_metrics
19443 computes ROW's hash value and stores it within the glyph_row
19446 /* Record whether this row ends inside an ellipsis. */
19447 row
->ends_in_ellipsis_p
19448 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19449 && it
->ellipsis_p
);
19451 /* Save fringe bitmaps in this row. */
19452 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19453 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19454 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19455 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19457 it
->left_user_fringe_bitmap
= 0;
19458 it
->left_user_fringe_face_id
= 0;
19459 it
->right_user_fringe_bitmap
= 0;
19460 it
->right_user_fringe_face_id
= 0;
19462 /* Maybe set the cursor. */
19463 cvpos
= it
->w
->cursor
.vpos
;
19465 /* In bidi-reordered rows, keep checking for proper cursor
19466 position even if one has been found already, because buffer
19467 positions in such rows change non-linearly with ROW->VPOS,
19468 when a line is continued. One exception: when we are at ZV,
19469 display cursor on the first suitable glyph row, since all
19470 the empty rows after that also have their position set to ZV. */
19471 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19472 lines' rows is implemented for bidi-reordered rows. */
19474 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19475 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19476 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19477 && cursor_row_p (row
))
19478 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19480 /* Prepare for the next line. This line starts horizontally at (X
19481 HPOS) = (0 0). Vertical positions are incremented. As a
19482 convenience for the caller, IT->glyph_row is set to the next
19484 it
->current_x
= it
->hpos
= 0;
19485 it
->current_y
+= row
->height
;
19486 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19489 /* The next row should by default use the same value of the
19490 reversed_p flag as this one. set_iterator_to_next decides when
19491 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19492 the flag accordingly. */
19493 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19494 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19495 it
->start
= row
->end
;
19496 return row
->displays_text_p
;
19498 #undef RECORD_MAX_MIN_POS
19501 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19502 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19503 doc
: /* Return paragraph direction at point in BUFFER.
19504 Value is either `left-to-right' or `right-to-left'.
19505 If BUFFER is omitted or nil, it defaults to the current buffer.
19507 Paragraph direction determines how the text in the paragraph is displayed.
19508 In left-to-right paragraphs, text begins at the left margin of the window
19509 and the reading direction is generally left to right. In right-to-left
19510 paragraphs, text begins at the right margin and is read from right to left.
19512 See also `bidi-paragraph-direction'. */)
19513 (Lisp_Object buffer
)
19515 struct buffer
*buf
= current_buffer
;
19516 struct buffer
*old
= buf
;
19518 if (! NILP (buffer
))
19520 CHECK_BUFFER (buffer
);
19521 buf
= XBUFFER (buffer
);
19524 if (NILP (BVAR (buf
, bidi_display_reordering
))
19525 || NILP (BVAR (buf
, enable_multibyte_characters
))
19526 /* When we are loading loadup.el, the character property tables
19527 needed for bidi iteration are not yet available. */
19528 || !NILP (Vpurify_flag
))
19529 return Qleft_to_right
;
19530 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19531 return BVAR (buf
, bidi_paragraph_direction
);
19534 /* Determine the direction from buffer text. We could try to
19535 use current_matrix if it is up to date, but this seems fast
19536 enough as it is. */
19537 struct bidi_it itb
;
19538 EMACS_INT pos
= BUF_PT (buf
);
19539 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19541 void *itb_data
= bidi_shelve_cache ();
19543 set_buffer_temp (buf
);
19544 /* bidi_paragraph_init finds the base direction of the paragraph
19545 by searching forward from paragraph start. We need the base
19546 direction of the current or _previous_ paragraph, so we need
19547 to make sure we are within that paragraph. To that end, find
19548 the previous non-empty line. */
19549 if (pos
>= ZV
&& pos
> BEGV
)
19552 bytepos
= CHAR_TO_BYTE (pos
);
19554 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19555 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19557 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19558 || c
== ' ' || c
== '\t' || c
== '\f')
19560 if (bytepos
<= BEGV_BYTE
)
19565 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19568 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19569 itb
.paragraph_dir
= NEUTRAL_DIR
;
19570 itb
.string
.s
= NULL
;
19571 itb
.string
.lstring
= Qnil
;
19572 itb
.string
.bufpos
= 0;
19573 itb
.string
.unibyte
= 0;
19574 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19575 bidi_unshelve_cache (itb_data
, 0);
19576 set_buffer_temp (old
);
19577 switch (itb
.paragraph_dir
)
19580 return Qleft_to_right
;
19583 return Qright_to_left
;
19593 /***********************************************************************
19595 ***********************************************************************/
19597 /* Redisplay the menu bar in the frame for window W.
19599 The menu bar of X frames that don't have X toolkit support is
19600 displayed in a special window W->frame->menu_bar_window.
19602 The menu bar of terminal frames is treated specially as far as
19603 glyph matrices are concerned. Menu bar lines are not part of
19604 windows, so the update is done directly on the frame matrix rows
19605 for the menu bar. */
19608 display_menu_bar (struct window
*w
)
19610 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19615 /* Don't do all this for graphical frames. */
19617 if (FRAME_W32_P (f
))
19620 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19626 if (FRAME_NS_P (f
))
19628 #endif /* HAVE_NS */
19630 #ifdef USE_X_TOOLKIT
19631 xassert (!FRAME_WINDOW_P (f
));
19632 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19633 it
.first_visible_x
= 0;
19634 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19635 #else /* not USE_X_TOOLKIT */
19636 if (FRAME_WINDOW_P (f
))
19638 /* Menu bar lines are displayed in the desired matrix of the
19639 dummy window menu_bar_window. */
19640 struct window
*menu_w
;
19641 xassert (WINDOWP (f
->menu_bar_window
));
19642 menu_w
= XWINDOW (f
->menu_bar_window
);
19643 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19645 it
.first_visible_x
= 0;
19646 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19650 /* This is a TTY frame, i.e. character hpos/vpos are used as
19652 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19654 it
.first_visible_x
= 0;
19655 it
.last_visible_x
= FRAME_COLS (f
);
19657 #endif /* not USE_X_TOOLKIT */
19659 /* FIXME: This should be controlled by a user option. See the
19660 comments in redisplay_tool_bar and display_mode_line about
19662 it
.paragraph_embedding
= L2R
;
19664 if (! mode_line_inverse_video
)
19665 /* Force the menu-bar to be displayed in the default face. */
19666 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19668 /* Clear all rows of the menu bar. */
19669 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19671 struct glyph_row
*row
= it
.glyph_row
+ i
;
19672 clear_glyph_row (row
);
19673 row
->enabled_p
= 1;
19674 row
->full_width_p
= 1;
19677 /* Display all items of the menu bar. */
19678 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19679 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19681 Lisp_Object string
;
19683 /* Stop at nil string. */
19684 string
= AREF (items
, i
+ 1);
19688 /* Remember where item was displayed. */
19689 ASET (items
, i
+ 3, make_number (it
.hpos
));
19691 /* Display the item, pad with one space. */
19692 if (it
.current_x
< it
.last_visible_x
)
19693 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19694 SCHARS (string
) + 1, 0, 0, -1);
19697 /* Fill out the line with spaces. */
19698 if (it
.current_x
< it
.last_visible_x
)
19699 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19701 /* Compute the total height of the lines. */
19702 compute_line_metrics (&it
);
19707 /***********************************************************************
19709 ***********************************************************************/
19711 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19712 FORCE is non-zero, redisplay mode lines unconditionally.
19713 Otherwise, redisplay only mode lines that are garbaged. Value is
19714 the number of windows whose mode lines were redisplayed. */
19717 redisplay_mode_lines (Lisp_Object window
, int force
)
19721 while (!NILP (window
))
19723 struct window
*w
= XWINDOW (window
);
19725 if (WINDOWP (w
->hchild
))
19726 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19727 else if (WINDOWP (w
->vchild
))
19728 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19730 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19731 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19733 struct text_pos lpoint
;
19734 struct buffer
*old
= current_buffer
;
19736 /* Set the window's buffer for the mode line display. */
19737 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19738 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19740 /* Point refers normally to the selected window. For any
19741 other window, set up appropriate value. */
19742 if (!EQ (window
, selected_window
))
19744 struct text_pos pt
;
19746 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19747 if (CHARPOS (pt
) < BEGV
)
19748 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19749 else if (CHARPOS (pt
) > (ZV
- 1))
19750 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19752 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19755 /* Display mode lines. */
19756 clear_glyph_matrix (w
->desired_matrix
);
19757 if (display_mode_lines (w
))
19760 w
->must_be_updated_p
= 1;
19763 /* Restore old settings. */
19764 set_buffer_internal_1 (old
);
19765 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19775 /* Display the mode and/or header line of window W. Value is the
19776 sum number of mode lines and header lines displayed. */
19779 display_mode_lines (struct window
*w
)
19781 Lisp_Object old_selected_window
, old_selected_frame
;
19784 old_selected_frame
= selected_frame
;
19785 selected_frame
= w
->frame
;
19786 old_selected_window
= selected_window
;
19787 XSETWINDOW (selected_window
, w
);
19789 /* These will be set while the mode line specs are processed. */
19790 line_number_displayed
= 0;
19791 w
->column_number_displayed
= Qnil
;
19793 if (WINDOW_WANTS_MODELINE_P (w
))
19795 struct window
*sel_w
= XWINDOW (old_selected_window
);
19797 /* Select mode line face based on the real selected window. */
19798 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19799 BVAR (current_buffer
, mode_line_format
));
19803 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19805 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19806 BVAR (current_buffer
, header_line_format
));
19810 selected_frame
= old_selected_frame
;
19811 selected_window
= old_selected_window
;
19816 /* Display mode or header line of window W. FACE_ID specifies which
19817 line to display; it is either MODE_LINE_FACE_ID or
19818 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19819 display. Value is the pixel height of the mode/header line
19823 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19827 int count
= SPECPDL_INDEX ();
19829 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19830 /* Don't extend on a previously drawn mode-line.
19831 This may happen if called from pos_visible_p. */
19832 it
.glyph_row
->enabled_p
= 0;
19833 prepare_desired_row (it
.glyph_row
);
19835 it
.glyph_row
->mode_line_p
= 1;
19837 if (! mode_line_inverse_video
)
19838 /* Force the mode-line to be displayed in the default face. */
19839 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19841 /* FIXME: This should be controlled by a user option. But
19842 supporting such an option is not trivial, since the mode line is
19843 made up of many separate strings. */
19844 it
.paragraph_embedding
= L2R
;
19846 record_unwind_protect (unwind_format_mode_line
,
19847 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19849 mode_line_target
= MODE_LINE_DISPLAY
;
19851 /* Temporarily make frame's keyboard the current kboard so that
19852 kboard-local variables in the mode_line_format will get the right
19854 push_kboard (FRAME_KBOARD (it
.f
));
19855 record_unwind_save_match_data ();
19856 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19859 unbind_to (count
, Qnil
);
19861 /* Fill up with spaces. */
19862 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19864 compute_line_metrics (&it
);
19865 it
.glyph_row
->full_width_p
= 1;
19866 it
.glyph_row
->continued_p
= 0;
19867 it
.glyph_row
->truncated_on_left_p
= 0;
19868 it
.glyph_row
->truncated_on_right_p
= 0;
19870 /* Make a 3D mode-line have a shadow at its right end. */
19871 face
= FACE_FROM_ID (it
.f
, face_id
);
19872 extend_face_to_end_of_line (&it
);
19873 if (face
->box
!= FACE_NO_BOX
)
19875 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19876 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19877 last
->right_box_line_p
= 1;
19880 return it
.glyph_row
->height
;
19883 /* Move element ELT in LIST to the front of LIST.
19884 Return the updated list. */
19887 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19889 register Lisp_Object tail
, prev
;
19890 register Lisp_Object tem
;
19894 while (CONSP (tail
))
19900 /* Splice out the link TAIL. */
19902 list
= XCDR (tail
);
19904 Fsetcdr (prev
, XCDR (tail
));
19906 /* Now make it the first. */
19907 Fsetcdr (tail
, list
);
19912 tail
= XCDR (tail
);
19916 /* Not found--return unchanged LIST. */
19920 /* Contribute ELT to the mode line for window IT->w. How it
19921 translates into text depends on its data type.
19923 IT describes the display environment in which we display, as usual.
19925 DEPTH is the depth in recursion. It is used to prevent
19926 infinite recursion here.
19928 FIELD_WIDTH is the number of characters the display of ELT should
19929 occupy in the mode line, and PRECISION is the maximum number of
19930 characters to display from ELT's representation. See
19931 display_string for details.
19933 Returns the hpos of the end of the text generated by ELT.
19935 PROPS is a property list to add to any string we encounter.
19937 If RISKY is nonzero, remove (disregard) any properties in any string
19938 we encounter, and ignore :eval and :propertize.
19940 The global variable `mode_line_target' determines whether the
19941 output is passed to `store_mode_line_noprop',
19942 `store_mode_line_string', or `display_string'. */
19945 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19946 Lisp_Object elt
, Lisp_Object props
, int risky
)
19948 int n
= 0, field
, prec
;
19953 elt
= build_string ("*too-deep*");
19957 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19961 /* A string: output it and check for %-constructs within it. */
19963 EMACS_INT offset
= 0;
19965 if (SCHARS (elt
) > 0
19966 && (!NILP (props
) || risky
))
19968 Lisp_Object oprops
, aelt
;
19969 oprops
= Ftext_properties_at (make_number (0), elt
);
19971 /* If the starting string's properties are not what
19972 we want, translate the string. Also, if the string
19973 is risky, do that anyway. */
19975 if (NILP (Fequal (props
, oprops
)) || risky
)
19977 /* If the starting string has properties,
19978 merge the specified ones onto the existing ones. */
19979 if (! NILP (oprops
) && !risky
)
19983 oprops
= Fcopy_sequence (oprops
);
19985 while (CONSP (tem
))
19987 oprops
= Fplist_put (oprops
, XCAR (tem
),
19988 XCAR (XCDR (tem
)));
19989 tem
= XCDR (XCDR (tem
));
19994 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19995 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19997 /* AELT is what we want. Move it to the front
19998 without consing. */
20000 mode_line_proptrans_alist
20001 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20007 /* If AELT has the wrong props, it is useless.
20008 so get rid of it. */
20010 mode_line_proptrans_alist
20011 = Fdelq (aelt
, mode_line_proptrans_alist
);
20013 elt
= Fcopy_sequence (elt
);
20014 Fset_text_properties (make_number (0), Flength (elt
),
20016 /* Add this item to mode_line_proptrans_alist. */
20017 mode_line_proptrans_alist
20018 = Fcons (Fcons (elt
, props
),
20019 mode_line_proptrans_alist
);
20020 /* Truncate mode_line_proptrans_alist
20021 to at most 50 elements. */
20022 tem
= Fnthcdr (make_number (50),
20023 mode_line_proptrans_alist
);
20025 XSETCDR (tem
, Qnil
);
20034 prec
= precision
- n
;
20035 switch (mode_line_target
)
20037 case MODE_LINE_NOPROP
:
20038 case MODE_LINE_TITLE
:
20039 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20041 case MODE_LINE_STRING
:
20042 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20044 case MODE_LINE_DISPLAY
:
20045 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20046 0, prec
, 0, STRING_MULTIBYTE (elt
));
20053 /* Handle the non-literal case. */
20055 while ((precision
<= 0 || n
< precision
)
20056 && SREF (elt
, offset
) != 0
20057 && (mode_line_target
!= MODE_LINE_DISPLAY
20058 || it
->current_x
< it
->last_visible_x
))
20060 EMACS_INT last_offset
= offset
;
20062 /* Advance to end of string or next format specifier. */
20063 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20066 if (offset
- 1 != last_offset
)
20068 EMACS_INT nchars
, nbytes
;
20070 /* Output to end of string or up to '%'. Field width
20071 is length of string. Don't output more than
20072 PRECISION allows us. */
20075 prec
= c_string_width (SDATA (elt
) + last_offset
,
20076 offset
- last_offset
, precision
- n
,
20079 switch (mode_line_target
)
20081 case MODE_LINE_NOPROP
:
20082 case MODE_LINE_TITLE
:
20083 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20085 case MODE_LINE_STRING
:
20087 EMACS_INT bytepos
= last_offset
;
20088 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20089 EMACS_INT endpos
= (precision
<= 0
20090 ? string_byte_to_char (elt
, offset
)
20091 : charpos
+ nchars
);
20093 n
+= store_mode_line_string (NULL
,
20094 Fsubstring (elt
, make_number (charpos
),
20095 make_number (endpos
)),
20099 case MODE_LINE_DISPLAY
:
20101 EMACS_INT bytepos
= last_offset
;
20102 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20104 if (precision
<= 0)
20105 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20106 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20108 STRING_MULTIBYTE (elt
));
20113 else /* c == '%' */
20115 EMACS_INT percent_position
= offset
;
20117 /* Get the specified minimum width. Zero means
20120 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20121 field
= field
* 10 + c
- '0';
20123 /* Don't pad beyond the total padding allowed. */
20124 if (field_width
- n
> 0 && field
> field_width
- n
)
20125 field
= field_width
- n
;
20127 /* Note that either PRECISION <= 0 or N < PRECISION. */
20128 prec
= precision
- n
;
20131 n
+= display_mode_element (it
, depth
, field
, prec
,
20132 Vglobal_mode_string
, props
,
20137 EMACS_INT bytepos
, charpos
;
20139 Lisp_Object string
;
20141 bytepos
= percent_position
;
20142 charpos
= (STRING_MULTIBYTE (elt
)
20143 ? string_byte_to_char (elt
, bytepos
)
20145 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20146 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20148 switch (mode_line_target
)
20150 case MODE_LINE_NOPROP
:
20151 case MODE_LINE_TITLE
:
20152 n
+= store_mode_line_noprop (spec
, field
, prec
);
20154 case MODE_LINE_STRING
:
20156 Lisp_Object tem
= build_string (spec
);
20157 props
= Ftext_properties_at (make_number (charpos
), elt
);
20158 /* Should only keep face property in props */
20159 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20162 case MODE_LINE_DISPLAY
:
20164 int nglyphs_before
, nwritten
;
20166 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20167 nwritten
= display_string (spec
, string
, elt
,
20172 /* Assign to the glyphs written above the
20173 string where the `%x' came from, position
20177 struct glyph
*glyph
20178 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20182 for (i
= 0; i
< nwritten
; ++i
)
20184 glyph
[i
].object
= elt
;
20185 glyph
[i
].charpos
= charpos
;
20202 /* A symbol: process the value of the symbol recursively
20203 as if it appeared here directly. Avoid error if symbol void.
20204 Special case: if value of symbol is a string, output the string
20207 register Lisp_Object tem
;
20209 /* If the variable is not marked as risky to set
20210 then its contents are risky to use. */
20211 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20214 tem
= Fboundp (elt
);
20217 tem
= Fsymbol_value (elt
);
20218 /* If value is a string, output that string literally:
20219 don't check for % within it. */
20223 if (!EQ (tem
, elt
))
20225 /* Give up right away for nil or t. */
20235 register Lisp_Object car
, tem
;
20237 /* A cons cell: five distinct cases.
20238 If first element is :eval or :propertize, do something special.
20239 If first element is a string or a cons, process all the elements
20240 and effectively concatenate them.
20241 If first element is a negative number, truncate displaying cdr to
20242 at most that many characters. If positive, pad (with spaces)
20243 to at least that many characters.
20244 If first element is a symbol, process the cadr or caddr recursively
20245 according to whether the symbol's value is non-nil or nil. */
20247 if (EQ (car
, QCeval
))
20249 /* An element of the form (:eval FORM) means evaluate FORM
20250 and use the result as mode line elements. */
20255 if (CONSP (XCDR (elt
)))
20258 spec
= safe_eval (XCAR (XCDR (elt
)));
20259 n
+= display_mode_element (it
, depth
, field_width
- n
,
20260 precision
- n
, spec
, props
,
20264 else if (EQ (car
, QCpropertize
))
20266 /* An element of the form (:propertize ELT PROPS...)
20267 means display ELT but applying properties PROPS. */
20272 if (CONSP (XCDR (elt
)))
20273 n
+= display_mode_element (it
, depth
, field_width
- n
,
20274 precision
- n
, XCAR (XCDR (elt
)),
20275 XCDR (XCDR (elt
)), risky
);
20277 else if (SYMBOLP (car
))
20279 tem
= Fboundp (car
);
20283 /* elt is now the cdr, and we know it is a cons cell.
20284 Use its car if CAR has a non-nil value. */
20287 tem
= Fsymbol_value (car
);
20294 /* Symbol's value is nil (or symbol is unbound)
20295 Get the cddr of the original list
20296 and if possible find the caddr and use that. */
20300 else if (!CONSP (elt
))
20305 else if (INTEGERP (car
))
20307 register int lim
= XINT (car
);
20311 /* Negative int means reduce maximum width. */
20312 if (precision
<= 0)
20315 precision
= min (precision
, -lim
);
20319 /* Padding specified. Don't let it be more than
20320 current maximum. */
20322 lim
= min (precision
, lim
);
20324 /* If that's more padding than already wanted, queue it.
20325 But don't reduce padding already specified even if
20326 that is beyond the current truncation point. */
20327 field_width
= max (lim
, field_width
);
20331 else if (STRINGP (car
) || CONSP (car
))
20333 Lisp_Object halftail
= elt
;
20337 && (precision
<= 0 || n
< precision
))
20339 n
+= display_mode_element (it
, depth
,
20340 /* Do padding only after the last
20341 element in the list. */
20342 (! CONSP (XCDR (elt
))
20345 precision
- n
, XCAR (elt
),
20349 if ((len
& 1) == 0)
20350 halftail
= XCDR (halftail
);
20351 /* Check for cycle. */
20352 if (EQ (halftail
, elt
))
20361 elt
= build_string ("*invalid*");
20365 /* Pad to FIELD_WIDTH. */
20366 if (field_width
> 0 && n
< field_width
)
20368 switch (mode_line_target
)
20370 case MODE_LINE_NOPROP
:
20371 case MODE_LINE_TITLE
:
20372 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20374 case MODE_LINE_STRING
:
20375 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20377 case MODE_LINE_DISPLAY
:
20378 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20387 /* Store a mode-line string element in mode_line_string_list.
20389 If STRING is non-null, display that C string. Otherwise, the Lisp
20390 string LISP_STRING is displayed.
20392 FIELD_WIDTH is the minimum number of output glyphs to produce.
20393 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20394 with spaces. FIELD_WIDTH <= 0 means don't pad.
20396 PRECISION is the maximum number of characters to output from
20397 STRING. PRECISION <= 0 means don't truncate the string.
20399 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20400 properties to the string.
20402 PROPS are the properties to add to the string.
20403 The mode_line_string_face face property is always added to the string.
20407 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20408 int field_width
, int precision
, Lisp_Object props
)
20413 if (string
!= NULL
)
20415 len
= strlen (string
);
20416 if (precision
> 0 && len
> precision
)
20418 lisp_string
= make_string (string
, len
);
20420 props
= mode_line_string_face_prop
;
20421 else if (!NILP (mode_line_string_face
))
20423 Lisp_Object face
= Fplist_get (props
, Qface
);
20424 props
= Fcopy_sequence (props
);
20426 face
= mode_line_string_face
;
20428 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20429 props
= Fplist_put (props
, Qface
, face
);
20431 Fadd_text_properties (make_number (0), make_number (len
),
20432 props
, lisp_string
);
20436 len
= XFASTINT (Flength (lisp_string
));
20437 if (precision
> 0 && len
> precision
)
20440 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20443 if (!NILP (mode_line_string_face
))
20447 props
= Ftext_properties_at (make_number (0), lisp_string
);
20448 face
= Fplist_get (props
, Qface
);
20450 face
= mode_line_string_face
;
20452 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20453 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20455 lisp_string
= Fcopy_sequence (lisp_string
);
20458 Fadd_text_properties (make_number (0), make_number (len
),
20459 props
, lisp_string
);
20464 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20468 if (field_width
> len
)
20470 field_width
-= len
;
20471 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20473 Fadd_text_properties (make_number (0), make_number (field_width
),
20474 props
, lisp_string
);
20475 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20483 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20485 doc
: /* Format a string out of a mode line format specification.
20486 First arg FORMAT specifies the mode line format (see `mode-line-format'
20487 for details) to use.
20489 By default, the format is evaluated for the currently selected window.
20491 Optional second arg FACE specifies the face property to put on all
20492 characters for which no face is specified. The value nil means the
20493 default face. The value t means whatever face the window's mode line
20494 currently uses (either `mode-line' or `mode-line-inactive',
20495 depending on whether the window is the selected window or not).
20496 An integer value means the value string has no text
20499 Optional third and fourth args WINDOW and BUFFER specify the window
20500 and buffer to use as the context for the formatting (defaults
20501 are the selected window and the WINDOW's buffer). */)
20502 (Lisp_Object format
, Lisp_Object face
,
20503 Lisp_Object window
, Lisp_Object buffer
)
20508 struct buffer
*old_buffer
= NULL
;
20510 int no_props
= INTEGERP (face
);
20511 int count
= SPECPDL_INDEX ();
20513 int string_start
= 0;
20516 window
= selected_window
;
20517 CHECK_WINDOW (window
);
20518 w
= XWINDOW (window
);
20521 buffer
= w
->buffer
;
20522 CHECK_BUFFER (buffer
);
20524 /* Make formatting the modeline a non-op when noninteractive, otherwise
20525 there will be problems later caused by a partially initialized frame. */
20526 if (NILP (format
) || noninteractive
)
20527 return empty_unibyte_string
;
20532 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20533 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20534 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20535 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20536 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20537 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20538 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20541 if (XBUFFER (buffer
) != current_buffer
)
20542 old_buffer
= current_buffer
;
20544 /* Save things including mode_line_proptrans_alist,
20545 and set that to nil so that we don't alter the outer value. */
20546 record_unwind_protect (unwind_format_mode_line
,
20547 format_mode_line_unwind_data
20548 (old_buffer
, selected_window
, 1));
20549 mode_line_proptrans_alist
= Qnil
;
20551 Fselect_window (window
, Qt
);
20553 set_buffer_internal_1 (XBUFFER (buffer
));
20555 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20559 mode_line_target
= MODE_LINE_NOPROP
;
20560 mode_line_string_face_prop
= Qnil
;
20561 mode_line_string_list
= Qnil
;
20562 string_start
= MODE_LINE_NOPROP_LEN (0);
20566 mode_line_target
= MODE_LINE_STRING
;
20567 mode_line_string_list
= Qnil
;
20568 mode_line_string_face
= face
;
20569 mode_line_string_face_prop
20570 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20573 push_kboard (FRAME_KBOARD (it
.f
));
20574 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20579 len
= MODE_LINE_NOPROP_LEN (string_start
);
20580 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20584 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20585 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20586 empty_unibyte_string
);
20589 unbind_to (count
, Qnil
);
20593 /* Write a null-terminated, right justified decimal representation of
20594 the positive integer D to BUF using a minimal field width WIDTH. */
20597 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20599 register char *p
= buf
;
20607 *p
++ = d
% 10 + '0';
20612 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20623 /* Write a null-terminated, right justified decimal and "human
20624 readable" representation of the nonnegative integer D to BUF using
20625 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20627 static const char power_letter
[] =
20641 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20643 /* We aim to represent the nonnegative integer D as
20644 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20645 EMACS_INT quotient
= d
;
20647 /* -1 means: do not use TENTHS. */
20651 /* Length of QUOTIENT.TENTHS as a string. */
20657 if (1000 <= quotient
)
20659 /* Scale to the appropriate EXPONENT. */
20662 remainder
= quotient
% 1000;
20666 while (1000 <= quotient
);
20668 /* Round to nearest and decide whether to use TENTHS or not. */
20671 tenths
= remainder
/ 100;
20672 if (50 <= remainder
% 100)
20679 if (quotient
== 10)
20687 if (500 <= remainder
)
20689 if (quotient
< 999)
20700 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20701 if (tenths
== -1 && quotient
<= 99)
20708 p
= psuffix
= buf
+ max (width
, length
);
20710 /* Print EXPONENT. */
20711 *psuffix
++ = power_letter
[exponent
];
20714 /* Print TENTHS. */
20717 *--p
= '0' + tenths
;
20721 /* Print QUOTIENT. */
20724 int digit
= quotient
% 10;
20725 *--p
= '0' + digit
;
20727 while ((quotient
/= 10) != 0);
20729 /* Print leading spaces. */
20734 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20735 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20736 type of CODING_SYSTEM. Return updated pointer into BUF. */
20738 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20741 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20744 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20745 const unsigned char *eol_str
;
20747 /* The EOL conversion we are using. */
20748 Lisp_Object eoltype
;
20750 val
= CODING_SYSTEM_SPEC (coding_system
);
20753 if (!VECTORP (val
)) /* Not yet decided. */
20758 eoltype
= eol_mnemonic_undecided
;
20759 /* Don't mention EOL conversion if it isn't decided. */
20764 Lisp_Object eolvalue
;
20766 attrs
= AREF (val
, 0);
20767 eolvalue
= AREF (val
, 2);
20770 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20774 /* The EOL conversion that is normal on this system. */
20776 if (NILP (eolvalue
)) /* Not yet decided. */
20777 eoltype
= eol_mnemonic_undecided
;
20778 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20779 eoltype
= eol_mnemonic_undecided
;
20780 else /* eolvalue is Qunix, Qdos, or Qmac. */
20781 eoltype
= (EQ (eolvalue
, Qunix
)
20782 ? eol_mnemonic_unix
20783 : (EQ (eolvalue
, Qdos
) == 1
20784 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20790 /* Mention the EOL conversion if it is not the usual one. */
20791 if (STRINGP (eoltype
))
20793 eol_str
= SDATA (eoltype
);
20794 eol_str_len
= SBYTES (eoltype
);
20796 else if (CHARACTERP (eoltype
))
20798 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20799 int c
= XFASTINT (eoltype
);
20800 eol_str_len
= CHAR_STRING (c
, tmp
);
20805 eol_str
= invalid_eol_type
;
20806 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20808 memcpy (buf
, eol_str
, eol_str_len
);
20809 buf
+= eol_str_len
;
20815 /* Return a string for the output of a mode line %-spec for window W,
20816 generated by character C. FIELD_WIDTH > 0 means pad the string
20817 returned with spaces to that value. Return a Lisp string in
20818 *STRING if the resulting string is taken from that Lisp string.
20820 Note we operate on the current buffer for most purposes,
20821 the exception being w->base_line_pos. */
20823 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20825 static const char *
20826 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20827 Lisp_Object
*string
)
20830 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20831 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20832 struct buffer
*b
= current_buffer
;
20840 if (!NILP (BVAR (b
, read_only
)))
20842 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20847 /* This differs from %* only for a modified read-only buffer. */
20848 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20850 if (!NILP (BVAR (b
, read_only
)))
20855 /* This differs from %* in ignoring read-only-ness. */
20856 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20868 if (command_loop_level
> 5)
20870 p
= decode_mode_spec_buf
;
20871 for (i
= 0; i
< command_loop_level
; i
++)
20874 return decode_mode_spec_buf
;
20882 if (command_loop_level
> 5)
20884 p
= decode_mode_spec_buf
;
20885 for (i
= 0; i
< command_loop_level
; i
++)
20888 return decode_mode_spec_buf
;
20895 /* Let lots_of_dashes be a string of infinite length. */
20896 if (mode_line_target
== MODE_LINE_NOPROP
||
20897 mode_line_target
== MODE_LINE_STRING
)
20899 if (field_width
<= 0
20900 || field_width
> sizeof (lots_of_dashes
))
20902 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20903 decode_mode_spec_buf
[i
] = '-';
20904 decode_mode_spec_buf
[i
] = '\0';
20905 return decode_mode_spec_buf
;
20908 return lots_of_dashes
;
20912 obj
= BVAR (b
, name
);
20916 /* %c and %l are ignored in `frame-title-format'.
20917 (In redisplay_internal, the frame title is drawn _before_ the
20918 windows are updated, so the stuff which depends on actual
20919 window contents (such as %l) may fail to render properly, or
20920 even crash emacs.) */
20921 if (mode_line_target
== MODE_LINE_TITLE
)
20925 EMACS_INT col
= current_column ();
20926 w
->column_number_displayed
= make_number (col
);
20927 pint2str (decode_mode_spec_buf
, field_width
, col
);
20928 return decode_mode_spec_buf
;
20932 #ifndef SYSTEM_MALLOC
20934 if (NILP (Vmemory_full
))
20937 return "!MEM FULL! ";
20944 /* %F displays the frame name. */
20945 if (!NILP (f
->title
))
20946 return SSDATA (f
->title
);
20947 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20948 return SSDATA (f
->name
);
20952 obj
= BVAR (b
, filename
);
20957 EMACS_INT size
= ZV
- BEGV
;
20958 pint2str (decode_mode_spec_buf
, field_width
, size
);
20959 return decode_mode_spec_buf
;
20964 EMACS_INT size
= ZV
- BEGV
;
20965 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20966 return decode_mode_spec_buf
;
20971 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20972 EMACS_INT topline
, nlines
, height
;
20975 /* %c and %l are ignored in `frame-title-format'. */
20976 if (mode_line_target
== MODE_LINE_TITLE
)
20979 startpos
= XMARKER (w
->start
)->charpos
;
20980 startpos_byte
= marker_byte_position (w
->start
);
20981 height
= WINDOW_TOTAL_LINES (w
);
20983 /* If we decided that this buffer isn't suitable for line numbers,
20984 don't forget that too fast. */
20985 if (EQ (w
->base_line_pos
, w
->buffer
))
20987 /* But do forget it, if the window shows a different buffer now. */
20988 else if (BUFFERP (w
->base_line_pos
))
20989 w
->base_line_pos
= Qnil
;
20991 /* If the buffer is very big, don't waste time. */
20992 if (INTEGERP (Vline_number_display_limit
)
20993 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20995 w
->base_line_pos
= Qnil
;
20996 w
->base_line_number
= Qnil
;
21000 if (INTEGERP (w
->base_line_number
)
21001 && INTEGERP (w
->base_line_pos
)
21002 && XFASTINT (w
->base_line_pos
) <= startpos
)
21004 line
= XFASTINT (w
->base_line_number
);
21005 linepos
= XFASTINT (w
->base_line_pos
);
21006 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21011 linepos
= BUF_BEGV (b
);
21012 linepos_byte
= BUF_BEGV_BYTE (b
);
21015 /* Count lines from base line to window start position. */
21016 nlines
= display_count_lines (linepos_byte
,
21020 topline
= nlines
+ line
;
21022 /* Determine a new base line, if the old one is too close
21023 or too far away, or if we did not have one.
21024 "Too close" means it's plausible a scroll-down would
21025 go back past it. */
21026 if (startpos
== BUF_BEGV (b
))
21028 w
->base_line_number
= make_number (topline
);
21029 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21031 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21032 || linepos
== BUF_BEGV (b
))
21034 EMACS_INT limit
= BUF_BEGV (b
);
21035 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
21036 EMACS_INT position
;
21037 EMACS_INT distance
=
21038 (height
* 2 + 30) * line_number_display_limit_width
;
21040 if (startpos
- distance
> limit
)
21042 limit
= startpos
- distance
;
21043 limit_byte
= CHAR_TO_BYTE (limit
);
21046 nlines
= display_count_lines (startpos_byte
,
21048 - (height
* 2 + 30),
21050 /* If we couldn't find the lines we wanted within
21051 line_number_display_limit_width chars per line,
21052 give up on line numbers for this window. */
21053 if (position
== limit_byte
&& limit
== startpos
- distance
)
21055 w
->base_line_pos
= w
->buffer
;
21056 w
->base_line_number
= Qnil
;
21060 w
->base_line_number
= make_number (topline
- nlines
);
21061 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21064 /* Now count lines from the start pos to point. */
21065 nlines
= display_count_lines (startpos_byte
,
21066 PT_BYTE
, PT
, &junk
);
21068 /* Record that we did display the line number. */
21069 line_number_displayed
= 1;
21071 /* Make the string to show. */
21072 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21073 return decode_mode_spec_buf
;
21076 char* p
= decode_mode_spec_buf
;
21077 int pad
= field_width
- 2;
21083 return decode_mode_spec_buf
;
21089 obj
= BVAR (b
, mode_name
);
21093 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21099 EMACS_INT pos
= marker_position (w
->start
);
21100 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21102 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21104 if (pos
<= BUF_BEGV (b
))
21109 else if (pos
<= BUF_BEGV (b
))
21113 if (total
> 1000000)
21114 /* Do it differently for a large value, to avoid overflow. */
21115 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21117 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21118 /* We can't normally display a 3-digit number,
21119 so get us a 2-digit number that is close. */
21122 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21123 return decode_mode_spec_buf
;
21127 /* Display percentage of size above the bottom of the screen. */
21130 EMACS_INT toppos
= marker_position (w
->start
);
21131 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21132 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21134 if (botpos
>= BUF_ZV (b
))
21136 if (toppos
<= BUF_BEGV (b
))
21143 if (total
> 1000000)
21144 /* Do it differently for a large value, to avoid overflow. */
21145 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21147 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21148 /* We can't normally display a 3-digit number,
21149 so get us a 2-digit number that is close. */
21152 if (toppos
<= BUF_BEGV (b
))
21153 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21155 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21156 return decode_mode_spec_buf
;
21161 /* status of process */
21162 obj
= Fget_buffer_process (Fcurrent_buffer ());
21164 return "no process";
21166 obj
= Fsymbol_name (Fprocess_status (obj
));
21172 int count
= inhibit_garbage_collection ();
21173 Lisp_Object val
= call1 (intern ("file-remote-p"),
21174 BVAR (current_buffer
, directory
));
21175 unbind_to (count
, Qnil
);
21183 case 't': /* indicate TEXT or BINARY */
21187 /* coding-system (not including end-of-line format) */
21189 /* coding-system (including end-of-line type) */
21191 int eol_flag
= (c
== 'Z');
21192 char *p
= decode_mode_spec_buf
;
21194 if (! FRAME_WINDOW_P (f
))
21196 /* No need to mention EOL here--the terminal never needs
21197 to do EOL conversion. */
21198 p
= decode_mode_spec_coding (CODING_ID_NAME
21199 (FRAME_KEYBOARD_CODING (f
)->id
),
21201 p
= decode_mode_spec_coding (CODING_ID_NAME
21202 (FRAME_TERMINAL_CODING (f
)->id
),
21205 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21208 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21209 #ifdef subprocesses
21210 obj
= Fget_buffer_process (Fcurrent_buffer ());
21211 if (PROCESSP (obj
))
21213 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21215 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21218 #endif /* subprocesses */
21221 return decode_mode_spec_buf
;
21228 return SSDATA (obj
);
21235 /* Count up to COUNT lines starting from START_BYTE.
21236 But don't go beyond LIMIT_BYTE.
21237 Return the number of lines thus found (always nonnegative).
21239 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21242 display_count_lines (EMACS_INT start_byte
,
21243 EMACS_INT limit_byte
, EMACS_INT count
,
21244 EMACS_INT
*byte_pos_ptr
)
21246 register unsigned char *cursor
;
21247 unsigned char *base
;
21249 register EMACS_INT ceiling
;
21250 register unsigned char *ceiling_addr
;
21251 EMACS_INT orig_count
= count
;
21253 /* If we are not in selective display mode,
21254 check only for newlines. */
21255 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21256 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21260 while (start_byte
< limit_byte
)
21262 ceiling
= BUFFER_CEILING_OF (start_byte
);
21263 ceiling
= min (limit_byte
- 1, ceiling
);
21264 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21265 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21268 if (selective_display
)
21269 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21272 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21275 if (cursor
!= ceiling_addr
)
21279 start_byte
+= cursor
- base
+ 1;
21280 *byte_pos_ptr
= start_byte
;
21284 if (++cursor
== ceiling_addr
)
21290 start_byte
+= cursor
- base
;
21295 while (start_byte
> limit_byte
)
21297 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21298 ceiling
= max (limit_byte
, ceiling
);
21299 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21300 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21303 if (selective_display
)
21304 while (--cursor
!= ceiling_addr
21305 && *cursor
!= '\n' && *cursor
!= 015)
21308 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21311 if (cursor
!= ceiling_addr
)
21315 start_byte
+= cursor
- base
+ 1;
21316 *byte_pos_ptr
= start_byte
;
21317 /* When scanning backwards, we should
21318 not count the newline posterior to which we stop. */
21319 return - orig_count
- 1;
21325 /* Here we add 1 to compensate for the last decrement
21326 of CURSOR, which took it past the valid range. */
21327 start_byte
+= cursor
- base
+ 1;
21331 *byte_pos_ptr
= limit_byte
;
21334 return - orig_count
+ count
;
21335 return orig_count
- count
;
21341 /***********************************************************************
21343 ***********************************************************************/
21345 /* Display a NUL-terminated string, starting with index START.
21347 If STRING is non-null, display that C string. Otherwise, the Lisp
21348 string LISP_STRING is displayed. There's a case that STRING is
21349 non-null and LISP_STRING is not nil. It means STRING is a string
21350 data of LISP_STRING. In that case, we display LISP_STRING while
21351 ignoring its text properties.
21353 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21354 FACE_STRING. Display STRING or LISP_STRING with the face at
21355 FACE_STRING_POS in FACE_STRING:
21357 Display the string in the environment given by IT, but use the
21358 standard display table, temporarily.
21360 FIELD_WIDTH is the minimum number of output glyphs to produce.
21361 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21362 with spaces. If STRING has more characters, more than FIELD_WIDTH
21363 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21365 PRECISION is the maximum number of characters to output from
21366 STRING. PRECISION < 0 means don't truncate the string.
21368 This is roughly equivalent to printf format specifiers:
21370 FIELD_WIDTH PRECISION PRINTF
21371 ----------------------------------------
21377 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21378 display them, and < 0 means obey the current buffer's value of
21379 enable_multibyte_characters.
21381 Value is the number of columns displayed. */
21384 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21385 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21386 int field_width
, int precision
, int max_x
, int multibyte
)
21388 int hpos_at_start
= it
->hpos
;
21389 int saved_face_id
= it
->face_id
;
21390 struct glyph_row
*row
= it
->glyph_row
;
21391 EMACS_INT it_charpos
;
21393 /* Initialize the iterator IT for iteration over STRING beginning
21394 with index START. */
21395 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21396 precision
, field_width
, multibyte
);
21397 if (string
&& STRINGP (lisp_string
))
21398 /* LISP_STRING is the one returned by decode_mode_spec. We should
21399 ignore its text properties. */
21400 it
->stop_charpos
= it
->end_charpos
;
21402 /* If displaying STRING, set up the face of the iterator from
21403 FACE_STRING, if that's given. */
21404 if (STRINGP (face_string
))
21410 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21411 0, it
->region_beg_charpos
,
21412 it
->region_end_charpos
,
21413 &endptr
, it
->base_face_id
, 0);
21414 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21415 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21418 /* Set max_x to the maximum allowed X position. Don't let it go
21419 beyond the right edge of the window. */
21421 max_x
= it
->last_visible_x
;
21423 max_x
= min (max_x
, it
->last_visible_x
);
21425 /* Skip over display elements that are not visible. because IT->w is
21427 if (it
->current_x
< it
->first_visible_x
)
21428 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21429 MOVE_TO_POS
| MOVE_TO_X
);
21431 row
->ascent
= it
->max_ascent
;
21432 row
->height
= it
->max_ascent
+ it
->max_descent
;
21433 row
->phys_ascent
= it
->max_phys_ascent
;
21434 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21435 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21437 if (STRINGP (it
->string
))
21438 it_charpos
= IT_STRING_CHARPOS (*it
);
21440 it_charpos
= IT_CHARPOS (*it
);
21442 /* This condition is for the case that we are called with current_x
21443 past last_visible_x. */
21444 while (it
->current_x
< max_x
)
21446 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21448 /* Get the next display element. */
21449 if (!get_next_display_element (it
))
21452 /* Produce glyphs. */
21453 x_before
= it
->current_x
;
21454 n_glyphs_before
= row
->used
[TEXT_AREA
];
21455 PRODUCE_GLYPHS (it
);
21457 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21460 while (i
< nglyphs
)
21462 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21464 if (it
->line_wrap
!= TRUNCATE
21465 && x
+ glyph
->pixel_width
> max_x
)
21467 /* End of continued line or max_x reached. */
21468 if (CHAR_GLYPH_PADDING_P (*glyph
))
21470 /* A wide character is unbreakable. */
21471 if (row
->reversed_p
)
21472 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21473 - n_glyphs_before
);
21474 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21475 it
->current_x
= x_before
;
21479 if (row
->reversed_p
)
21480 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21481 - (n_glyphs_before
+ i
));
21482 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21487 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21489 /* Glyph is at least partially visible. */
21491 if (x
< it
->first_visible_x
)
21492 row
->x
= x
- it
->first_visible_x
;
21496 /* Glyph is off the left margin of the display area.
21497 Should not happen. */
21501 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21502 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21503 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21504 row
->phys_height
= max (row
->phys_height
,
21505 it
->max_phys_ascent
+ it
->max_phys_descent
);
21506 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21507 it
->max_extra_line_spacing
);
21508 x
+= glyph
->pixel_width
;
21512 /* Stop if max_x reached. */
21516 /* Stop at line ends. */
21517 if (ITERATOR_AT_END_OF_LINE_P (it
))
21519 it
->continuation_lines_width
= 0;
21523 set_iterator_to_next (it
, 1);
21524 if (STRINGP (it
->string
))
21525 it_charpos
= IT_STRING_CHARPOS (*it
);
21527 it_charpos
= IT_CHARPOS (*it
);
21529 /* Stop if truncating at the right edge. */
21530 if (it
->line_wrap
== TRUNCATE
21531 && it
->current_x
>= it
->last_visible_x
)
21533 /* Add truncation mark, but don't do it if the line is
21534 truncated at a padding space. */
21535 if (it_charpos
< it
->string_nchars
)
21537 if (!FRAME_WINDOW_P (it
->f
))
21541 if (it
->current_x
> it
->last_visible_x
)
21543 if (!row
->reversed_p
)
21545 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21546 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21551 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21552 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21554 unproduce_glyphs (it
, ii
+ 1);
21555 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21557 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21559 row
->used
[TEXT_AREA
] = ii
;
21560 produce_special_glyphs (it
, IT_TRUNCATION
);
21563 produce_special_glyphs (it
, IT_TRUNCATION
);
21565 row
->truncated_on_right_p
= 1;
21571 /* Maybe insert a truncation at the left. */
21572 if (it
->first_visible_x
21575 if (!FRAME_WINDOW_P (it
->f
))
21576 insert_left_trunc_glyphs (it
);
21577 row
->truncated_on_left_p
= 1;
21580 it
->face_id
= saved_face_id
;
21582 /* Value is number of columns displayed. */
21583 return it
->hpos
- hpos_at_start
;
21588 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21589 appears as an element of LIST or as the car of an element of LIST.
21590 If PROPVAL is a list, compare each element against LIST in that
21591 way, and return 1/2 if any element of PROPVAL is found in LIST.
21592 Otherwise return 0. This function cannot quit.
21593 The return value is 2 if the text is invisible but with an ellipsis
21594 and 1 if it's invisible and without an ellipsis. */
21597 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21599 register Lisp_Object tail
, proptail
;
21601 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21603 register Lisp_Object tem
;
21605 if (EQ (propval
, tem
))
21607 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21608 return NILP (XCDR (tem
)) ? 1 : 2;
21611 if (CONSP (propval
))
21613 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21615 Lisp_Object propelt
;
21616 propelt
= XCAR (proptail
);
21617 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21619 register Lisp_Object tem
;
21621 if (EQ (propelt
, tem
))
21623 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21624 return NILP (XCDR (tem
)) ? 1 : 2;
21632 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21633 doc
: /* Non-nil if the property makes the text invisible.
21634 POS-OR-PROP can be a marker or number, in which case it is taken to be
21635 a position in the current buffer and the value of the `invisible' property
21636 is checked; or it can be some other value, which is then presumed to be the
21637 value of the `invisible' property of the text of interest.
21638 The non-nil value returned can be t for truly invisible text or something
21639 else if the text is replaced by an ellipsis. */)
21640 (Lisp_Object pos_or_prop
)
21643 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21644 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21646 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21647 return (invis
== 0 ? Qnil
21649 : make_number (invis
));
21652 /* Calculate a width or height in pixels from a specification using
21653 the following elements:
21656 NUM - a (fractional) multiple of the default font width/height
21657 (NUM) - specifies exactly NUM pixels
21658 UNIT - a fixed number of pixels, see below.
21659 ELEMENT - size of a display element in pixels, see below.
21660 (NUM . SPEC) - equals NUM * SPEC
21661 (+ SPEC SPEC ...) - add pixel values
21662 (- SPEC SPEC ...) - subtract pixel values
21663 (- SPEC) - negate pixel value
21666 INT or FLOAT - a number constant
21667 SYMBOL - use symbol's (buffer local) variable binding.
21670 in - pixels per inch *)
21671 mm - pixels per 1/1000 meter *)
21672 cm - pixels per 1/100 meter *)
21673 width - width of current font in pixels.
21674 height - height of current font in pixels.
21676 *) using the ratio(s) defined in display-pixels-per-inch.
21680 left-fringe - left fringe width in pixels
21681 right-fringe - right fringe width in pixels
21683 left-margin - left margin width in pixels
21684 right-margin - right margin width in pixels
21686 scroll-bar - scroll-bar area width in pixels
21690 Pixels corresponding to 5 inches:
21693 Total width of non-text areas on left side of window (if scroll-bar is on left):
21694 '(space :width (+ left-fringe left-margin scroll-bar))
21696 Align to first text column (in header line):
21697 '(space :align-to 0)
21699 Align to middle of text area minus half the width of variable `my-image'
21700 containing a loaded image:
21701 '(space :align-to (0.5 . (- text my-image)))
21703 Width of left margin minus width of 1 character in the default font:
21704 '(space :width (- left-margin 1))
21706 Width of left margin minus width of 2 characters in the current font:
21707 '(space :width (- left-margin (2 . width)))
21709 Center 1 character over left-margin (in header line):
21710 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21712 Different ways to express width of left fringe plus left margin minus one pixel:
21713 '(space :width (- (+ left-fringe left-margin) (1)))
21714 '(space :width (+ left-fringe left-margin (- (1))))
21715 '(space :width (+ left-fringe left-margin (-1)))
21719 #define NUMVAL(X) \
21720 ((INTEGERP (X) || FLOATP (X)) \
21725 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21726 struct font
*font
, int width_p
, int *align_to
)
21730 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21731 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21734 return OK_PIXELS (0);
21736 xassert (FRAME_LIVE_P (it
->f
));
21738 if (SYMBOLP (prop
))
21740 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21742 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21744 if (unit
[0] == 'i' && unit
[1] == 'n')
21746 else if (unit
[0] == 'm' && unit
[1] == 'm')
21748 else if (unit
[0] == 'c' && unit
[1] == 'm')
21755 #ifdef HAVE_WINDOW_SYSTEM
21756 if (FRAME_WINDOW_P (it
->f
)
21758 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21759 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21761 return OK_PIXELS (ppi
/ pixels
);
21764 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21765 || (CONSP (Vdisplay_pixels_per_inch
)
21767 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21768 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21770 return OK_PIXELS (ppi
/ pixels
);
21776 #ifdef HAVE_WINDOW_SYSTEM
21777 if (EQ (prop
, Qheight
))
21778 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21779 if (EQ (prop
, Qwidth
))
21780 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21782 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21783 return OK_PIXELS (1);
21786 if (EQ (prop
, Qtext
))
21787 return OK_PIXELS (width_p
21788 ? window_box_width (it
->w
, TEXT_AREA
)
21789 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21791 if (align_to
&& *align_to
< 0)
21794 if (EQ (prop
, Qleft
))
21795 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21796 if (EQ (prop
, Qright
))
21797 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21798 if (EQ (prop
, Qcenter
))
21799 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21800 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21801 if (EQ (prop
, Qleft_fringe
))
21802 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21803 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21804 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21805 if (EQ (prop
, Qright_fringe
))
21806 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21807 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21808 : window_box_right_offset (it
->w
, TEXT_AREA
));
21809 if (EQ (prop
, Qleft_margin
))
21810 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21811 if (EQ (prop
, Qright_margin
))
21812 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21813 if (EQ (prop
, Qscroll_bar
))
21814 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21816 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21817 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21818 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21823 if (EQ (prop
, Qleft_fringe
))
21824 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21825 if (EQ (prop
, Qright_fringe
))
21826 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21827 if (EQ (prop
, Qleft_margin
))
21828 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21829 if (EQ (prop
, Qright_margin
))
21830 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21831 if (EQ (prop
, Qscroll_bar
))
21832 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21835 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21838 if (INTEGERP (prop
) || FLOATP (prop
))
21840 int base_unit
= (width_p
21841 ? FRAME_COLUMN_WIDTH (it
->f
)
21842 : FRAME_LINE_HEIGHT (it
->f
));
21843 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21848 Lisp_Object car
= XCAR (prop
);
21849 Lisp_Object cdr
= XCDR (prop
);
21853 #ifdef HAVE_WINDOW_SYSTEM
21854 if (FRAME_WINDOW_P (it
->f
)
21855 && valid_image_p (prop
))
21857 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21858 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21860 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21863 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21869 while (CONSP (cdr
))
21871 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21872 font
, width_p
, align_to
))
21875 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21880 if (EQ (car
, Qminus
))
21882 return OK_PIXELS (pixels
);
21885 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21888 if (INTEGERP (car
) || FLOATP (car
))
21891 pixels
= XFLOATINT (car
);
21893 return OK_PIXELS (pixels
);
21894 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21895 font
, width_p
, align_to
))
21896 return OK_PIXELS (pixels
* fact
);
21907 /***********************************************************************
21909 ***********************************************************************/
21911 #ifdef HAVE_WINDOW_SYSTEM
21916 dump_glyph_string (struct glyph_string
*s
)
21918 fprintf (stderr
, "glyph string\n");
21919 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21920 s
->x
, s
->y
, s
->width
, s
->height
);
21921 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21922 fprintf (stderr
, " hl = %d\n", s
->hl
);
21923 fprintf (stderr
, " left overhang = %d, right = %d\n",
21924 s
->left_overhang
, s
->right_overhang
);
21925 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21926 fprintf (stderr
, " extends to end of line = %d\n",
21927 s
->extends_to_end_of_line_p
);
21928 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21929 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21932 #endif /* GLYPH_DEBUG */
21934 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21935 of XChar2b structures for S; it can't be allocated in
21936 init_glyph_string because it must be allocated via `alloca'. W
21937 is the window on which S is drawn. ROW and AREA are the glyph row
21938 and area within the row from which S is constructed. START is the
21939 index of the first glyph structure covered by S. HL is a
21940 face-override for drawing S. */
21943 #define OPTIONAL_HDC(hdc) HDC hdc,
21944 #define DECLARE_HDC(hdc) HDC hdc;
21945 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21946 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21949 #ifndef OPTIONAL_HDC
21950 #define OPTIONAL_HDC(hdc)
21951 #define DECLARE_HDC(hdc)
21952 #define ALLOCATE_HDC(hdc, f)
21953 #define RELEASE_HDC(hdc, f)
21957 init_glyph_string (struct glyph_string
*s
,
21959 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21960 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21962 memset (s
, 0, sizeof *s
);
21964 s
->f
= XFRAME (w
->frame
);
21968 s
->display
= FRAME_X_DISPLAY (s
->f
);
21969 s
->window
= FRAME_X_WINDOW (s
->f
);
21970 s
->char2b
= char2b
;
21974 s
->first_glyph
= row
->glyphs
[area
] + start
;
21975 s
->height
= row
->height
;
21976 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21977 s
->ybase
= s
->y
+ row
->ascent
;
21981 /* Append the list of glyph strings with head H and tail T to the list
21982 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21985 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21986 struct glyph_string
*h
, struct glyph_string
*t
)
22000 /* Prepend the list of glyph strings with head H and tail T to the
22001 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22005 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22006 struct glyph_string
*h
, struct glyph_string
*t
)
22020 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22021 Set *HEAD and *TAIL to the resulting list. */
22024 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22025 struct glyph_string
*s
)
22027 s
->next
= s
->prev
= NULL
;
22028 append_glyph_string_lists (head
, tail
, s
, s
);
22032 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22033 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22034 make sure that X resources for the face returned are allocated.
22035 Value is a pointer to a realized face that is ready for display if
22036 DISPLAY_P is non-zero. */
22038 static inline struct face
*
22039 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22040 XChar2b
*char2b
, int display_p
)
22042 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22046 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22048 if (code
!= FONT_INVALID_CODE
)
22049 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22051 STORE_XCHAR2B (char2b
, 0, 0);
22054 /* Make sure X resources of the face are allocated. */
22055 #ifdef HAVE_X_WINDOWS
22059 xassert (face
!= NULL
);
22060 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22067 /* Get face and two-byte form of character glyph GLYPH on frame F.
22068 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22069 a pointer to a realized face that is ready for display. */
22071 static inline struct face
*
22072 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22073 XChar2b
*char2b
, int *two_byte_p
)
22077 xassert (glyph
->type
== CHAR_GLYPH
);
22078 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22087 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22088 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22090 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22092 if (code
!= FONT_INVALID_CODE
)
22093 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22095 STORE_XCHAR2B (char2b
, 0, 0);
22098 /* Make sure X resources of the face are allocated. */
22099 xassert (face
!= NULL
);
22100 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22105 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22106 Return 1 if FONT has a glyph for C, otherwise return 0. */
22109 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22113 if (CHAR_BYTE8_P (c
))
22114 code
= CHAR_TO_BYTE8 (c
);
22116 code
= font
->driver
->encode_char (font
, c
);
22118 if (code
== FONT_INVALID_CODE
)
22120 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22125 /* Fill glyph string S with composition components specified by S->cmp.
22127 BASE_FACE is the base face of the composition.
22128 S->cmp_from is the index of the first component for S.
22130 OVERLAPS non-zero means S should draw the foreground only, and use
22131 its physical height for clipping. See also draw_glyphs.
22133 Value is the index of a component not in S. */
22136 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22140 /* For all glyphs of this composition, starting at the offset
22141 S->cmp_from, until we reach the end of the definition or encounter a
22142 glyph that requires the different face, add it to S. */
22147 s
->for_overlaps
= overlaps
;
22150 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22152 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22154 /* TAB in a composition means display glyphs with padding space
22155 on the left or right. */
22158 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22161 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22168 s
->font
= s
->face
->font
;
22170 else if (s
->face
!= face
)
22178 if (s
->face
== NULL
)
22180 s
->face
= base_face
->ascii_face
;
22181 s
->font
= s
->face
->font
;
22184 /* All glyph strings for the same composition has the same width,
22185 i.e. the width set for the first component of the composition. */
22186 s
->width
= s
->first_glyph
->pixel_width
;
22188 /* If the specified font could not be loaded, use the frame's
22189 default font, but record the fact that we couldn't load it in
22190 the glyph string so that we can draw rectangles for the
22191 characters of the glyph string. */
22192 if (s
->font
== NULL
)
22194 s
->font_not_found_p
= 1;
22195 s
->font
= FRAME_FONT (s
->f
);
22198 /* Adjust base line for subscript/superscript text. */
22199 s
->ybase
+= s
->first_glyph
->voffset
;
22201 /* This glyph string must always be drawn with 16-bit functions. */
22208 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22209 int start
, int end
, int overlaps
)
22211 struct glyph
*glyph
, *last
;
22212 Lisp_Object lgstring
;
22215 s
->for_overlaps
= overlaps
;
22216 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22217 last
= s
->row
->glyphs
[s
->area
] + end
;
22218 s
->cmp_id
= glyph
->u
.cmp
.id
;
22219 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22220 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22221 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22222 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22223 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22225 while (glyph
< last
22226 && glyph
->u
.cmp
.automatic
22227 && glyph
->u
.cmp
.id
== s
->cmp_id
22228 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22229 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22231 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22233 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22234 unsigned code
= LGLYPH_CODE (lglyph
);
22236 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22238 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22239 return glyph
- s
->row
->glyphs
[s
->area
];
22243 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22244 See the comment of fill_glyph_string for arguments.
22245 Value is the index of the first glyph not in S. */
22249 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22250 int start
, int end
, int overlaps
)
22252 struct glyph
*glyph
, *last
;
22255 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22256 s
->for_overlaps
= overlaps
;
22257 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22258 last
= s
->row
->glyphs
[s
->area
] + end
;
22259 voffset
= glyph
->voffset
;
22260 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22261 s
->font
= s
->face
->font
;
22263 s
->width
= glyph
->pixel_width
;
22265 while (glyph
< last
22266 && glyph
->type
== GLYPHLESS_GLYPH
22267 && glyph
->voffset
== voffset
22268 && glyph
->face_id
== face_id
)
22271 s
->width
+= glyph
->pixel_width
;
22274 s
->ybase
+= voffset
;
22275 return glyph
- s
->row
->glyphs
[s
->area
];
22279 /* Fill glyph string S from a sequence of character glyphs.
22281 FACE_ID is the face id of the string. START is the index of the
22282 first glyph to consider, END is the index of the last + 1.
22283 OVERLAPS non-zero means S should draw the foreground only, and use
22284 its physical height for clipping. See also draw_glyphs.
22286 Value is the index of the first glyph not in S. */
22289 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22290 int start
, int end
, int overlaps
)
22292 struct glyph
*glyph
, *last
;
22294 int glyph_not_available_p
;
22296 xassert (s
->f
== XFRAME (s
->w
->frame
));
22297 xassert (s
->nchars
== 0);
22298 xassert (start
>= 0 && end
> start
);
22300 s
->for_overlaps
= overlaps
;
22301 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22302 last
= s
->row
->glyphs
[s
->area
] + end
;
22303 voffset
= glyph
->voffset
;
22304 s
->padding_p
= glyph
->padding_p
;
22305 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22307 while (glyph
< last
22308 && glyph
->type
== CHAR_GLYPH
22309 && glyph
->voffset
== voffset
22310 /* Same face id implies same font, nowadays. */
22311 && glyph
->face_id
== face_id
22312 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22316 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22317 s
->char2b
+ s
->nchars
,
22319 s
->two_byte_p
= two_byte_p
;
22321 xassert (s
->nchars
<= end
- start
);
22322 s
->width
+= glyph
->pixel_width
;
22323 if (glyph
++->padding_p
!= s
->padding_p
)
22327 s
->font
= s
->face
->font
;
22329 /* If the specified font could not be loaded, use the frame's font,
22330 but record the fact that we couldn't load it in
22331 S->font_not_found_p so that we can draw rectangles for the
22332 characters of the glyph string. */
22333 if (s
->font
== NULL
|| glyph_not_available_p
)
22335 s
->font_not_found_p
= 1;
22336 s
->font
= FRAME_FONT (s
->f
);
22339 /* Adjust base line for subscript/superscript text. */
22340 s
->ybase
+= voffset
;
22342 xassert (s
->face
&& s
->face
->gc
);
22343 return glyph
- s
->row
->glyphs
[s
->area
];
22347 /* Fill glyph string S from image glyph S->first_glyph. */
22350 fill_image_glyph_string (struct glyph_string
*s
)
22352 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22353 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22355 s
->slice
= s
->first_glyph
->slice
.img
;
22356 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22357 s
->font
= s
->face
->font
;
22358 s
->width
= s
->first_glyph
->pixel_width
;
22360 /* Adjust base line for subscript/superscript text. */
22361 s
->ybase
+= s
->first_glyph
->voffset
;
22365 /* Fill glyph string S from a sequence of stretch glyphs.
22367 START is the index of the first glyph to consider,
22368 END is the index of the last + 1.
22370 Value is the index of the first glyph not in S. */
22373 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22375 struct glyph
*glyph
, *last
;
22376 int voffset
, face_id
;
22378 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22380 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22381 last
= s
->row
->glyphs
[s
->area
] + end
;
22382 face_id
= glyph
->face_id
;
22383 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22384 s
->font
= s
->face
->font
;
22385 s
->width
= glyph
->pixel_width
;
22387 voffset
= glyph
->voffset
;
22391 && glyph
->type
== STRETCH_GLYPH
22392 && glyph
->voffset
== voffset
22393 && glyph
->face_id
== face_id
);
22395 s
->width
+= glyph
->pixel_width
;
22397 /* Adjust base line for subscript/superscript text. */
22398 s
->ybase
+= voffset
;
22400 /* The case that face->gc == 0 is handled when drawing the glyph
22401 string by calling PREPARE_FACE_FOR_DISPLAY. */
22403 return glyph
- s
->row
->glyphs
[s
->area
];
22406 static struct font_metrics
*
22407 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22409 static struct font_metrics metrics
;
22410 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22412 if (! font
|| code
== FONT_INVALID_CODE
)
22414 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22419 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22420 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22421 assumed to be zero. */
22424 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22426 *left
= *right
= 0;
22428 if (glyph
->type
== CHAR_GLYPH
)
22432 struct font_metrics
*pcm
;
22434 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22435 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22437 if (pcm
->rbearing
> pcm
->width
)
22438 *right
= pcm
->rbearing
- pcm
->width
;
22439 if (pcm
->lbearing
< 0)
22440 *left
= -pcm
->lbearing
;
22443 else if (glyph
->type
== COMPOSITE_GLYPH
)
22445 if (! glyph
->u
.cmp
.automatic
)
22447 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22449 if (cmp
->rbearing
> cmp
->pixel_width
)
22450 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22451 if (cmp
->lbearing
< 0)
22452 *left
= - cmp
->lbearing
;
22456 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22457 struct font_metrics metrics
;
22459 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22460 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22461 if (metrics
.rbearing
> metrics
.width
)
22462 *right
= metrics
.rbearing
- metrics
.width
;
22463 if (metrics
.lbearing
< 0)
22464 *left
= - metrics
.lbearing
;
22470 /* Return the index of the first glyph preceding glyph string S that
22471 is overwritten by S because of S's left overhang. Value is -1
22472 if no glyphs are overwritten. */
22475 left_overwritten (struct glyph_string
*s
)
22479 if (s
->left_overhang
)
22482 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22483 int first
= s
->first_glyph
- glyphs
;
22485 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22486 x
-= glyphs
[i
].pixel_width
;
22497 /* Return the index of the first glyph preceding glyph string S that
22498 is overwriting S because of its right overhang. Value is -1 if no
22499 glyph in front of S overwrites S. */
22502 left_overwriting (struct glyph_string
*s
)
22505 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22506 int first
= s
->first_glyph
- glyphs
;
22510 for (i
= first
- 1; i
>= 0; --i
)
22513 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22516 x
-= glyphs
[i
].pixel_width
;
22523 /* Return the index of the last glyph following glyph string S that is
22524 overwritten by S because of S's right overhang. Value is -1 if
22525 no such glyph is found. */
22528 right_overwritten (struct glyph_string
*s
)
22532 if (s
->right_overhang
)
22535 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22536 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22537 int end
= s
->row
->used
[s
->area
];
22539 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22540 x
+= glyphs
[i
].pixel_width
;
22549 /* Return the index of the last glyph following glyph string S that
22550 overwrites S because of its left overhang. Value is negative
22551 if no such glyph is found. */
22554 right_overwriting (struct glyph_string
*s
)
22557 int end
= s
->row
->used
[s
->area
];
22558 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22559 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22563 for (i
= first
; i
< end
; ++i
)
22566 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22569 x
+= glyphs
[i
].pixel_width
;
22576 /* Set background width of glyph string S. START is the index of the
22577 first glyph following S. LAST_X is the right-most x-position + 1
22578 in the drawing area. */
22581 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22583 /* If the face of this glyph string has to be drawn to the end of
22584 the drawing area, set S->extends_to_end_of_line_p. */
22586 if (start
== s
->row
->used
[s
->area
]
22587 && s
->area
== TEXT_AREA
22588 && ((s
->row
->fill_line_p
22589 && (s
->hl
== DRAW_NORMAL_TEXT
22590 || s
->hl
== DRAW_IMAGE_RAISED
22591 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22592 || s
->hl
== DRAW_MOUSE_FACE
))
22593 s
->extends_to_end_of_line_p
= 1;
22595 /* If S extends its face to the end of the line, set its
22596 background_width to the distance to the right edge of the drawing
22598 if (s
->extends_to_end_of_line_p
)
22599 s
->background_width
= last_x
- s
->x
+ 1;
22601 s
->background_width
= s
->width
;
22605 /* Compute overhangs and x-positions for glyph string S and its
22606 predecessors, or successors. X is the starting x-position for S.
22607 BACKWARD_P non-zero means process predecessors. */
22610 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22616 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22617 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22627 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22628 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22638 /* The following macros are only called from draw_glyphs below.
22639 They reference the following parameters of that function directly:
22640 `w', `row', `area', and `overlap_p'
22641 as well as the following local variables:
22642 `s', `f', and `hdc' (in W32) */
22645 /* On W32, silently add local `hdc' variable to argument list of
22646 init_glyph_string. */
22647 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22648 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22650 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22651 init_glyph_string (s, char2b, w, row, area, start, hl)
22654 /* Add a glyph string for a stretch glyph to the list of strings
22655 between HEAD and TAIL. START is the index of the stretch glyph in
22656 row area AREA of glyph row ROW. END is the index of the last glyph
22657 in that glyph row area. X is the current output position assigned
22658 to the new glyph string constructed. HL overrides that face of the
22659 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22660 is the right-most x-position of the drawing area. */
22662 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22663 and below -- keep them on one line. */
22664 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22667 s = (struct glyph_string *) alloca (sizeof *s); \
22668 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22669 START = fill_stretch_glyph_string (s, START, END); \
22670 append_glyph_string (&HEAD, &TAIL, s); \
22676 /* Add a glyph string for an image glyph to the list of strings
22677 between HEAD and TAIL. START is the index of the image glyph in
22678 row area AREA of glyph row ROW. END is the index of the last glyph
22679 in that glyph row area. X is the current output position assigned
22680 to the new glyph string constructed. HL overrides that face of the
22681 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22682 is the right-most x-position of the drawing area. */
22684 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22687 s = (struct glyph_string *) alloca (sizeof *s); \
22688 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22689 fill_image_glyph_string (s); \
22690 append_glyph_string (&HEAD, &TAIL, s); \
22697 /* Add a glyph string for a sequence of character glyphs to the list
22698 of strings between HEAD and TAIL. START is the index of the first
22699 glyph in row area AREA of glyph row ROW that is part of the new
22700 glyph string. END is the index of the last glyph in that glyph row
22701 area. X is the current output position assigned to the new glyph
22702 string constructed. HL overrides that face of the glyph; e.g. it
22703 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22704 right-most x-position of the drawing area. */
22706 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22712 face_id = (row)->glyphs[area][START].face_id; \
22714 s = (struct glyph_string *) alloca (sizeof *s); \
22715 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22716 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22717 append_glyph_string (&HEAD, &TAIL, s); \
22719 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22724 /* Add a glyph string for a composite sequence to the list of strings
22725 between HEAD and TAIL. START is the index of the first glyph in
22726 row area AREA of glyph row ROW that is part of the new glyph
22727 string. END is the index of the last glyph in that glyph row area.
22728 X is the current output position assigned to the new glyph string
22729 constructed. HL overrides that face of the glyph; e.g. it is
22730 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22731 x-position of the drawing area. */
22733 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22735 int face_id = (row)->glyphs[area][START].face_id; \
22736 struct face *base_face = FACE_FROM_ID (f, face_id); \
22737 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22738 struct composition *cmp = composition_table[cmp_id]; \
22740 struct glyph_string *first_s IF_LINT (= NULL); \
22743 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22745 /* Make glyph_strings for each glyph sequence that is drawable by \
22746 the same face, and append them to HEAD/TAIL. */ \
22747 for (n = 0; n < cmp->glyph_len;) \
22749 s = (struct glyph_string *) alloca (sizeof *s); \
22750 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22751 append_glyph_string (&(HEAD), &(TAIL), s); \
22757 n = fill_composite_glyph_string (s, base_face, overlaps); \
22765 /* Add a glyph string for a glyph-string sequence to the list of strings
22766 between HEAD and TAIL. */
22768 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22772 Lisp_Object gstring; \
22774 face_id = (row)->glyphs[area][START].face_id; \
22775 gstring = (composition_gstring_from_id \
22776 ((row)->glyphs[area][START].u.cmp.id)); \
22777 s = (struct glyph_string *) alloca (sizeof *s); \
22778 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22779 * LGSTRING_GLYPH_LEN (gstring)); \
22780 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22781 append_glyph_string (&(HEAD), &(TAIL), s); \
22783 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22787 /* Add a glyph string for a sequence of glyphless character's glyphs
22788 to the list of strings between HEAD and TAIL. The meanings of
22789 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22791 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22796 face_id = (row)->glyphs[area][START].face_id; \
22798 s = (struct glyph_string *) alloca (sizeof *s); \
22799 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22800 append_glyph_string (&HEAD, &TAIL, s); \
22802 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22808 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22809 of AREA of glyph row ROW on window W between indices START and END.
22810 HL overrides the face for drawing glyph strings, e.g. it is
22811 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22812 x-positions of the drawing area.
22814 This is an ugly monster macro construct because we must use alloca
22815 to allocate glyph strings (because draw_glyphs can be called
22816 asynchronously). */
22818 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22821 HEAD = TAIL = NULL; \
22822 while (START < END) \
22824 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22825 switch (first_glyph->type) \
22828 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22832 case COMPOSITE_GLYPH: \
22833 if (first_glyph->u.cmp.automatic) \
22834 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22837 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22841 case STRETCH_GLYPH: \
22842 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22846 case IMAGE_GLYPH: \
22847 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22851 case GLYPHLESS_GLYPH: \
22852 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22862 set_glyph_string_background_width (s, START, LAST_X); \
22869 /* Draw glyphs between START and END in AREA of ROW on window W,
22870 starting at x-position X. X is relative to AREA in W. HL is a
22871 face-override with the following meaning:
22873 DRAW_NORMAL_TEXT draw normally
22874 DRAW_CURSOR draw in cursor face
22875 DRAW_MOUSE_FACE draw in mouse face.
22876 DRAW_INVERSE_VIDEO draw in mode line face
22877 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22878 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22880 If OVERLAPS is non-zero, draw only the foreground of characters and
22881 clip to the physical height of ROW. Non-zero value also defines
22882 the overlapping part to be drawn:
22884 OVERLAPS_PRED overlap with preceding rows
22885 OVERLAPS_SUCC overlap with succeeding rows
22886 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22887 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22889 Value is the x-position reached, relative to AREA of W. */
22892 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22893 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22894 enum draw_glyphs_face hl
, int overlaps
)
22896 struct glyph_string
*head
, *tail
;
22897 struct glyph_string
*s
;
22898 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22899 int i
, j
, x_reached
, last_x
, area_left
= 0;
22900 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22903 ALLOCATE_HDC (hdc
, f
);
22905 /* Let's rather be paranoid than getting a SEGV. */
22906 end
= min (end
, row
->used
[area
]);
22907 start
= max (0, start
);
22908 start
= min (end
, start
);
22910 /* Translate X to frame coordinates. Set last_x to the right
22911 end of the drawing area. */
22912 if (row
->full_width_p
)
22914 /* X is relative to the left edge of W, without scroll bars
22916 area_left
= WINDOW_LEFT_EDGE_X (w
);
22917 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22921 area_left
= window_box_left (w
, area
);
22922 last_x
= area_left
+ window_box_width (w
, area
);
22926 /* Build a doubly-linked list of glyph_string structures between
22927 head and tail from what we have to draw. Note that the macro
22928 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22929 the reason we use a separate variable `i'. */
22931 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22933 x_reached
= tail
->x
+ tail
->background_width
;
22937 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22938 the row, redraw some glyphs in front or following the glyph
22939 strings built above. */
22940 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22942 struct glyph_string
*h
, *t
;
22943 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22944 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22945 int check_mouse_face
= 0;
22948 /* If mouse highlighting is on, we may need to draw adjacent
22949 glyphs using mouse-face highlighting. */
22950 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22952 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22954 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22955 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22957 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22959 check_mouse_face
= 1;
22960 mouse_beg_col
= (row
== mouse_beg_row
)
22961 ? hlinfo
->mouse_face_beg_col
: 0;
22962 mouse_end_col
= (row
== mouse_end_row
)
22963 ? hlinfo
->mouse_face_end_col
22964 : row
->used
[TEXT_AREA
];
22968 /* Compute overhangs for all glyph strings. */
22969 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22970 for (s
= head
; s
; s
= s
->next
)
22971 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22973 /* Prepend glyph strings for glyphs in front of the first glyph
22974 string that are overwritten because of the first glyph
22975 string's left overhang. The background of all strings
22976 prepended must be drawn because the first glyph string
22978 i
= left_overwritten (head
);
22981 enum draw_glyphs_face overlap_hl
;
22983 /* If this row contains mouse highlighting, attempt to draw
22984 the overlapped glyphs with the correct highlight. This
22985 code fails if the overlap encompasses more than one glyph
22986 and mouse-highlight spans only some of these glyphs.
22987 However, making it work perfectly involves a lot more
22988 code, and I don't know if the pathological case occurs in
22989 practice, so we'll stick to this for now. --- cyd */
22990 if (check_mouse_face
22991 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22992 overlap_hl
= DRAW_MOUSE_FACE
;
22994 overlap_hl
= DRAW_NORMAL_TEXT
;
22997 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22998 overlap_hl
, dummy_x
, last_x
);
23000 compute_overhangs_and_x (t
, head
->x
, 1);
23001 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23005 /* Prepend glyph strings for glyphs in front of the first glyph
23006 string that overwrite that glyph string because of their
23007 right overhang. For these strings, only the foreground must
23008 be drawn, because it draws over the glyph string at `head'.
23009 The background must not be drawn because this would overwrite
23010 right overhangs of preceding glyphs for which no glyph
23012 i
= left_overwriting (head
);
23015 enum draw_glyphs_face overlap_hl
;
23017 if (check_mouse_face
23018 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23019 overlap_hl
= DRAW_MOUSE_FACE
;
23021 overlap_hl
= DRAW_NORMAL_TEXT
;
23024 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23025 overlap_hl
, dummy_x
, last_x
);
23026 for (s
= h
; s
; s
= s
->next
)
23027 s
->background_filled_p
= 1;
23028 compute_overhangs_and_x (t
, head
->x
, 1);
23029 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23032 /* Append glyphs strings for glyphs following the last glyph
23033 string tail that are overwritten by tail. The background of
23034 these strings has to be drawn because tail's foreground draws
23036 i
= right_overwritten (tail
);
23039 enum draw_glyphs_face overlap_hl
;
23041 if (check_mouse_face
23042 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23043 overlap_hl
= DRAW_MOUSE_FACE
;
23045 overlap_hl
= DRAW_NORMAL_TEXT
;
23047 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23048 overlap_hl
, x
, last_x
);
23049 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23050 we don't have `end = i;' here. */
23051 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23052 append_glyph_string_lists (&head
, &tail
, h
, t
);
23056 /* Append glyph strings for glyphs following the last glyph
23057 string tail that overwrite tail. The foreground of such
23058 glyphs has to be drawn because it writes into the background
23059 of tail. The background must not be drawn because it could
23060 paint over the foreground of following glyphs. */
23061 i
= right_overwriting (tail
);
23064 enum draw_glyphs_face overlap_hl
;
23065 if (check_mouse_face
23066 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23067 overlap_hl
= DRAW_MOUSE_FACE
;
23069 overlap_hl
= DRAW_NORMAL_TEXT
;
23072 i
++; /* We must include the Ith glyph. */
23073 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23074 overlap_hl
, x
, last_x
);
23075 for (s
= h
; s
; s
= s
->next
)
23076 s
->background_filled_p
= 1;
23077 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23078 append_glyph_string_lists (&head
, &tail
, h
, t
);
23080 if (clip_head
|| clip_tail
)
23081 for (s
= head
; s
; s
= s
->next
)
23083 s
->clip_head
= clip_head
;
23084 s
->clip_tail
= clip_tail
;
23088 /* Draw all strings. */
23089 for (s
= head
; s
; s
= s
->next
)
23090 FRAME_RIF (f
)->draw_glyph_string (s
);
23093 /* When focus a sole frame and move horizontally, this sets on_p to 0
23094 causing a failure to erase prev cursor position. */
23095 if (area
== TEXT_AREA
23096 && !row
->full_width_p
23097 /* When drawing overlapping rows, only the glyph strings'
23098 foreground is drawn, which doesn't erase a cursor
23102 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23103 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23104 : (tail
? tail
->x
+ tail
->background_width
: x
));
23108 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23109 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23113 /* Value is the x-position up to which drawn, relative to AREA of W.
23114 This doesn't include parts drawn because of overhangs. */
23115 if (row
->full_width_p
)
23116 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23118 x_reached
-= area_left
;
23120 RELEASE_HDC (hdc
, f
);
23125 /* Expand row matrix if too narrow. Don't expand if area
23128 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23130 if (!fonts_changed_p \
23131 && (it->glyph_row->glyphs[area] \
23132 < it->glyph_row->glyphs[area + 1])) \
23134 it->w->ncols_scale_factor++; \
23135 fonts_changed_p = 1; \
23139 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23140 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23143 append_glyph (struct it
*it
)
23145 struct glyph
*glyph
;
23146 enum glyph_row_area area
= it
->area
;
23148 xassert (it
->glyph_row
);
23149 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23151 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23152 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23154 /* If the glyph row is reversed, we need to prepend the glyph
23155 rather than append it. */
23156 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23160 /* Make room for the additional glyph. */
23161 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23163 glyph
= it
->glyph_row
->glyphs
[area
];
23165 glyph
->charpos
= CHARPOS (it
->position
);
23166 glyph
->object
= it
->object
;
23167 if (it
->pixel_width
> 0)
23169 glyph
->pixel_width
= it
->pixel_width
;
23170 glyph
->padding_p
= 0;
23174 /* Assure at least 1-pixel width. Otherwise, cursor can't
23175 be displayed correctly. */
23176 glyph
->pixel_width
= 1;
23177 glyph
->padding_p
= 1;
23179 glyph
->ascent
= it
->ascent
;
23180 glyph
->descent
= it
->descent
;
23181 glyph
->voffset
= it
->voffset
;
23182 glyph
->type
= CHAR_GLYPH
;
23183 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23184 glyph
->multibyte_p
= it
->multibyte_p
;
23185 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23186 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23187 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23188 || it
->phys_descent
> it
->descent
);
23189 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23190 glyph
->face_id
= it
->face_id
;
23191 glyph
->u
.ch
= it
->char_to_display
;
23192 glyph
->slice
.img
= null_glyph_slice
;
23193 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23196 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23197 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23199 glyph
->bidi_type
= it
->bidi_it
.type
;
23203 glyph
->resolved_level
= 0;
23204 glyph
->bidi_type
= UNKNOWN_BT
;
23206 ++it
->glyph_row
->used
[area
];
23209 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23212 /* Store one glyph for the composition IT->cmp_it.id in
23213 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23217 append_composite_glyph (struct it
*it
)
23219 struct glyph
*glyph
;
23220 enum glyph_row_area area
= it
->area
;
23222 xassert (it
->glyph_row
);
23224 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23225 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23227 /* If the glyph row is reversed, we need to prepend the glyph
23228 rather than append it. */
23229 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23233 /* Make room for the new glyph. */
23234 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23236 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23238 glyph
->charpos
= it
->cmp_it
.charpos
;
23239 glyph
->object
= it
->object
;
23240 glyph
->pixel_width
= it
->pixel_width
;
23241 glyph
->ascent
= it
->ascent
;
23242 glyph
->descent
= it
->descent
;
23243 glyph
->voffset
= it
->voffset
;
23244 glyph
->type
= COMPOSITE_GLYPH
;
23245 if (it
->cmp_it
.ch
< 0)
23247 glyph
->u
.cmp
.automatic
= 0;
23248 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23249 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23253 glyph
->u
.cmp
.automatic
= 1;
23254 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23255 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23256 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23258 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23259 glyph
->multibyte_p
= it
->multibyte_p
;
23260 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23261 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23262 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23263 || it
->phys_descent
> it
->descent
);
23264 glyph
->padding_p
= 0;
23265 glyph
->glyph_not_available_p
= 0;
23266 glyph
->face_id
= it
->face_id
;
23267 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23270 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23271 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23273 glyph
->bidi_type
= it
->bidi_it
.type
;
23275 ++it
->glyph_row
->used
[area
];
23278 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23282 /* Change IT->ascent and IT->height according to the setting of
23286 take_vertical_position_into_account (struct it
*it
)
23290 if (it
->voffset
< 0)
23291 /* Increase the ascent so that we can display the text higher
23293 it
->ascent
-= it
->voffset
;
23295 /* Increase the descent so that we can display the text lower
23297 it
->descent
+= it
->voffset
;
23302 /* Produce glyphs/get display metrics for the image IT is loaded with.
23303 See the description of struct display_iterator in dispextern.h for
23304 an overview of struct display_iterator. */
23307 produce_image_glyph (struct it
*it
)
23311 int glyph_ascent
, crop
;
23312 struct glyph_slice slice
;
23314 xassert (it
->what
== IT_IMAGE
);
23316 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23318 /* Make sure X resources of the face is loaded. */
23319 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23321 if (it
->image_id
< 0)
23323 /* Fringe bitmap. */
23324 it
->ascent
= it
->phys_ascent
= 0;
23325 it
->descent
= it
->phys_descent
= 0;
23326 it
->pixel_width
= 0;
23331 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23333 /* Make sure X resources of the image is loaded. */
23334 prepare_image_for_display (it
->f
, img
);
23336 slice
.x
= slice
.y
= 0;
23337 slice
.width
= img
->width
;
23338 slice
.height
= img
->height
;
23340 if (INTEGERP (it
->slice
.x
))
23341 slice
.x
= XINT (it
->slice
.x
);
23342 else if (FLOATP (it
->slice
.x
))
23343 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23345 if (INTEGERP (it
->slice
.y
))
23346 slice
.y
= XINT (it
->slice
.y
);
23347 else if (FLOATP (it
->slice
.y
))
23348 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23350 if (INTEGERP (it
->slice
.width
))
23351 slice
.width
= XINT (it
->slice
.width
);
23352 else if (FLOATP (it
->slice
.width
))
23353 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23355 if (INTEGERP (it
->slice
.height
))
23356 slice
.height
= XINT (it
->slice
.height
);
23357 else if (FLOATP (it
->slice
.height
))
23358 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23360 if (slice
.x
>= img
->width
)
23361 slice
.x
= img
->width
;
23362 if (slice
.y
>= img
->height
)
23363 slice
.y
= img
->height
;
23364 if (slice
.x
+ slice
.width
>= img
->width
)
23365 slice
.width
= img
->width
- slice
.x
;
23366 if (slice
.y
+ slice
.height
> img
->height
)
23367 slice
.height
= img
->height
- slice
.y
;
23369 if (slice
.width
== 0 || slice
.height
== 0)
23372 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23374 it
->descent
= slice
.height
- glyph_ascent
;
23376 it
->descent
+= img
->vmargin
;
23377 if (slice
.y
+ slice
.height
== img
->height
)
23378 it
->descent
+= img
->vmargin
;
23379 it
->phys_descent
= it
->descent
;
23381 it
->pixel_width
= slice
.width
;
23383 it
->pixel_width
+= img
->hmargin
;
23384 if (slice
.x
+ slice
.width
== img
->width
)
23385 it
->pixel_width
+= img
->hmargin
;
23387 /* It's quite possible for images to have an ascent greater than
23388 their height, so don't get confused in that case. */
23389 if (it
->descent
< 0)
23394 if (face
->box
!= FACE_NO_BOX
)
23396 if (face
->box_line_width
> 0)
23399 it
->ascent
+= face
->box_line_width
;
23400 if (slice
.y
+ slice
.height
== img
->height
)
23401 it
->descent
+= face
->box_line_width
;
23404 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23405 it
->pixel_width
+= eabs (face
->box_line_width
);
23406 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23407 it
->pixel_width
+= eabs (face
->box_line_width
);
23410 take_vertical_position_into_account (it
);
23412 /* Automatically crop wide image glyphs at right edge so we can
23413 draw the cursor on same display row. */
23414 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23415 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23417 it
->pixel_width
-= crop
;
23418 slice
.width
-= crop
;
23423 struct glyph
*glyph
;
23424 enum glyph_row_area area
= it
->area
;
23426 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23427 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23429 glyph
->charpos
= CHARPOS (it
->position
);
23430 glyph
->object
= it
->object
;
23431 glyph
->pixel_width
= it
->pixel_width
;
23432 glyph
->ascent
= glyph_ascent
;
23433 glyph
->descent
= it
->descent
;
23434 glyph
->voffset
= it
->voffset
;
23435 glyph
->type
= IMAGE_GLYPH
;
23436 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23437 glyph
->multibyte_p
= it
->multibyte_p
;
23438 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23439 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23440 glyph
->overlaps_vertically_p
= 0;
23441 glyph
->padding_p
= 0;
23442 glyph
->glyph_not_available_p
= 0;
23443 glyph
->face_id
= it
->face_id
;
23444 glyph
->u
.img_id
= img
->id
;
23445 glyph
->slice
.img
= slice
;
23446 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23449 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23450 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23452 glyph
->bidi_type
= it
->bidi_it
.type
;
23454 ++it
->glyph_row
->used
[area
];
23457 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23462 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23463 of the glyph, WIDTH and HEIGHT are the width and height of the
23464 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23467 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23468 int width
, int height
, int ascent
)
23470 struct glyph
*glyph
;
23471 enum glyph_row_area area
= it
->area
;
23473 xassert (ascent
>= 0 && ascent
<= height
);
23475 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23476 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23478 /* If the glyph row is reversed, we need to prepend the glyph
23479 rather than append it. */
23480 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23484 /* Make room for the additional glyph. */
23485 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23487 glyph
= it
->glyph_row
->glyphs
[area
];
23489 glyph
->charpos
= CHARPOS (it
->position
);
23490 glyph
->object
= object
;
23491 glyph
->pixel_width
= width
;
23492 glyph
->ascent
= ascent
;
23493 glyph
->descent
= height
- ascent
;
23494 glyph
->voffset
= it
->voffset
;
23495 glyph
->type
= STRETCH_GLYPH
;
23496 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23497 glyph
->multibyte_p
= it
->multibyte_p
;
23498 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23499 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23500 glyph
->overlaps_vertically_p
= 0;
23501 glyph
->padding_p
= 0;
23502 glyph
->glyph_not_available_p
= 0;
23503 glyph
->face_id
= it
->face_id
;
23504 glyph
->u
.stretch
.ascent
= ascent
;
23505 glyph
->u
.stretch
.height
= height
;
23506 glyph
->slice
.img
= null_glyph_slice
;
23507 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23510 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23511 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23513 glyph
->bidi_type
= it
->bidi_it
.type
;
23517 glyph
->resolved_level
= 0;
23518 glyph
->bidi_type
= UNKNOWN_BT
;
23520 ++it
->glyph_row
->used
[area
];
23523 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23526 #endif /* HAVE_WINDOW_SYSTEM */
23528 /* Produce a stretch glyph for iterator IT. IT->object is the value
23529 of the glyph property displayed. The value must be a list
23530 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23533 1. `:width WIDTH' specifies that the space should be WIDTH *
23534 canonical char width wide. WIDTH may be an integer or floating
23537 2. `:relative-width FACTOR' specifies that the width of the stretch
23538 should be computed from the width of the first character having the
23539 `glyph' property, and should be FACTOR times that width.
23541 3. `:align-to HPOS' specifies that the space should be wide enough
23542 to reach HPOS, a value in canonical character units.
23544 Exactly one of the above pairs must be present.
23546 4. `:height HEIGHT' specifies that the height of the stretch produced
23547 should be HEIGHT, measured in canonical character units.
23549 5. `:relative-height FACTOR' specifies that the height of the
23550 stretch should be FACTOR times the height of the characters having
23551 the glyph property.
23553 Either none or exactly one of 4 or 5 must be present.
23555 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23556 of the stretch should be used for the ascent of the stretch.
23557 ASCENT must be in the range 0 <= ASCENT <= 100. */
23560 produce_stretch_glyph (struct it
*it
)
23562 /* (space :width WIDTH :height HEIGHT ...) */
23563 Lisp_Object prop
, plist
;
23564 int width
= 0, height
= 0, align_to
= -1;
23565 int zero_width_ok_p
= 0;
23568 struct face
*face
= NULL
;
23569 struct font
*font
= NULL
;
23571 #ifdef HAVE_WINDOW_SYSTEM
23572 int zero_height_ok_p
= 0;
23574 if (FRAME_WINDOW_P (it
->f
))
23576 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23577 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23578 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23582 /* List should start with `space'. */
23583 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23584 plist
= XCDR (it
->object
);
23586 /* Compute the width of the stretch. */
23587 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23588 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23590 /* Absolute width `:width WIDTH' specified and valid. */
23591 zero_width_ok_p
= 1;
23594 #ifdef HAVE_WINDOW_SYSTEM
23595 else if (FRAME_WINDOW_P (it
->f
)
23596 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23598 /* Relative width `:relative-width FACTOR' specified and valid.
23599 Compute the width of the characters having the `glyph'
23602 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23605 if (it
->multibyte_p
)
23606 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23609 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23610 if (! ASCII_CHAR_P (it2
.c
))
23611 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23614 it2
.glyph_row
= NULL
;
23615 it2
.what
= IT_CHARACTER
;
23616 x_produce_glyphs (&it2
);
23617 width
= NUMVAL (prop
) * it2
.pixel_width
;
23619 #endif /* HAVE_WINDOW_SYSTEM */
23620 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23621 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23623 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23624 align_to
= (align_to
< 0
23626 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23627 else if (align_to
< 0)
23628 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23629 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23630 zero_width_ok_p
= 1;
23633 /* Nothing specified -> width defaults to canonical char width. */
23634 width
= FRAME_COLUMN_WIDTH (it
->f
);
23636 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23639 #ifdef HAVE_WINDOW_SYSTEM
23640 /* Compute height. */
23641 if (FRAME_WINDOW_P (it
->f
))
23643 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23644 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23647 zero_height_ok_p
= 1;
23649 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23651 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23653 height
= FONT_HEIGHT (font
);
23655 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23658 /* Compute percentage of height used for ascent. If
23659 `:ascent ASCENT' is present and valid, use that. Otherwise,
23660 derive the ascent from the font in use. */
23661 if (prop
= Fplist_get (plist
, QCascent
),
23662 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23663 ascent
= height
* NUMVAL (prop
) / 100.0;
23664 else if (!NILP (prop
)
23665 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23666 ascent
= min (max (0, (int)tem
), height
);
23668 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23671 #endif /* HAVE_WINDOW_SYSTEM */
23674 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23675 && it
->current_x
+ width
> it
->last_visible_x
)
23677 width
= it
->last_visible_x
- it
->current_x
;
23678 #ifdef HAVE_WINDOW_SYSTEM
23679 /* Subtract one more pixel from the stretch width, but only on
23680 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23681 width
-= FRAME_WINDOW_P (it
->f
);
23685 if (width
> 0 && height
> 0 && it
->glyph_row
)
23687 Lisp_Object o_object
= it
->object
;
23688 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23691 if (!STRINGP (object
))
23692 object
= it
->w
->buffer
;
23693 #ifdef HAVE_WINDOW_SYSTEM
23694 if (FRAME_WINDOW_P (it
->f
))
23695 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23699 it
->object
= object
;
23700 it
->char_to_display
= ' ';
23701 it
->pixel_width
= it
->len
= 1;
23703 tty_append_glyph (it
);
23704 it
->object
= o_object
;
23708 it
->pixel_width
= width
;
23709 #ifdef HAVE_WINDOW_SYSTEM
23710 if (FRAME_WINDOW_P (it
->f
))
23712 it
->ascent
= it
->phys_ascent
= ascent
;
23713 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23714 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23715 take_vertical_position_into_account (it
);
23719 it
->nglyphs
= width
;
23722 #ifdef HAVE_WINDOW_SYSTEM
23724 /* Calculate line-height and line-spacing properties.
23725 An integer value specifies explicit pixel value.
23726 A float value specifies relative value to current face height.
23727 A cons (float . face-name) specifies relative value to
23728 height of specified face font.
23730 Returns height in pixels, or nil. */
23734 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23735 int boff
, int override
)
23737 Lisp_Object face_name
= Qnil
;
23738 int ascent
, descent
, height
;
23740 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23745 face_name
= XCAR (val
);
23747 if (!NUMBERP (val
))
23748 val
= make_number (1);
23749 if (NILP (face_name
))
23751 height
= it
->ascent
+ it
->descent
;
23756 if (NILP (face_name
))
23758 font
= FRAME_FONT (it
->f
);
23759 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23761 else if (EQ (face_name
, Qt
))
23770 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23772 return make_number (-1);
23774 face
= FACE_FROM_ID (it
->f
, face_id
);
23777 return make_number (-1);
23778 boff
= font
->baseline_offset
;
23779 if (font
->vertical_centering
)
23780 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23783 ascent
= FONT_BASE (font
) + boff
;
23784 descent
= FONT_DESCENT (font
) - boff
;
23788 it
->override_ascent
= ascent
;
23789 it
->override_descent
= descent
;
23790 it
->override_boff
= boff
;
23793 height
= ascent
+ descent
;
23797 height
= (int)(XFLOAT_DATA (val
) * height
);
23798 else if (INTEGERP (val
))
23799 height
*= XINT (val
);
23801 return make_number (height
);
23805 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23806 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23807 and only if this is for a character for which no font was found.
23809 If the display method (it->glyphless_method) is
23810 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23811 length of the acronym or the hexadecimal string, UPPER_XOFF and
23812 UPPER_YOFF are pixel offsets for the upper part of the string,
23813 LOWER_XOFF and LOWER_YOFF are for the lower part.
23815 For the other display methods, LEN through LOWER_YOFF are zero. */
23818 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23819 short upper_xoff
, short upper_yoff
,
23820 short lower_xoff
, short lower_yoff
)
23822 struct glyph
*glyph
;
23823 enum glyph_row_area area
= it
->area
;
23825 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23826 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23828 /* If the glyph row is reversed, we need to prepend the glyph
23829 rather than append it. */
23830 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23834 /* Make room for the additional glyph. */
23835 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23837 glyph
= it
->glyph_row
->glyphs
[area
];
23839 glyph
->charpos
= CHARPOS (it
->position
);
23840 glyph
->object
= it
->object
;
23841 glyph
->pixel_width
= it
->pixel_width
;
23842 glyph
->ascent
= it
->ascent
;
23843 glyph
->descent
= it
->descent
;
23844 glyph
->voffset
= it
->voffset
;
23845 glyph
->type
= GLYPHLESS_GLYPH
;
23846 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23847 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23848 glyph
->u
.glyphless
.len
= len
;
23849 glyph
->u
.glyphless
.ch
= it
->c
;
23850 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23851 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23852 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23853 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23854 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23855 glyph
->multibyte_p
= it
->multibyte_p
;
23856 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23857 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23858 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23859 || it
->phys_descent
> it
->descent
);
23860 glyph
->padding_p
= 0;
23861 glyph
->glyph_not_available_p
= 0;
23862 glyph
->face_id
= face_id
;
23863 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23866 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23867 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23869 glyph
->bidi_type
= it
->bidi_it
.type
;
23871 ++it
->glyph_row
->used
[area
];
23874 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23878 /* Produce a glyph for a glyphless character for iterator IT.
23879 IT->glyphless_method specifies which method to use for displaying
23880 the character. See the description of enum
23881 glyphless_display_method in dispextern.h for the detail.
23883 FOR_NO_FONT is nonzero if and only if this is for a character for
23884 which no font was found. ACRONYM, if non-nil, is an acronym string
23885 for the character. */
23888 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23893 int base_width
, base_height
, width
, height
;
23894 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23897 /* Get the metrics of the base font. We always refer to the current
23899 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23900 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23901 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23902 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23903 base_height
= it
->ascent
+ it
->descent
;
23904 base_width
= font
->average_width
;
23906 /* Get a face ID for the glyph by utilizing a cache (the same way as
23907 done for `escape-glyph' in get_next_display_element). */
23908 if (it
->f
== last_glyphless_glyph_frame
23909 && it
->face_id
== last_glyphless_glyph_face_id
)
23911 face_id
= last_glyphless_glyph_merged_face_id
;
23915 /* Merge the `glyphless-char' face into the current face. */
23916 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23917 last_glyphless_glyph_frame
= it
->f
;
23918 last_glyphless_glyph_face_id
= it
->face_id
;
23919 last_glyphless_glyph_merged_face_id
= face_id
;
23922 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23924 it
->pixel_width
= THIN_SPACE_WIDTH
;
23926 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23928 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23930 width
= CHAR_WIDTH (it
->c
);
23933 else if (width
> 4)
23935 it
->pixel_width
= base_width
* width
;
23937 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23943 unsigned int code
[6];
23945 int ascent
, descent
;
23946 struct font_metrics metrics_upper
, metrics_lower
;
23948 face
= FACE_FROM_ID (it
->f
, face_id
);
23949 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23950 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23952 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23954 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23955 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23956 if (CONSP (acronym
))
23957 acronym
= XCAR (acronym
);
23958 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23962 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23963 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23966 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23967 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23968 upper_len
= (len
+ 1) / 2;
23969 font
->driver
->text_extents (font
, code
, upper_len
,
23971 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23976 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23977 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23978 upper_xoff
= upper_yoff
= 2; /* the typical case */
23979 if (base_width
>= width
)
23981 /* Align the upper to the left, the lower to the right. */
23982 it
->pixel_width
= base_width
;
23983 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23987 /* Center the shorter one. */
23988 it
->pixel_width
= width
;
23989 if (metrics_upper
.width
>= metrics_lower
.width
)
23990 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23993 /* FIXME: This code doesn't look right. It formerly was
23994 missing the "lower_xoff = 0;", which couldn't have
23995 been right since it left lower_xoff uninitialized. */
23997 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24001 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24002 top, bottom, and between upper and lower strings. */
24003 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24004 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24005 /* Center vertically.
24006 H:base_height, D:base_descent
24007 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24009 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24010 descent = D - H/2 + h/2;
24011 lower_yoff = descent - 2 - ld;
24012 upper_yoff = lower_yoff - la - 1 - ud; */
24013 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24014 descent
= it
->descent
- (base_height
- height
) / 2;
24015 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24016 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24017 - metrics_upper
.descent
);
24018 /* Don't make the height shorter than the base height. */
24019 if (height
> base_height
)
24021 it
->ascent
= ascent
;
24022 it
->descent
= descent
;
24026 it
->phys_ascent
= it
->ascent
;
24027 it
->phys_descent
= it
->descent
;
24029 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24030 upper_xoff
, upper_yoff
,
24031 lower_xoff
, lower_yoff
);
24033 take_vertical_position_into_account (it
);
24038 Produce glyphs/get display metrics for the display element IT is
24039 loaded with. See the description of struct it in dispextern.h
24040 for an overview of struct it. */
24043 x_produce_glyphs (struct it
*it
)
24045 int extra_line_spacing
= it
->extra_line_spacing
;
24047 it
->glyph_not_available_p
= 0;
24049 if (it
->what
== IT_CHARACTER
)
24052 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24053 struct font
*font
= face
->font
;
24054 struct font_metrics
*pcm
= NULL
;
24055 int boff
; /* baseline offset */
24059 /* When no suitable font is found, display this character by
24060 the method specified in the first extra slot of
24061 Vglyphless_char_display. */
24062 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24064 xassert (it
->what
== IT_GLYPHLESS
);
24065 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24069 boff
= font
->baseline_offset
;
24070 if (font
->vertical_centering
)
24071 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24073 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24079 if (it
->override_ascent
>= 0)
24081 it
->ascent
= it
->override_ascent
;
24082 it
->descent
= it
->override_descent
;
24083 boff
= it
->override_boff
;
24087 it
->ascent
= FONT_BASE (font
) + boff
;
24088 it
->descent
= FONT_DESCENT (font
) - boff
;
24091 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24093 pcm
= get_per_char_metric (font
, &char2b
);
24094 if (pcm
->width
== 0
24095 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24101 it
->phys_ascent
= pcm
->ascent
+ boff
;
24102 it
->phys_descent
= pcm
->descent
- boff
;
24103 it
->pixel_width
= pcm
->width
;
24107 it
->glyph_not_available_p
= 1;
24108 it
->phys_ascent
= it
->ascent
;
24109 it
->phys_descent
= it
->descent
;
24110 it
->pixel_width
= font
->space_width
;
24113 if (it
->constrain_row_ascent_descent_p
)
24115 if (it
->descent
> it
->max_descent
)
24117 it
->ascent
+= it
->descent
- it
->max_descent
;
24118 it
->descent
= it
->max_descent
;
24120 if (it
->ascent
> it
->max_ascent
)
24122 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24123 it
->ascent
= it
->max_ascent
;
24125 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24126 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24127 extra_line_spacing
= 0;
24130 /* If this is a space inside a region of text with
24131 `space-width' property, change its width. */
24132 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24134 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24136 /* If face has a box, add the box thickness to the character
24137 height. If character has a box line to the left and/or
24138 right, add the box line width to the character's width. */
24139 if (face
->box
!= FACE_NO_BOX
)
24141 int thick
= face
->box_line_width
;
24145 it
->ascent
+= thick
;
24146 it
->descent
+= thick
;
24151 if (it
->start_of_box_run_p
)
24152 it
->pixel_width
+= thick
;
24153 if (it
->end_of_box_run_p
)
24154 it
->pixel_width
+= thick
;
24157 /* If face has an overline, add the height of the overline
24158 (1 pixel) and a 1 pixel margin to the character height. */
24159 if (face
->overline_p
)
24160 it
->ascent
+= overline_margin
;
24162 if (it
->constrain_row_ascent_descent_p
)
24164 if (it
->ascent
> it
->max_ascent
)
24165 it
->ascent
= it
->max_ascent
;
24166 if (it
->descent
> it
->max_descent
)
24167 it
->descent
= it
->max_descent
;
24170 take_vertical_position_into_account (it
);
24172 /* If we have to actually produce glyphs, do it. */
24177 /* Translate a space with a `space-width' property
24178 into a stretch glyph. */
24179 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24180 / FONT_HEIGHT (font
));
24181 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24182 it
->ascent
+ it
->descent
, ascent
);
24187 /* If characters with lbearing or rbearing are displayed
24188 in this line, record that fact in a flag of the
24189 glyph row. This is used to optimize X output code. */
24190 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24191 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24193 if (! stretched_p
&& it
->pixel_width
== 0)
24194 /* We assure that all visible glyphs have at least 1-pixel
24196 it
->pixel_width
= 1;
24198 else if (it
->char_to_display
== '\n')
24200 /* A newline has no width, but we need the height of the
24201 line. But if previous part of the line sets a height,
24202 don't increase that height */
24204 Lisp_Object height
;
24205 Lisp_Object total_height
= Qnil
;
24207 it
->override_ascent
= -1;
24208 it
->pixel_width
= 0;
24211 height
= get_it_property (it
, Qline_height
);
24212 /* Split (line-height total-height) list */
24214 && CONSP (XCDR (height
))
24215 && NILP (XCDR (XCDR (height
))))
24217 total_height
= XCAR (XCDR (height
));
24218 height
= XCAR (height
);
24220 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24222 if (it
->override_ascent
>= 0)
24224 it
->ascent
= it
->override_ascent
;
24225 it
->descent
= it
->override_descent
;
24226 boff
= it
->override_boff
;
24230 it
->ascent
= FONT_BASE (font
) + boff
;
24231 it
->descent
= FONT_DESCENT (font
) - boff
;
24234 if (EQ (height
, Qt
))
24236 if (it
->descent
> it
->max_descent
)
24238 it
->ascent
+= it
->descent
- it
->max_descent
;
24239 it
->descent
= it
->max_descent
;
24241 if (it
->ascent
> it
->max_ascent
)
24243 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24244 it
->ascent
= it
->max_ascent
;
24246 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24247 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24248 it
->constrain_row_ascent_descent_p
= 1;
24249 extra_line_spacing
= 0;
24253 Lisp_Object spacing
;
24255 it
->phys_ascent
= it
->ascent
;
24256 it
->phys_descent
= it
->descent
;
24258 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24259 && face
->box
!= FACE_NO_BOX
24260 && face
->box_line_width
> 0)
24262 it
->ascent
+= face
->box_line_width
;
24263 it
->descent
+= face
->box_line_width
;
24266 && XINT (height
) > it
->ascent
+ it
->descent
)
24267 it
->ascent
= XINT (height
) - it
->descent
;
24269 if (!NILP (total_height
))
24270 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24273 spacing
= get_it_property (it
, Qline_spacing
);
24274 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24276 if (INTEGERP (spacing
))
24278 extra_line_spacing
= XINT (spacing
);
24279 if (!NILP (total_height
))
24280 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24284 else /* i.e. (it->char_to_display == '\t') */
24286 if (font
->space_width
> 0)
24288 int tab_width
= it
->tab_width
* font
->space_width
;
24289 int x
= it
->current_x
+ it
->continuation_lines_width
;
24290 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24292 /* If the distance from the current position to the next tab
24293 stop is less than a space character width, use the
24294 tab stop after that. */
24295 if (next_tab_x
- x
< font
->space_width
)
24296 next_tab_x
+= tab_width
;
24298 it
->pixel_width
= next_tab_x
- x
;
24300 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24301 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24305 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24306 it
->ascent
+ it
->descent
, it
->ascent
);
24311 it
->pixel_width
= 0;
24316 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24318 /* A static composition.
24320 Note: A composition is represented as one glyph in the
24321 glyph matrix. There are no padding glyphs.
24323 Important note: pixel_width, ascent, and descent are the
24324 values of what is drawn by draw_glyphs (i.e. the values of
24325 the overall glyphs composed). */
24326 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24327 int boff
; /* baseline offset */
24328 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24329 int glyph_len
= cmp
->glyph_len
;
24330 struct font
*font
= face
->font
;
24334 /* If we have not yet calculated pixel size data of glyphs of
24335 the composition for the current face font, calculate them
24336 now. Theoretically, we have to check all fonts for the
24337 glyphs, but that requires much time and memory space. So,
24338 here we check only the font of the first glyph. This may
24339 lead to incorrect display, but it's very rare, and C-l
24340 (recenter-top-bottom) can correct the display anyway. */
24341 if (! cmp
->font
|| cmp
->font
!= font
)
24343 /* Ascent and descent of the font of the first character
24344 of this composition (adjusted by baseline offset).
24345 Ascent and descent of overall glyphs should not be less
24346 than these, respectively. */
24347 int font_ascent
, font_descent
, font_height
;
24348 /* Bounding box of the overall glyphs. */
24349 int leftmost
, rightmost
, lowest
, highest
;
24350 int lbearing
, rbearing
;
24351 int i
, width
, ascent
, descent
;
24352 int left_padded
= 0, right_padded
= 0;
24353 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24355 struct font_metrics
*pcm
;
24356 int font_not_found_p
;
24359 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24360 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24362 if (glyph_len
< cmp
->glyph_len
)
24364 for (i
= 0; i
< glyph_len
; i
++)
24366 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24368 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24373 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24374 : IT_CHARPOS (*it
));
24375 /* If no suitable font is found, use the default font. */
24376 font_not_found_p
= font
== NULL
;
24377 if (font_not_found_p
)
24379 face
= face
->ascii_face
;
24382 boff
= font
->baseline_offset
;
24383 if (font
->vertical_centering
)
24384 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24385 font_ascent
= FONT_BASE (font
) + boff
;
24386 font_descent
= FONT_DESCENT (font
) - boff
;
24387 font_height
= FONT_HEIGHT (font
);
24389 cmp
->font
= (void *) font
;
24392 if (! font_not_found_p
)
24394 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24396 pcm
= get_per_char_metric (font
, &char2b
);
24399 /* Initialize the bounding box. */
24402 width
= pcm
->width
;
24403 ascent
= pcm
->ascent
;
24404 descent
= pcm
->descent
;
24405 lbearing
= pcm
->lbearing
;
24406 rbearing
= pcm
->rbearing
;
24410 width
= font
->space_width
;
24411 ascent
= FONT_BASE (font
);
24412 descent
= FONT_DESCENT (font
);
24419 lowest
= - descent
+ boff
;
24420 highest
= ascent
+ boff
;
24422 if (! font_not_found_p
24423 && font
->default_ascent
24424 && CHAR_TABLE_P (Vuse_default_ascent
)
24425 && !NILP (Faref (Vuse_default_ascent
,
24426 make_number (it
->char_to_display
))))
24427 highest
= font
->default_ascent
+ boff
;
24429 /* Draw the first glyph at the normal position. It may be
24430 shifted to right later if some other glyphs are drawn
24432 cmp
->offsets
[i
* 2] = 0;
24433 cmp
->offsets
[i
* 2 + 1] = boff
;
24434 cmp
->lbearing
= lbearing
;
24435 cmp
->rbearing
= rbearing
;
24437 /* Set cmp->offsets for the remaining glyphs. */
24438 for (i
++; i
< glyph_len
; i
++)
24440 int left
, right
, btm
, top
;
24441 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24443 struct face
*this_face
;
24447 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24448 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24449 font
= this_face
->font
;
24455 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24457 pcm
= get_per_char_metric (font
, &char2b
);
24460 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24463 width
= pcm
->width
;
24464 ascent
= pcm
->ascent
;
24465 descent
= pcm
->descent
;
24466 lbearing
= pcm
->lbearing
;
24467 rbearing
= pcm
->rbearing
;
24468 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24470 /* Relative composition with or without
24471 alternate chars. */
24472 left
= (leftmost
+ rightmost
- width
) / 2;
24473 btm
= - descent
+ boff
;
24474 if (font
->relative_compose
24475 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24476 || NILP (Faref (Vignore_relative_composition
,
24477 make_number (ch
)))))
24480 if (- descent
>= font
->relative_compose
)
24481 /* One extra pixel between two glyphs. */
24483 else if (ascent
<= 0)
24484 /* One extra pixel between two glyphs. */
24485 btm
= lowest
- 1 - ascent
- descent
;
24490 /* A composition rule is specified by an integer
24491 value that encodes global and new reference
24492 points (GREF and NREF). GREF and NREF are
24493 specified by numbers as below:
24495 0---1---2 -- ascent
24499 9--10--11 -- center
24501 ---3---4---5--- baseline
24503 6---7---8 -- descent
24505 int rule
= COMPOSITION_RULE (cmp
, i
);
24506 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24508 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24509 grefx
= gref
% 3, nrefx
= nref
% 3;
24510 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24512 xoff
= font_height
* (xoff
- 128) / 256;
24514 yoff
= font_height
* (yoff
- 128) / 256;
24517 + grefx
* (rightmost
- leftmost
) / 2
24518 - nrefx
* width
/ 2
24521 btm
= ((grefy
== 0 ? highest
24523 : grefy
== 2 ? lowest
24524 : (highest
+ lowest
) / 2)
24525 - (nrefy
== 0 ? ascent
+ descent
24526 : nrefy
== 1 ? descent
- boff
24528 : (ascent
+ descent
) / 2)
24532 cmp
->offsets
[i
* 2] = left
;
24533 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24535 /* Update the bounding box of the overall glyphs. */
24538 right
= left
+ width
;
24539 if (left
< leftmost
)
24541 if (right
> rightmost
)
24544 top
= btm
+ descent
+ ascent
;
24550 if (cmp
->lbearing
> left
+ lbearing
)
24551 cmp
->lbearing
= left
+ lbearing
;
24552 if (cmp
->rbearing
< left
+ rbearing
)
24553 cmp
->rbearing
= left
+ rbearing
;
24557 /* If there are glyphs whose x-offsets are negative,
24558 shift all glyphs to the right and make all x-offsets
24562 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24563 cmp
->offsets
[i
* 2] -= leftmost
;
24564 rightmost
-= leftmost
;
24565 cmp
->lbearing
-= leftmost
;
24566 cmp
->rbearing
-= leftmost
;
24569 if (left_padded
&& cmp
->lbearing
< 0)
24571 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24572 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24573 rightmost
-= cmp
->lbearing
;
24574 cmp
->rbearing
-= cmp
->lbearing
;
24577 if (right_padded
&& rightmost
< cmp
->rbearing
)
24579 rightmost
= cmp
->rbearing
;
24582 cmp
->pixel_width
= rightmost
;
24583 cmp
->ascent
= highest
;
24584 cmp
->descent
= - lowest
;
24585 if (cmp
->ascent
< font_ascent
)
24586 cmp
->ascent
= font_ascent
;
24587 if (cmp
->descent
< font_descent
)
24588 cmp
->descent
= font_descent
;
24592 && (cmp
->lbearing
< 0
24593 || cmp
->rbearing
> cmp
->pixel_width
))
24594 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24596 it
->pixel_width
= cmp
->pixel_width
;
24597 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24598 it
->descent
= it
->phys_descent
= cmp
->descent
;
24599 if (face
->box
!= FACE_NO_BOX
)
24601 int thick
= face
->box_line_width
;
24605 it
->ascent
+= thick
;
24606 it
->descent
+= thick
;
24611 if (it
->start_of_box_run_p
)
24612 it
->pixel_width
+= thick
;
24613 if (it
->end_of_box_run_p
)
24614 it
->pixel_width
+= thick
;
24617 /* If face has an overline, add the height of the overline
24618 (1 pixel) and a 1 pixel margin to the character height. */
24619 if (face
->overline_p
)
24620 it
->ascent
+= overline_margin
;
24622 take_vertical_position_into_account (it
);
24623 if (it
->ascent
< 0)
24625 if (it
->descent
< 0)
24629 append_composite_glyph (it
);
24631 else if (it
->what
== IT_COMPOSITION
)
24633 /* A dynamic (automatic) composition. */
24634 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24635 Lisp_Object gstring
;
24636 struct font_metrics metrics
;
24640 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24642 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24645 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24646 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24647 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24648 it
->descent
= it
->phys_descent
= metrics
.descent
;
24649 if (face
->box
!= FACE_NO_BOX
)
24651 int thick
= face
->box_line_width
;
24655 it
->ascent
+= thick
;
24656 it
->descent
+= thick
;
24661 if (it
->start_of_box_run_p
)
24662 it
->pixel_width
+= thick
;
24663 if (it
->end_of_box_run_p
)
24664 it
->pixel_width
+= thick
;
24666 /* If face has an overline, add the height of the overline
24667 (1 pixel) and a 1 pixel margin to the character height. */
24668 if (face
->overline_p
)
24669 it
->ascent
+= overline_margin
;
24670 take_vertical_position_into_account (it
);
24671 if (it
->ascent
< 0)
24673 if (it
->descent
< 0)
24677 append_composite_glyph (it
);
24679 else if (it
->what
== IT_GLYPHLESS
)
24680 produce_glyphless_glyph (it
, 0, Qnil
);
24681 else if (it
->what
== IT_IMAGE
)
24682 produce_image_glyph (it
);
24683 else if (it
->what
== IT_STRETCH
)
24684 produce_stretch_glyph (it
);
24687 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24688 because this isn't true for images with `:ascent 100'. */
24689 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24690 if (it
->area
== TEXT_AREA
)
24691 it
->current_x
+= it
->pixel_width
;
24693 if (extra_line_spacing
> 0)
24695 it
->descent
+= extra_line_spacing
;
24696 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24697 it
->max_extra_line_spacing
= extra_line_spacing
;
24700 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24701 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24702 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24703 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24707 Output LEN glyphs starting at START at the nominal cursor position.
24708 Advance the nominal cursor over the text. The global variable
24709 updated_window contains the window being updated, updated_row is
24710 the glyph row being updated, and updated_area is the area of that
24711 row being updated. */
24714 x_write_glyphs (struct glyph
*start
, int len
)
24716 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
24718 xassert (updated_window
&& updated_row
);
24719 /* When the window is hscrolled, cursor hpos can legitimately be out
24720 of bounds, but we draw the cursor at the corresponding window
24721 margin in that case. */
24722 if (!updated_row
->reversed_p
&& chpos
< 0)
24724 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
24725 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
24729 /* Write glyphs. */
24731 hpos
= start
- updated_row
->glyphs
[updated_area
];
24732 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24733 updated_row
, updated_area
,
24735 DRAW_NORMAL_TEXT
, 0);
24737 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24738 if (updated_area
== TEXT_AREA
24739 && updated_window
->phys_cursor_on_p
24740 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24742 && chpos
< hpos
+ len
)
24743 updated_window
->phys_cursor_on_p
= 0;
24747 /* Advance the output cursor. */
24748 output_cursor
.hpos
+= len
;
24749 output_cursor
.x
= x
;
24754 Insert LEN glyphs from START at the nominal cursor position. */
24757 x_insert_glyphs (struct glyph
*start
, int len
)
24761 int line_height
, shift_by_width
, shifted_region_width
;
24762 struct glyph_row
*row
;
24763 struct glyph
*glyph
;
24764 int frame_x
, frame_y
;
24767 xassert (updated_window
&& updated_row
);
24769 w
= updated_window
;
24770 f
= XFRAME (WINDOW_FRAME (w
));
24772 /* Get the height of the line we are in. */
24774 line_height
= row
->height
;
24776 /* Get the width of the glyphs to insert. */
24777 shift_by_width
= 0;
24778 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24779 shift_by_width
+= glyph
->pixel_width
;
24781 /* Get the width of the region to shift right. */
24782 shifted_region_width
= (window_box_width (w
, updated_area
)
24787 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24788 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24790 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24791 line_height
, shift_by_width
);
24793 /* Write the glyphs. */
24794 hpos
= start
- row
->glyphs
[updated_area
];
24795 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24797 DRAW_NORMAL_TEXT
, 0);
24799 /* Advance the output cursor. */
24800 output_cursor
.hpos
+= len
;
24801 output_cursor
.x
+= shift_by_width
;
24807 Erase the current text line from the nominal cursor position
24808 (inclusive) to pixel column TO_X (exclusive). The idea is that
24809 everything from TO_X onward is already erased.
24811 TO_X is a pixel position relative to updated_area of
24812 updated_window. TO_X == -1 means clear to the end of this area. */
24815 x_clear_end_of_line (int to_x
)
24818 struct window
*w
= updated_window
;
24819 int max_x
, min_y
, max_y
;
24820 int from_x
, from_y
, to_y
;
24822 xassert (updated_window
&& updated_row
);
24823 f
= XFRAME (w
->frame
);
24825 if (updated_row
->full_width_p
)
24826 max_x
= WINDOW_TOTAL_WIDTH (w
);
24828 max_x
= window_box_width (w
, updated_area
);
24829 max_y
= window_text_bottom_y (w
);
24831 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24832 of window. For TO_X > 0, truncate to end of drawing area. */
24838 to_x
= min (to_x
, max_x
);
24840 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24842 /* Notice if the cursor will be cleared by this operation. */
24843 if (!updated_row
->full_width_p
)
24844 notice_overwritten_cursor (w
, updated_area
,
24845 output_cursor
.x
, -1,
24847 MATRIX_ROW_BOTTOM_Y (updated_row
));
24849 from_x
= output_cursor
.x
;
24851 /* Translate to frame coordinates. */
24852 if (updated_row
->full_width_p
)
24854 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24855 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24859 int area_left
= window_box_left (w
, updated_area
);
24860 from_x
+= area_left
;
24864 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24865 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24866 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24868 /* Prevent inadvertently clearing to end of the X window. */
24869 if (to_x
> from_x
&& to_y
> from_y
)
24872 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24873 to_x
- from_x
, to_y
- from_y
);
24878 #endif /* HAVE_WINDOW_SYSTEM */
24882 /***********************************************************************
24884 ***********************************************************************/
24886 /* Value is the internal representation of the specified cursor type
24887 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24888 of the bar cursor. */
24890 static enum text_cursor_kinds
24891 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24893 enum text_cursor_kinds type
;
24898 if (EQ (arg
, Qbox
))
24899 return FILLED_BOX_CURSOR
;
24901 if (EQ (arg
, Qhollow
))
24902 return HOLLOW_BOX_CURSOR
;
24904 if (EQ (arg
, Qbar
))
24911 && EQ (XCAR (arg
), Qbar
)
24912 && INTEGERP (XCDR (arg
))
24913 && XINT (XCDR (arg
)) >= 0)
24915 *width
= XINT (XCDR (arg
));
24919 if (EQ (arg
, Qhbar
))
24922 return HBAR_CURSOR
;
24926 && EQ (XCAR (arg
), Qhbar
)
24927 && INTEGERP (XCDR (arg
))
24928 && XINT (XCDR (arg
)) >= 0)
24930 *width
= XINT (XCDR (arg
));
24931 return HBAR_CURSOR
;
24934 /* Treat anything unknown as "hollow box cursor".
24935 It was bad to signal an error; people have trouble fixing
24936 .Xdefaults with Emacs, when it has something bad in it. */
24937 type
= HOLLOW_BOX_CURSOR
;
24942 /* Set the default cursor types for specified frame. */
24944 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24949 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24950 FRAME_CURSOR_WIDTH (f
) = width
;
24952 /* By default, set up the blink-off state depending on the on-state. */
24954 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24957 FRAME_BLINK_OFF_CURSOR (f
)
24958 = get_specified_cursor_type (XCDR (tem
), &width
);
24959 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24962 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24966 #ifdef HAVE_WINDOW_SYSTEM
24968 /* Return the cursor we want to be displayed in window W. Return
24969 width of bar/hbar cursor through WIDTH arg. Return with
24970 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24971 (i.e. if the `system caret' should track this cursor).
24973 In a mini-buffer window, we want the cursor only to appear if we
24974 are reading input from this window. For the selected window, we
24975 want the cursor type given by the frame parameter or buffer local
24976 setting of cursor-type. If explicitly marked off, draw no cursor.
24977 In all other cases, we want a hollow box cursor. */
24979 static enum text_cursor_kinds
24980 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24981 int *active_cursor
)
24983 struct frame
*f
= XFRAME (w
->frame
);
24984 struct buffer
*b
= XBUFFER (w
->buffer
);
24985 int cursor_type
= DEFAULT_CURSOR
;
24986 Lisp_Object alt_cursor
;
24987 int non_selected
= 0;
24989 *active_cursor
= 1;
24992 if (cursor_in_echo_area
24993 && FRAME_HAS_MINIBUF_P (f
)
24994 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24996 if (w
== XWINDOW (echo_area_window
))
24998 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25000 *width
= FRAME_CURSOR_WIDTH (f
);
25001 return FRAME_DESIRED_CURSOR (f
);
25004 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25007 *active_cursor
= 0;
25011 /* Detect a nonselected window or nonselected frame. */
25012 else if (w
!= XWINDOW (f
->selected_window
)
25013 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25015 *active_cursor
= 0;
25017 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25023 /* Never display a cursor in a window in which cursor-type is nil. */
25024 if (NILP (BVAR (b
, cursor_type
)))
25027 /* Get the normal cursor type for this window. */
25028 if (EQ (BVAR (b
, cursor_type
), Qt
))
25030 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25031 *width
= FRAME_CURSOR_WIDTH (f
);
25034 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25036 /* Use cursor-in-non-selected-windows instead
25037 for non-selected window or frame. */
25040 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25041 if (!EQ (Qt
, alt_cursor
))
25042 return get_specified_cursor_type (alt_cursor
, width
);
25043 /* t means modify the normal cursor type. */
25044 if (cursor_type
== FILLED_BOX_CURSOR
)
25045 cursor_type
= HOLLOW_BOX_CURSOR
;
25046 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25048 return cursor_type
;
25051 /* Use normal cursor if not blinked off. */
25052 if (!w
->cursor_off_p
)
25054 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25056 if (cursor_type
== FILLED_BOX_CURSOR
)
25058 /* Using a block cursor on large images can be very annoying.
25059 So use a hollow cursor for "large" images.
25060 If image is not transparent (no mask), also use hollow cursor. */
25061 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25062 if (img
!= NULL
&& IMAGEP (img
->spec
))
25064 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25065 where N = size of default frame font size.
25066 This should cover most of the "tiny" icons people may use. */
25068 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25069 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25070 cursor_type
= HOLLOW_BOX_CURSOR
;
25073 else if (cursor_type
!= NO_CURSOR
)
25075 /* Display current only supports BOX and HOLLOW cursors for images.
25076 So for now, unconditionally use a HOLLOW cursor when cursor is
25077 not a solid box cursor. */
25078 cursor_type
= HOLLOW_BOX_CURSOR
;
25081 return cursor_type
;
25084 /* Cursor is blinked off, so determine how to "toggle" it. */
25086 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25087 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25088 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25090 /* Then see if frame has specified a specific blink off cursor type. */
25091 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25093 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25094 return FRAME_BLINK_OFF_CURSOR (f
);
25098 /* Some people liked having a permanently visible blinking cursor,
25099 while others had very strong opinions against it. So it was
25100 decided to remove it. KFS 2003-09-03 */
25102 /* Finally perform built-in cursor blinking:
25103 filled box <-> hollow box
25104 wide [h]bar <-> narrow [h]bar
25105 narrow [h]bar <-> no cursor
25106 other type <-> no cursor */
25108 if (cursor_type
== FILLED_BOX_CURSOR
)
25109 return HOLLOW_BOX_CURSOR
;
25111 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25114 return cursor_type
;
25122 /* Notice when the text cursor of window W has been completely
25123 overwritten by a drawing operation that outputs glyphs in AREA
25124 starting at X0 and ending at X1 in the line starting at Y0 and
25125 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25126 the rest of the line after X0 has been written. Y coordinates
25127 are window-relative. */
25130 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25131 int x0
, int x1
, int y0
, int y1
)
25133 int cx0
, cx1
, cy0
, cy1
;
25134 struct glyph_row
*row
;
25136 if (!w
->phys_cursor_on_p
)
25138 if (area
!= TEXT_AREA
)
25141 if (w
->phys_cursor
.vpos
< 0
25142 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25143 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25144 !(row
->enabled_p
&& row
->displays_text_p
)))
25147 if (row
->cursor_in_fringe_p
)
25149 row
->cursor_in_fringe_p
= 0;
25150 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25151 w
->phys_cursor_on_p
= 0;
25155 cx0
= w
->phys_cursor
.x
;
25156 cx1
= cx0
+ w
->phys_cursor_width
;
25157 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25160 /* The cursor image will be completely removed from the
25161 screen if the output area intersects the cursor area in
25162 y-direction. When we draw in [y0 y1[, and some part of
25163 the cursor is at y < y0, that part must have been drawn
25164 before. When scrolling, the cursor is erased before
25165 actually scrolling, so we don't come here. When not
25166 scrolling, the rows above the old cursor row must have
25167 changed, and in this case these rows must have written
25168 over the cursor image.
25170 Likewise if part of the cursor is below y1, with the
25171 exception of the cursor being in the first blank row at
25172 the buffer and window end because update_text_area
25173 doesn't draw that row. (Except when it does, but
25174 that's handled in update_text_area.) */
25176 cy0
= w
->phys_cursor
.y
;
25177 cy1
= cy0
+ w
->phys_cursor_height
;
25178 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25181 w
->phys_cursor_on_p
= 0;
25184 #endif /* HAVE_WINDOW_SYSTEM */
25187 /************************************************************************
25189 ************************************************************************/
25191 #ifdef HAVE_WINDOW_SYSTEM
25194 Fix the display of area AREA of overlapping row ROW in window W
25195 with respect to the overlapping part OVERLAPS. */
25198 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25199 enum glyph_row_area area
, int overlaps
)
25206 for (i
= 0; i
< row
->used
[area
];)
25208 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25210 int start
= i
, start_x
= x
;
25214 x
+= row
->glyphs
[area
][i
].pixel_width
;
25217 while (i
< row
->used
[area
]
25218 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25220 draw_glyphs (w
, start_x
, row
, area
,
25222 DRAW_NORMAL_TEXT
, overlaps
);
25226 x
+= row
->glyphs
[area
][i
].pixel_width
;
25236 Draw the cursor glyph of window W in glyph row ROW. See the
25237 comment of draw_glyphs for the meaning of HL. */
25240 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25241 enum draw_glyphs_face hl
)
25243 /* If cursor hpos is out of bounds, don't draw garbage. This can
25244 happen in mini-buffer windows when switching between echo area
25245 glyphs and mini-buffer. */
25246 if ((row
->reversed_p
25247 ? (w
->phys_cursor
.hpos
>= 0)
25248 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25250 int on_p
= w
->phys_cursor_on_p
;
25252 int hpos
= w
->phys_cursor
.hpos
;
25254 /* When the window is hscrolled, cursor hpos can legitimately be
25255 out of bounds, but we draw the cursor at the corresponding
25256 window margin in that case. */
25257 if (!row
->reversed_p
&& hpos
< 0)
25259 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25260 hpos
= row
->used
[TEXT_AREA
] - 1;
25262 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25264 w
->phys_cursor_on_p
= on_p
;
25266 if (hl
== DRAW_CURSOR
)
25267 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25268 /* When we erase the cursor, and ROW is overlapped by other
25269 rows, make sure that these overlapping parts of other rows
25271 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25273 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25275 if (row
> w
->current_matrix
->rows
25276 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25277 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25278 OVERLAPS_ERASED_CURSOR
);
25280 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25281 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25282 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25283 OVERLAPS_ERASED_CURSOR
);
25290 Erase the image of a cursor of window W from the screen. */
25293 erase_phys_cursor (struct window
*w
)
25295 struct frame
*f
= XFRAME (w
->frame
);
25296 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25297 int hpos
= w
->phys_cursor
.hpos
;
25298 int vpos
= w
->phys_cursor
.vpos
;
25299 int mouse_face_here_p
= 0;
25300 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25301 struct glyph_row
*cursor_row
;
25302 struct glyph
*cursor_glyph
;
25303 enum draw_glyphs_face hl
;
25305 /* No cursor displayed or row invalidated => nothing to do on the
25307 if (w
->phys_cursor_type
== NO_CURSOR
)
25308 goto mark_cursor_off
;
25310 /* VPOS >= active_glyphs->nrows means that window has been resized.
25311 Don't bother to erase the cursor. */
25312 if (vpos
>= active_glyphs
->nrows
)
25313 goto mark_cursor_off
;
25315 /* If row containing cursor is marked invalid, there is nothing we
25317 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25318 if (!cursor_row
->enabled_p
)
25319 goto mark_cursor_off
;
25321 /* If line spacing is > 0, old cursor may only be partially visible in
25322 window after split-window. So adjust visible height. */
25323 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25324 window_text_bottom_y (w
) - cursor_row
->y
);
25326 /* If row is completely invisible, don't attempt to delete a cursor which
25327 isn't there. This can happen if cursor is at top of a window, and
25328 we switch to a buffer with a header line in that window. */
25329 if (cursor_row
->visible_height
<= 0)
25330 goto mark_cursor_off
;
25332 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25333 if (cursor_row
->cursor_in_fringe_p
)
25335 cursor_row
->cursor_in_fringe_p
= 0;
25336 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25337 goto mark_cursor_off
;
25340 /* This can happen when the new row is shorter than the old one.
25341 In this case, either draw_glyphs or clear_end_of_line
25342 should have cleared the cursor. Note that we wouldn't be
25343 able to erase the cursor in this case because we don't have a
25344 cursor glyph at hand. */
25345 if ((cursor_row
->reversed_p
25346 ? (w
->phys_cursor
.hpos
< 0)
25347 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25348 goto mark_cursor_off
;
25350 /* When the window is hscrolled, cursor hpos can legitimately be out
25351 of bounds, but we draw the cursor at the corresponding window
25352 margin in that case. */
25353 if (!cursor_row
->reversed_p
&& hpos
< 0)
25355 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25356 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25358 /* If the cursor is in the mouse face area, redisplay that when
25359 we clear the cursor. */
25360 if (! NILP (hlinfo
->mouse_face_window
)
25361 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25362 /* Don't redraw the cursor's spot in mouse face if it is at the
25363 end of a line (on a newline). The cursor appears there, but
25364 mouse highlighting does not. */
25365 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25366 mouse_face_here_p
= 1;
25368 /* Maybe clear the display under the cursor. */
25369 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25372 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25375 cursor_glyph
= get_phys_cursor_glyph (w
);
25376 if (cursor_glyph
== NULL
)
25377 goto mark_cursor_off
;
25379 width
= cursor_glyph
->pixel_width
;
25380 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25381 x
= w
->phys_cursor
.x
;
25383 width
-= left_x
- x
;
25384 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25385 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25386 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25389 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25392 /* Erase the cursor by redrawing the character underneath it. */
25393 if (mouse_face_here_p
)
25394 hl
= DRAW_MOUSE_FACE
;
25396 hl
= DRAW_NORMAL_TEXT
;
25397 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25400 w
->phys_cursor_on_p
= 0;
25401 w
->phys_cursor_type
= NO_CURSOR
;
25406 Display or clear cursor of window W. If ON is zero, clear the
25407 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25408 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25411 display_and_set_cursor (struct window
*w
, int on
,
25412 int hpos
, int vpos
, int x
, int y
)
25414 struct frame
*f
= XFRAME (w
->frame
);
25415 int new_cursor_type
;
25416 int new_cursor_width
;
25418 struct glyph_row
*glyph_row
;
25419 struct glyph
*glyph
;
25421 /* This is pointless on invisible frames, and dangerous on garbaged
25422 windows and frames; in the latter case, the frame or window may
25423 be in the midst of changing its size, and x and y may be off the
25425 if (! FRAME_VISIBLE_P (f
)
25426 || FRAME_GARBAGED_P (f
)
25427 || vpos
>= w
->current_matrix
->nrows
25428 || hpos
>= w
->current_matrix
->matrix_w
)
25431 /* If cursor is off and we want it off, return quickly. */
25432 if (!on
&& !w
->phys_cursor_on_p
)
25435 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25436 /* If cursor row is not enabled, we don't really know where to
25437 display the cursor. */
25438 if (!glyph_row
->enabled_p
)
25440 w
->phys_cursor_on_p
= 0;
25445 if (!glyph_row
->exact_window_width_line_p
25446 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25447 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25449 xassert (interrupt_input_blocked
);
25451 /* Set new_cursor_type to the cursor we want to be displayed. */
25452 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25453 &new_cursor_width
, &active_cursor
);
25455 /* If cursor is currently being shown and we don't want it to be or
25456 it is in the wrong place, or the cursor type is not what we want,
25458 if (w
->phys_cursor_on_p
25460 || w
->phys_cursor
.x
!= x
25461 || w
->phys_cursor
.y
!= y
25462 || new_cursor_type
!= w
->phys_cursor_type
25463 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25464 && new_cursor_width
!= w
->phys_cursor_width
)))
25465 erase_phys_cursor (w
);
25467 /* Don't check phys_cursor_on_p here because that flag is only set
25468 to zero in some cases where we know that the cursor has been
25469 completely erased, to avoid the extra work of erasing the cursor
25470 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25471 still not be visible, or it has only been partly erased. */
25474 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25475 w
->phys_cursor_height
= glyph_row
->height
;
25477 /* Set phys_cursor_.* before x_draw_.* is called because some
25478 of them may need the information. */
25479 w
->phys_cursor
.x
= x
;
25480 w
->phys_cursor
.y
= glyph_row
->y
;
25481 w
->phys_cursor
.hpos
= hpos
;
25482 w
->phys_cursor
.vpos
= vpos
;
25485 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25486 new_cursor_type
, new_cursor_width
,
25487 on
, active_cursor
);
25491 /* Switch the display of W's cursor on or off, according to the value
25495 update_window_cursor (struct window
*w
, int on
)
25497 /* Don't update cursor in windows whose frame is in the process
25498 of being deleted. */
25499 if (w
->current_matrix
)
25501 int hpos
= w
->phys_cursor
.hpos
;
25502 int vpos
= w
->phys_cursor
.vpos
;
25503 struct glyph_row
*row
;
25505 if (vpos
>= w
->current_matrix
->nrows
25506 || hpos
>= w
->current_matrix
->matrix_w
)
25509 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25511 /* When the window is hscrolled, cursor hpos can legitimately be
25512 out of bounds, but we draw the cursor at the corresponding
25513 window margin in that case. */
25514 if (!row
->reversed_p
&& hpos
< 0)
25516 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25517 hpos
= row
->used
[TEXT_AREA
] - 1;
25520 display_and_set_cursor (w
, on
, hpos
, vpos
,
25521 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25527 /* Call update_window_cursor with parameter ON_P on all leaf windows
25528 in the window tree rooted at W. */
25531 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25535 if (!NILP (w
->hchild
))
25536 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25537 else if (!NILP (w
->vchild
))
25538 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25540 update_window_cursor (w
, on_p
);
25542 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25548 Display the cursor on window W, or clear it, according to ON_P.
25549 Don't change the cursor's position. */
25552 x_update_cursor (struct frame
*f
, int on_p
)
25554 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25559 Clear the cursor of window W to background color, and mark the
25560 cursor as not shown. This is used when the text where the cursor
25561 is about to be rewritten. */
25564 x_clear_cursor (struct window
*w
)
25566 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25567 update_window_cursor (w
, 0);
25570 #endif /* HAVE_WINDOW_SYSTEM */
25572 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25575 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25576 int start_hpos
, int end_hpos
,
25577 enum draw_glyphs_face draw
)
25579 #ifdef HAVE_WINDOW_SYSTEM
25580 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25582 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25586 #if defined (HAVE_GPM) || defined (MSDOS)
25587 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25591 /* Display the active region described by mouse_face_* according to DRAW. */
25594 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25596 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25597 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25599 if (/* If window is in the process of being destroyed, don't bother
25601 w
->current_matrix
!= NULL
25602 /* Don't update mouse highlight if hidden */
25603 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25604 /* Recognize when we are called to operate on rows that don't exist
25605 anymore. This can happen when a window is split. */
25606 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25608 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25609 struct glyph_row
*row
, *first
, *last
;
25611 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25612 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25614 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25616 int start_hpos
, end_hpos
, start_x
;
25618 /* For all but the first row, the highlight starts at column 0. */
25621 /* R2L rows have BEG and END in reversed order, but the
25622 screen drawing geometry is always left to right. So
25623 we need to mirror the beginning and end of the
25624 highlighted area in R2L rows. */
25625 if (!row
->reversed_p
)
25627 start_hpos
= hlinfo
->mouse_face_beg_col
;
25628 start_x
= hlinfo
->mouse_face_beg_x
;
25630 else if (row
== last
)
25632 start_hpos
= hlinfo
->mouse_face_end_col
;
25633 start_x
= hlinfo
->mouse_face_end_x
;
25641 else if (row
->reversed_p
&& row
== last
)
25643 start_hpos
= hlinfo
->mouse_face_end_col
;
25644 start_x
= hlinfo
->mouse_face_end_x
;
25654 if (!row
->reversed_p
)
25655 end_hpos
= hlinfo
->mouse_face_end_col
;
25656 else if (row
== first
)
25657 end_hpos
= hlinfo
->mouse_face_beg_col
;
25660 end_hpos
= row
->used
[TEXT_AREA
];
25661 if (draw
== DRAW_NORMAL_TEXT
)
25662 row
->fill_line_p
= 1; /* Clear to end of line */
25665 else if (row
->reversed_p
&& row
== first
)
25666 end_hpos
= hlinfo
->mouse_face_beg_col
;
25669 end_hpos
= row
->used
[TEXT_AREA
];
25670 if (draw
== DRAW_NORMAL_TEXT
)
25671 row
->fill_line_p
= 1; /* Clear to end of line */
25674 if (end_hpos
> start_hpos
)
25676 draw_row_with_mouse_face (w
, start_x
, row
,
25677 start_hpos
, end_hpos
, draw
);
25680 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25684 #ifdef HAVE_WINDOW_SYSTEM
25685 /* When we've written over the cursor, arrange for it to
25686 be displayed again. */
25687 if (FRAME_WINDOW_P (f
)
25688 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25690 int hpos
= w
->phys_cursor
.hpos
;
25692 /* When the window is hscrolled, cursor hpos can legitimately be
25693 out of bounds, but we draw the cursor at the corresponding
25694 window margin in that case. */
25695 if (!row
->reversed_p
&& hpos
< 0)
25697 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25698 hpos
= row
->used
[TEXT_AREA
] - 1;
25701 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
25702 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25705 #endif /* HAVE_WINDOW_SYSTEM */
25708 #ifdef HAVE_WINDOW_SYSTEM
25709 /* Change the mouse cursor. */
25710 if (FRAME_WINDOW_P (f
))
25712 if (draw
== DRAW_NORMAL_TEXT
25713 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25714 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25715 else if (draw
== DRAW_MOUSE_FACE
)
25716 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25718 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25720 #endif /* HAVE_WINDOW_SYSTEM */
25724 Clear out the mouse-highlighted active region.
25725 Redraw it un-highlighted first. Value is non-zero if mouse
25726 face was actually drawn unhighlighted. */
25729 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25733 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25735 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25739 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25740 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25741 hlinfo
->mouse_face_window
= Qnil
;
25742 hlinfo
->mouse_face_overlay
= Qnil
;
25746 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25747 within the mouse face on that window. */
25749 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25751 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25753 /* Quickly resolve the easy cases. */
25754 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25755 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25757 if (vpos
< hlinfo
->mouse_face_beg_row
25758 || vpos
> hlinfo
->mouse_face_end_row
)
25760 if (vpos
> hlinfo
->mouse_face_beg_row
25761 && vpos
< hlinfo
->mouse_face_end_row
)
25764 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25766 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25768 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25771 else if ((vpos
== hlinfo
->mouse_face_beg_row
25772 && hpos
>= hlinfo
->mouse_face_beg_col
)
25773 || (vpos
== hlinfo
->mouse_face_end_row
25774 && hpos
< hlinfo
->mouse_face_end_col
))
25779 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25781 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25784 else if ((vpos
== hlinfo
->mouse_face_beg_row
25785 && hpos
<= hlinfo
->mouse_face_beg_col
)
25786 || (vpos
== hlinfo
->mouse_face_end_row
25787 && hpos
> hlinfo
->mouse_face_end_col
))
25795 Non-zero if physical cursor of window W is within mouse face. */
25798 cursor_in_mouse_face_p (struct window
*w
)
25800 int hpos
= w
->phys_cursor
.hpos
;
25801 int vpos
= w
->phys_cursor
.vpos
;
25802 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25804 /* When the window is hscrolled, cursor hpos can legitimately be out
25805 of bounds, but we draw the cursor at the corresponding window
25806 margin in that case. */
25807 if (!row
->reversed_p
&& hpos
< 0)
25809 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25810 hpos
= row
->used
[TEXT_AREA
] - 1;
25812 return coords_in_mouse_face_p (w
, hpos
, vpos
);
25817 /* Find the glyph rows START_ROW and END_ROW of window W that display
25818 characters between buffer positions START_CHARPOS and END_CHARPOS
25819 (excluding END_CHARPOS). This is similar to row_containing_pos,
25820 but is more accurate when bidi reordering makes buffer positions
25821 change non-linearly with glyph rows. */
25823 rows_from_pos_range (struct window
*w
,
25824 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25825 struct glyph_row
**start
, struct glyph_row
**end
)
25827 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25828 int last_y
= window_text_bottom_y (w
);
25829 struct glyph_row
*row
;
25834 while (!first
->enabled_p
25835 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25838 /* Find the START row. */
25840 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25843 /* A row can potentially be the START row if the range of the
25844 characters it displays intersects the range
25845 [START_CHARPOS..END_CHARPOS). */
25846 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25847 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25848 /* See the commentary in row_containing_pos, for the
25849 explanation of the complicated way to check whether
25850 some position is beyond the end of the characters
25851 displayed by a row. */
25852 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25853 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25854 && !row
->ends_at_zv_p
25855 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25856 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25857 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25858 && !row
->ends_at_zv_p
25859 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25861 /* Found a candidate row. Now make sure at least one of the
25862 glyphs it displays has a charpos from the range
25863 [START_CHARPOS..END_CHARPOS).
25865 This is not obvious because bidi reordering could make
25866 buffer positions of a row be 1,2,3,102,101,100, and if we
25867 want to highlight characters in [50..60), we don't want
25868 this row, even though [50..60) does intersect [1..103),
25869 the range of character positions given by the row's start
25870 and end positions. */
25871 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25872 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25876 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25877 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25886 /* Find the END row. */
25888 /* If the last row is partially visible, start looking for END
25889 from that row, instead of starting from FIRST. */
25890 && !(row
->enabled_p
25891 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25893 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25895 struct glyph_row
*next
= row
+ 1;
25897 if (!next
->enabled_p
25898 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25899 /* The first row >= START whose range of displayed characters
25900 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25901 is the row END + 1. */
25902 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25903 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25904 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25905 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25906 && !next
->ends_at_zv_p
25907 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25908 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25909 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25910 && !next
->ends_at_zv_p
25911 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25918 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25919 but none of the characters it displays are in the range, it is
25921 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25922 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25926 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25927 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25940 /* This function sets the mouse_face_* elements of HLINFO, assuming
25941 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25942 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25943 for the overlay or run of text properties specifying the mouse
25944 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25945 before-string and after-string that must also be highlighted.
25946 DISP_STRING, if non-nil, is a display string that may cover some
25947 or all of the highlighted text. */
25950 mouse_face_from_buffer_pos (Lisp_Object window
,
25951 Mouse_HLInfo
*hlinfo
,
25952 EMACS_INT mouse_charpos
,
25953 EMACS_INT start_charpos
,
25954 EMACS_INT end_charpos
,
25955 Lisp_Object before_string
,
25956 Lisp_Object after_string
,
25957 Lisp_Object disp_string
)
25959 struct window
*w
= XWINDOW (window
);
25960 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25961 struct glyph_row
*r1
, *r2
;
25962 struct glyph
*glyph
, *end
;
25963 EMACS_INT ignore
, pos
;
25966 xassert (NILP (disp_string
) || STRINGP (disp_string
));
25967 xassert (NILP (before_string
) || STRINGP (before_string
));
25968 xassert (NILP (after_string
) || STRINGP (after_string
));
25970 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25971 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25973 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25974 /* If the before-string or display-string contains newlines,
25975 rows_from_pos_range skips to its last row. Move back. */
25976 if (!NILP (before_string
) || !NILP (disp_string
))
25978 struct glyph_row
*prev
;
25979 while ((prev
= r1
- 1, prev
>= first
)
25980 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25981 && prev
->used
[TEXT_AREA
] > 0)
25983 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25984 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25985 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25987 || !(EQ (glyph
->object
, before_string
)
25988 || EQ (glyph
->object
, disp_string
)))
25995 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25996 hlinfo
->mouse_face_past_end
= 1;
25998 else if (!NILP (after_string
))
26000 /* If the after-string has newlines, advance to its last row. */
26001 struct glyph_row
*next
;
26002 struct glyph_row
*last
26003 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26005 for (next
= r2
+ 1;
26007 && next
->used
[TEXT_AREA
] > 0
26008 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26012 /* The rest of the display engine assumes that mouse_face_beg_row is
26013 either above mouse_face_end_row or identical to it. But with
26014 bidi-reordered continued lines, the row for START_CHARPOS could
26015 be below the row for END_CHARPOS. If so, swap the rows and store
26016 them in correct order. */
26019 struct glyph_row
*tem
= r2
;
26025 hlinfo
->mouse_face_beg_y
= r1
->y
;
26026 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26027 hlinfo
->mouse_face_end_y
= r2
->y
;
26028 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26030 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26031 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26032 could be anywhere in the row and in any order. The strategy
26033 below is to find the leftmost and the rightmost glyph that
26034 belongs to either of these 3 strings, or whose position is
26035 between START_CHARPOS and END_CHARPOS, and highlight all the
26036 glyphs between those two. This may cover more than just the text
26037 between START_CHARPOS and END_CHARPOS if the range of characters
26038 strides the bidi level boundary, e.g. if the beginning is in R2L
26039 text while the end is in L2R text or vice versa. */
26040 if (!r1
->reversed_p
)
26042 /* This row is in a left to right paragraph. Scan it left to
26044 glyph
= r1
->glyphs
[TEXT_AREA
];
26045 end
= glyph
+ r1
->used
[TEXT_AREA
];
26048 /* Skip truncation glyphs at the start of the glyph row. */
26049 if (r1
->displays_text_p
)
26051 && INTEGERP (glyph
->object
)
26052 && glyph
->charpos
< 0;
26054 x
+= glyph
->pixel_width
;
26056 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26057 or DISP_STRING, and the first glyph from buffer whose
26058 position is between START_CHARPOS and END_CHARPOS. */
26060 && !INTEGERP (glyph
->object
)
26061 && !EQ (glyph
->object
, disp_string
)
26062 && !(BUFFERP (glyph
->object
)
26063 && (glyph
->charpos
>= start_charpos
26064 && glyph
->charpos
< end_charpos
));
26067 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26068 are present at buffer positions between START_CHARPOS and
26069 END_CHARPOS, or if they come from an overlay. */
26070 if (EQ (glyph
->object
, before_string
))
26072 pos
= string_buffer_position (before_string
,
26074 /* If pos == 0, it means before_string came from an
26075 overlay, not from a buffer position. */
26076 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26079 else if (EQ (glyph
->object
, after_string
))
26081 pos
= string_buffer_position (after_string
, end_charpos
);
26082 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26085 x
+= glyph
->pixel_width
;
26087 hlinfo
->mouse_face_beg_x
= x
;
26088 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26092 /* This row is in a right to left paragraph. Scan it right to
26096 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26097 glyph
= end
+ r1
->used
[TEXT_AREA
];
26099 /* Skip truncation glyphs at the start of the glyph row. */
26100 if (r1
->displays_text_p
)
26102 && INTEGERP (glyph
->object
)
26103 && glyph
->charpos
< 0;
26107 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26108 or DISP_STRING, and the first glyph from buffer whose
26109 position is between START_CHARPOS and END_CHARPOS. */
26111 && !INTEGERP (glyph
->object
)
26112 && !EQ (glyph
->object
, disp_string
)
26113 && !(BUFFERP (glyph
->object
)
26114 && (glyph
->charpos
>= start_charpos
26115 && glyph
->charpos
< end_charpos
));
26118 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26119 are present at buffer positions between START_CHARPOS and
26120 END_CHARPOS, or if they come from an overlay. */
26121 if (EQ (glyph
->object
, before_string
))
26123 pos
= string_buffer_position (before_string
, start_charpos
);
26124 /* If pos == 0, it means before_string came from an
26125 overlay, not from a buffer position. */
26126 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26129 else if (EQ (glyph
->object
, after_string
))
26131 pos
= string_buffer_position (after_string
, end_charpos
);
26132 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26137 glyph
++; /* first glyph to the right of the highlighted area */
26138 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26139 x
+= g
->pixel_width
;
26140 hlinfo
->mouse_face_beg_x
= x
;
26141 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26144 /* If the highlight ends in a different row, compute GLYPH and END
26145 for the end row. Otherwise, reuse the values computed above for
26146 the row where the highlight begins. */
26149 if (!r2
->reversed_p
)
26151 glyph
= r2
->glyphs
[TEXT_AREA
];
26152 end
= glyph
+ r2
->used
[TEXT_AREA
];
26157 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26158 glyph
= end
+ r2
->used
[TEXT_AREA
];
26162 if (!r2
->reversed_p
)
26164 /* Skip truncation and continuation glyphs near the end of the
26165 row, and also blanks and stretch glyphs inserted by
26166 extend_face_to_end_of_line. */
26168 && INTEGERP ((end
- 1)->object
))
26170 /* Scan the rest of the glyph row from the end, looking for the
26171 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26172 DISP_STRING, or whose position is between START_CHARPOS
26176 && !INTEGERP (end
->object
)
26177 && !EQ (end
->object
, disp_string
)
26178 && !(BUFFERP (end
->object
)
26179 && (end
->charpos
>= start_charpos
26180 && end
->charpos
< end_charpos
));
26183 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26184 are present at buffer positions between START_CHARPOS and
26185 END_CHARPOS, or if they come from an overlay. */
26186 if (EQ (end
->object
, before_string
))
26188 pos
= string_buffer_position (before_string
, start_charpos
);
26189 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26192 else if (EQ (end
->object
, after_string
))
26194 pos
= string_buffer_position (after_string
, end_charpos
);
26195 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26199 /* Find the X coordinate of the last glyph to be highlighted. */
26200 for (; glyph
<= end
; ++glyph
)
26201 x
+= glyph
->pixel_width
;
26203 hlinfo
->mouse_face_end_x
= x
;
26204 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26208 /* Skip truncation and continuation glyphs near the end of the
26209 row, and also blanks and stretch glyphs inserted by
26210 extend_face_to_end_of_line. */
26214 && INTEGERP (end
->object
))
26216 x
+= end
->pixel_width
;
26219 /* Scan the rest of the glyph row from the end, looking for the
26220 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26221 DISP_STRING, or whose position is between START_CHARPOS
26225 && !INTEGERP (end
->object
)
26226 && !EQ (end
->object
, disp_string
)
26227 && !(BUFFERP (end
->object
)
26228 && (end
->charpos
>= start_charpos
26229 && end
->charpos
< end_charpos
));
26232 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26233 are present at buffer positions between START_CHARPOS and
26234 END_CHARPOS, or if they come from an overlay. */
26235 if (EQ (end
->object
, before_string
))
26237 pos
= string_buffer_position (before_string
, start_charpos
);
26238 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26241 else if (EQ (end
->object
, after_string
))
26243 pos
= string_buffer_position (after_string
, end_charpos
);
26244 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26247 x
+= end
->pixel_width
;
26249 hlinfo
->mouse_face_end_x
= x
;
26250 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26253 hlinfo
->mouse_face_window
= window
;
26254 hlinfo
->mouse_face_face_id
26255 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26257 !hlinfo
->mouse_face_hidden
, -1);
26258 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26261 /* The following function is not used anymore (replaced with
26262 mouse_face_from_string_pos), but I leave it here for the time
26263 being, in case someone would. */
26265 #if 0 /* not used */
26267 /* Find the position of the glyph for position POS in OBJECT in
26268 window W's current matrix, and return in *X, *Y the pixel
26269 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26271 RIGHT_P non-zero means return the position of the right edge of the
26272 glyph, RIGHT_P zero means return the left edge position.
26274 If no glyph for POS exists in the matrix, return the position of
26275 the glyph with the next smaller position that is in the matrix, if
26276 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26277 exists in the matrix, return the position of the glyph with the
26278 next larger position in OBJECT.
26280 Value is non-zero if a glyph was found. */
26283 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26284 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26286 int yb
= window_text_bottom_y (w
);
26287 struct glyph_row
*r
;
26288 struct glyph
*best_glyph
= NULL
;
26289 struct glyph_row
*best_row
= NULL
;
26292 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26293 r
->enabled_p
&& r
->y
< yb
;
26296 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26297 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26300 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26301 if (EQ (g
->object
, object
))
26303 if (g
->charpos
== pos
)
26310 else if (best_glyph
== NULL
26311 || ((eabs (g
->charpos
- pos
)
26312 < eabs (best_glyph
->charpos
- pos
))
26315 : g
->charpos
> pos
)))
26329 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26333 *x
+= best_glyph
->pixel_width
;
26338 *vpos
= best_row
- w
->current_matrix
->rows
;
26341 return best_glyph
!= NULL
;
26343 #endif /* not used */
26345 /* Find the positions of the first and the last glyphs in window W's
26346 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26347 (assumed to be a string), and return in HLINFO's mouse_face_*
26348 members the pixel and column/row coordinates of those glyphs. */
26351 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26352 Lisp_Object object
,
26353 EMACS_INT startpos
, EMACS_INT endpos
)
26355 int yb
= window_text_bottom_y (w
);
26356 struct glyph_row
*r
;
26357 struct glyph
*g
, *e
;
26361 /* Find the glyph row with at least one position in the range
26362 [STARTPOS..ENDPOS], and the first glyph in that row whose
26363 position belongs to that range. */
26364 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26365 r
->enabled_p
&& r
->y
< yb
;
26368 if (!r
->reversed_p
)
26370 g
= r
->glyphs
[TEXT_AREA
];
26371 e
= g
+ r
->used
[TEXT_AREA
];
26372 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26373 if (EQ (g
->object
, object
)
26374 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26376 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26377 hlinfo
->mouse_face_beg_y
= r
->y
;
26378 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26379 hlinfo
->mouse_face_beg_x
= gx
;
26388 e
= r
->glyphs
[TEXT_AREA
];
26389 g
= e
+ r
->used
[TEXT_AREA
];
26390 for ( ; g
> e
; --g
)
26391 if (EQ ((g
-1)->object
, object
)
26392 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26394 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26395 hlinfo
->mouse_face_beg_y
= r
->y
;
26396 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26397 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26398 gx
+= g1
->pixel_width
;
26399 hlinfo
->mouse_face_beg_x
= gx
;
26411 /* Starting with the next row, look for the first row which does NOT
26412 include any glyphs whose positions are in the range. */
26413 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26415 g
= r
->glyphs
[TEXT_AREA
];
26416 e
= g
+ r
->used
[TEXT_AREA
];
26418 for ( ; g
< e
; ++g
)
26419 if (EQ (g
->object
, object
)
26420 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26429 /* The highlighted region ends on the previous row. */
26432 /* Set the end row and its vertical pixel coordinate. */
26433 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26434 hlinfo
->mouse_face_end_y
= r
->y
;
26436 /* Compute and set the end column and the end column's horizontal
26437 pixel coordinate. */
26438 if (!r
->reversed_p
)
26440 g
= r
->glyphs
[TEXT_AREA
];
26441 e
= g
+ r
->used
[TEXT_AREA
];
26442 for ( ; e
> g
; --e
)
26443 if (EQ ((e
-1)->object
, object
)
26444 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26446 hlinfo
->mouse_face_end_col
= e
- g
;
26448 for (gx
= r
->x
; g
< e
; ++g
)
26449 gx
+= g
->pixel_width
;
26450 hlinfo
->mouse_face_end_x
= gx
;
26454 e
= r
->glyphs
[TEXT_AREA
];
26455 g
= e
+ r
->used
[TEXT_AREA
];
26456 for (gx
= r
->x
; e
< g
; ++e
)
26458 if (EQ (e
->object
, object
)
26459 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26461 gx
+= e
->pixel_width
;
26463 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26464 hlinfo
->mouse_face_end_x
= gx
;
26468 #ifdef HAVE_WINDOW_SYSTEM
26470 /* See if position X, Y is within a hot-spot of an image. */
26473 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26475 if (!CONSP (hot_spot
))
26478 if (EQ (XCAR (hot_spot
), Qrect
))
26480 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26481 Lisp_Object rect
= XCDR (hot_spot
);
26485 if (!CONSP (XCAR (rect
)))
26487 if (!CONSP (XCDR (rect
)))
26489 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26491 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26493 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26495 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26499 else if (EQ (XCAR (hot_spot
), Qcircle
))
26501 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26502 Lisp_Object circ
= XCDR (hot_spot
);
26503 Lisp_Object lr
, lx0
, ly0
;
26505 && CONSP (XCAR (circ
))
26506 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26507 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26508 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26510 double r
= XFLOATINT (lr
);
26511 double dx
= XINT (lx0
) - x
;
26512 double dy
= XINT (ly0
) - y
;
26513 return (dx
* dx
+ dy
* dy
<= r
* r
);
26516 else if (EQ (XCAR (hot_spot
), Qpoly
))
26518 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26519 if (VECTORP (XCDR (hot_spot
)))
26521 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26522 Lisp_Object
*poly
= v
->contents
;
26523 int n
= v
->header
.size
;
26526 Lisp_Object lx
, ly
;
26529 /* Need an even number of coordinates, and at least 3 edges. */
26530 if (n
< 6 || n
& 1)
26533 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26534 If count is odd, we are inside polygon. Pixels on edges
26535 may or may not be included depending on actual geometry of the
26537 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26538 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26540 x0
= XINT (lx
), y0
= XINT (ly
);
26541 for (i
= 0; i
< n
; i
+= 2)
26543 int x1
= x0
, y1
= y0
;
26544 if ((lx
= poly
[i
], !INTEGERP (lx
))
26545 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26547 x0
= XINT (lx
), y0
= XINT (ly
);
26549 /* Does this segment cross the X line? */
26557 if (y
> y0
&& y
> y1
)
26559 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26569 find_hot_spot (Lisp_Object map
, int x
, int y
)
26571 while (CONSP (map
))
26573 if (CONSP (XCAR (map
))
26574 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26582 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26584 doc
: /* Lookup in image map MAP coordinates X and Y.
26585 An image map is an alist where each element has the format (AREA ID PLIST).
26586 An AREA is specified as either a rectangle, a circle, or a polygon:
26587 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26588 pixel coordinates of the upper left and bottom right corners.
26589 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26590 and the radius of the circle; r may be a float or integer.
26591 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26592 vector describes one corner in the polygon.
26593 Returns the alist element for the first matching AREA in MAP. */)
26594 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26602 return find_hot_spot (map
, XINT (x
), XINT (y
));
26606 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26608 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26610 /* Do not change cursor shape while dragging mouse. */
26611 if (!NILP (do_mouse_tracking
))
26614 if (!NILP (pointer
))
26616 if (EQ (pointer
, Qarrow
))
26617 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26618 else if (EQ (pointer
, Qhand
))
26619 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26620 else if (EQ (pointer
, Qtext
))
26621 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26622 else if (EQ (pointer
, intern ("hdrag")))
26623 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26624 #ifdef HAVE_X_WINDOWS
26625 else if (EQ (pointer
, intern ("vdrag")))
26626 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26628 else if (EQ (pointer
, intern ("hourglass")))
26629 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26630 else if (EQ (pointer
, Qmodeline
))
26631 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26633 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26636 if (cursor
!= No_Cursor
)
26637 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26640 #endif /* HAVE_WINDOW_SYSTEM */
26642 /* Take proper action when mouse has moved to the mode or header line
26643 or marginal area AREA of window W, x-position X and y-position Y.
26644 X is relative to the start of the text display area of W, so the
26645 width of bitmap areas and scroll bars must be subtracted to get a
26646 position relative to the start of the mode line. */
26649 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26650 enum window_part area
)
26652 struct window
*w
= XWINDOW (window
);
26653 struct frame
*f
= XFRAME (w
->frame
);
26654 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26655 #ifdef HAVE_WINDOW_SYSTEM
26656 Display_Info
*dpyinfo
;
26658 Cursor cursor
= No_Cursor
;
26659 Lisp_Object pointer
= Qnil
;
26660 int dx
, dy
, width
, height
;
26662 Lisp_Object string
, object
= Qnil
;
26663 Lisp_Object pos
, help
;
26665 Lisp_Object mouse_face
;
26666 int original_x_pixel
= x
;
26667 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26668 struct glyph_row
*row
;
26670 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26675 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26676 returns them in row/column units! */
26677 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26678 &object
, &dx
, &dy
, &width
, &height
);
26680 row
= (area
== ON_MODE_LINE
26681 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26682 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26684 /* Find the glyph under the mouse pointer. */
26685 if (row
->mode_line_p
&& row
->enabled_p
)
26687 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26688 end
= glyph
+ row
->used
[TEXT_AREA
];
26690 for (x0
= original_x_pixel
;
26691 glyph
< end
&& x0
>= glyph
->pixel_width
;
26693 x0
-= glyph
->pixel_width
;
26701 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26702 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26703 returns them in row/column units! */
26704 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26705 &object
, &dx
, &dy
, &width
, &height
);
26710 #ifdef HAVE_WINDOW_SYSTEM
26711 if (IMAGEP (object
))
26713 Lisp_Object image_map
, hotspot
;
26714 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26716 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26718 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26722 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26723 If so, we could look for mouse-enter, mouse-leave
26724 properties in PLIST (and do something...). */
26725 hotspot
= XCDR (hotspot
);
26726 if (CONSP (hotspot
)
26727 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26729 pointer
= Fplist_get (plist
, Qpointer
);
26730 if (NILP (pointer
))
26732 help
= Fplist_get (plist
, Qhelp_echo
);
26735 help_echo_string
= help
;
26736 /* Is this correct? ++kfs */
26737 XSETWINDOW (help_echo_window
, w
);
26738 help_echo_object
= w
->buffer
;
26739 help_echo_pos
= charpos
;
26743 if (NILP (pointer
))
26744 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26746 #endif /* HAVE_WINDOW_SYSTEM */
26748 if (STRINGP (string
))
26750 pos
= make_number (charpos
);
26751 /* If we're on a string with `help-echo' text property, arrange
26752 for the help to be displayed. This is done by setting the
26753 global variable help_echo_string to the help string. */
26756 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26759 help_echo_string
= help
;
26760 XSETWINDOW (help_echo_window
, w
);
26761 help_echo_object
= string
;
26762 help_echo_pos
= charpos
;
26766 #ifdef HAVE_WINDOW_SYSTEM
26767 if (FRAME_WINDOW_P (f
))
26769 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26770 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26771 if (NILP (pointer
))
26772 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26774 /* Change the mouse pointer according to what is under X/Y. */
26776 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26779 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26780 if (!KEYMAPP (map
))
26781 map
= Fget_text_property (pos
, Qkeymap
, string
);
26782 if (!KEYMAPP (map
))
26783 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26788 /* Change the mouse face according to what is under X/Y. */
26789 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26790 if (!NILP (mouse_face
)
26791 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26796 struct glyph
* tmp_glyph
;
26800 int total_pixel_width
;
26801 EMACS_INT begpos
, endpos
, ignore
;
26805 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26806 Qmouse_face
, string
, Qnil
);
26812 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26814 endpos
= SCHARS (string
);
26818 /* Calculate the glyph position GPOS of GLYPH in the
26819 displayed string, relative to the beginning of the
26820 highlighted part of the string.
26822 Note: GPOS is different from CHARPOS. CHARPOS is the
26823 position of GLYPH in the internal string object. A mode
26824 line string format has structures which are converted to
26825 a flattened string by the Emacs Lisp interpreter. The
26826 internal string is an element of those structures. The
26827 displayed string is the flattened string. */
26828 tmp_glyph
= row_start_glyph
;
26829 while (tmp_glyph
< glyph
26830 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26831 && begpos
<= tmp_glyph
->charpos
26832 && tmp_glyph
->charpos
< endpos
)))
26834 gpos
= glyph
- tmp_glyph
;
26836 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26837 the highlighted part of the displayed string to which
26838 GLYPH belongs. Note: GSEQ_LENGTH is different from
26839 SCHARS (STRING), because the latter returns the length of
26840 the internal string. */
26841 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26843 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26844 && begpos
<= tmp_glyph
->charpos
26845 && tmp_glyph
->charpos
< endpos
));
26848 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26850 /* Calculate the total pixel width of all the glyphs between
26851 the beginning of the highlighted area and GLYPH. */
26852 total_pixel_width
= 0;
26853 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26854 total_pixel_width
+= tmp_glyph
->pixel_width
;
26856 /* Pre calculation of re-rendering position. Note: X is in
26857 column units here, after the call to mode_line_string or
26858 marginal_area_string. */
26860 vpos
= (area
== ON_MODE_LINE
26861 ? (w
->current_matrix
)->nrows
- 1
26864 /* If GLYPH's position is included in the region that is
26865 already drawn in mouse face, we have nothing to do. */
26866 if ( EQ (window
, hlinfo
->mouse_face_window
)
26867 && (!row
->reversed_p
26868 ? (hlinfo
->mouse_face_beg_col
<= hpos
26869 && hpos
< hlinfo
->mouse_face_end_col
)
26870 /* In R2L rows we swap BEG and END, see below. */
26871 : (hlinfo
->mouse_face_end_col
<= hpos
26872 && hpos
< hlinfo
->mouse_face_beg_col
))
26873 && hlinfo
->mouse_face_beg_row
== vpos
)
26876 if (clear_mouse_face (hlinfo
))
26877 cursor
= No_Cursor
;
26879 if (!row
->reversed_p
)
26881 hlinfo
->mouse_face_beg_col
= hpos
;
26882 hlinfo
->mouse_face_beg_x
= original_x_pixel
26883 - (total_pixel_width
+ dx
);
26884 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26885 hlinfo
->mouse_face_end_x
= 0;
26889 /* In R2L rows, show_mouse_face expects BEG and END
26890 coordinates to be swapped. */
26891 hlinfo
->mouse_face_end_col
= hpos
;
26892 hlinfo
->mouse_face_end_x
= original_x_pixel
26893 - (total_pixel_width
+ dx
);
26894 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26895 hlinfo
->mouse_face_beg_x
= 0;
26898 hlinfo
->mouse_face_beg_row
= vpos
;
26899 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26900 hlinfo
->mouse_face_beg_y
= 0;
26901 hlinfo
->mouse_face_end_y
= 0;
26902 hlinfo
->mouse_face_past_end
= 0;
26903 hlinfo
->mouse_face_window
= window
;
26905 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26911 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26913 if (NILP (pointer
))
26916 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26917 clear_mouse_face (hlinfo
);
26919 #ifdef HAVE_WINDOW_SYSTEM
26920 if (FRAME_WINDOW_P (f
))
26921 define_frame_cursor1 (f
, cursor
, pointer
);
26927 Take proper action when the mouse has moved to position X, Y on
26928 frame F as regards highlighting characters that have mouse-face
26929 properties. Also de-highlighting chars where the mouse was before.
26930 X and Y can be negative or out of range. */
26933 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26935 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26936 enum window_part part
= ON_NOTHING
;
26937 Lisp_Object window
;
26939 Cursor cursor
= No_Cursor
;
26940 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26943 /* When a menu is active, don't highlight because this looks odd. */
26944 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26945 if (popup_activated ())
26949 if (NILP (Vmouse_highlight
)
26950 || !f
->glyphs_initialized_p
26951 || f
->pointer_invisible
)
26954 hlinfo
->mouse_face_mouse_x
= x
;
26955 hlinfo
->mouse_face_mouse_y
= y
;
26956 hlinfo
->mouse_face_mouse_frame
= f
;
26958 if (hlinfo
->mouse_face_defer
)
26961 if (gc_in_progress
)
26963 hlinfo
->mouse_face_deferred_gc
= 1;
26967 /* Which window is that in? */
26968 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26970 /* If displaying active text in another window, clear that. */
26971 if (! EQ (window
, hlinfo
->mouse_face_window
)
26972 /* Also clear if we move out of text area in same window. */
26973 || (!NILP (hlinfo
->mouse_face_window
)
26976 && part
!= ON_MODE_LINE
26977 && part
!= ON_HEADER_LINE
))
26978 clear_mouse_face (hlinfo
);
26980 /* Not on a window -> return. */
26981 if (!WINDOWP (window
))
26984 /* Reset help_echo_string. It will get recomputed below. */
26985 help_echo_string
= Qnil
;
26987 /* Convert to window-relative pixel coordinates. */
26988 w
= XWINDOW (window
);
26989 frame_to_window_pixel_xy (w
, &x
, &y
);
26991 #ifdef HAVE_WINDOW_SYSTEM
26992 /* Handle tool-bar window differently since it doesn't display a
26994 if (EQ (window
, f
->tool_bar_window
))
26996 note_tool_bar_highlight (f
, x
, y
);
27001 /* Mouse is on the mode, header line or margin? */
27002 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27003 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27005 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27009 #ifdef HAVE_WINDOW_SYSTEM
27010 if (part
== ON_VERTICAL_BORDER
)
27012 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27013 help_echo_string
= build_string ("drag-mouse-1: resize");
27015 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27016 || part
== ON_SCROLL_BAR
)
27017 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27019 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27022 /* Are we in a window whose display is up to date?
27023 And verify the buffer's text has not changed. */
27024 b
= XBUFFER (w
->buffer
);
27025 if (part
== ON_TEXT
27026 && EQ (w
->window_end_valid
, w
->buffer
)
27027 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27028 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27030 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27032 struct glyph
*glyph
;
27033 Lisp_Object object
;
27034 Lisp_Object mouse_face
= Qnil
, position
;
27035 Lisp_Object
*overlay_vec
= NULL
;
27036 ptrdiff_t i
, noverlays
;
27037 struct buffer
*obuf
;
27038 EMACS_INT obegv
, ozv
;
27041 /* Find the glyph under X/Y. */
27042 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27044 #ifdef HAVE_WINDOW_SYSTEM
27045 /* Look for :pointer property on image. */
27046 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27048 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27049 if (img
!= NULL
&& IMAGEP (img
->spec
))
27051 Lisp_Object image_map
, hotspot
;
27052 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27054 && (hotspot
= find_hot_spot (image_map
,
27055 glyph
->slice
.img
.x
+ dx
,
27056 glyph
->slice
.img
.y
+ dy
),
27058 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27062 /* Could check XCAR (hotspot) to see if we enter/leave
27064 If so, we could look for mouse-enter, mouse-leave
27065 properties in PLIST (and do something...). */
27066 hotspot
= XCDR (hotspot
);
27067 if (CONSP (hotspot
)
27068 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27070 pointer
= Fplist_get (plist
, Qpointer
);
27071 if (NILP (pointer
))
27073 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27074 if (!NILP (help_echo_string
))
27076 help_echo_window
= window
;
27077 help_echo_object
= glyph
->object
;
27078 help_echo_pos
= glyph
->charpos
;
27082 if (NILP (pointer
))
27083 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27086 #endif /* HAVE_WINDOW_SYSTEM */
27088 /* Clear mouse face if X/Y not over text. */
27090 || area
!= TEXT_AREA
27091 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27092 /* Glyph's OBJECT is an integer for glyphs inserted by the
27093 display engine for its internal purposes, like truncation
27094 and continuation glyphs and blanks beyond the end of
27095 line's text on text terminals. If we are over such a
27096 glyph, we are not over any text. */
27097 || INTEGERP (glyph
->object
)
27098 /* R2L rows have a stretch glyph at their front, which
27099 stands for no text, whereas L2R rows have no glyphs at
27100 all beyond the end of text. Treat such stretch glyphs
27101 like we do with NULL glyphs in L2R rows. */
27102 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27103 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27104 && glyph
->type
== STRETCH_GLYPH
27105 && glyph
->avoid_cursor_p
))
27107 if (clear_mouse_face (hlinfo
))
27108 cursor
= No_Cursor
;
27109 #ifdef HAVE_WINDOW_SYSTEM
27110 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27112 if (area
!= TEXT_AREA
)
27113 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27115 pointer
= Vvoid_text_area_pointer
;
27121 pos
= glyph
->charpos
;
27122 object
= glyph
->object
;
27123 if (!STRINGP (object
) && !BUFFERP (object
))
27126 /* If we get an out-of-range value, return now; avoid an error. */
27127 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27130 /* Make the window's buffer temporarily current for
27131 overlays_at and compute_char_face. */
27132 obuf
= current_buffer
;
27133 current_buffer
= b
;
27139 /* Is this char mouse-active or does it have help-echo? */
27140 position
= make_number (pos
);
27142 if (BUFFERP (object
))
27144 /* Put all the overlays we want in a vector in overlay_vec. */
27145 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27146 /* Sort overlays into increasing priority order. */
27147 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27152 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27155 cursor
= No_Cursor
;
27157 /* Check mouse-face highlighting. */
27159 /* If there exists an overlay with mouse-face overlapping
27160 the one we are currently highlighting, we have to
27161 check if we enter the overlapping overlay, and then
27162 highlight only that. */
27163 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27164 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27166 /* Find the highest priority overlay with a mouse-face. */
27167 Lisp_Object overlay
= Qnil
;
27168 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27170 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27171 if (!NILP (mouse_face
))
27172 overlay
= overlay_vec
[i
];
27175 /* If we're highlighting the same overlay as before, there's
27176 no need to do that again. */
27177 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27178 goto check_help_echo
;
27179 hlinfo
->mouse_face_overlay
= overlay
;
27181 /* Clear the display of the old active region, if any. */
27182 if (clear_mouse_face (hlinfo
))
27183 cursor
= No_Cursor
;
27185 /* If no overlay applies, get a text property. */
27186 if (NILP (overlay
))
27187 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27189 /* Next, compute the bounds of the mouse highlighting and
27191 if (!NILP (mouse_face
) && STRINGP (object
))
27193 /* The mouse-highlighting comes from a display string
27194 with a mouse-face. */
27198 s
= Fprevious_single_property_change
27199 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27200 e
= Fnext_single_property_change
27201 (position
, Qmouse_face
, object
, Qnil
);
27203 s
= make_number (0);
27205 e
= make_number (SCHARS (object
) - 1);
27206 mouse_face_from_string_pos (w
, hlinfo
, object
,
27207 XINT (s
), XINT (e
));
27208 hlinfo
->mouse_face_past_end
= 0;
27209 hlinfo
->mouse_face_window
= window
;
27210 hlinfo
->mouse_face_face_id
27211 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27212 glyph
->face_id
, 1);
27213 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27214 cursor
= No_Cursor
;
27218 /* The mouse-highlighting, if any, comes from an overlay
27219 or text property in the buffer. */
27220 Lisp_Object buffer
IF_LINT (= Qnil
);
27221 Lisp_Object disp_string
IF_LINT (= Qnil
);
27223 if (STRINGP (object
))
27225 /* If we are on a display string with no mouse-face,
27226 check if the text under it has one. */
27227 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27228 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27229 pos
= string_buffer_position (object
, start
);
27232 mouse_face
= get_char_property_and_overlay
27233 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27234 buffer
= w
->buffer
;
27235 disp_string
= object
;
27241 disp_string
= Qnil
;
27244 if (!NILP (mouse_face
))
27246 Lisp_Object before
, after
;
27247 Lisp_Object before_string
, after_string
;
27248 /* To correctly find the limits of mouse highlight
27249 in a bidi-reordered buffer, we must not use the
27250 optimization of limiting the search in
27251 previous-single-property-change and
27252 next-single-property-change, because
27253 rows_from_pos_range needs the real start and end
27254 positions to DTRT in this case. That's because
27255 the first row visible in a window does not
27256 necessarily display the character whose position
27257 is the smallest. */
27259 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27260 ? Fmarker_position (w
->start
)
27263 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27264 ? make_number (BUF_Z (XBUFFER (buffer
))
27265 - XFASTINT (w
->window_end_pos
))
27268 if (NILP (overlay
))
27270 /* Handle the text property case. */
27271 before
= Fprevious_single_property_change
27272 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27273 after
= Fnext_single_property_change
27274 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27275 before_string
= after_string
= Qnil
;
27279 /* Handle the overlay case. */
27280 before
= Foverlay_start (overlay
);
27281 after
= Foverlay_end (overlay
);
27282 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27283 after_string
= Foverlay_get (overlay
, Qafter_string
);
27285 if (!STRINGP (before_string
)) before_string
= Qnil
;
27286 if (!STRINGP (after_string
)) after_string
= Qnil
;
27289 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27292 : XFASTINT (before
),
27294 ? BUF_Z (XBUFFER (buffer
))
27295 : XFASTINT (after
),
27296 before_string
, after_string
,
27298 cursor
= No_Cursor
;
27305 /* Look for a `help-echo' property. */
27306 if (NILP (help_echo_string
)) {
27307 Lisp_Object help
, overlay
;
27309 /* Check overlays first. */
27310 help
= overlay
= Qnil
;
27311 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27313 overlay
= overlay_vec
[i
];
27314 help
= Foverlay_get (overlay
, Qhelp_echo
);
27319 help_echo_string
= help
;
27320 help_echo_window
= window
;
27321 help_echo_object
= overlay
;
27322 help_echo_pos
= pos
;
27326 Lisp_Object obj
= glyph
->object
;
27327 EMACS_INT charpos
= glyph
->charpos
;
27329 /* Try text properties. */
27332 && charpos
< SCHARS (obj
))
27334 help
= Fget_text_property (make_number (charpos
),
27338 /* If the string itself doesn't specify a help-echo,
27339 see if the buffer text ``under'' it does. */
27340 struct glyph_row
*r
27341 = MATRIX_ROW (w
->current_matrix
, vpos
);
27342 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27343 EMACS_INT p
= string_buffer_position (obj
, start
);
27346 help
= Fget_char_property (make_number (p
),
27347 Qhelp_echo
, w
->buffer
);
27356 else if (BUFFERP (obj
)
27359 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27364 help_echo_string
= help
;
27365 help_echo_window
= window
;
27366 help_echo_object
= obj
;
27367 help_echo_pos
= charpos
;
27372 #ifdef HAVE_WINDOW_SYSTEM
27373 /* Look for a `pointer' property. */
27374 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27376 /* Check overlays first. */
27377 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27378 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27380 if (NILP (pointer
))
27382 Lisp_Object obj
= glyph
->object
;
27383 EMACS_INT charpos
= glyph
->charpos
;
27385 /* Try text properties. */
27388 && charpos
< SCHARS (obj
))
27390 pointer
= Fget_text_property (make_number (charpos
),
27392 if (NILP (pointer
))
27394 /* If the string itself doesn't specify a pointer,
27395 see if the buffer text ``under'' it does. */
27396 struct glyph_row
*r
27397 = MATRIX_ROW (w
->current_matrix
, vpos
);
27398 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27399 EMACS_INT p
= string_buffer_position (obj
, start
);
27401 pointer
= Fget_char_property (make_number (p
),
27402 Qpointer
, w
->buffer
);
27405 else if (BUFFERP (obj
)
27408 pointer
= Fget_text_property (make_number (charpos
),
27412 #endif /* HAVE_WINDOW_SYSTEM */
27416 current_buffer
= obuf
;
27421 #ifdef HAVE_WINDOW_SYSTEM
27422 if (FRAME_WINDOW_P (f
))
27423 define_frame_cursor1 (f
, cursor
, pointer
);
27425 /* This is here to prevent a compiler error, about "label at end of
27426 compound statement". */
27433 Clear any mouse-face on window W. This function is part of the
27434 redisplay interface, and is called from try_window_id and similar
27435 functions to ensure the mouse-highlight is off. */
27438 x_clear_window_mouse_face (struct window
*w
)
27440 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27441 Lisp_Object window
;
27444 XSETWINDOW (window
, w
);
27445 if (EQ (window
, hlinfo
->mouse_face_window
))
27446 clear_mouse_face (hlinfo
);
27452 Just discard the mouse face information for frame F, if any.
27453 This is used when the size of F is changed. */
27456 cancel_mouse_face (struct frame
*f
)
27458 Lisp_Object window
;
27459 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27461 window
= hlinfo
->mouse_face_window
;
27462 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27464 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27465 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27466 hlinfo
->mouse_face_window
= Qnil
;
27472 /***********************************************************************
27474 ***********************************************************************/
27476 #ifdef HAVE_WINDOW_SYSTEM
27478 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27479 which intersects rectangle R. R is in window-relative coordinates. */
27482 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27483 enum glyph_row_area area
)
27485 struct glyph
*first
= row
->glyphs
[area
];
27486 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27487 struct glyph
*last
;
27488 int first_x
, start_x
, x
;
27490 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27491 /* If row extends face to end of line write the whole line. */
27492 draw_glyphs (w
, 0, row
, area
,
27493 0, row
->used
[area
],
27494 DRAW_NORMAL_TEXT
, 0);
27497 /* Set START_X to the window-relative start position for drawing glyphs of
27498 AREA. The first glyph of the text area can be partially visible.
27499 The first glyphs of other areas cannot. */
27500 start_x
= window_box_left_offset (w
, area
);
27502 if (area
== TEXT_AREA
)
27505 /* Find the first glyph that must be redrawn. */
27507 && x
+ first
->pixel_width
< r
->x
)
27509 x
+= first
->pixel_width
;
27513 /* Find the last one. */
27517 && x
< r
->x
+ r
->width
)
27519 x
+= last
->pixel_width
;
27525 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27526 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27527 DRAW_NORMAL_TEXT
, 0);
27532 /* Redraw the parts of the glyph row ROW on window W intersecting
27533 rectangle R. R is in window-relative coordinates. Value is
27534 non-zero if mouse-face was overwritten. */
27537 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27539 xassert (row
->enabled_p
);
27541 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27542 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27543 0, row
->used
[TEXT_AREA
],
27544 DRAW_NORMAL_TEXT
, 0);
27547 if (row
->used
[LEFT_MARGIN_AREA
])
27548 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27549 if (row
->used
[TEXT_AREA
])
27550 expose_area (w
, row
, r
, TEXT_AREA
);
27551 if (row
->used
[RIGHT_MARGIN_AREA
])
27552 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27553 draw_row_fringe_bitmaps (w
, row
);
27556 return row
->mouse_face_p
;
27560 /* Redraw those parts of glyphs rows during expose event handling that
27561 overlap other rows. Redrawing of an exposed line writes over parts
27562 of lines overlapping that exposed line; this function fixes that.
27564 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27565 row in W's current matrix that is exposed and overlaps other rows.
27566 LAST_OVERLAPPING_ROW is the last such row. */
27569 expose_overlaps (struct window
*w
,
27570 struct glyph_row
*first_overlapping_row
,
27571 struct glyph_row
*last_overlapping_row
,
27574 struct glyph_row
*row
;
27576 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27577 if (row
->overlapping_p
)
27579 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27582 if (row
->used
[LEFT_MARGIN_AREA
])
27583 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27585 if (row
->used
[TEXT_AREA
])
27586 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27588 if (row
->used
[RIGHT_MARGIN_AREA
])
27589 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27595 /* Return non-zero if W's cursor intersects rectangle R. */
27598 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27600 XRectangle cr
, result
;
27601 struct glyph
*cursor_glyph
;
27602 struct glyph_row
*row
;
27604 if (w
->phys_cursor
.vpos
>= 0
27605 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27606 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27608 && row
->cursor_in_fringe_p
)
27610 /* Cursor is in the fringe. */
27611 cr
.x
= window_box_right_offset (w
,
27612 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27613 ? RIGHT_MARGIN_AREA
27616 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27617 cr
.height
= row
->height
;
27618 return x_intersect_rectangles (&cr
, r
, &result
);
27621 cursor_glyph
= get_phys_cursor_glyph (w
);
27624 /* r is relative to W's box, but w->phys_cursor.x is relative
27625 to left edge of W's TEXT area. Adjust it. */
27626 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27627 cr
.y
= w
->phys_cursor
.y
;
27628 cr
.width
= cursor_glyph
->pixel_width
;
27629 cr
.height
= w
->phys_cursor_height
;
27630 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27631 I assume the effect is the same -- and this is portable. */
27632 return x_intersect_rectangles (&cr
, r
, &result
);
27634 /* If we don't understand the format, pretend we're not in the hot-spot. */
27640 Draw a vertical window border to the right of window W if W doesn't
27641 have vertical scroll bars. */
27644 x_draw_vertical_border (struct window
*w
)
27646 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27648 /* We could do better, if we knew what type of scroll-bar the adjacent
27649 windows (on either side) have... But we don't :-(
27650 However, I think this works ok. ++KFS 2003-04-25 */
27652 /* Redraw borders between horizontally adjacent windows. Don't
27653 do it for frames with vertical scroll bars because either the
27654 right scroll bar of a window, or the left scroll bar of its
27655 neighbor will suffice as a border. */
27656 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27659 if (!WINDOW_RIGHTMOST_P (w
)
27660 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27662 int x0
, x1
, y0
, y1
;
27664 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27667 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27670 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27672 else if (!WINDOW_LEFTMOST_P (w
)
27673 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27675 int x0
, x1
, y0
, y1
;
27677 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27680 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27683 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27688 /* Redraw the part of window W intersection rectangle FR. Pixel
27689 coordinates in FR are frame-relative. Call this function with
27690 input blocked. Value is non-zero if the exposure overwrites
27694 expose_window (struct window
*w
, XRectangle
*fr
)
27696 struct frame
*f
= XFRAME (w
->frame
);
27698 int mouse_face_overwritten_p
= 0;
27700 /* If window is not yet fully initialized, do nothing. This can
27701 happen when toolkit scroll bars are used and a window is split.
27702 Reconfiguring the scroll bar will generate an expose for a newly
27704 if (w
->current_matrix
== NULL
)
27707 /* When we're currently updating the window, display and current
27708 matrix usually don't agree. Arrange for a thorough display
27710 if (w
== updated_window
)
27712 SET_FRAME_GARBAGED (f
);
27716 /* Frame-relative pixel rectangle of W. */
27717 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27718 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27719 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27720 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27722 if (x_intersect_rectangles (fr
, &wr
, &r
))
27724 int yb
= window_text_bottom_y (w
);
27725 struct glyph_row
*row
;
27726 int cursor_cleared_p
, phys_cursor_on_p
;
27727 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27729 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27730 r
.x
, r
.y
, r
.width
, r
.height
));
27732 /* Convert to window coordinates. */
27733 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27734 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27736 /* Turn off the cursor. */
27737 if (!w
->pseudo_window_p
27738 && phys_cursor_in_rect_p (w
, &r
))
27740 x_clear_cursor (w
);
27741 cursor_cleared_p
= 1;
27744 cursor_cleared_p
= 0;
27746 /* If the row containing the cursor extends face to end of line,
27747 then expose_area might overwrite the cursor outside the
27748 rectangle and thus notice_overwritten_cursor might clear
27749 w->phys_cursor_on_p. We remember the original value and
27750 check later if it is changed. */
27751 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27753 /* Update lines intersecting rectangle R. */
27754 first_overlapping_row
= last_overlapping_row
= NULL
;
27755 for (row
= w
->current_matrix
->rows
;
27760 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27762 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27763 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27764 || (r
.y
>= y0
&& r
.y
< y1
)
27765 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27767 /* A header line may be overlapping, but there is no need
27768 to fix overlapping areas for them. KFS 2005-02-12 */
27769 if (row
->overlapping_p
&& !row
->mode_line_p
)
27771 if (first_overlapping_row
== NULL
)
27772 first_overlapping_row
= row
;
27773 last_overlapping_row
= row
;
27777 if (expose_line (w
, row
, &r
))
27778 mouse_face_overwritten_p
= 1;
27781 else if (row
->overlapping_p
)
27783 /* We must redraw a row overlapping the exposed area. */
27785 ? y0
+ row
->phys_height
> r
.y
27786 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27788 if (first_overlapping_row
== NULL
)
27789 first_overlapping_row
= row
;
27790 last_overlapping_row
= row
;
27798 /* Display the mode line if there is one. */
27799 if (WINDOW_WANTS_MODELINE_P (w
)
27800 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27802 && row
->y
< r
.y
+ r
.height
)
27804 if (expose_line (w
, row
, &r
))
27805 mouse_face_overwritten_p
= 1;
27808 if (!w
->pseudo_window_p
)
27810 /* Fix the display of overlapping rows. */
27811 if (first_overlapping_row
)
27812 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27815 /* Draw border between windows. */
27816 x_draw_vertical_border (w
);
27818 /* Turn the cursor on again. */
27819 if (cursor_cleared_p
27820 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27821 update_window_cursor (w
, 1);
27825 return mouse_face_overwritten_p
;
27830 /* Redraw (parts) of all windows in the window tree rooted at W that
27831 intersect R. R contains frame pixel coordinates. Value is
27832 non-zero if the exposure overwrites mouse-face. */
27835 expose_window_tree (struct window
*w
, XRectangle
*r
)
27837 struct frame
*f
= XFRAME (w
->frame
);
27838 int mouse_face_overwritten_p
= 0;
27840 while (w
&& !FRAME_GARBAGED_P (f
))
27842 if (!NILP (w
->hchild
))
27843 mouse_face_overwritten_p
27844 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27845 else if (!NILP (w
->vchild
))
27846 mouse_face_overwritten_p
27847 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27849 mouse_face_overwritten_p
|= expose_window (w
, r
);
27851 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27854 return mouse_face_overwritten_p
;
27859 Redisplay an exposed area of frame F. X and Y are the upper-left
27860 corner of the exposed rectangle. W and H are width and height of
27861 the exposed area. All are pixel values. W or H zero means redraw
27862 the entire frame. */
27865 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27868 int mouse_face_overwritten_p
= 0;
27870 TRACE ((stderr
, "expose_frame "));
27872 /* No need to redraw if frame will be redrawn soon. */
27873 if (FRAME_GARBAGED_P (f
))
27875 TRACE ((stderr
, " garbaged\n"));
27879 /* If basic faces haven't been realized yet, there is no point in
27880 trying to redraw anything. This can happen when we get an expose
27881 event while Emacs is starting, e.g. by moving another window. */
27882 if (FRAME_FACE_CACHE (f
) == NULL
27883 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27885 TRACE ((stderr
, " no faces\n"));
27889 if (w
== 0 || h
== 0)
27892 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27893 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27903 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27904 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27906 if (WINDOWP (f
->tool_bar_window
))
27907 mouse_face_overwritten_p
27908 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27910 #ifdef HAVE_X_WINDOWS
27912 #ifndef USE_X_TOOLKIT
27913 if (WINDOWP (f
->menu_bar_window
))
27914 mouse_face_overwritten_p
27915 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27916 #endif /* not USE_X_TOOLKIT */
27920 /* Some window managers support a focus-follows-mouse style with
27921 delayed raising of frames. Imagine a partially obscured frame,
27922 and moving the mouse into partially obscured mouse-face on that
27923 frame. The visible part of the mouse-face will be highlighted,
27924 then the WM raises the obscured frame. With at least one WM, KDE
27925 2.1, Emacs is not getting any event for the raising of the frame
27926 (even tried with SubstructureRedirectMask), only Expose events.
27927 These expose events will draw text normally, i.e. not
27928 highlighted. Which means we must redo the highlight here.
27929 Subsume it under ``we love X''. --gerd 2001-08-15 */
27930 /* Included in Windows version because Windows most likely does not
27931 do the right thing if any third party tool offers
27932 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27933 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27935 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27936 if (f
== hlinfo
->mouse_face_mouse_frame
)
27938 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27939 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27940 clear_mouse_face (hlinfo
);
27941 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27948 Determine the intersection of two rectangles R1 and R2. Return
27949 the intersection in *RESULT. Value is non-zero if RESULT is not
27953 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27955 XRectangle
*left
, *right
;
27956 XRectangle
*upper
, *lower
;
27957 int intersection_p
= 0;
27959 /* Rearrange so that R1 is the left-most rectangle. */
27961 left
= r1
, right
= r2
;
27963 left
= r2
, right
= r1
;
27965 /* X0 of the intersection is right.x0, if this is inside R1,
27966 otherwise there is no intersection. */
27967 if (right
->x
<= left
->x
+ left
->width
)
27969 result
->x
= right
->x
;
27971 /* The right end of the intersection is the minimum of
27972 the right ends of left and right. */
27973 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27976 /* Same game for Y. */
27978 upper
= r1
, lower
= r2
;
27980 upper
= r2
, lower
= r1
;
27982 /* The upper end of the intersection is lower.y0, if this is inside
27983 of upper. Otherwise, there is no intersection. */
27984 if (lower
->y
<= upper
->y
+ upper
->height
)
27986 result
->y
= lower
->y
;
27988 /* The lower end of the intersection is the minimum of the lower
27989 ends of upper and lower. */
27990 result
->height
= (min (lower
->y
+ lower
->height
,
27991 upper
->y
+ upper
->height
)
27993 intersection_p
= 1;
27997 return intersection_p
;
28000 #endif /* HAVE_WINDOW_SYSTEM */
28003 /***********************************************************************
28005 ***********************************************************************/
28008 syms_of_xdisp (void)
28010 Vwith_echo_area_save_vector
= Qnil
;
28011 staticpro (&Vwith_echo_area_save_vector
);
28013 Vmessage_stack
= Qnil
;
28014 staticpro (&Vmessage_stack
);
28016 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28018 message_dolog_marker1
= Fmake_marker ();
28019 staticpro (&message_dolog_marker1
);
28020 message_dolog_marker2
= Fmake_marker ();
28021 staticpro (&message_dolog_marker2
);
28022 message_dolog_marker3
= Fmake_marker ();
28023 staticpro (&message_dolog_marker3
);
28026 defsubr (&Sdump_frame_glyph_matrix
);
28027 defsubr (&Sdump_glyph_matrix
);
28028 defsubr (&Sdump_glyph_row
);
28029 defsubr (&Sdump_tool_bar_row
);
28030 defsubr (&Strace_redisplay
);
28031 defsubr (&Strace_to_stderr
);
28033 #ifdef HAVE_WINDOW_SYSTEM
28034 defsubr (&Stool_bar_lines_needed
);
28035 defsubr (&Slookup_image_map
);
28037 defsubr (&Sformat_mode_line
);
28038 defsubr (&Sinvisible_p
);
28039 defsubr (&Scurrent_bidi_paragraph_direction
);
28041 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28042 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28043 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28044 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28045 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28046 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28047 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28048 DEFSYM (Qeval
, "eval");
28049 DEFSYM (QCdata
, ":data");
28050 DEFSYM (Qdisplay
, "display");
28051 DEFSYM (Qspace_width
, "space-width");
28052 DEFSYM (Qraise
, "raise");
28053 DEFSYM (Qslice
, "slice");
28054 DEFSYM (Qspace
, "space");
28055 DEFSYM (Qmargin
, "margin");
28056 DEFSYM (Qpointer
, "pointer");
28057 DEFSYM (Qleft_margin
, "left-margin");
28058 DEFSYM (Qright_margin
, "right-margin");
28059 DEFSYM (Qcenter
, "center");
28060 DEFSYM (Qline_height
, "line-height");
28061 DEFSYM (QCalign_to
, ":align-to");
28062 DEFSYM (QCrelative_width
, ":relative-width");
28063 DEFSYM (QCrelative_height
, ":relative-height");
28064 DEFSYM (QCeval
, ":eval");
28065 DEFSYM (QCpropertize
, ":propertize");
28066 DEFSYM (QCfile
, ":file");
28067 DEFSYM (Qfontified
, "fontified");
28068 DEFSYM (Qfontification_functions
, "fontification-functions");
28069 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28070 DEFSYM (Qescape_glyph
, "escape-glyph");
28071 DEFSYM (Qnobreak_space
, "nobreak-space");
28072 DEFSYM (Qimage
, "image");
28073 DEFSYM (Qtext
, "text");
28074 DEFSYM (Qboth
, "both");
28075 DEFSYM (Qboth_horiz
, "both-horiz");
28076 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28077 DEFSYM (QCmap
, ":map");
28078 DEFSYM (QCpointer
, ":pointer");
28079 DEFSYM (Qrect
, "rect");
28080 DEFSYM (Qcircle
, "circle");
28081 DEFSYM (Qpoly
, "poly");
28082 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28083 DEFSYM (Qgrow_only
, "grow-only");
28084 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28085 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28086 DEFSYM (Qposition
, "position");
28087 DEFSYM (Qbuffer_position
, "buffer-position");
28088 DEFSYM (Qobject
, "object");
28089 DEFSYM (Qbar
, "bar");
28090 DEFSYM (Qhbar
, "hbar");
28091 DEFSYM (Qbox
, "box");
28092 DEFSYM (Qhollow
, "hollow");
28093 DEFSYM (Qhand
, "hand");
28094 DEFSYM (Qarrow
, "arrow");
28095 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28097 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28098 Fcons (intern_c_string ("void-variable"), Qnil
)),
28100 staticpro (&list_of_error
);
28102 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28103 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28104 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28105 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28107 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28108 staticpro (&echo_buffer
[0]);
28109 staticpro (&echo_buffer
[1]);
28111 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28112 staticpro (&echo_area_buffer
[0]);
28113 staticpro (&echo_area_buffer
[1]);
28115 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28116 staticpro (&Vmessages_buffer_name
);
28118 mode_line_proptrans_alist
= Qnil
;
28119 staticpro (&mode_line_proptrans_alist
);
28120 mode_line_string_list
= Qnil
;
28121 staticpro (&mode_line_string_list
);
28122 mode_line_string_face
= Qnil
;
28123 staticpro (&mode_line_string_face
);
28124 mode_line_string_face_prop
= Qnil
;
28125 staticpro (&mode_line_string_face_prop
);
28126 Vmode_line_unwind_vector
= Qnil
;
28127 staticpro (&Vmode_line_unwind_vector
);
28129 help_echo_string
= Qnil
;
28130 staticpro (&help_echo_string
);
28131 help_echo_object
= Qnil
;
28132 staticpro (&help_echo_object
);
28133 help_echo_window
= Qnil
;
28134 staticpro (&help_echo_window
);
28135 previous_help_echo_string
= Qnil
;
28136 staticpro (&previous_help_echo_string
);
28137 help_echo_pos
= -1;
28139 DEFSYM (Qright_to_left
, "right-to-left");
28140 DEFSYM (Qleft_to_right
, "left-to-right");
28142 #ifdef HAVE_WINDOW_SYSTEM
28143 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28144 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
28145 For example, if a block cursor is over a tab, it will be drawn as
28146 wide as that tab on the display. */);
28147 x_stretch_cursor_p
= 0;
28150 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28151 doc
: /* *Non-nil means highlight trailing whitespace.
28152 The face used for trailing whitespace is `trailing-whitespace'. */);
28153 Vshow_trailing_whitespace
= Qnil
;
28155 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28156 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28157 If the value is t, Emacs highlights non-ASCII chars which have the
28158 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28159 or `escape-glyph' face respectively.
28161 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28162 U+2011 (non-breaking hyphen) are affected.
28164 Any other non-nil value means to display these characters as a escape
28165 glyph followed by an ordinary space or hyphen.
28167 A value of nil means no special handling of these characters. */);
28168 Vnobreak_char_display
= Qt
;
28170 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28171 doc
: /* *The pointer shape to show in void text areas.
28172 A value of nil means to show the text pointer. Other options are `arrow',
28173 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28174 Vvoid_text_area_pointer
= Qarrow
;
28176 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28177 doc
: /* Non-nil means don't actually do any redisplay.
28178 This is used for internal purposes. */);
28179 Vinhibit_redisplay
= Qnil
;
28181 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28182 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28183 Vglobal_mode_string
= Qnil
;
28185 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28186 doc
: /* Marker for where to display an arrow on top of the buffer text.
28187 This must be the beginning of a line in order to work.
28188 See also `overlay-arrow-string'. */);
28189 Voverlay_arrow_position
= Qnil
;
28191 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28192 doc
: /* String to display as an arrow in non-window frames.
28193 See also `overlay-arrow-position'. */);
28194 Voverlay_arrow_string
= make_pure_c_string ("=>");
28196 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28197 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28198 The symbols on this list are examined during redisplay to determine
28199 where to display overlay arrows. */);
28200 Voverlay_arrow_variable_list
28201 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28203 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28204 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28205 If that fails to bring point back on frame, point is centered instead.
28206 If this is zero, point is always centered after it moves off frame.
28207 If you want scrolling to always be a line at a time, you should set
28208 `scroll-conservatively' to a large value rather than set this to 1. */);
28210 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28211 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28212 If point moves off-screen, redisplay will scroll by up to
28213 `scroll-conservatively' lines in order to bring point just barely
28214 onto the screen again. If that cannot be done, then redisplay
28215 recenters point as usual.
28217 If the value is greater than 100, redisplay will never recenter point,
28218 but will always scroll just enough text to bring point into view, even
28219 if you move far away.
28221 A value of zero means always recenter point if it moves off screen. */);
28222 scroll_conservatively
= 0;
28224 DEFVAR_INT ("scroll-margin", scroll_margin
,
28225 doc
: /* *Number of lines of margin at the top and bottom of a window.
28226 Recenter the window whenever point gets within this many lines
28227 of the top or bottom of the window. */);
28230 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28231 doc
: /* Pixels per inch value for non-window system displays.
28232 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28233 Vdisplay_pixels_per_inch
= make_float (72.0);
28236 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28239 DEFVAR_LISP ("truncate-partial-width-windows",
28240 Vtruncate_partial_width_windows
,
28241 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28242 For an integer value, truncate lines in each window narrower than the
28243 full frame width, provided the window width is less than that integer;
28244 otherwise, respect the value of `truncate-lines'.
28246 For any other non-nil value, truncate lines in all windows that do
28247 not span the full frame width.
28249 A value of nil means to respect the value of `truncate-lines'.
28251 If `word-wrap' is enabled, you might want to reduce this. */);
28252 Vtruncate_partial_width_windows
= make_number (50);
28254 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28255 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28256 Any other value means to use the appropriate face, `mode-line',
28257 `header-line', or `menu' respectively. */);
28258 mode_line_inverse_video
= 1;
28260 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28261 doc
: /* *Maximum buffer size for which line number should be displayed.
28262 If the buffer is bigger than this, the line number does not appear
28263 in the mode line. A value of nil means no limit. */);
28264 Vline_number_display_limit
= Qnil
;
28266 DEFVAR_INT ("line-number-display-limit-width",
28267 line_number_display_limit_width
,
28268 doc
: /* *Maximum line width (in characters) for line number display.
28269 If the average length of the lines near point is bigger than this, then the
28270 line number may be omitted from the mode line. */);
28271 line_number_display_limit_width
= 200;
28273 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28274 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28275 highlight_nonselected_windows
= 0;
28277 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28278 doc
: /* Non-nil if more than one frame is visible on this display.
28279 Minibuffer-only frames don't count, but iconified frames do.
28280 This variable is not guaranteed to be accurate except while processing
28281 `frame-title-format' and `icon-title-format'. */);
28283 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28284 doc
: /* Template for displaying the title bar of visible frames.
28285 \(Assuming the window manager supports this feature.)
28287 This variable has the same structure as `mode-line-format', except that
28288 the %c and %l constructs are ignored. It is used only on frames for
28289 which no explicit name has been set \(see `modify-frame-parameters'). */);
28291 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28292 doc
: /* Template for displaying the title bar of an iconified frame.
28293 \(Assuming the window manager supports this feature.)
28294 This variable has the same structure as `mode-line-format' (which see),
28295 and is used only on frames for which no explicit name has been set
28296 \(see `modify-frame-parameters'). */);
28298 = Vframe_title_format
28299 = pure_cons (intern_c_string ("multiple-frames"),
28300 pure_cons (make_pure_c_string ("%b"),
28301 pure_cons (pure_cons (empty_unibyte_string
,
28302 pure_cons (intern_c_string ("invocation-name"),
28303 pure_cons (make_pure_c_string ("@"),
28304 pure_cons (intern_c_string ("system-name"),
28308 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28309 doc
: /* Maximum number of lines to keep in the message log buffer.
28310 If nil, disable message logging. If t, log messages but don't truncate
28311 the buffer when it becomes large. */);
28312 Vmessage_log_max
= make_number (100);
28314 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28315 doc
: /* Functions called before redisplay, if window sizes have changed.
28316 The value should be a list of functions that take one argument.
28317 Just before redisplay, for each frame, if any of its windows have changed
28318 size since the last redisplay, or have been split or deleted,
28319 all the functions in the list are called, with the frame as argument. */);
28320 Vwindow_size_change_functions
= Qnil
;
28322 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28323 doc
: /* List of functions to call before redisplaying a window with scrolling.
28324 Each function is called with two arguments, the window and its new
28325 display-start position. Note that these functions are also called by
28326 `set-window-buffer'. Also note that the value of `window-end' is not
28327 valid when these functions are called. */);
28328 Vwindow_scroll_functions
= Qnil
;
28330 DEFVAR_LISP ("window-text-change-functions",
28331 Vwindow_text_change_functions
,
28332 doc
: /* Functions to call in redisplay when text in the window might change. */);
28333 Vwindow_text_change_functions
= Qnil
;
28335 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28336 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28337 Each function is called with two arguments, the window and the end trigger value.
28338 See `set-window-redisplay-end-trigger'. */);
28339 Vredisplay_end_trigger_functions
= Qnil
;
28341 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28342 doc
: /* *Non-nil means autoselect window with mouse pointer.
28343 If nil, do not autoselect windows.
28344 A positive number means delay autoselection by that many seconds: a
28345 window is autoselected only after the mouse has remained in that
28346 window for the duration of the delay.
28347 A negative number has a similar effect, but causes windows to be
28348 autoselected only after the mouse has stopped moving. \(Because of
28349 the way Emacs compares mouse events, you will occasionally wait twice
28350 that time before the window gets selected.\)
28351 Any other value means to autoselect window instantaneously when the
28352 mouse pointer enters it.
28354 Autoselection selects the minibuffer only if it is active, and never
28355 unselects the minibuffer if it is active.
28357 When customizing this variable make sure that the actual value of
28358 `focus-follows-mouse' matches the behavior of your window manager. */);
28359 Vmouse_autoselect_window
= Qnil
;
28361 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28362 doc
: /* *Non-nil means automatically resize tool-bars.
28363 This dynamically changes the tool-bar's height to the minimum height
28364 that is needed to make all tool-bar items visible.
28365 If value is `grow-only', the tool-bar's height is only increased
28366 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28367 Vauto_resize_tool_bars
= Qt
;
28369 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28370 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28371 auto_raise_tool_bar_buttons_p
= 1;
28373 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28374 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28375 make_cursor_line_fully_visible_p
= 1;
28377 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28378 doc
: /* *Border below tool-bar in pixels.
28379 If an integer, use it as the height of the border.
28380 If it is one of `internal-border-width' or `border-width', use the
28381 value of the corresponding frame parameter.
28382 Otherwise, no border is added below the tool-bar. */);
28383 Vtool_bar_border
= Qinternal_border_width
;
28385 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28386 doc
: /* *Margin around tool-bar buttons in pixels.
28387 If an integer, use that for both horizontal and vertical margins.
28388 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28389 HORZ specifying the horizontal margin, and VERT specifying the
28390 vertical margin. */);
28391 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28393 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28394 doc
: /* *Relief thickness of tool-bar buttons. */);
28395 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28397 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28398 doc
: /* Tool bar style to use.
28400 image - show images only
28401 text - show text only
28402 both - show both, text below image
28403 both-horiz - show text to the right of the image
28404 text-image-horiz - show text to the left of the image
28405 any other - use system default or image if no system default. */);
28406 Vtool_bar_style
= Qnil
;
28408 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28409 doc
: /* *Maximum number of characters a label can have to be shown.
28410 The tool bar style must also show labels for this to have any effect, see
28411 `tool-bar-style'. */);
28412 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28414 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28415 doc
: /* List of functions to call to fontify regions of text.
28416 Each function is called with one argument POS. Functions must
28417 fontify a region starting at POS in the current buffer, and give
28418 fontified regions the property `fontified'. */);
28419 Vfontification_functions
= Qnil
;
28420 Fmake_variable_buffer_local (Qfontification_functions
);
28422 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28423 unibyte_display_via_language_environment
,
28424 doc
: /* *Non-nil means display unibyte text according to language environment.
28425 Specifically, this means that raw bytes in the range 160-255 decimal
28426 are displayed by converting them to the equivalent multibyte characters
28427 according to the current language environment. As a result, they are
28428 displayed according to the current fontset.
28430 Note that this variable affects only how these bytes are displayed,
28431 but does not change the fact they are interpreted as raw bytes. */);
28432 unibyte_display_via_language_environment
= 0;
28434 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28435 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28436 If a float, it specifies a fraction of the mini-window frame's height.
28437 If an integer, it specifies a number of lines. */);
28438 Vmax_mini_window_height
= make_float (0.25);
28440 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28441 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28442 A value of nil means don't automatically resize mini-windows.
28443 A value of t means resize them to fit the text displayed in them.
28444 A value of `grow-only', the default, means let mini-windows grow only;
28445 they return to their normal size when the minibuffer is closed, or the
28446 echo area becomes empty. */);
28447 Vresize_mini_windows
= Qgrow_only
;
28449 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28450 doc
: /* Alist specifying how to blink the cursor off.
28451 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28452 `cursor-type' frame-parameter or variable equals ON-STATE,
28453 comparing using `equal', Emacs uses OFF-STATE to specify
28454 how to blink it off. ON-STATE and OFF-STATE are values for
28455 the `cursor-type' frame parameter.
28457 If a frame's ON-STATE has no entry in this list,
28458 the frame's other specifications determine how to blink the cursor off. */);
28459 Vblink_cursor_alist
= Qnil
;
28461 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28462 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28463 If non-nil, windows are automatically scrolled horizontally to make
28464 point visible. */);
28465 automatic_hscrolling_p
= 1;
28466 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28468 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28469 doc
: /* *How many columns away from the window edge point is allowed to get
28470 before automatic hscrolling will horizontally scroll the window. */);
28471 hscroll_margin
= 5;
28473 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28474 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28475 When point is less than `hscroll-margin' columns from the window
28476 edge, automatic hscrolling will scroll the window by the amount of columns
28477 determined by this variable. If its value is a positive integer, scroll that
28478 many columns. If it's a positive floating-point number, it specifies the
28479 fraction of the window's width to scroll. If it's nil or zero, point will be
28480 centered horizontally after the scroll. Any other value, including negative
28481 numbers, are treated as if the value were zero.
28483 Automatic hscrolling always moves point outside the scroll margin, so if
28484 point was more than scroll step columns inside the margin, the window will
28485 scroll more than the value given by the scroll step.
28487 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28488 and `scroll-right' overrides this variable's effect. */);
28489 Vhscroll_step
= make_number (0);
28491 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28492 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28493 Bind this around calls to `message' to let it take effect. */);
28494 message_truncate_lines
= 0;
28496 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28497 doc
: /* Normal hook run to update the menu bar definitions.
28498 Redisplay runs this hook before it redisplays the menu bar.
28499 This is used to update submenus such as Buffers,
28500 whose contents depend on various data. */);
28501 Vmenu_bar_update_hook
= Qnil
;
28503 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28504 doc
: /* Frame for which we are updating a menu.
28505 The enable predicate for a menu binding should check this variable. */);
28506 Vmenu_updating_frame
= Qnil
;
28508 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28509 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28510 inhibit_menubar_update
= 0;
28512 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28513 doc
: /* Prefix prepended to all continuation lines at display time.
28514 The value may be a string, an image, or a stretch-glyph; it is
28515 interpreted in the same way as the value of a `display' text property.
28517 This variable is overridden by any `wrap-prefix' text or overlay
28520 To add a prefix to non-continuation lines, use `line-prefix'. */);
28521 Vwrap_prefix
= Qnil
;
28522 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28523 Fmake_variable_buffer_local (Qwrap_prefix
);
28525 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28526 doc
: /* Prefix prepended to all non-continuation lines at display time.
28527 The value may be a string, an image, or a stretch-glyph; it is
28528 interpreted in the same way as the value of a `display' text property.
28530 This variable is overridden by any `line-prefix' text or overlay
28533 To add a prefix to continuation lines, use `wrap-prefix'. */);
28534 Vline_prefix
= Qnil
;
28535 DEFSYM (Qline_prefix
, "line-prefix");
28536 Fmake_variable_buffer_local (Qline_prefix
);
28538 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28539 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28540 inhibit_eval_during_redisplay
= 0;
28542 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28543 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28544 inhibit_free_realized_faces
= 0;
28547 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28548 doc
: /* Inhibit try_window_id display optimization. */);
28549 inhibit_try_window_id
= 0;
28551 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28552 doc
: /* Inhibit try_window_reusing display optimization. */);
28553 inhibit_try_window_reusing
= 0;
28555 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28556 doc
: /* Inhibit try_cursor_movement display optimization. */);
28557 inhibit_try_cursor_movement
= 0;
28558 #endif /* GLYPH_DEBUG */
28560 DEFVAR_INT ("overline-margin", overline_margin
,
28561 doc
: /* *Space between overline and text, in pixels.
28562 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28563 margin to the character height. */);
28564 overline_margin
= 2;
28566 DEFVAR_INT ("underline-minimum-offset",
28567 underline_minimum_offset
,
28568 doc
: /* Minimum distance between baseline and underline.
28569 This can improve legibility of underlined text at small font sizes,
28570 particularly when using variable `x-use-underline-position-properties'
28571 with fonts that specify an UNDERLINE_POSITION relatively close to the
28572 baseline. The default value is 1. */);
28573 underline_minimum_offset
= 1;
28575 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28576 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28577 This feature only works when on a window system that can change
28578 cursor shapes. */);
28579 display_hourglass_p
= 1;
28581 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28582 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28583 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28585 hourglass_atimer
= NULL
;
28586 hourglass_shown_p
= 0;
28588 DEFSYM (Qglyphless_char
, "glyphless-char");
28589 DEFSYM (Qhex_code
, "hex-code");
28590 DEFSYM (Qempty_box
, "empty-box");
28591 DEFSYM (Qthin_space
, "thin-space");
28592 DEFSYM (Qzero_width
, "zero-width");
28594 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28595 /* Intern this now in case it isn't already done.
28596 Setting this variable twice is harmless.
28597 But don't staticpro it here--that is done in alloc.c. */
28598 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28599 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28601 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28602 doc
: /* Char-table defining glyphless characters.
28603 Each element, if non-nil, should be one of the following:
28604 an ASCII acronym string: display this string in a box
28605 `hex-code': display the hexadecimal code of a character in a box
28606 `empty-box': display as an empty box
28607 `thin-space': display as 1-pixel width space
28608 `zero-width': don't display
28609 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28610 display method for graphical terminals and text terminals respectively.
28611 GRAPHICAL and TEXT should each have one of the values listed above.
28613 The char-table has one extra slot to control the display of a character for
28614 which no font is found. This slot only takes effect on graphical terminals.
28615 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28616 `thin-space'. The default is `empty-box'. */);
28617 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28618 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28623 /* Initialize this module when Emacs starts. */
28628 current_header_line_height
= current_mode_line_height
= -1;
28630 CHARPOS (this_line_start_pos
) = 0;
28632 if (!noninteractive
)
28634 struct window
*m
= XWINDOW (minibuf_window
);
28635 Lisp_Object frame
= m
->frame
;
28636 struct frame
*f
= XFRAME (frame
);
28637 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28638 struct window
*r
= XWINDOW (root
);
28641 echo_area_window
= minibuf_window
;
28643 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28644 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28645 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28646 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28647 XSETFASTINT (m
->total_lines
, 1);
28648 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28650 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28651 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28652 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28654 /* The default ellipsis glyphs `...'. */
28655 for (i
= 0; i
< 3; ++i
)
28656 default_invis_vector
[i
] = make_number ('.');
28660 /* Allocate the buffer for frame titles.
28661 Also used for `format-mode-line'. */
28663 mode_line_noprop_buf
= (char *) xmalloc (size
);
28664 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28665 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28666 mode_line_target
= MODE_LINE_DISPLAY
;
28669 help_echo_showing_p
= 0;
28672 /* Since w32 does not support atimers, it defines its own implementation of
28673 the following three functions in w32fns.c. */
28676 /* Platform-independent portion of hourglass implementation. */
28678 /* Return non-zero if hourglass timer has been started or hourglass is
28681 hourglass_started (void)
28683 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28686 /* Cancel a currently active hourglass timer, and start a new one. */
28688 start_hourglass (void)
28690 #if defined (HAVE_WINDOW_SYSTEM)
28692 int secs
, usecs
= 0;
28694 cancel_hourglass ();
28696 if (INTEGERP (Vhourglass_delay
)
28697 && XINT (Vhourglass_delay
) > 0)
28698 secs
= XFASTINT (Vhourglass_delay
);
28699 else if (FLOATP (Vhourglass_delay
)
28700 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28703 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28704 secs
= XFASTINT (tem
);
28705 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28708 secs
= DEFAULT_HOURGLASS_DELAY
;
28710 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28711 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28712 show_hourglass
, NULL
);
28717 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28720 cancel_hourglass (void)
28722 #if defined (HAVE_WINDOW_SYSTEM)
28723 if (hourglass_atimer
)
28725 cancel_atimer (hourglass_atimer
);
28726 hourglass_atimer
= NULL
;
28729 if (hourglass_shown_p
)
28733 #endif /* ! WINDOWSNT */