1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1213 /* Subroutine of pos_visible_p below. Extracts a display string, if
1214 any, from the display spec given as its argument. */
1216 string_from_display_spec (Lisp_Object spec
)
1220 while (CONSP (spec
))
1222 if (STRINGP (XCAR (spec
)))
1227 else if (VECTORP (spec
))
1231 for (i
= 0; i
< ASIZE (spec
); i
++)
1233 if (STRINGP (AREF (spec
, i
)))
1234 return AREF (spec
, i
);
1242 /* Return 1 if position CHARPOS is visible in window W.
1243 CHARPOS < 0 means return info about WINDOW_END position.
1244 If visible, set *X and *Y to pixel coordinates of top left corner.
1245 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1246 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1249 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1250 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1253 void *itdata
= bidi_shelve_cache ();
1254 struct text_pos top
;
1256 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->buffer
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1269 /* Compute exact mode line heights. */
1270 if (WINDOW_WANTS_MODELINE_P (w
))
1271 current_mode_line_height
1272 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1273 BVAR (current_buffer
, mode_line_format
));
1275 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1276 current_header_line_height
1277 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1278 BVAR (current_buffer
, header_line_format
));
1280 start_display (&it
, w
, top
);
1281 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1282 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1285 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1286 && IT_CHARPOS (it
) >= charpos
)
1287 /* When scanning backwards under bidi iteration, move_it_to
1288 stops at or _before_ CHARPOS, because it stops at or to
1289 the _right_ of the character at CHARPOS. */
1290 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1291 && IT_CHARPOS (it
) <= charpos
)))
1293 /* We have reached CHARPOS, or passed it. How the call to
1294 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1295 or covered by a display property, move_it_to stops at the end
1296 of the invisible text, to the right of CHARPOS. (ii) If
1297 CHARPOS is in a display vector, move_it_to stops on its last
1299 int top_x
= it
.current_x
;
1300 int top_y
= it
.current_y
;
1301 enum it_method it_method
= it
.method
;
1302 /* Calling line_bottom_y may change it.method, it.position, etc. */
1303 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1304 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1306 if (top_y
< window_top_y
)
1307 visible_p
= bottom_y
> window_top_y
;
1308 else if (top_y
< it
.last_visible_y
)
1312 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1314 /* We stopped on the last glyph of a display vector.
1315 Try and recompute. Hack alert! */
1316 if (charpos
< 2 || top
.charpos
>= charpos
)
1317 top_x
= it
.glyph_row
->x
;
1321 start_display (&it2
, w
, top
);
1322 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1323 get_next_display_element (&it2
);
1324 PRODUCE_GLYPHS (&it2
);
1325 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1326 || it2
.current_x
> it2
.last_visible_x
)
1327 top_x
= it
.glyph_row
->x
;
1330 top_x
= it2
.current_x
;
1331 top_y
= it2
.current_y
;
1335 else if (IT_CHARPOS (it
) != charpos
)
1337 Lisp_Object cpos
= make_number (charpos
);
1338 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1339 Lisp_Object string
= string_from_display_spec (spec
);
1340 int newline_in_string
= 0;
1342 if (STRINGP (string
))
1344 const char *s
= SSDATA (string
);
1345 const char *e
= s
+ SBYTES (string
);
1350 newline_in_string
= 1;
1355 /* The tricky code below is needed because there's a
1356 discrepancy between move_it_to and how we set cursor
1357 when the display line ends in a newline from a
1358 display string. move_it_to will stop _after_ such
1359 display strings, whereas set_cursor_from_row
1360 conspires with cursor_row_p to place the cursor on
1361 the first glyph produced from the display string. */
1363 /* We have overshoot PT because it is covered by a
1364 display property whose value is a string. If the
1365 string includes embedded newlines, we are also in the
1366 wrong display line. Backtrack to the correct line,
1367 where the display string begins. */
1368 if (newline_in_string
)
1370 Lisp_Object startpos
, endpos
;
1371 EMACS_INT start
, end
;
1374 /* Find the first and the last buffer positions
1375 covered by the display string. */
1377 Fnext_single_char_property_change (cpos
, Qdisplay
,
1380 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1382 start
= XFASTINT (startpos
);
1383 end
= XFASTINT (endpos
);
1384 /* Move to the last buffer position before the
1385 display property. */
1386 start_display (&it3
, w
, top
);
1387 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1388 /* Move forward one more line if the position before
1389 the display string is a newline or if it is the
1390 rightmost character on a line that is
1391 continued or word-wrapped. */
1392 if (it3
.method
== GET_FROM_BUFFER
1394 move_it_by_lines (&it3
, 1);
1395 else if (move_it_in_display_line_to (&it3
, -1,
1399 == MOVE_LINE_CONTINUED
)
1401 move_it_by_lines (&it3
, 1);
1402 /* When we are under word-wrap, the #$@%!
1403 move_it_by_lines moves 2 lines, so we need to
1405 if (it3
.line_wrap
== WORD_WRAP
)
1406 move_it_by_lines (&it3
, -1);
1409 /* Record the vertical coordinate of the display
1410 line where we wound up. */
1411 top_y
= it3
.current_y
;
1414 /* When characters are reordered for display,
1415 the character displayed to the left of the
1416 display string could be _after_ the display
1417 property in the logical order. Use the
1418 smallest vertical position of these two. */
1419 start_display (&it3
, w
, top
);
1420 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1421 if (it3
.current_y
< top_y
)
1422 top_y
= it3
.current_y
;
1424 /* Move from the top of the window to the beginning
1425 of the display line where the display string
1427 start_display (&it3
, w
, top
);
1428 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1429 /* Finally, advance the iterator until we hit the
1430 first display element whose character position is
1431 CHARPOS, or until the first newline from the
1432 display string, which signals the end of the
1434 while (get_next_display_element (&it3
))
1436 PRODUCE_GLYPHS (&it3
);
1437 if (IT_CHARPOS (it3
) == charpos
1438 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1440 set_iterator_to_next (&it3
, 0);
1442 top_x
= it3
.current_x
- it3
.pixel_width
;
1443 /* Normally, we would exit the above loop because we
1444 found the display element whose character
1445 position is CHARPOS. For the contingency that we
1446 didn't, and stopped at the first newline from the
1447 display string, move back over the glyphs
1448 produced from the string, until we find the
1449 rightmost glyph not from the string. */
1450 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1452 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1453 + it3
.glyph_row
->used
[TEXT_AREA
];
1455 while (EQ ((g
- 1)->object
, string
))
1458 top_x
-= g
->pixel_width
;
1460 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1461 + it3
.glyph_row
->used
[TEXT_AREA
]);
1467 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1468 *rtop
= max (0, window_top_y
- top_y
);
1469 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1470 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1471 - max (top_y
, window_top_y
)));
1477 /* We were asked to provide info about WINDOW_END. */
1479 void *it2data
= NULL
;
1481 SAVE_IT (it2
, it
, it2data
);
1482 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1483 move_it_by_lines (&it
, 1);
1484 if (charpos
< IT_CHARPOS (it
)
1485 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1488 RESTORE_IT (&it2
, &it2
, it2data
);
1489 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1491 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1492 *rtop
= max (0, -it2
.current_y
);
1493 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1494 - it
.last_visible_y
));
1495 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1497 - max (it2
.current_y
,
1498 WINDOW_HEADER_LINE_HEIGHT (w
))));
1502 bidi_unshelve_cache (it2data
, 1);
1504 bidi_unshelve_cache (itdata
, 0);
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR. Return in *LEN the length of
1528 the character. This is like STRING_CHAR_AND_LENGTH but never
1529 returns an invalid character. If we find one, we return a `?', but
1530 with the length of the invalid character. */
1533 string_char_and_length (const unsigned char *str
, int *len
)
1537 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1538 if (!CHAR_VALID_P (c
))
1539 /* We may not change the length here because other places in Emacs
1540 don't use this function, i.e. they silently accept invalid
1549 /* Given a position POS containing a valid character and byte position
1550 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1552 static struct text_pos
1553 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1555 xassert (STRINGP (string
) && nchars
>= 0);
1557 if (STRING_MULTIBYTE (string
))
1559 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1564 string_char_and_length (p
, &len
);
1567 BYTEPOS (pos
) += len
;
1571 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1577 /* Value is the text position, i.e. character and byte position,
1578 for character position CHARPOS in STRING. */
1580 static inline struct text_pos
1581 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1583 struct text_pos pos
;
1584 xassert (STRINGP (string
));
1585 xassert (charpos
>= 0);
1586 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1591 /* Value is a text position, i.e. character and byte position, for
1592 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1593 means recognize multibyte characters. */
1595 static struct text_pos
1596 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1598 struct text_pos pos
;
1600 xassert (s
!= NULL
);
1601 xassert (charpos
>= 0);
1607 SET_TEXT_POS (pos
, 0, 0);
1610 string_char_and_length ((const unsigned char *) s
, &len
);
1613 BYTEPOS (pos
) += len
;
1617 SET_TEXT_POS (pos
, charpos
, charpos
);
1623 /* Value is the number of characters in C string S. MULTIBYTE_P
1624 non-zero means recognize multibyte characters. */
1627 number_of_chars (const char *s
, int multibyte_p
)
1633 EMACS_INT rest
= strlen (s
);
1635 const unsigned char *p
= (const unsigned char *) s
;
1637 for (nchars
= 0; rest
> 0; ++nchars
)
1639 string_char_and_length (p
, &len
);
1640 rest
-= len
, p
+= len
;
1644 nchars
= strlen (s
);
1650 /* Compute byte position NEWPOS->bytepos corresponding to
1651 NEWPOS->charpos. POS is a known position in string STRING.
1652 NEWPOS->charpos must be >= POS.charpos. */
1655 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1657 xassert (STRINGP (string
));
1658 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1660 if (STRING_MULTIBYTE (string
))
1661 *newpos
= string_pos_nchars_ahead (pos
, string
,
1662 CHARPOS (*newpos
) - CHARPOS (pos
));
1664 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1668 Return an estimation of the pixel height of mode or header lines on
1669 frame F. FACE_ID specifies what line's height to estimate. */
1672 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1674 #ifdef HAVE_WINDOW_SYSTEM
1675 if (FRAME_WINDOW_P (f
))
1677 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1679 /* This function is called so early when Emacs starts that the face
1680 cache and mode line face are not yet initialized. */
1681 if (FRAME_FACE_CACHE (f
))
1683 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1687 height
= FONT_HEIGHT (face
->font
);
1688 if (face
->box_line_width
> 0)
1689 height
+= 2 * face
->box_line_width
;
1700 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1701 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1702 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1703 not force the value into range. */
1706 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1707 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1710 #ifdef HAVE_WINDOW_SYSTEM
1711 if (FRAME_WINDOW_P (f
))
1713 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1714 even for negative values. */
1716 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1718 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1720 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1721 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1724 STORE_NATIVE_RECT (*bounds
,
1725 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1726 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1727 FRAME_COLUMN_WIDTH (f
) - 1,
1728 FRAME_LINE_HEIGHT (f
) - 1);
1734 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1735 pix_x
= FRAME_TOTAL_COLS (f
);
1739 else if (pix_y
> FRAME_LINES (f
))
1740 pix_y
= FRAME_LINES (f
);
1750 /* Find the glyph under window-relative coordinates X/Y in window W.
1751 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1752 strings. Return in *HPOS and *VPOS the row and column number of
1753 the glyph found. Return in *AREA the glyph area containing X.
1754 Value is a pointer to the glyph found or null if X/Y is not on
1755 text, or we can't tell because W's current matrix is not up to
1760 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1761 int *dx
, int *dy
, int *area
)
1763 struct glyph
*glyph
, *end
;
1764 struct glyph_row
*row
= NULL
;
1767 /* Find row containing Y. Give up if some row is not enabled. */
1768 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1770 row
= MATRIX_ROW (w
->current_matrix
, i
);
1771 if (!row
->enabled_p
)
1773 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1780 /* Give up if Y is not in the window. */
1781 if (i
== w
->current_matrix
->nrows
)
1784 /* Get the glyph area containing X. */
1785 if (w
->pseudo_window_p
)
1792 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1794 *area
= LEFT_MARGIN_AREA
;
1795 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1797 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1800 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1804 *area
= RIGHT_MARGIN_AREA
;
1805 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1809 /* Find glyph containing X. */
1810 glyph
= row
->glyphs
[*area
];
1811 end
= glyph
+ row
->used
[*area
];
1813 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1815 x
-= glyph
->pixel_width
;
1825 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1828 *hpos
= glyph
- row
->glyphs
[*area
];
1832 /* Convert frame-relative x/y to coordinates relative to window W.
1833 Takes pseudo-windows into account. */
1836 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1838 if (w
->pseudo_window_p
)
1840 /* A pseudo-window is always full-width, and starts at the
1841 left edge of the frame, plus a frame border. */
1842 struct frame
*f
= XFRAME (w
->frame
);
1843 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1844 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1848 *x
-= WINDOW_LEFT_EDGE_X (w
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 #ifdef HAVE_WINDOW_SYSTEM
1856 Return in RECTS[] at most N clipping rectangles for glyph string S.
1857 Return the number of stored rectangles. */
1860 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1867 if (s
->row
->full_width_p
)
1869 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1870 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1871 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1873 /* Unless displaying a mode or menu bar line, which are always
1874 fully visible, clip to the visible part of the row. */
1875 if (s
->w
->pseudo_window_p
)
1876 r
.height
= s
->row
->visible_height
;
1878 r
.height
= s
->height
;
1882 /* This is a text line that may be partially visible. */
1883 r
.x
= window_box_left (s
->w
, s
->area
);
1884 r
.width
= window_box_width (s
->w
, s
->area
);
1885 r
.height
= s
->row
->visible_height
;
1889 if (r
.x
< s
->clip_head
->x
)
1891 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1892 r
.width
-= s
->clip_head
->x
- r
.x
;
1895 r
.x
= s
->clip_head
->x
;
1898 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1900 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1901 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1906 /* If S draws overlapping rows, it's sufficient to use the top and
1907 bottom of the window for clipping because this glyph string
1908 intentionally draws over other lines. */
1909 if (s
->for_overlaps
)
1911 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1912 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1914 /* Alas, the above simple strategy does not work for the
1915 environments with anti-aliased text: if the same text is
1916 drawn onto the same place multiple times, it gets thicker.
1917 If the overlap we are processing is for the erased cursor, we
1918 take the intersection with the rectangle of the cursor. */
1919 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1921 XRectangle rc
, r_save
= r
;
1923 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1924 rc
.y
= s
->w
->phys_cursor
.y
;
1925 rc
.width
= s
->w
->phys_cursor_width
;
1926 rc
.height
= s
->w
->phys_cursor_height
;
1928 x_intersect_rectangles (&r_save
, &rc
, &r
);
1933 /* Don't use S->y for clipping because it doesn't take partially
1934 visible lines into account. For example, it can be negative for
1935 partially visible lines at the top of a window. */
1936 if (!s
->row
->full_width_p
1937 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1938 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1940 r
.y
= max (0, s
->row
->y
);
1943 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1945 /* If drawing the cursor, don't let glyph draw outside its
1946 advertised boundaries. Cleartype does this under some circumstances. */
1947 if (s
->hl
== DRAW_CURSOR
)
1949 struct glyph
*glyph
= s
->first_glyph
;
1954 r
.width
-= s
->x
- r
.x
;
1957 r
.width
= min (r
.width
, glyph
->pixel_width
);
1959 /* If r.y is below window bottom, ensure that we still see a cursor. */
1960 height
= min (glyph
->ascent
+ glyph
->descent
,
1961 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1962 max_y
= window_text_bottom_y (s
->w
) - height
;
1963 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1964 if (s
->ybase
- glyph
->ascent
> max_y
)
1971 /* Don't draw cursor glyph taller than our actual glyph. */
1972 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1973 if (height
< r
.height
)
1975 max_y
= r
.y
+ r
.height
;
1976 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1977 r
.height
= min (max_y
- r
.y
, height
);
1984 XRectangle r_save
= r
;
1986 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1990 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1991 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1993 #ifdef CONVERT_FROM_XRECT
1994 CONVERT_FROM_XRECT (r
, *rects
);
2002 /* If we are processing overlapping and allowed to return
2003 multiple clipping rectangles, we exclude the row of the glyph
2004 string from the clipping rectangle. This is to avoid drawing
2005 the same text on the environment with anti-aliasing. */
2006 #ifdef CONVERT_FROM_XRECT
2009 XRectangle
*rs
= rects
;
2011 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2013 if (s
->for_overlaps
& OVERLAPS_PRED
)
2016 if (r
.y
+ r
.height
> row_y
)
2019 rs
[i
].height
= row_y
- r
.y
;
2025 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2028 if (r
.y
< row_y
+ s
->row
->visible_height
)
2030 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2032 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2033 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2042 #ifdef CONVERT_FROM_XRECT
2043 for (i
= 0; i
< n
; i
++)
2044 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2051 Return in *NR the clipping rectangle for glyph string S. */
2054 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2056 get_glyph_string_clip_rects (s
, nr
, 1);
2061 Return the position and height of the phys cursor in window W.
2062 Set w->phys_cursor_width to width of phys cursor.
2066 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2067 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2070 int x
, y
, wd
, h
, h0
, y0
;
2072 /* Compute the width of the rectangle to draw. If on a stretch
2073 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2074 rectangle as wide as the glyph, but use a canonical character
2076 wd
= glyph
->pixel_width
- 1;
2077 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2081 x
= w
->phys_cursor
.x
;
2088 if (glyph
->type
== STRETCH_GLYPH
2089 && !x_stretch_cursor_p
)
2090 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2091 w
->phys_cursor_width
= wd
;
2093 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2095 /* If y is below window bottom, ensure that we still see a cursor. */
2096 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2098 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2099 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2101 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2104 h
= max (h
- (y0
- y
) + 1, h0
);
2109 y0
= window_text_bottom_y (w
) - h0
;
2117 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2118 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2123 * Remember which glyph the mouse is over.
2127 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2131 struct glyph_row
*r
, *gr
, *end_row
;
2132 enum window_part part
;
2133 enum glyph_row_area area
;
2134 int x
, y
, width
, height
;
2136 /* Try to determine frame pixel position and size of the glyph under
2137 frame pixel coordinates X/Y on frame F. */
2139 if (!f
->glyphs_initialized_p
2140 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2143 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2144 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2148 w
= XWINDOW (window
);
2149 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2150 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2152 x
= window_relative_x_coord (w
, part
, gx
);
2153 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2155 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2156 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2158 if (w
->pseudo_window_p
)
2161 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2167 case ON_LEFT_MARGIN
:
2168 area
= LEFT_MARGIN_AREA
;
2171 case ON_RIGHT_MARGIN
:
2172 area
= RIGHT_MARGIN_AREA
;
2175 case ON_HEADER_LINE
:
2177 gr
= (part
== ON_HEADER_LINE
2178 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2179 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2182 goto text_glyph_row_found
;
2189 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2190 if (r
->y
+ r
->height
> y
)
2196 text_glyph_row_found
:
2199 struct glyph
*g
= gr
->glyphs
[area
];
2200 struct glyph
*end
= g
+ gr
->used
[area
];
2202 height
= gr
->height
;
2203 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2204 if (gx
+ g
->pixel_width
> x
)
2209 if (g
->type
== IMAGE_GLYPH
)
2211 /* Don't remember when mouse is over image, as
2212 image may have hot-spots. */
2213 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2216 width
= g
->pixel_width
;
2220 /* Use nominal char spacing at end of line. */
2222 gx
+= (x
/ width
) * width
;
2225 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2226 gx
+= window_box_left_offset (w
, area
);
2230 /* Use nominal line height at end of window. */
2231 gx
= (x
/ width
) * width
;
2233 gy
+= (y
/ height
) * height
;
2237 case ON_LEFT_FRINGE
:
2238 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2239 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2240 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2241 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2244 case ON_RIGHT_FRINGE
:
2245 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2246 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2247 : window_box_right_offset (w
, TEXT_AREA
));
2248 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2252 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2254 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2255 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2256 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2258 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2262 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2263 if (r
->y
+ r
->height
> y
)
2270 height
= gr
->height
;
2273 /* Use nominal line height at end of window. */
2275 gy
+= (y
/ height
) * height
;
2282 /* If there is no glyph under the mouse, then we divide the screen
2283 into a grid of the smallest glyph in the frame, and use that
2286 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2287 round down even for negative values. */
2293 gx
= (gx
/ width
) * width
;
2294 gy
= (gy
/ height
) * height
;
2299 gx
+= WINDOW_LEFT_EDGE_X (w
);
2300 gy
+= WINDOW_TOP_EDGE_Y (w
);
2303 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2305 /* Visible feedback for debugging. */
2308 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2309 f
->output_data
.x
->normal_gc
,
2310 gx
, gy
, width
, height
);
2316 #endif /* HAVE_WINDOW_SYSTEM */
2319 /***********************************************************************
2320 Lisp form evaluation
2321 ***********************************************************************/
2323 /* Error handler for safe_eval and safe_call. */
2326 safe_eval_handler (Lisp_Object arg
)
2328 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2333 /* Evaluate SEXPR and return the result, or nil if something went
2334 wrong. Prevent redisplay during the evaluation. */
2336 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2337 Return the result, or nil if something went wrong. Prevent
2338 redisplay during the evaluation. */
2341 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2345 if (inhibit_eval_during_redisplay
)
2349 int count
= SPECPDL_INDEX ();
2350 struct gcpro gcpro1
;
2353 gcpro1
.nvars
= nargs
;
2354 specbind (Qinhibit_redisplay
, Qt
);
2355 /* Use Qt to ensure debugger does not run,
2356 so there is no possibility of wanting to redisplay. */
2357 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2360 val
= unbind_to (count
, val
);
2367 /* Call function FN with one argument ARG.
2368 Return the result, or nil if something went wrong. */
2371 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2373 Lisp_Object args
[2];
2376 return safe_call (2, args
);
2379 static Lisp_Object Qeval
;
2382 safe_eval (Lisp_Object sexpr
)
2384 return safe_call1 (Qeval
, sexpr
);
2387 /* Call function FN with one argument ARG.
2388 Return the result, or nil if something went wrong. */
2391 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2393 Lisp_Object args
[3];
2397 return safe_call (3, args
);
2402 /***********************************************************************
2404 ***********************************************************************/
2408 /* Define CHECK_IT to perform sanity checks on iterators.
2409 This is for debugging. It is too slow to do unconditionally. */
2412 check_it (struct it
*it
)
2414 if (it
->method
== GET_FROM_STRING
)
2416 xassert (STRINGP (it
->string
));
2417 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2421 xassert (IT_STRING_CHARPOS (*it
) < 0);
2422 if (it
->method
== GET_FROM_BUFFER
)
2424 /* Check that character and byte positions agree. */
2425 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2430 xassert (it
->current
.dpvec_index
>= 0);
2432 xassert (it
->current
.dpvec_index
< 0);
2435 #define CHECK_IT(IT) check_it ((IT))
2439 #define CHECK_IT(IT) (void) 0
2444 #if GLYPH_DEBUG && XASSERTS
2446 /* Check that the window end of window W is what we expect it
2447 to be---the last row in the current matrix displaying text. */
2450 check_window_end (struct window
*w
)
2452 if (!MINI_WINDOW_P (w
)
2453 && !NILP (w
->window_end_valid
))
2455 struct glyph_row
*row
;
2456 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2457 XFASTINT (w
->window_end_vpos
)),
2459 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2460 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2464 #define CHECK_WINDOW_END(W) check_window_end ((W))
2468 #define CHECK_WINDOW_END(W) (void) 0
2474 /***********************************************************************
2475 Iterator initialization
2476 ***********************************************************************/
2478 /* Initialize IT for displaying current_buffer in window W, starting
2479 at character position CHARPOS. CHARPOS < 0 means that no buffer
2480 position is specified which is useful when the iterator is assigned
2481 a position later. BYTEPOS is the byte position corresponding to
2482 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2484 If ROW is not null, calls to produce_glyphs with IT as parameter
2485 will produce glyphs in that row.
2487 BASE_FACE_ID is the id of a base face to use. It must be one of
2488 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2489 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2490 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2492 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2493 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2494 will be initialized to use the corresponding mode line glyph row of
2495 the desired matrix of W. */
2498 init_iterator (struct it
*it
, struct window
*w
,
2499 EMACS_INT charpos
, EMACS_INT bytepos
,
2500 struct glyph_row
*row
, enum face_id base_face_id
)
2502 int highlight_region_p
;
2503 enum face_id remapped_base_face_id
= base_face_id
;
2505 /* Some precondition checks. */
2506 xassert (w
!= NULL
&& it
!= NULL
);
2507 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2510 /* If face attributes have been changed since the last redisplay,
2511 free realized faces now because they depend on face definitions
2512 that might have changed. Don't free faces while there might be
2513 desired matrices pending which reference these faces. */
2514 if (face_change_count
&& !inhibit_free_realized_faces
)
2516 face_change_count
= 0;
2517 free_all_realized_faces (Qnil
);
2520 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2521 if (! NILP (Vface_remapping_alist
))
2522 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2524 /* Use one of the mode line rows of W's desired matrix if
2528 if (base_face_id
== MODE_LINE_FACE_ID
2529 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2530 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2531 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2532 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2536 memset (it
, 0, sizeof *it
);
2537 it
->current
.overlay_string_index
= -1;
2538 it
->current
.dpvec_index
= -1;
2539 it
->base_face_id
= remapped_base_face_id
;
2541 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2542 it
->paragraph_embedding
= L2R
;
2543 it
->bidi_it
.string
.lstring
= Qnil
;
2544 it
->bidi_it
.string
.s
= NULL
;
2545 it
->bidi_it
.string
.bufpos
= 0;
2547 /* The window in which we iterate over current_buffer: */
2548 XSETWINDOW (it
->window
, w
);
2550 it
->f
= XFRAME (w
->frame
);
2554 /* Extra space between lines (on window systems only). */
2555 if (base_face_id
== DEFAULT_FACE_ID
2556 && FRAME_WINDOW_P (it
->f
))
2558 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2559 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2560 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2561 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2562 * FRAME_LINE_HEIGHT (it
->f
));
2563 else if (it
->f
->extra_line_spacing
> 0)
2564 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2565 it
->max_extra_line_spacing
= 0;
2568 /* If realized faces have been removed, e.g. because of face
2569 attribute changes of named faces, recompute them. When running
2570 in batch mode, the face cache of the initial frame is null. If
2571 we happen to get called, make a dummy face cache. */
2572 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2573 init_frame_faces (it
->f
);
2574 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2575 recompute_basic_faces (it
->f
);
2577 /* Current value of the `slice', `space-width', and 'height' properties. */
2578 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2579 it
->space_width
= Qnil
;
2580 it
->font_height
= Qnil
;
2581 it
->override_ascent
= -1;
2583 /* Are control characters displayed as `^C'? */
2584 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2586 /* -1 means everything between a CR and the following line end
2587 is invisible. >0 means lines indented more than this value are
2589 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2590 ? XINT (BVAR (current_buffer
, selective_display
))
2591 : (!NILP (BVAR (current_buffer
, selective_display
))
2593 it
->selective_display_ellipsis_p
2594 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2596 /* Display table to use. */
2597 it
->dp
= window_display_table (w
);
2599 /* Are multibyte characters enabled in current_buffer? */
2600 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2602 /* Non-zero if we should highlight the region. */
2604 = (!NILP (Vtransient_mark_mode
)
2605 && !NILP (BVAR (current_buffer
, mark_active
))
2606 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2608 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2609 start and end of a visible region in window IT->w. Set both to
2610 -1 to indicate no region. */
2611 if (highlight_region_p
2612 /* Maybe highlight only in selected window. */
2613 && (/* Either show region everywhere. */
2614 highlight_nonselected_windows
2615 /* Or show region in the selected window. */
2616 || w
== XWINDOW (selected_window
)
2617 /* Or show the region if we are in the mini-buffer and W is
2618 the window the mini-buffer refers to. */
2619 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2620 && WINDOWP (minibuf_selected_window
)
2621 && w
== XWINDOW (minibuf_selected_window
))))
2623 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2624 it
->region_beg_charpos
= min (PT
, markpos
);
2625 it
->region_end_charpos
= max (PT
, markpos
);
2628 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2630 /* Get the position at which the redisplay_end_trigger hook should
2631 be run, if it is to be run at all. */
2632 if (MARKERP (w
->redisplay_end_trigger
)
2633 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2634 it
->redisplay_end_trigger_charpos
2635 = marker_position (w
->redisplay_end_trigger
);
2636 else if (INTEGERP (w
->redisplay_end_trigger
))
2637 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2639 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2641 /* Are lines in the display truncated? */
2642 if (base_face_id
!= DEFAULT_FACE_ID
2643 || XINT (it
->w
->hscroll
)
2644 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2645 && ((!NILP (Vtruncate_partial_width_windows
)
2646 && !INTEGERP (Vtruncate_partial_width_windows
))
2647 || (INTEGERP (Vtruncate_partial_width_windows
)
2648 && (WINDOW_TOTAL_COLS (it
->w
)
2649 < XINT (Vtruncate_partial_width_windows
))))))
2650 it
->line_wrap
= TRUNCATE
;
2651 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2652 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2653 ? WINDOW_WRAP
: WORD_WRAP
;
2655 it
->line_wrap
= TRUNCATE
;
2657 /* Get dimensions of truncation and continuation glyphs. These are
2658 displayed as fringe bitmaps under X, so we don't need them for such
2660 if (!FRAME_WINDOW_P (it
->f
))
2662 if (it
->line_wrap
== TRUNCATE
)
2664 /* We will need the truncation glyph. */
2665 xassert (it
->glyph_row
== NULL
);
2666 produce_special_glyphs (it
, IT_TRUNCATION
);
2667 it
->truncation_pixel_width
= it
->pixel_width
;
2671 /* We will need the continuation glyph. */
2672 xassert (it
->glyph_row
== NULL
);
2673 produce_special_glyphs (it
, IT_CONTINUATION
);
2674 it
->continuation_pixel_width
= it
->pixel_width
;
2677 /* Reset these values to zero because the produce_special_glyphs
2678 above has changed them. */
2679 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2680 it
->phys_ascent
= it
->phys_descent
= 0;
2683 /* Set this after getting the dimensions of truncation and
2684 continuation glyphs, so that we don't produce glyphs when calling
2685 produce_special_glyphs, above. */
2686 it
->glyph_row
= row
;
2687 it
->area
= TEXT_AREA
;
2689 /* Forget any previous info about this row being reversed. */
2691 it
->glyph_row
->reversed_p
= 0;
2693 /* Get the dimensions of the display area. The display area
2694 consists of the visible window area plus a horizontally scrolled
2695 part to the left of the window. All x-values are relative to the
2696 start of this total display area. */
2697 if (base_face_id
!= DEFAULT_FACE_ID
)
2699 /* Mode lines, menu bar in terminal frames. */
2700 it
->first_visible_x
= 0;
2701 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2706 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2707 it
->last_visible_x
= (it
->first_visible_x
2708 + window_box_width (w
, TEXT_AREA
));
2710 /* If we truncate lines, leave room for the truncator glyph(s) at
2711 the right margin. Otherwise, leave room for the continuation
2712 glyph(s). Truncation and continuation glyphs are not inserted
2713 for window-based redisplay. */
2714 if (!FRAME_WINDOW_P (it
->f
))
2716 if (it
->line_wrap
== TRUNCATE
)
2717 it
->last_visible_x
-= it
->truncation_pixel_width
;
2719 it
->last_visible_x
-= it
->continuation_pixel_width
;
2722 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2723 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2726 /* Leave room for a border glyph. */
2727 if (!FRAME_WINDOW_P (it
->f
)
2728 && !WINDOW_RIGHTMOST_P (it
->w
))
2729 it
->last_visible_x
-= 1;
2731 it
->last_visible_y
= window_text_bottom_y (w
);
2733 /* For mode lines and alike, arrange for the first glyph having a
2734 left box line if the face specifies a box. */
2735 if (base_face_id
!= DEFAULT_FACE_ID
)
2739 it
->face_id
= remapped_base_face_id
;
2741 /* If we have a boxed mode line, make the first character appear
2742 with a left box line. */
2743 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2744 if (face
->box
!= FACE_NO_BOX
)
2745 it
->start_of_box_run_p
= 1;
2748 /* If a buffer position was specified, set the iterator there,
2749 getting overlays and face properties from that position. */
2750 if (charpos
>= BUF_BEG (current_buffer
))
2752 it
->end_charpos
= ZV
;
2753 IT_CHARPOS (*it
) = charpos
;
2755 /* We will rely on `reseat' to set this up properly, via
2756 handle_face_prop. */
2757 it
->face_id
= it
->base_face_id
;
2759 /* Compute byte position if not specified. */
2760 if (bytepos
< charpos
)
2761 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2763 IT_BYTEPOS (*it
) = bytepos
;
2765 it
->start
= it
->current
;
2766 /* Do we need to reorder bidirectional text? Not if this is a
2767 unibyte buffer: by definition, none of the single-byte
2768 characters are strong R2L, so no reordering is needed. And
2769 bidi.c doesn't support unibyte buffers anyway. Also, don't
2770 reorder while we are loading loadup.el, since the tables of
2771 character properties needed for reordering are not yet
2775 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2778 /* If we are to reorder bidirectional text, init the bidi
2782 /* Note the paragraph direction that this buffer wants to
2784 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2786 it
->paragraph_embedding
= L2R
;
2787 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2789 it
->paragraph_embedding
= R2L
;
2791 it
->paragraph_embedding
= NEUTRAL_DIR
;
2792 bidi_unshelve_cache (NULL
, 0);
2793 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2797 /* Compute faces etc. */
2798 reseat (it
, it
->current
.pos
, 1);
2805 /* Initialize IT for the display of window W with window start POS. */
2808 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2810 struct glyph_row
*row
;
2811 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2813 row
= w
->desired_matrix
->rows
+ first_vpos
;
2814 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2815 it
->first_vpos
= first_vpos
;
2817 /* Don't reseat to previous visible line start if current start
2818 position is in a string or image. */
2819 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2821 int start_at_line_beg_p
;
2822 int first_y
= it
->current_y
;
2824 /* If window start is not at a line start, skip forward to POS to
2825 get the correct continuation lines width. */
2826 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2827 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2828 if (!start_at_line_beg_p
)
2832 reseat_at_previous_visible_line_start (it
);
2833 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2835 new_x
= it
->current_x
+ it
->pixel_width
;
2837 /* If lines are continued, this line may end in the middle
2838 of a multi-glyph character (e.g. a control character
2839 displayed as \003, or in the middle of an overlay
2840 string). In this case move_it_to above will not have
2841 taken us to the start of the continuation line but to the
2842 end of the continued line. */
2843 if (it
->current_x
> 0
2844 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2845 && (/* And glyph doesn't fit on the line. */
2846 new_x
> it
->last_visible_x
2847 /* Or it fits exactly and we're on a window
2849 || (new_x
== it
->last_visible_x
2850 && FRAME_WINDOW_P (it
->f
))))
2852 if ((it
->current
.dpvec_index
>= 0
2853 || it
->current
.overlay_string_index
>= 0)
2854 /* If we are on a newline from a display vector or
2855 overlay string, then we are already at the end of
2856 a screen line; no need to go to the next line in
2857 that case, as this line is not really continued.
2858 (If we do go to the next line, C-e will not DTRT.) */
2861 set_iterator_to_next (it
, 1);
2862 move_it_in_display_line_to (it
, -1, -1, 0);
2865 it
->continuation_lines_width
+= it
->current_x
;
2867 /* If the character at POS is displayed via a display
2868 vector, move_it_to above stops at the final glyph of
2869 IT->dpvec. To make the caller redisplay that character
2870 again (a.k.a. start at POS), we need to reset the
2871 dpvec_index to the beginning of IT->dpvec. */
2872 else if (it
->current
.dpvec_index
>= 0)
2873 it
->current
.dpvec_index
= 0;
2875 /* We're starting a new display line, not affected by the
2876 height of the continued line, so clear the appropriate
2877 fields in the iterator structure. */
2878 it
->max_ascent
= it
->max_descent
= 0;
2879 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2881 it
->current_y
= first_y
;
2883 it
->current_x
= it
->hpos
= 0;
2889 /* Return 1 if POS is a position in ellipses displayed for invisible
2890 text. W is the window we display, for text property lookup. */
2893 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2895 Lisp_Object prop
, window
;
2897 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2899 /* If POS specifies a position in a display vector, this might
2900 be for an ellipsis displayed for invisible text. We won't
2901 get the iterator set up for delivering that ellipsis unless
2902 we make sure that it gets aware of the invisible text. */
2903 if (pos
->dpvec_index
>= 0
2904 && pos
->overlay_string_index
< 0
2905 && CHARPOS (pos
->string_pos
) < 0
2907 && (XSETWINDOW (window
, w
),
2908 prop
= Fget_char_property (make_number (charpos
),
2909 Qinvisible
, window
),
2910 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2912 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2914 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2921 /* Initialize IT for stepping through current_buffer in window W,
2922 starting at position POS that includes overlay string and display
2923 vector/ control character translation position information. Value
2924 is zero if there are overlay strings with newlines at POS. */
2927 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2929 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2930 int i
, overlay_strings_with_newlines
= 0;
2932 /* If POS specifies a position in a display vector, this might
2933 be for an ellipsis displayed for invisible text. We won't
2934 get the iterator set up for delivering that ellipsis unless
2935 we make sure that it gets aware of the invisible text. */
2936 if (in_ellipses_for_invisible_text_p (pos
, w
))
2942 /* Keep in mind: the call to reseat in init_iterator skips invisible
2943 text, so we might end up at a position different from POS. This
2944 is only a problem when POS is a row start after a newline and an
2945 overlay starts there with an after-string, and the overlay has an
2946 invisible property. Since we don't skip invisible text in
2947 display_line and elsewhere immediately after consuming the
2948 newline before the row start, such a POS will not be in a string,
2949 but the call to init_iterator below will move us to the
2951 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2953 /* This only scans the current chunk -- it should scan all chunks.
2954 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2955 to 16 in 22.1 to make this a lesser problem. */
2956 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2958 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2959 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2961 while (s
< e
&& *s
!= '\n')
2966 overlay_strings_with_newlines
= 1;
2971 /* If position is within an overlay string, set up IT to the right
2973 if (pos
->overlay_string_index
>= 0)
2977 /* If the first overlay string happens to have a `display'
2978 property for an image, the iterator will be set up for that
2979 image, and we have to undo that setup first before we can
2980 correct the overlay string index. */
2981 if (it
->method
== GET_FROM_IMAGE
)
2984 /* We already have the first chunk of overlay strings in
2985 IT->overlay_strings. Load more until the one for
2986 pos->overlay_string_index is in IT->overlay_strings. */
2987 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2989 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2990 it
->current
.overlay_string_index
= 0;
2993 load_overlay_strings (it
, 0);
2994 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2998 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2999 relative_index
= (it
->current
.overlay_string_index
3000 % OVERLAY_STRING_CHUNK_SIZE
);
3001 it
->string
= it
->overlay_strings
[relative_index
];
3002 xassert (STRINGP (it
->string
));
3003 it
->current
.string_pos
= pos
->string_pos
;
3004 it
->method
= GET_FROM_STRING
;
3007 if (CHARPOS (pos
->string_pos
) >= 0)
3009 /* Recorded position is not in an overlay string, but in another
3010 string. This can only be a string from a `display' property.
3011 IT should already be filled with that string. */
3012 it
->current
.string_pos
= pos
->string_pos
;
3013 xassert (STRINGP (it
->string
));
3016 /* Restore position in display vector translations, control
3017 character translations or ellipses. */
3018 if (pos
->dpvec_index
>= 0)
3020 if (it
->dpvec
== NULL
)
3021 get_next_display_element (it
);
3022 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3023 it
->current
.dpvec_index
= pos
->dpvec_index
;
3027 return !overlay_strings_with_newlines
;
3031 /* Initialize IT for stepping through current_buffer in window W
3032 starting at ROW->start. */
3035 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3037 init_from_display_pos (it
, w
, &row
->start
);
3038 it
->start
= row
->start
;
3039 it
->continuation_lines_width
= row
->continuation_lines_width
;
3044 /* Initialize IT for stepping through current_buffer in window W
3045 starting in the line following ROW, i.e. starting at ROW->end.
3046 Value is zero if there are overlay strings with newlines at ROW's
3050 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3054 if (init_from_display_pos (it
, w
, &row
->end
))
3056 if (row
->continued_p
)
3057 it
->continuation_lines_width
3058 = row
->continuation_lines_width
+ row
->pixel_width
;
3069 /***********************************************************************
3071 ***********************************************************************/
3073 /* Called when IT reaches IT->stop_charpos. Handle text property and
3074 overlay changes. Set IT->stop_charpos to the next position where
3078 handle_stop (struct it
*it
)
3080 enum prop_handled handled
;
3081 int handle_overlay_change_p
;
3085 it
->current
.dpvec_index
= -1;
3086 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3087 it
->ignore_overlay_strings_at_pos_p
= 0;
3090 /* Use face of preceding text for ellipsis (if invisible) */
3091 if (it
->selective_display_ellipsis_p
)
3092 it
->saved_face_id
= it
->face_id
;
3096 handled
= HANDLED_NORMALLY
;
3098 /* Call text property handlers. */
3099 for (p
= it_props
; p
->handler
; ++p
)
3101 handled
= p
->handler (it
);
3103 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3105 else if (handled
== HANDLED_RETURN
)
3107 /* We still want to show before and after strings from
3108 overlays even if the actual buffer text is replaced. */
3109 if (!handle_overlay_change_p
3111 || !get_overlay_strings_1 (it
, 0, 0))
3114 setup_for_ellipsis (it
, 0);
3115 /* When handling a display spec, we might load an
3116 empty string. In that case, discard it here. We
3117 used to discard it in handle_single_display_spec,
3118 but that causes get_overlay_strings_1, above, to
3119 ignore overlay strings that we must check. */
3120 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3124 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3128 it
->ignore_overlay_strings_at_pos_p
= 1;
3129 it
->string_from_display_prop_p
= 0;
3130 it
->from_disp_prop_p
= 0;
3131 handle_overlay_change_p
= 0;
3133 handled
= HANDLED_RECOMPUTE_PROPS
;
3136 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3137 handle_overlay_change_p
= 0;
3140 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3142 /* Don't check for overlay strings below when set to deliver
3143 characters from a display vector. */
3144 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3145 handle_overlay_change_p
= 0;
3147 /* Handle overlay changes.
3148 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3149 if it finds overlays. */
3150 if (handle_overlay_change_p
)
3151 handled
= handle_overlay_change (it
);
3156 setup_for_ellipsis (it
, 0);
3160 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3162 /* Determine where to stop next. */
3163 if (handled
== HANDLED_NORMALLY
)
3164 compute_stop_pos (it
);
3168 /* Compute IT->stop_charpos from text property and overlay change
3169 information for IT's current position. */
3172 compute_stop_pos (struct it
*it
)
3174 register INTERVAL iv
, next_iv
;
3175 Lisp_Object object
, limit
, position
;
3176 EMACS_INT charpos
, bytepos
;
3178 if (STRINGP (it
->string
))
3180 /* Strings are usually short, so don't limit the search for
3182 it
->stop_charpos
= it
->end_charpos
;
3183 object
= it
->string
;
3185 charpos
= IT_STRING_CHARPOS (*it
);
3186 bytepos
= IT_STRING_BYTEPOS (*it
);
3192 /* If end_charpos is out of range for some reason, such as a
3193 misbehaving display function, rationalize it (Bug#5984). */
3194 if (it
->end_charpos
> ZV
)
3195 it
->end_charpos
= ZV
;
3196 it
->stop_charpos
= it
->end_charpos
;
3198 /* If next overlay change is in front of the current stop pos
3199 (which is IT->end_charpos), stop there. Note: value of
3200 next_overlay_change is point-max if no overlay change
3202 charpos
= IT_CHARPOS (*it
);
3203 bytepos
= IT_BYTEPOS (*it
);
3204 pos
= next_overlay_change (charpos
);
3205 if (pos
< it
->stop_charpos
)
3206 it
->stop_charpos
= pos
;
3208 /* If showing the region, we have to stop at the region
3209 start or end because the face might change there. */
3210 if (it
->region_beg_charpos
> 0)
3212 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3213 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3214 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3215 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3218 /* Set up variables for computing the stop position from text
3219 property changes. */
3220 XSETBUFFER (object
, current_buffer
);
3221 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3224 /* Get the interval containing IT's position. Value is a null
3225 interval if there isn't such an interval. */
3226 position
= make_number (charpos
);
3227 iv
= validate_interval_range (object
, &position
, &position
, 0);
3228 if (!NULL_INTERVAL_P (iv
))
3230 Lisp_Object values_here
[LAST_PROP_IDX
];
3233 /* Get properties here. */
3234 for (p
= it_props
; p
->handler
; ++p
)
3235 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3237 /* Look for an interval following iv that has different
3239 for (next_iv
= next_interval (iv
);
3240 (!NULL_INTERVAL_P (next_iv
)
3242 || XFASTINT (limit
) > next_iv
->position
));
3243 next_iv
= next_interval (next_iv
))
3245 for (p
= it_props
; p
->handler
; ++p
)
3247 Lisp_Object new_value
;
3249 new_value
= textget (next_iv
->plist
, *p
->name
);
3250 if (!EQ (values_here
[p
->idx
], new_value
))
3258 if (!NULL_INTERVAL_P (next_iv
))
3260 if (INTEGERP (limit
)
3261 && next_iv
->position
>= XFASTINT (limit
))
3262 /* No text property change up to limit. */
3263 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3265 /* Text properties change in next_iv. */
3266 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3270 if (it
->cmp_it
.id
< 0)
3272 EMACS_INT stoppos
= it
->end_charpos
;
3274 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3276 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3277 stoppos
, it
->string
);
3280 xassert (STRINGP (it
->string
)
3281 || (it
->stop_charpos
>= BEGV
3282 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3286 /* Return the position of the next overlay change after POS in
3287 current_buffer. Value is point-max if no overlay change
3288 follows. This is like `next-overlay-change' but doesn't use
3292 next_overlay_change (EMACS_INT pos
)
3294 ptrdiff_t i
, noverlays
;
3296 Lisp_Object
*overlays
;
3298 /* Get all overlays at the given position. */
3299 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3301 /* If any of these overlays ends before endpos,
3302 use its ending point instead. */
3303 for (i
= 0; i
< noverlays
; ++i
)
3308 oend
= OVERLAY_END (overlays
[i
]);
3309 oendpos
= OVERLAY_POSITION (oend
);
3310 endpos
= min (endpos
, oendpos
);
3316 /* How many characters forward to search for a display property or
3317 display string. Searching too far forward makes the bidi display
3318 sluggish, especially in small windows. */
3319 #define MAX_DISP_SCAN 250
3321 /* Return the character position of a display string at or after
3322 position specified by POSITION. If no display string exists at or
3323 after POSITION, return ZV. A display string is either an overlay
3324 with `display' property whose value is a string, or a `display'
3325 text property whose value is a string. STRING is data about the
3326 string to iterate; if STRING->lstring is nil, we are iterating a
3327 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3328 on a GUI frame. DISP_PROP is set to zero if we searched
3329 MAX_DISP_SCAN characters forward without finding any display
3330 strings, non-zero otherwise. It is set to 2 if the display string
3331 uses any kind of `(space ...)' spec that will produce a stretch of
3332 white space in the text area. */
3334 compute_display_string_pos (struct text_pos
*position
,
3335 struct bidi_string_data
*string
,
3336 int frame_window_p
, int *disp_prop
)
3338 /* OBJECT = nil means current buffer. */
3339 Lisp_Object object
=
3340 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3341 Lisp_Object pos
, spec
, limpos
;
3342 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3343 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3344 EMACS_INT begb
= string_p
? 0 : BEGV
;
3345 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3347 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3348 struct text_pos tpos
;
3354 /* We don't support display properties whose values are strings
3355 that have display string properties. */
3356 || string
->from_disp_str
3357 /* C strings cannot have display properties. */
3358 || (string
->s
&& !STRINGP (object
)))
3364 /* If the character at CHARPOS is where the display string begins,
3366 pos
= make_number (charpos
);
3367 if (STRINGP (object
))
3368 bufpos
= string
->bufpos
;
3372 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3374 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3377 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3385 /* Look forward for the first character with a `display' property
3386 that will replace the underlying text when displayed. */
3387 limpos
= make_number (lim
);
3389 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3390 CHARPOS (tpos
) = XFASTINT (pos
);
3391 if (CHARPOS (tpos
) >= lim
)
3396 if (STRINGP (object
))
3397 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3399 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3400 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3401 if (!STRINGP (object
))
3402 bufpos
= CHARPOS (tpos
);
3403 } while (NILP (spec
)
3404 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3405 bufpos
, frame_window_p
)));
3409 return CHARPOS (tpos
);
3412 /* Return the character position of the end of the display string that
3413 started at CHARPOS. If there's no display string at CHARPOS,
3414 return -1. A display string is either an overlay with `display'
3415 property whose value is a string or a `display' text property whose
3416 value is a string. */
3418 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3420 /* OBJECT = nil means current buffer. */
3421 Lisp_Object object
=
3422 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3423 Lisp_Object pos
= make_number (charpos
);
3425 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3427 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3430 /* It could happen that the display property or overlay was removed
3431 since we found it in compute_display_string_pos above. One way
3432 this can happen is if JIT font-lock was called (through
3433 handle_fontified_prop), and jit-lock-functions remove text
3434 properties or overlays from the portion of buffer that includes
3435 CHARPOS. Muse mode is known to do that, for example. In this
3436 case, we return -1 to the caller, to signal that no display
3437 string is actually present at CHARPOS. See bidi_fetch_char for
3438 how this is handled.
3440 An alternative would be to never look for display properties past
3441 it->stop_charpos. But neither compute_display_string_pos nor
3442 bidi_fetch_char that calls it know or care where the next
3444 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3447 /* Look forward for the first character where the `display' property
3449 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3451 return XFASTINT (pos
);
3456 /***********************************************************************
3458 ***********************************************************************/
3460 /* Handle changes in the `fontified' property of the current buffer by
3461 calling hook functions from Qfontification_functions to fontify
3464 static enum prop_handled
3465 handle_fontified_prop (struct it
*it
)
3467 Lisp_Object prop
, pos
;
3468 enum prop_handled handled
= HANDLED_NORMALLY
;
3470 if (!NILP (Vmemory_full
))
3473 /* Get the value of the `fontified' property at IT's current buffer
3474 position. (The `fontified' property doesn't have a special
3475 meaning in strings.) If the value is nil, call functions from
3476 Qfontification_functions. */
3477 if (!STRINGP (it
->string
)
3479 && !NILP (Vfontification_functions
)
3480 && !NILP (Vrun_hooks
)
3481 && (pos
= make_number (IT_CHARPOS (*it
)),
3482 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3483 /* Ignore the special cased nil value always present at EOB since
3484 no amount of fontifying will be able to change it. */
3485 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3487 int count
= SPECPDL_INDEX ();
3489 struct buffer
*obuf
= current_buffer
;
3490 int begv
= BEGV
, zv
= ZV
;
3491 int old_clip_changed
= current_buffer
->clip_changed
;
3493 val
= Vfontification_functions
;
3494 specbind (Qfontification_functions
, Qnil
);
3496 xassert (it
->end_charpos
== ZV
);
3498 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3499 safe_call1 (val
, pos
);
3502 Lisp_Object fns
, fn
;
3503 struct gcpro gcpro1
, gcpro2
;
3508 for (; CONSP (val
); val
= XCDR (val
))
3514 /* A value of t indicates this hook has a local
3515 binding; it means to run the global binding too.
3516 In a global value, t should not occur. If it
3517 does, we must ignore it to avoid an endless
3519 for (fns
= Fdefault_value (Qfontification_functions
);
3525 safe_call1 (fn
, pos
);
3529 safe_call1 (fn
, pos
);
3535 unbind_to (count
, Qnil
);
3537 /* Fontification functions routinely call `save-restriction'.
3538 Normally, this tags clip_changed, which can confuse redisplay
3539 (see discussion in Bug#6671). Since we don't perform any
3540 special handling of fontification changes in the case where
3541 `save-restriction' isn't called, there's no point doing so in
3542 this case either. So, if the buffer's restrictions are
3543 actually left unchanged, reset clip_changed. */
3544 if (obuf
== current_buffer
)
3546 if (begv
== BEGV
&& zv
== ZV
)
3547 current_buffer
->clip_changed
= old_clip_changed
;
3549 /* There isn't much we can reasonably do to protect against
3550 misbehaving fontification, but here's a fig leaf. */
3551 else if (!NILP (BVAR (obuf
, name
)))
3552 set_buffer_internal_1 (obuf
);
3554 /* The fontification code may have added/removed text.
3555 It could do even a lot worse, but let's at least protect against
3556 the most obvious case where only the text past `pos' gets changed',
3557 as is/was done in grep.el where some escapes sequences are turned
3558 into face properties (bug#7876). */
3559 it
->end_charpos
= ZV
;
3561 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3562 something. This avoids an endless loop if they failed to
3563 fontify the text for which reason ever. */
3564 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3565 handled
= HANDLED_RECOMPUTE_PROPS
;
3573 /***********************************************************************
3575 ***********************************************************************/
3577 /* Set up iterator IT from face properties at its current position.
3578 Called from handle_stop. */
3580 static enum prop_handled
3581 handle_face_prop (struct it
*it
)
3584 EMACS_INT next_stop
;
3586 if (!STRINGP (it
->string
))
3589 = face_at_buffer_position (it
->w
,
3591 it
->region_beg_charpos
,
3592 it
->region_end_charpos
,
3595 + TEXT_PROP_DISTANCE_LIMIT
),
3596 0, it
->base_face_id
);
3598 /* Is this a start of a run of characters with box face?
3599 Caveat: this can be called for a freshly initialized
3600 iterator; face_id is -1 in this case. We know that the new
3601 face will not change until limit, i.e. if the new face has a
3602 box, all characters up to limit will have one. But, as
3603 usual, we don't know whether limit is really the end. */
3604 if (new_face_id
!= it
->face_id
)
3606 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3608 /* If new face has a box but old face has not, this is
3609 the start of a run of characters with box, i.e. it has
3610 a shadow on the left side. The value of face_id of the
3611 iterator will be -1 if this is the initial call that gets
3612 the face. In this case, we have to look in front of IT's
3613 position and see whether there is a face != new_face_id. */
3614 it
->start_of_box_run_p
3615 = (new_face
->box
!= FACE_NO_BOX
3616 && (it
->face_id
>= 0
3617 || IT_CHARPOS (*it
) == BEG
3618 || new_face_id
!= face_before_it_pos (it
)));
3619 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3627 Lisp_Object from_overlay
3628 = (it
->current
.overlay_string_index
>= 0
3629 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3632 /* See if we got to this string directly or indirectly from
3633 an overlay property. That includes the before-string or
3634 after-string of an overlay, strings in display properties
3635 provided by an overlay, their text properties, etc.
3637 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3638 if (! NILP (from_overlay
))
3639 for (i
= it
->sp
- 1; i
>= 0; i
--)
3641 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3643 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3644 else if (! NILP (it
->stack
[i
].from_overlay
))
3645 from_overlay
= it
->stack
[i
].from_overlay
;
3647 if (!NILP (from_overlay
))
3651 if (! NILP (from_overlay
))
3653 bufpos
= IT_CHARPOS (*it
);
3654 /* For a string from an overlay, the base face depends
3655 only on text properties and ignores overlays. */
3657 = face_for_overlay_string (it
->w
,
3659 it
->region_beg_charpos
,
3660 it
->region_end_charpos
,
3663 + TEXT_PROP_DISTANCE_LIMIT
),
3671 /* For strings from a `display' property, use the face at
3672 IT's current buffer position as the base face to merge
3673 with, so that overlay strings appear in the same face as
3674 surrounding text, unless they specify their own
3676 base_face_id
= it
->string_from_prefix_prop_p
3678 : underlying_face_id (it
);
3681 new_face_id
= face_at_string_position (it
->w
,
3683 IT_STRING_CHARPOS (*it
),
3685 it
->region_beg_charpos
,
3686 it
->region_end_charpos
,
3690 /* Is this a start of a run of characters with box? Caveat:
3691 this can be called for a freshly allocated iterator; face_id
3692 is -1 is this case. We know that the new face will not
3693 change until the next check pos, i.e. if the new face has a
3694 box, all characters up to that position will have a
3695 box. But, as usual, we don't know whether that position
3696 is really the end. */
3697 if (new_face_id
!= it
->face_id
)
3699 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3700 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3702 /* If new face has a box but old face hasn't, this is the
3703 start of a run of characters with box, i.e. it has a
3704 shadow on the left side. */
3705 it
->start_of_box_run_p
3706 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3707 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3711 it
->face_id
= new_face_id
;
3712 return HANDLED_NORMALLY
;
3716 /* Return the ID of the face ``underlying'' IT's current position,
3717 which is in a string. If the iterator is associated with a
3718 buffer, return the face at IT's current buffer position.
3719 Otherwise, use the iterator's base_face_id. */
3722 underlying_face_id (struct it
*it
)
3724 int face_id
= it
->base_face_id
, i
;
3726 xassert (STRINGP (it
->string
));
3728 for (i
= it
->sp
- 1; i
>= 0; --i
)
3729 if (NILP (it
->stack
[i
].string
))
3730 face_id
= it
->stack
[i
].face_id
;
3736 /* Compute the face one character before or after the current position
3737 of IT, in the visual order. BEFORE_P non-zero means get the face
3738 in front (to the left in L2R paragraphs, to the right in R2L
3739 paragraphs) of IT's screen position. Value is the ID of the face. */
3742 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3745 EMACS_INT next_check_charpos
;
3747 void *it_copy_data
= NULL
;
3749 xassert (it
->s
== NULL
);
3751 if (STRINGP (it
->string
))
3753 EMACS_INT bufpos
, charpos
;
3756 /* No face change past the end of the string (for the case
3757 we are padding with spaces). No face change before the
3759 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3760 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3765 /* Set charpos to the position before or after IT's current
3766 position, in the logical order, which in the non-bidi
3767 case is the same as the visual order. */
3769 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3770 else if (it
->what
== IT_COMPOSITION
)
3771 /* For composition, we must check the character after the
3773 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3775 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3781 /* With bidi iteration, the character before the current
3782 in the visual order cannot be found by simple
3783 iteration, because "reverse" reordering is not
3784 supported. Instead, we need to use the move_it_*
3785 family of functions. */
3786 /* Ignore face changes before the first visible
3787 character on this display line. */
3788 if (it
->current_x
<= it
->first_visible_x
)
3790 SAVE_IT (it_copy
, *it
, it_copy_data
);
3791 /* Implementation note: Since move_it_in_display_line
3792 works in the iterator geometry, and thinks the first
3793 character is always the leftmost, even in R2L lines,
3794 we don't need to distinguish between the R2L and L2R
3796 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3797 it_copy
.current_x
- 1, MOVE_TO_X
);
3798 charpos
= IT_STRING_CHARPOS (it_copy
);
3799 RESTORE_IT (it
, it
, it_copy_data
);
3803 /* Set charpos to the string position of the character
3804 that comes after IT's current position in the visual
3806 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3810 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3812 charpos
= it_copy
.bidi_it
.charpos
;
3815 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3817 if (it
->current
.overlay_string_index
>= 0)
3818 bufpos
= IT_CHARPOS (*it
);
3822 base_face_id
= underlying_face_id (it
);
3824 /* Get the face for ASCII, or unibyte. */
3825 face_id
= face_at_string_position (it
->w
,
3829 it
->region_beg_charpos
,
3830 it
->region_end_charpos
,
3831 &next_check_charpos
,
3834 /* Correct the face for charsets different from ASCII. Do it
3835 for the multibyte case only. The face returned above is
3836 suitable for unibyte text if IT->string is unibyte. */
3837 if (STRING_MULTIBYTE (it
->string
))
3839 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3840 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3842 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3844 c
= string_char_and_length (p
, &len
);
3845 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3850 struct text_pos pos
;
3852 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3853 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3856 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3857 pos
= it
->current
.pos
;
3862 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3865 if (it
->what
== IT_COMPOSITION
)
3867 /* For composition, we must check the position after
3869 pos
.charpos
+= it
->cmp_it
.nchars
;
3870 pos
.bytepos
+= it
->len
;
3873 INC_TEXT_POS (pos
, it
->multibyte_p
);
3880 /* With bidi iteration, the character before the current
3881 in the visual order cannot be found by simple
3882 iteration, because "reverse" reordering is not
3883 supported. Instead, we need to use the move_it_*
3884 family of functions. */
3885 /* Ignore face changes before the first visible
3886 character on this display line. */
3887 if (it
->current_x
<= it
->first_visible_x
)
3889 SAVE_IT (it_copy
, *it
, it_copy_data
);
3890 /* Implementation note: Since move_it_in_display_line
3891 works in the iterator geometry, and thinks the first
3892 character is always the leftmost, even in R2L lines,
3893 we don't need to distinguish between the R2L and L2R
3895 move_it_in_display_line (&it_copy
, ZV
,
3896 it_copy
.current_x
- 1, MOVE_TO_X
);
3897 pos
= it_copy
.current
.pos
;
3898 RESTORE_IT (it
, it
, it_copy_data
);
3902 /* Set charpos to the buffer position of the character
3903 that comes after IT's current position in the visual
3905 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3909 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3912 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3915 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3917 /* Determine face for CHARSET_ASCII, or unibyte. */
3918 face_id
= face_at_buffer_position (it
->w
,
3920 it
->region_beg_charpos
,
3921 it
->region_end_charpos
,
3922 &next_check_charpos
,
3925 /* Correct the face for charsets different from ASCII. Do it
3926 for the multibyte case only. The face returned above is
3927 suitable for unibyte text if current_buffer is unibyte. */
3928 if (it
->multibyte_p
)
3930 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3931 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3932 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3941 /***********************************************************************
3943 ***********************************************************************/
3945 /* Set up iterator IT from invisible properties at its current
3946 position. Called from handle_stop. */
3948 static enum prop_handled
3949 handle_invisible_prop (struct it
*it
)
3951 enum prop_handled handled
= HANDLED_NORMALLY
;
3953 if (STRINGP (it
->string
))
3955 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3957 /* Get the value of the invisible text property at the
3958 current position. Value will be nil if there is no such
3960 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3961 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3964 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3968 handled
= HANDLED_RECOMPUTE_PROPS
;
3970 /* Get the position at which the next change of the
3971 invisible text property can be found in IT->string.
3972 Value will be nil if the property value is the same for
3973 all the rest of IT->string. */
3974 XSETINT (limit
, SCHARS (it
->string
));
3975 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3978 /* Text at current position is invisible. The next
3979 change in the property is at position end_charpos.
3980 Move IT's current position to that position. */
3981 if (INTEGERP (end_charpos
)
3982 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3984 struct text_pos old
;
3987 old
= it
->current
.string_pos
;
3988 oldpos
= CHARPOS (old
);
3991 if (it
->bidi_it
.first_elt
3992 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3993 bidi_paragraph_init (it
->paragraph_embedding
,
3995 /* Bidi-iterate out of the invisible text. */
3998 bidi_move_to_visually_next (&it
->bidi_it
);
4000 while (oldpos
<= it
->bidi_it
.charpos
4001 && it
->bidi_it
.charpos
< endpos
);
4003 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4004 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4005 if (IT_CHARPOS (*it
) >= endpos
)
4006 it
->prev_stop
= endpos
;
4010 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4011 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4016 /* The rest of the string is invisible. If this is an
4017 overlay string, proceed with the next overlay string
4018 or whatever comes and return a character from there. */
4019 if (it
->current
.overlay_string_index
>= 0)
4021 next_overlay_string (it
);
4022 /* Don't check for overlay strings when we just
4023 finished processing them. */
4024 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4028 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4029 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4037 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4038 Lisp_Object pos
, prop
, overlay
;
4040 /* First of all, is there invisible text at this position? */
4041 tem
= start_charpos
= IT_CHARPOS (*it
);
4042 pos
= make_number (tem
);
4043 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4045 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4047 /* If we are on invisible text, skip over it. */
4048 if (invis_p
&& start_charpos
< it
->end_charpos
)
4050 /* Record whether we have to display an ellipsis for the
4052 int display_ellipsis_p
= invis_p
== 2;
4054 handled
= HANDLED_RECOMPUTE_PROPS
;
4056 /* Loop skipping over invisible text. The loop is left at
4057 ZV or with IT on the first char being visible again. */
4060 /* Try to skip some invisible text. Return value is the
4061 position reached which can be equal to where we start
4062 if there is nothing invisible there. This skips both
4063 over invisible text properties and overlays with
4064 invisible property. */
4065 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4067 /* If we skipped nothing at all we weren't at invisible
4068 text in the first place. If everything to the end of
4069 the buffer was skipped, end the loop. */
4070 if (newpos
== tem
|| newpos
>= ZV
)
4074 /* We skipped some characters but not necessarily
4075 all there are. Check if we ended up on visible
4076 text. Fget_char_property returns the property of
4077 the char before the given position, i.e. if we
4078 get invis_p = 0, this means that the char at
4079 newpos is visible. */
4080 pos
= make_number (newpos
);
4081 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4082 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4085 /* If we ended up on invisible text, proceed to
4086 skip starting with next_stop. */
4090 /* If there are adjacent invisible texts, don't lose the
4091 second one's ellipsis. */
4093 display_ellipsis_p
= 1;
4097 /* The position newpos is now either ZV or on visible text. */
4100 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4102 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4104 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4106 /* If the invisible text ends on a newline or on a
4107 character after a newline, we can avoid the costly,
4108 character by character, bidi iteration to NEWPOS, and
4109 instead simply reseat the iterator there. That's
4110 because all bidi reordering information is tossed at
4111 the newline. This is a big win for modes that hide
4112 complete lines, like Outline, Org, etc. */
4113 if (on_newline
|| after_newline
)
4115 struct text_pos tpos
;
4116 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4118 SET_TEXT_POS (tpos
, newpos
, bpos
);
4119 reseat_1 (it
, tpos
, 0);
4120 /* If we reseat on a newline/ZV, we need to prep the
4121 bidi iterator for advancing to the next character
4122 after the newline/EOB, keeping the current paragraph
4123 direction (so that PRODUCE_GLYPHS does TRT wrt
4124 prepending/appending glyphs to a glyph row). */
4127 it
->bidi_it
.first_elt
= 0;
4128 it
->bidi_it
.paragraph_dir
= pdir
;
4129 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4130 it
->bidi_it
.nchars
= 1;
4131 it
->bidi_it
.ch_len
= 1;
4134 else /* Must use the slow method. */
4136 /* With bidi iteration, the region of invisible text
4137 could start and/or end in the middle of a
4138 non-base embedding level. Therefore, we need to
4139 skip invisible text using the bidi iterator,
4140 starting at IT's current position, until we find
4141 ourselves outside of the invisible text.
4142 Skipping invisible text _after_ bidi iteration
4143 avoids affecting the visual order of the
4144 displayed text when invisible properties are
4145 added or removed. */
4146 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4148 /* If we were `reseat'ed to a new paragraph,
4149 determine the paragraph base direction. We
4150 need to do it now because
4151 next_element_from_buffer may not have a
4152 chance to do it, if we are going to skip any
4153 text at the beginning, which resets the
4155 bidi_paragraph_init (it
->paragraph_embedding
,
4160 bidi_move_to_visually_next (&it
->bidi_it
);
4162 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4163 && it
->bidi_it
.charpos
< newpos
);
4164 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4165 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4166 /* If we overstepped NEWPOS, record its position in
4167 the iterator, so that we skip invisible text if
4168 later the bidi iteration lands us in the
4169 invisible region again. */
4170 if (IT_CHARPOS (*it
) >= newpos
)
4171 it
->prev_stop
= newpos
;
4176 IT_CHARPOS (*it
) = newpos
;
4177 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4180 /* If there are before-strings at the start of invisible
4181 text, and the text is invisible because of a text
4182 property, arrange to show before-strings because 20.x did
4183 it that way. (If the text is invisible because of an
4184 overlay property instead of a text property, this is
4185 already handled in the overlay code.) */
4187 && get_overlay_strings (it
, it
->stop_charpos
))
4189 handled
= HANDLED_RECOMPUTE_PROPS
;
4190 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4192 else if (display_ellipsis_p
)
4194 /* Make sure that the glyphs of the ellipsis will get
4195 correct `charpos' values. If we would not update
4196 it->position here, the glyphs would belong to the
4197 last visible character _before_ the invisible
4198 text, which confuses `set_cursor_from_row'.
4200 We use the last invisible position instead of the
4201 first because this way the cursor is always drawn on
4202 the first "." of the ellipsis, whenever PT is inside
4203 the invisible text. Otherwise the cursor would be
4204 placed _after_ the ellipsis when the point is after the
4205 first invisible character. */
4206 if (!STRINGP (it
->object
))
4208 it
->position
.charpos
= newpos
- 1;
4209 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4212 /* Let the ellipsis display before
4213 considering any properties of the following char.
4214 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4215 handled
= HANDLED_RETURN
;
4224 /* Make iterator IT return `...' next.
4225 Replaces LEN characters from buffer. */
4228 setup_for_ellipsis (struct it
*it
, int len
)
4230 /* Use the display table definition for `...'. Invalid glyphs
4231 will be handled by the method returning elements from dpvec. */
4232 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4234 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4235 it
->dpvec
= v
->contents
;
4236 it
->dpend
= v
->contents
+ v
->header
.size
;
4240 /* Default `...'. */
4241 it
->dpvec
= default_invis_vector
;
4242 it
->dpend
= default_invis_vector
+ 3;
4245 it
->dpvec_char_len
= len
;
4246 it
->current
.dpvec_index
= 0;
4247 it
->dpvec_face_id
= -1;
4249 /* Remember the current face id in case glyphs specify faces.
4250 IT's face is restored in set_iterator_to_next.
4251 saved_face_id was set to preceding char's face in handle_stop. */
4252 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4253 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4255 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4261 /***********************************************************************
4263 ***********************************************************************/
4265 /* Set up iterator IT from `display' property at its current position.
4266 Called from handle_stop.
4267 We return HANDLED_RETURN if some part of the display property
4268 overrides the display of the buffer text itself.
4269 Otherwise we return HANDLED_NORMALLY. */
4271 static enum prop_handled
4272 handle_display_prop (struct it
*it
)
4274 Lisp_Object propval
, object
, overlay
;
4275 struct text_pos
*position
;
4277 /* Nonzero if some property replaces the display of the text itself. */
4278 int display_replaced_p
= 0;
4280 if (STRINGP (it
->string
))
4282 object
= it
->string
;
4283 position
= &it
->current
.string_pos
;
4284 bufpos
= CHARPOS (it
->current
.pos
);
4288 XSETWINDOW (object
, it
->w
);
4289 position
= &it
->current
.pos
;
4290 bufpos
= CHARPOS (*position
);
4293 /* Reset those iterator values set from display property values. */
4294 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4295 it
->space_width
= Qnil
;
4296 it
->font_height
= Qnil
;
4299 /* We don't support recursive `display' properties, i.e. string
4300 values that have a string `display' property, that have a string
4301 `display' property etc. */
4302 if (!it
->string_from_display_prop_p
)
4303 it
->area
= TEXT_AREA
;
4305 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4306 Qdisplay
, object
, &overlay
);
4308 return HANDLED_NORMALLY
;
4309 /* Now OVERLAY is the overlay that gave us this property, or nil
4310 if it was a text property. */
4312 if (!STRINGP (it
->string
))
4313 object
= it
->w
->buffer
;
4315 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4317 FRAME_WINDOW_P (it
->f
));
4319 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4322 /* Subroutine of handle_display_prop. Returns non-zero if the display
4323 specification in SPEC is a replacing specification, i.e. it would
4324 replace the text covered by `display' property with something else,
4325 such as an image or a display string. If SPEC includes any kind or
4326 `(space ...) specification, the value is 2; this is used by
4327 compute_display_string_pos, which see.
4329 See handle_single_display_spec for documentation of arguments.
4330 frame_window_p is non-zero if the window being redisplayed is on a
4331 GUI frame; this argument is used only if IT is NULL, see below.
4333 IT can be NULL, if this is called by the bidi reordering code
4334 through compute_display_string_pos, which see. In that case, this
4335 function only examines SPEC, but does not otherwise "handle" it, in
4336 the sense that it doesn't set up members of IT from the display
4339 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4340 Lisp_Object overlay
, struct text_pos
*position
,
4341 EMACS_INT bufpos
, int frame_window_p
)
4343 int replacing_p
= 0;
4347 /* Simple specifications. */
4348 && !EQ (XCAR (spec
), Qimage
)
4349 && !EQ (XCAR (spec
), Qspace
)
4350 && !EQ (XCAR (spec
), Qwhen
)
4351 && !EQ (XCAR (spec
), Qslice
)
4352 && !EQ (XCAR (spec
), Qspace_width
)
4353 && !EQ (XCAR (spec
), Qheight
)
4354 && !EQ (XCAR (spec
), Qraise
)
4355 /* Marginal area specifications. */
4356 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4357 && !EQ (XCAR (spec
), Qleft_fringe
)
4358 && !EQ (XCAR (spec
), Qright_fringe
)
4359 && !NILP (XCAR (spec
)))
4361 for (; CONSP (spec
); spec
= XCDR (spec
))
4363 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4364 overlay
, position
, bufpos
,
4365 replacing_p
, frame_window_p
)))
4368 /* If some text in a string is replaced, `position' no
4369 longer points to the position of `object'. */
4370 if (!it
|| STRINGP (object
))
4375 else if (VECTORP (spec
))
4378 for (i
= 0; i
< ASIZE (spec
); ++i
)
4379 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4380 overlay
, position
, bufpos
,
4381 replacing_p
, frame_window_p
)))
4384 /* If some text in a string is replaced, `position' no
4385 longer points to the position of `object'. */
4386 if (!it
|| STRINGP (object
))
4392 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4393 position
, bufpos
, 0,
4401 /* Value is the position of the end of the `display' property starting
4402 at START_POS in OBJECT. */
4404 static struct text_pos
4405 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4408 struct text_pos end_pos
;
4410 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4411 Qdisplay
, object
, Qnil
);
4412 CHARPOS (end_pos
) = XFASTINT (end
);
4413 if (STRINGP (object
))
4414 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4416 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4422 /* Set up IT from a single `display' property specification SPEC. OBJECT
4423 is the object in which the `display' property was found. *POSITION
4424 is the position in OBJECT at which the `display' property was found.
4425 BUFPOS is the buffer position of OBJECT (different from POSITION if
4426 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4427 previously saw a display specification which already replaced text
4428 display with something else, for example an image; we ignore such
4429 properties after the first one has been processed.
4431 OVERLAY is the overlay this `display' property came from,
4432 or nil if it was a text property.
4434 If SPEC is a `space' or `image' specification, and in some other
4435 cases too, set *POSITION to the position where the `display'
4438 If IT is NULL, only examine the property specification in SPEC, but
4439 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4440 is intended to be displayed in a window on a GUI frame.
4442 Value is non-zero if something was found which replaces the display
4443 of buffer or string text. */
4446 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4447 Lisp_Object overlay
, struct text_pos
*position
,
4448 EMACS_INT bufpos
, int display_replaced_p
,
4452 Lisp_Object location
, value
;
4453 struct text_pos start_pos
= *position
;
4456 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4457 If the result is non-nil, use VALUE instead of SPEC. */
4459 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4468 if (!NILP (form
) && !EQ (form
, Qt
))
4470 int count
= SPECPDL_INDEX ();
4471 struct gcpro gcpro1
;
4473 /* Bind `object' to the object having the `display' property, a
4474 buffer or string. Bind `position' to the position in the
4475 object where the property was found, and `buffer-position'
4476 to the current position in the buffer. */
4479 XSETBUFFER (object
, current_buffer
);
4480 specbind (Qobject
, object
);
4481 specbind (Qposition
, make_number (CHARPOS (*position
)));
4482 specbind (Qbuffer_position
, make_number (bufpos
));
4484 form
= safe_eval (form
);
4486 unbind_to (count
, Qnil
);
4492 /* Handle `(height HEIGHT)' specifications. */
4494 && EQ (XCAR (spec
), Qheight
)
4495 && CONSP (XCDR (spec
)))
4499 if (!FRAME_WINDOW_P (it
->f
))
4502 it
->font_height
= XCAR (XCDR (spec
));
4503 if (!NILP (it
->font_height
))
4505 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4506 int new_height
= -1;
4508 if (CONSP (it
->font_height
)
4509 && (EQ (XCAR (it
->font_height
), Qplus
)
4510 || EQ (XCAR (it
->font_height
), Qminus
))
4511 && CONSP (XCDR (it
->font_height
))
4512 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4514 /* `(+ N)' or `(- N)' where N is an integer. */
4515 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4516 if (EQ (XCAR (it
->font_height
), Qplus
))
4518 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4520 else if (FUNCTIONP (it
->font_height
))
4522 /* Call function with current height as argument.
4523 Value is the new height. */
4525 height
= safe_call1 (it
->font_height
,
4526 face
->lface
[LFACE_HEIGHT_INDEX
]);
4527 if (NUMBERP (height
))
4528 new_height
= XFLOATINT (height
);
4530 else if (NUMBERP (it
->font_height
))
4532 /* Value is a multiple of the canonical char height. */
4535 f
= FACE_FROM_ID (it
->f
,
4536 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4537 new_height
= (XFLOATINT (it
->font_height
)
4538 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4542 /* Evaluate IT->font_height with `height' bound to the
4543 current specified height to get the new height. */
4544 int count
= SPECPDL_INDEX ();
4546 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4547 value
= safe_eval (it
->font_height
);
4548 unbind_to (count
, Qnil
);
4550 if (NUMBERP (value
))
4551 new_height
= XFLOATINT (value
);
4555 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4562 /* Handle `(space-width WIDTH)'. */
4564 && EQ (XCAR (spec
), Qspace_width
)
4565 && CONSP (XCDR (spec
)))
4569 if (!FRAME_WINDOW_P (it
->f
))
4572 value
= XCAR (XCDR (spec
));
4573 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4574 it
->space_width
= value
;
4580 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4582 && EQ (XCAR (spec
), Qslice
))
4588 if (!FRAME_WINDOW_P (it
->f
))
4591 if (tem
= XCDR (spec
), CONSP (tem
))
4593 it
->slice
.x
= XCAR (tem
);
4594 if (tem
= XCDR (tem
), CONSP (tem
))
4596 it
->slice
.y
= XCAR (tem
);
4597 if (tem
= XCDR (tem
), CONSP (tem
))
4599 it
->slice
.width
= XCAR (tem
);
4600 if (tem
= XCDR (tem
), CONSP (tem
))
4601 it
->slice
.height
= XCAR (tem
);
4610 /* Handle `(raise FACTOR)'. */
4612 && EQ (XCAR (spec
), Qraise
)
4613 && CONSP (XCDR (spec
)))
4617 if (!FRAME_WINDOW_P (it
->f
))
4620 #ifdef HAVE_WINDOW_SYSTEM
4621 value
= XCAR (XCDR (spec
));
4622 if (NUMBERP (value
))
4624 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4625 it
->voffset
= - (XFLOATINT (value
)
4626 * (FONT_HEIGHT (face
->font
)));
4628 #endif /* HAVE_WINDOW_SYSTEM */
4634 /* Don't handle the other kinds of display specifications
4635 inside a string that we got from a `display' property. */
4636 if (it
&& it
->string_from_display_prop_p
)
4639 /* Characters having this form of property are not displayed, so
4640 we have to find the end of the property. */
4643 start_pos
= *position
;
4644 *position
= display_prop_end (it
, object
, start_pos
);
4648 /* Stop the scan at that end position--we assume that all
4649 text properties change there. */
4651 it
->stop_charpos
= position
->charpos
;
4653 /* Handle `(left-fringe BITMAP [FACE])'
4654 and `(right-fringe BITMAP [FACE])'. */
4656 && (EQ (XCAR (spec
), Qleft_fringe
)
4657 || EQ (XCAR (spec
), Qright_fringe
))
4658 && CONSP (XCDR (spec
)))
4664 if (!FRAME_WINDOW_P (it
->f
))
4665 /* If we return here, POSITION has been advanced
4666 across the text with this property. */
4669 else if (!frame_window_p
)
4672 #ifdef HAVE_WINDOW_SYSTEM
4673 value
= XCAR (XCDR (spec
));
4674 if (!SYMBOLP (value
)
4675 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4676 /* If we return here, POSITION has been advanced
4677 across the text with this property. */
4682 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4684 if (CONSP (XCDR (XCDR (spec
))))
4686 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4687 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4693 /* Save current settings of IT so that we can restore them
4694 when we are finished with the glyph property value. */
4695 push_it (it
, position
);
4697 it
->area
= TEXT_AREA
;
4698 it
->what
= IT_IMAGE
;
4699 it
->image_id
= -1; /* no image */
4700 it
->position
= start_pos
;
4701 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4702 it
->method
= GET_FROM_IMAGE
;
4703 it
->from_overlay
= Qnil
;
4704 it
->face_id
= face_id
;
4705 it
->from_disp_prop_p
= 1;
4707 /* Say that we haven't consumed the characters with
4708 `display' property yet. The call to pop_it in
4709 set_iterator_to_next will clean this up. */
4710 *position
= start_pos
;
4712 if (EQ (XCAR (spec
), Qleft_fringe
))
4714 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4715 it
->left_user_fringe_face_id
= face_id
;
4719 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4720 it
->right_user_fringe_face_id
= face_id
;
4723 #endif /* HAVE_WINDOW_SYSTEM */
4727 /* Prepare to handle `((margin left-margin) ...)',
4728 `((margin right-margin) ...)' and `((margin nil) ...)'
4729 prefixes for display specifications. */
4730 location
= Qunbound
;
4731 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4735 value
= XCDR (spec
);
4737 value
= XCAR (value
);
4740 if (EQ (XCAR (tem
), Qmargin
)
4741 && (tem
= XCDR (tem
),
4742 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4744 || EQ (tem
, Qleft_margin
)
4745 || EQ (tem
, Qright_margin
))))
4749 if (EQ (location
, Qunbound
))
4755 /* After this point, VALUE is the property after any
4756 margin prefix has been stripped. It must be a string,
4757 an image specification, or `(space ...)'.
4759 LOCATION specifies where to display: `left-margin',
4760 `right-margin' or nil. */
4762 valid_p
= (STRINGP (value
)
4763 #ifdef HAVE_WINDOW_SYSTEM
4764 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4765 && valid_image_p (value
))
4766 #endif /* not HAVE_WINDOW_SYSTEM */
4767 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4769 if (valid_p
&& !display_replaced_p
)
4775 /* Callers need to know whether the display spec is any kind
4776 of `(space ...)' spec that is about to affect text-area
4778 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4783 /* Save current settings of IT so that we can restore them
4784 when we are finished with the glyph property value. */
4785 push_it (it
, position
);
4786 it
->from_overlay
= overlay
;
4787 it
->from_disp_prop_p
= 1;
4789 if (NILP (location
))
4790 it
->area
= TEXT_AREA
;
4791 else if (EQ (location
, Qleft_margin
))
4792 it
->area
= LEFT_MARGIN_AREA
;
4794 it
->area
= RIGHT_MARGIN_AREA
;
4796 if (STRINGP (value
))
4799 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4800 it
->current
.overlay_string_index
= -1;
4801 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4802 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4803 it
->method
= GET_FROM_STRING
;
4804 it
->stop_charpos
= 0;
4806 it
->base_level_stop
= 0;
4807 it
->string_from_display_prop_p
= 1;
4808 /* Say that we haven't consumed the characters with
4809 `display' property yet. The call to pop_it in
4810 set_iterator_to_next will clean this up. */
4811 if (BUFFERP (object
))
4812 *position
= start_pos
;
4814 /* Force paragraph direction to be that of the parent
4815 object. If the parent object's paragraph direction is
4816 not yet determined, default to L2R. */
4817 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4818 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4820 it
->paragraph_embedding
= L2R
;
4822 /* Set up the bidi iterator for this display string. */
4825 it
->bidi_it
.string
.lstring
= it
->string
;
4826 it
->bidi_it
.string
.s
= NULL
;
4827 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4828 it
->bidi_it
.string
.bufpos
= bufpos
;
4829 it
->bidi_it
.string
.from_disp_str
= 1;
4830 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4831 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4834 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4836 it
->method
= GET_FROM_STRETCH
;
4838 *position
= it
->position
= start_pos
;
4839 retval
= 1 + (it
->area
== TEXT_AREA
);
4841 #ifdef HAVE_WINDOW_SYSTEM
4844 it
->what
= IT_IMAGE
;
4845 it
->image_id
= lookup_image (it
->f
, value
);
4846 it
->position
= start_pos
;
4847 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4848 it
->method
= GET_FROM_IMAGE
;
4850 /* Say that we haven't consumed the characters with
4851 `display' property yet. The call to pop_it in
4852 set_iterator_to_next will clean this up. */
4853 *position
= start_pos
;
4855 #endif /* HAVE_WINDOW_SYSTEM */
4860 /* Invalid property or property not supported. Restore
4861 POSITION to what it was before. */
4862 *position
= start_pos
;
4866 /* Check if PROP is a display property value whose text should be
4867 treated as intangible. OVERLAY is the overlay from which PROP
4868 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4869 specify the buffer position covered by PROP. */
4872 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4873 EMACS_INT charpos
, EMACS_INT bytepos
)
4875 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4876 struct text_pos position
;
4878 SET_TEXT_POS (position
, charpos
, bytepos
);
4879 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4880 &position
, charpos
, frame_window_p
);
4884 /* Return 1 if PROP is a display sub-property value containing STRING.
4886 Implementation note: this and the following function are really
4887 special cases of handle_display_spec and
4888 handle_single_display_spec, and should ideally use the same code.
4889 Until they do, these two pairs must be consistent and must be
4890 modified in sync. */
4893 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4895 if (EQ (string
, prop
))
4898 /* Skip over `when FORM'. */
4899 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4904 /* Actually, the condition following `when' should be eval'ed,
4905 like handle_single_display_spec does, and we should return
4906 zero if it evaluates to nil. However, this function is
4907 called only when the buffer was already displayed and some
4908 glyph in the glyph matrix was found to come from a display
4909 string. Therefore, the condition was already evaluated, and
4910 the result was non-nil, otherwise the display string wouldn't
4911 have been displayed and we would have never been called for
4912 this property. Thus, we can skip the evaluation and assume
4913 its result is non-nil. */
4918 /* Skip over `margin LOCATION'. */
4919 if (EQ (XCAR (prop
), Qmargin
))
4930 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4934 /* Return 1 if STRING appears in the `display' property PROP. */
4937 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4940 && !EQ (XCAR (prop
), Qwhen
)
4941 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4943 /* A list of sub-properties. */
4944 while (CONSP (prop
))
4946 if (single_display_spec_string_p (XCAR (prop
), string
))
4951 else if (VECTORP (prop
))
4953 /* A vector of sub-properties. */
4955 for (i
= 0; i
< ASIZE (prop
); ++i
)
4956 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4960 return single_display_spec_string_p (prop
, string
);
4965 /* Look for STRING in overlays and text properties in the current
4966 buffer, between character positions FROM and TO (excluding TO).
4967 BACK_P non-zero means look back (in this case, TO is supposed to be
4969 Value is the first character position where STRING was found, or
4970 zero if it wasn't found before hitting TO.
4972 This function may only use code that doesn't eval because it is
4973 called asynchronously from note_mouse_highlight. */
4976 string_buffer_position_lim (Lisp_Object string
,
4977 EMACS_INT from
, EMACS_INT to
, int back_p
)
4979 Lisp_Object limit
, prop
, pos
;
4982 pos
= make_number (max (from
, BEGV
));
4984 if (!back_p
) /* looking forward */
4986 limit
= make_number (min (to
, ZV
));
4987 while (!found
&& !EQ (pos
, limit
))
4989 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4990 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4993 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4997 else /* looking back */
4999 limit
= make_number (max (to
, BEGV
));
5000 while (!found
&& !EQ (pos
, limit
))
5002 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5003 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5006 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5011 return found
? XINT (pos
) : 0;
5014 /* Determine which buffer position in current buffer STRING comes from.
5015 AROUND_CHARPOS is an approximate position where it could come from.
5016 Value is the buffer position or 0 if it couldn't be determined.
5018 This function is necessary because we don't record buffer positions
5019 in glyphs generated from strings (to keep struct glyph small).
5020 This function may only use code that doesn't eval because it is
5021 called asynchronously from note_mouse_highlight. */
5024 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
5026 const int MAX_DISTANCE
= 1000;
5027 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
5028 around_charpos
+ MAX_DISTANCE
,
5032 found
= string_buffer_position_lim (string
, around_charpos
,
5033 around_charpos
- MAX_DISTANCE
, 1);
5039 /***********************************************************************
5040 `composition' property
5041 ***********************************************************************/
5043 /* Set up iterator IT from `composition' property at its current
5044 position. Called from handle_stop. */
5046 static enum prop_handled
5047 handle_composition_prop (struct it
*it
)
5049 Lisp_Object prop
, string
;
5050 EMACS_INT pos
, pos_byte
, start
, end
;
5052 if (STRINGP (it
->string
))
5056 pos
= IT_STRING_CHARPOS (*it
);
5057 pos_byte
= IT_STRING_BYTEPOS (*it
);
5058 string
= it
->string
;
5059 s
= SDATA (string
) + pos_byte
;
5060 it
->c
= STRING_CHAR (s
);
5064 pos
= IT_CHARPOS (*it
);
5065 pos_byte
= IT_BYTEPOS (*it
);
5067 it
->c
= FETCH_CHAR (pos_byte
);
5070 /* If there's a valid composition and point is not inside of the
5071 composition (in the case that the composition is from the current
5072 buffer), draw a glyph composed from the composition components. */
5073 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5074 && COMPOSITION_VALID_P (start
, end
, prop
)
5075 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5078 /* As we can't handle this situation (perhaps font-lock added
5079 a new composition), we just return here hoping that next
5080 redisplay will detect this composition much earlier. */
5081 return HANDLED_NORMALLY
;
5084 if (STRINGP (it
->string
))
5085 pos_byte
= string_char_to_byte (it
->string
, start
);
5087 pos_byte
= CHAR_TO_BYTE (start
);
5089 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5092 if (it
->cmp_it
.id
>= 0)
5095 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5096 it
->cmp_it
.nglyphs
= -1;
5100 return HANDLED_NORMALLY
;
5105 /***********************************************************************
5107 ***********************************************************************/
5109 /* The following structure is used to record overlay strings for
5110 later sorting in load_overlay_strings. */
5112 struct overlay_entry
5114 Lisp_Object overlay
;
5121 /* Set up iterator IT from overlay strings at its current position.
5122 Called from handle_stop. */
5124 static enum prop_handled
5125 handle_overlay_change (struct it
*it
)
5127 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5128 return HANDLED_RECOMPUTE_PROPS
;
5130 return HANDLED_NORMALLY
;
5134 /* Set up the next overlay string for delivery by IT, if there is an
5135 overlay string to deliver. Called by set_iterator_to_next when the
5136 end of the current overlay string is reached. If there are more
5137 overlay strings to display, IT->string and
5138 IT->current.overlay_string_index are set appropriately here.
5139 Otherwise IT->string is set to nil. */
5142 next_overlay_string (struct it
*it
)
5144 ++it
->current
.overlay_string_index
;
5145 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5147 /* No more overlay strings. Restore IT's settings to what
5148 they were before overlay strings were processed, and
5149 continue to deliver from current_buffer. */
5151 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5154 || (NILP (it
->string
)
5155 && it
->method
== GET_FROM_BUFFER
5156 && it
->stop_charpos
>= BEGV
5157 && it
->stop_charpos
<= it
->end_charpos
));
5158 it
->current
.overlay_string_index
= -1;
5159 it
->n_overlay_strings
= 0;
5160 it
->overlay_strings_charpos
= -1;
5161 /* If there's an empty display string on the stack, pop the
5162 stack, to resync the bidi iterator with IT's position. Such
5163 empty strings are pushed onto the stack in
5164 get_overlay_strings_1. */
5165 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5168 /* If we're at the end of the buffer, record that we have
5169 processed the overlay strings there already, so that
5170 next_element_from_buffer doesn't try it again. */
5171 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5172 it
->overlay_strings_at_end_processed_p
= 1;
5176 /* There are more overlay strings to process. If
5177 IT->current.overlay_string_index has advanced to a position
5178 where we must load IT->overlay_strings with more strings, do
5179 it. We must load at the IT->overlay_strings_charpos where
5180 IT->n_overlay_strings was originally computed; when invisible
5181 text is present, this might not be IT_CHARPOS (Bug#7016). */
5182 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5184 if (it
->current
.overlay_string_index
&& i
== 0)
5185 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5187 /* Initialize IT to deliver display elements from the overlay
5189 it
->string
= it
->overlay_strings
[i
];
5190 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5191 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5192 it
->method
= GET_FROM_STRING
;
5193 it
->stop_charpos
= 0;
5194 if (it
->cmp_it
.stop_pos
>= 0)
5195 it
->cmp_it
.stop_pos
= 0;
5197 it
->base_level_stop
= 0;
5199 /* Set up the bidi iterator for this overlay string. */
5202 it
->bidi_it
.string
.lstring
= it
->string
;
5203 it
->bidi_it
.string
.s
= NULL
;
5204 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5205 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5206 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5207 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5208 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5216 /* Compare two overlay_entry structures E1 and E2. Used as a
5217 comparison function for qsort in load_overlay_strings. Overlay
5218 strings for the same position are sorted so that
5220 1. All after-strings come in front of before-strings, except
5221 when they come from the same overlay.
5223 2. Within after-strings, strings are sorted so that overlay strings
5224 from overlays with higher priorities come first.
5226 2. Within before-strings, strings are sorted so that overlay
5227 strings from overlays with higher priorities come last.
5229 Value is analogous to strcmp. */
5233 compare_overlay_entries (const void *e1
, const void *e2
)
5235 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5236 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5239 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5241 /* Let after-strings appear in front of before-strings if
5242 they come from different overlays. */
5243 if (EQ (entry1
->overlay
, entry2
->overlay
))
5244 result
= entry1
->after_string_p
? 1 : -1;
5246 result
= entry1
->after_string_p
? -1 : 1;
5248 else if (entry1
->after_string_p
)
5249 /* After-strings sorted in order of decreasing priority. */
5250 result
= entry2
->priority
- entry1
->priority
;
5252 /* Before-strings sorted in order of increasing priority. */
5253 result
= entry1
->priority
- entry2
->priority
;
5259 /* Load the vector IT->overlay_strings with overlay strings from IT's
5260 current buffer position, or from CHARPOS if that is > 0. Set
5261 IT->n_overlays to the total number of overlay strings found.
5263 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5264 a time. On entry into load_overlay_strings,
5265 IT->current.overlay_string_index gives the number of overlay
5266 strings that have already been loaded by previous calls to this
5269 IT->add_overlay_start contains an additional overlay start
5270 position to consider for taking overlay strings from, if non-zero.
5271 This position comes into play when the overlay has an `invisible'
5272 property, and both before and after-strings. When we've skipped to
5273 the end of the overlay, because of its `invisible' property, we
5274 nevertheless want its before-string to appear.
5275 IT->add_overlay_start will contain the overlay start position
5278 Overlay strings are sorted so that after-string strings come in
5279 front of before-string strings. Within before and after-strings,
5280 strings are sorted by overlay priority. See also function
5281 compare_overlay_entries. */
5284 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5286 Lisp_Object overlay
, window
, str
, invisible
;
5287 struct Lisp_Overlay
*ov
;
5288 EMACS_INT start
, end
;
5290 int n
= 0, i
, j
, invis_p
;
5291 struct overlay_entry
*entries
5292 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5295 charpos
= IT_CHARPOS (*it
);
5297 /* Append the overlay string STRING of overlay OVERLAY to vector
5298 `entries' which has size `size' and currently contains `n'
5299 elements. AFTER_P non-zero means STRING is an after-string of
5301 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5304 Lisp_Object priority; \
5308 int new_size = 2 * size; \
5309 struct overlay_entry *old = entries; \
5311 (struct overlay_entry *) alloca (new_size \
5312 * sizeof *entries); \
5313 memcpy (entries, old, size * sizeof *entries); \
5317 entries[n].string = (STRING); \
5318 entries[n].overlay = (OVERLAY); \
5319 priority = Foverlay_get ((OVERLAY), Qpriority); \
5320 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5321 entries[n].after_string_p = (AFTER_P); \
5326 /* Process overlay before the overlay center. */
5327 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5329 XSETMISC (overlay
, ov
);
5330 xassert (OVERLAYP (overlay
));
5331 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5332 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5337 /* Skip this overlay if it doesn't start or end at IT's current
5339 if (end
!= charpos
&& start
!= charpos
)
5342 /* Skip this overlay if it doesn't apply to IT->w. */
5343 window
= Foverlay_get (overlay
, Qwindow
);
5344 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5347 /* If the text ``under'' the overlay is invisible, both before-
5348 and after-strings from this overlay are visible; start and
5349 end position are indistinguishable. */
5350 invisible
= Foverlay_get (overlay
, Qinvisible
);
5351 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5353 /* If overlay has a non-empty before-string, record it. */
5354 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5355 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5357 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5359 /* If overlay has a non-empty after-string, record it. */
5360 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5361 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5363 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5366 /* Process overlays after the overlay center. */
5367 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5369 XSETMISC (overlay
, ov
);
5370 xassert (OVERLAYP (overlay
));
5371 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5372 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5374 if (start
> charpos
)
5377 /* Skip this overlay if it doesn't start or end at IT's current
5379 if (end
!= charpos
&& start
!= charpos
)
5382 /* Skip this overlay if it doesn't apply to IT->w. */
5383 window
= Foverlay_get (overlay
, Qwindow
);
5384 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5387 /* If the text ``under'' the overlay is invisible, it has a zero
5388 dimension, and both before- and after-strings apply. */
5389 invisible
= Foverlay_get (overlay
, Qinvisible
);
5390 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5392 /* If overlay has a non-empty before-string, record it. */
5393 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5394 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5396 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5398 /* If overlay has a non-empty after-string, record it. */
5399 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5400 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5402 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5405 #undef RECORD_OVERLAY_STRING
5409 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5411 /* Record number of overlay strings, and where we computed it. */
5412 it
->n_overlay_strings
= n
;
5413 it
->overlay_strings_charpos
= charpos
;
5415 /* IT->current.overlay_string_index is the number of overlay strings
5416 that have already been consumed by IT. Copy some of the
5417 remaining overlay strings to IT->overlay_strings. */
5419 j
= it
->current
.overlay_string_index
;
5420 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5422 it
->overlay_strings
[i
] = entries
[j
].string
;
5423 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5430 /* Get the first chunk of overlay strings at IT's current buffer
5431 position, or at CHARPOS if that is > 0. Value is non-zero if at
5432 least one overlay string was found. */
5435 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5437 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5438 process. This fills IT->overlay_strings with strings, and sets
5439 IT->n_overlay_strings to the total number of strings to process.
5440 IT->pos.overlay_string_index has to be set temporarily to zero
5441 because load_overlay_strings needs this; it must be set to -1
5442 when no overlay strings are found because a zero value would
5443 indicate a position in the first overlay string. */
5444 it
->current
.overlay_string_index
= 0;
5445 load_overlay_strings (it
, charpos
);
5447 /* If we found overlay strings, set up IT to deliver display
5448 elements from the first one. Otherwise set up IT to deliver
5449 from current_buffer. */
5450 if (it
->n_overlay_strings
)
5452 /* Make sure we know settings in current_buffer, so that we can
5453 restore meaningful values when we're done with the overlay
5456 compute_stop_pos (it
);
5457 xassert (it
->face_id
>= 0);
5459 /* Save IT's settings. They are restored after all overlay
5460 strings have been processed. */
5461 xassert (!compute_stop_p
|| it
->sp
== 0);
5463 /* When called from handle_stop, there might be an empty display
5464 string loaded. In that case, don't bother saving it. But
5465 don't use this optimization with the bidi iterator, since we
5466 need the corresponding pop_it call to resync the bidi
5467 iterator's position with IT's position, after we are done
5468 with the overlay strings. (The corresponding call to pop_it
5469 in case of an empty display string is in
5470 next_overlay_string.) */
5472 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5475 /* Set up IT to deliver display elements from the first overlay
5477 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5478 it
->string
= it
->overlay_strings
[0];
5479 it
->from_overlay
= Qnil
;
5480 it
->stop_charpos
= 0;
5481 xassert (STRINGP (it
->string
));
5482 it
->end_charpos
= SCHARS (it
->string
);
5484 it
->base_level_stop
= 0;
5485 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5486 it
->method
= GET_FROM_STRING
;
5487 it
->from_disp_prop_p
= 0;
5489 /* Force paragraph direction to be that of the parent
5491 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5492 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5494 it
->paragraph_embedding
= L2R
;
5496 /* Set up the bidi iterator for this overlay string. */
5499 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5501 it
->bidi_it
.string
.lstring
= it
->string
;
5502 it
->bidi_it
.string
.s
= NULL
;
5503 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5504 it
->bidi_it
.string
.bufpos
= pos
;
5505 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5506 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5507 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5512 it
->current
.overlay_string_index
= -1;
5517 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5520 it
->method
= GET_FROM_BUFFER
;
5522 (void) get_overlay_strings_1 (it
, charpos
, 1);
5526 /* Value is non-zero if we found at least one overlay string. */
5527 return STRINGP (it
->string
);
5532 /***********************************************************************
5533 Saving and restoring state
5534 ***********************************************************************/
5536 /* Save current settings of IT on IT->stack. Called, for example,
5537 before setting up IT for an overlay string, to be able to restore
5538 IT's settings to what they were after the overlay string has been
5539 processed. If POSITION is non-NULL, it is the position to save on
5540 the stack instead of IT->position. */
5543 push_it (struct it
*it
, struct text_pos
*position
)
5545 struct iterator_stack_entry
*p
;
5547 xassert (it
->sp
< IT_STACK_SIZE
);
5548 p
= it
->stack
+ it
->sp
;
5550 p
->stop_charpos
= it
->stop_charpos
;
5551 p
->prev_stop
= it
->prev_stop
;
5552 p
->base_level_stop
= it
->base_level_stop
;
5553 p
->cmp_it
= it
->cmp_it
;
5554 xassert (it
->face_id
>= 0);
5555 p
->face_id
= it
->face_id
;
5556 p
->string
= it
->string
;
5557 p
->method
= it
->method
;
5558 p
->from_overlay
= it
->from_overlay
;
5561 case GET_FROM_IMAGE
:
5562 p
->u
.image
.object
= it
->object
;
5563 p
->u
.image
.image_id
= it
->image_id
;
5564 p
->u
.image
.slice
= it
->slice
;
5566 case GET_FROM_STRETCH
:
5567 p
->u
.stretch
.object
= it
->object
;
5570 p
->position
= position
? *position
: it
->position
;
5571 p
->current
= it
->current
;
5572 p
->end_charpos
= it
->end_charpos
;
5573 p
->string_nchars
= it
->string_nchars
;
5575 p
->multibyte_p
= it
->multibyte_p
;
5576 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5577 p
->space_width
= it
->space_width
;
5578 p
->font_height
= it
->font_height
;
5579 p
->voffset
= it
->voffset
;
5580 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5581 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5582 p
->display_ellipsis_p
= 0;
5583 p
->line_wrap
= it
->line_wrap
;
5584 p
->bidi_p
= it
->bidi_p
;
5585 p
->paragraph_embedding
= it
->paragraph_embedding
;
5586 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5589 /* Save the state of the bidi iterator as well. */
5591 bidi_push_it (&it
->bidi_it
);
5595 iterate_out_of_display_property (struct it
*it
)
5597 int buffer_p
= BUFFERP (it
->object
);
5598 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5599 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5601 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5603 /* Maybe initialize paragraph direction. If we are at the beginning
5604 of a new paragraph, next_element_from_buffer may not have a
5605 chance to do that. */
5606 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5607 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5608 /* prev_stop can be zero, so check against BEGV as well. */
5609 while (it
->bidi_it
.charpos
>= bob
5610 && it
->prev_stop
<= it
->bidi_it
.charpos
5611 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5612 && it
->bidi_it
.charpos
< eob
)
5613 bidi_move_to_visually_next (&it
->bidi_it
);
5614 /* Record the stop_pos we just crossed, for when we cross it
5616 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5617 it
->prev_stop
= CHARPOS (it
->position
);
5618 /* If we ended up not where pop_it put us, resync IT's
5619 positional members with the bidi iterator. */
5620 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5621 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5623 it
->current
.pos
= it
->position
;
5625 it
->current
.string_pos
= it
->position
;
5628 /* Restore IT's settings from IT->stack. Called, for example, when no
5629 more overlay strings must be processed, and we return to delivering
5630 display elements from a buffer, or when the end of a string from a
5631 `display' property is reached and we return to delivering display
5632 elements from an overlay string, or from a buffer. */
5635 pop_it (struct it
*it
)
5637 struct iterator_stack_entry
*p
;
5638 int from_display_prop
= it
->from_disp_prop_p
;
5640 xassert (it
->sp
> 0);
5642 p
= it
->stack
+ it
->sp
;
5643 it
->stop_charpos
= p
->stop_charpos
;
5644 it
->prev_stop
= p
->prev_stop
;
5645 it
->base_level_stop
= p
->base_level_stop
;
5646 it
->cmp_it
= p
->cmp_it
;
5647 it
->face_id
= p
->face_id
;
5648 it
->current
= p
->current
;
5649 it
->position
= p
->position
;
5650 it
->string
= p
->string
;
5651 it
->from_overlay
= p
->from_overlay
;
5652 if (NILP (it
->string
))
5653 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5654 it
->method
= p
->method
;
5657 case GET_FROM_IMAGE
:
5658 it
->image_id
= p
->u
.image
.image_id
;
5659 it
->object
= p
->u
.image
.object
;
5660 it
->slice
= p
->u
.image
.slice
;
5662 case GET_FROM_STRETCH
:
5663 it
->object
= p
->u
.stretch
.object
;
5665 case GET_FROM_BUFFER
:
5666 it
->object
= it
->w
->buffer
;
5668 case GET_FROM_STRING
:
5669 it
->object
= it
->string
;
5671 case GET_FROM_DISPLAY_VECTOR
:
5673 it
->method
= GET_FROM_C_STRING
;
5674 else if (STRINGP (it
->string
))
5675 it
->method
= GET_FROM_STRING
;
5678 it
->method
= GET_FROM_BUFFER
;
5679 it
->object
= it
->w
->buffer
;
5682 it
->end_charpos
= p
->end_charpos
;
5683 it
->string_nchars
= p
->string_nchars
;
5685 it
->multibyte_p
= p
->multibyte_p
;
5686 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5687 it
->space_width
= p
->space_width
;
5688 it
->font_height
= p
->font_height
;
5689 it
->voffset
= p
->voffset
;
5690 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5691 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5692 it
->line_wrap
= p
->line_wrap
;
5693 it
->bidi_p
= p
->bidi_p
;
5694 it
->paragraph_embedding
= p
->paragraph_embedding
;
5695 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5698 bidi_pop_it (&it
->bidi_it
);
5699 /* Bidi-iterate until we get out of the portion of text, if any,
5700 covered by a `display' text property or by an overlay with
5701 `display' property. (We cannot just jump there, because the
5702 internal coherency of the bidi iterator state can not be
5703 preserved across such jumps.) We also must determine the
5704 paragraph base direction if the overlay we just processed is
5705 at the beginning of a new paragraph. */
5706 if (from_display_prop
5707 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5708 iterate_out_of_display_property (it
);
5710 xassert ((BUFFERP (it
->object
)
5711 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5712 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5713 || (STRINGP (it
->object
)
5714 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5715 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5716 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5722 /***********************************************************************
5724 ***********************************************************************/
5726 /* Set IT's current position to the previous line start. */
5729 back_to_previous_line_start (struct it
*it
)
5731 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5732 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5736 /* Move IT to the next line start.
5738 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5739 we skipped over part of the text (as opposed to moving the iterator
5740 continuously over the text). Otherwise, don't change the value
5743 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5744 iterator on the newline, if it was found.
5746 Newlines may come from buffer text, overlay strings, or strings
5747 displayed via the `display' property. That's the reason we can't
5748 simply use find_next_newline_no_quit.
5750 Note that this function may not skip over invisible text that is so
5751 because of text properties and immediately follows a newline. If
5752 it would, function reseat_at_next_visible_line_start, when called
5753 from set_iterator_to_next, would effectively make invisible
5754 characters following a newline part of the wrong glyph row, which
5755 leads to wrong cursor motion. */
5758 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5759 struct bidi_it
*bidi_it_prev
)
5761 EMACS_INT old_selective
;
5762 int newline_found_p
, n
;
5763 const int MAX_NEWLINE_DISTANCE
= 500;
5765 /* If already on a newline, just consume it to avoid unintended
5766 skipping over invisible text below. */
5767 if (it
->what
== IT_CHARACTER
5769 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5771 if (it
->bidi_p
&& bidi_it_prev
)
5772 *bidi_it_prev
= it
->bidi_it
;
5773 set_iterator_to_next (it
, 0);
5778 /* Don't handle selective display in the following. It's (a)
5779 unnecessary because it's done by the caller, and (b) leads to an
5780 infinite recursion because next_element_from_ellipsis indirectly
5781 calls this function. */
5782 old_selective
= it
->selective
;
5785 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5786 from buffer text. */
5787 for (n
= newline_found_p
= 0;
5788 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5789 n
+= STRINGP (it
->string
) ? 0 : 1)
5791 if (!get_next_display_element (it
))
5793 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5794 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5795 *bidi_it_prev
= it
->bidi_it
;
5796 set_iterator_to_next (it
, 0);
5799 /* If we didn't find a newline near enough, see if we can use a
5801 if (!newline_found_p
)
5803 EMACS_INT start
= IT_CHARPOS (*it
);
5804 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5807 xassert (!STRINGP (it
->string
));
5809 /* If there isn't any `display' property in sight, and no
5810 overlays, we can just use the position of the newline in
5812 if (it
->stop_charpos
>= limit
5813 || ((pos
= Fnext_single_property_change (make_number (start
),
5815 make_number (limit
)),
5817 && next_overlay_change (start
) == ZV
))
5821 IT_CHARPOS (*it
) = limit
;
5822 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5826 struct bidi_it bprev
;
5828 /* Help bidi.c avoid expensive searches for display
5829 properties and overlays, by telling it that there are
5830 none up to `limit'. */
5831 if (it
->bidi_it
.disp_pos
< limit
)
5833 it
->bidi_it
.disp_pos
= limit
;
5834 it
->bidi_it
.disp_prop
= 0;
5837 bprev
= it
->bidi_it
;
5838 bidi_move_to_visually_next (&it
->bidi_it
);
5839 } while (it
->bidi_it
.charpos
!= limit
);
5840 IT_CHARPOS (*it
) = limit
;
5841 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5843 *bidi_it_prev
= bprev
;
5845 *skipped_p
= newline_found_p
= 1;
5849 while (get_next_display_element (it
)
5850 && !newline_found_p
)
5852 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5853 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5854 *bidi_it_prev
= it
->bidi_it
;
5855 set_iterator_to_next (it
, 0);
5860 it
->selective
= old_selective
;
5861 return newline_found_p
;
5865 /* Set IT's current position to the previous visible line start. Skip
5866 invisible text that is so either due to text properties or due to
5867 selective display. Caution: this does not change IT->current_x and
5871 back_to_previous_visible_line_start (struct it
*it
)
5873 while (IT_CHARPOS (*it
) > BEGV
)
5875 back_to_previous_line_start (it
);
5877 if (IT_CHARPOS (*it
) <= BEGV
)
5880 /* If selective > 0, then lines indented more than its value are
5882 if (it
->selective
> 0
5883 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5887 /* Check the newline before point for invisibility. */
5890 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5891 Qinvisible
, it
->window
);
5892 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5896 if (IT_CHARPOS (*it
) <= BEGV
)
5901 void *it2data
= NULL
;
5904 Lisp_Object val
, overlay
;
5906 SAVE_IT (it2
, *it
, it2data
);
5908 /* If newline is part of a composition, continue from start of composition */
5909 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5910 && beg
< IT_CHARPOS (*it
))
5913 /* If newline is replaced by a display property, find start of overlay
5914 or interval and continue search from that point. */
5915 pos
= --IT_CHARPOS (it2
);
5918 bidi_unshelve_cache (NULL
, 0);
5919 it2
.string_from_display_prop_p
= 0;
5920 it2
.from_disp_prop_p
= 0;
5921 if (handle_display_prop (&it2
) == HANDLED_RETURN
5922 && !NILP (val
= get_char_property_and_overlay
5923 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5924 && (OVERLAYP (overlay
)
5925 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5926 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5928 RESTORE_IT (it
, it
, it2data
);
5932 /* Newline is not replaced by anything -- so we are done. */
5933 RESTORE_IT (it
, it
, it2data
);
5939 IT_CHARPOS (*it
) = beg
;
5940 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5944 it
->continuation_lines_width
= 0;
5946 xassert (IT_CHARPOS (*it
) >= BEGV
);
5947 xassert (IT_CHARPOS (*it
) == BEGV
5948 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5953 /* Reseat iterator IT at the previous visible line start. Skip
5954 invisible text that is so either due to text properties or due to
5955 selective display. At the end, update IT's overlay information,
5956 face information etc. */
5959 reseat_at_previous_visible_line_start (struct it
*it
)
5961 back_to_previous_visible_line_start (it
);
5962 reseat (it
, it
->current
.pos
, 1);
5967 /* Reseat iterator IT on the next visible line start in the current
5968 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5969 preceding the line start. Skip over invisible text that is so
5970 because of selective display. Compute faces, overlays etc at the
5971 new position. Note that this function does not skip over text that
5972 is invisible because of text properties. */
5975 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5977 int newline_found_p
, skipped_p
= 0;
5978 struct bidi_it bidi_it_prev
;
5980 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5982 /* Skip over lines that are invisible because they are indented
5983 more than the value of IT->selective. */
5984 if (it
->selective
> 0)
5985 while (IT_CHARPOS (*it
) < ZV
5986 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5989 xassert (IT_BYTEPOS (*it
) == BEGV
5990 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5992 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5995 /* Position on the newline if that's what's requested. */
5996 if (on_newline_p
&& newline_found_p
)
5998 if (STRINGP (it
->string
))
6000 if (IT_STRING_CHARPOS (*it
) > 0)
6004 --IT_STRING_CHARPOS (*it
);
6005 --IT_STRING_BYTEPOS (*it
);
6009 /* We need to restore the bidi iterator to the state
6010 it had on the newline, and resync the IT's
6011 position with that. */
6012 it
->bidi_it
= bidi_it_prev
;
6013 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6014 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6018 else if (IT_CHARPOS (*it
) > BEGV
)
6027 /* We need to restore the bidi iterator to the state it
6028 had on the newline and resync IT with that. */
6029 it
->bidi_it
= bidi_it_prev
;
6030 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6031 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6033 reseat (it
, it
->current
.pos
, 0);
6037 reseat (it
, it
->current
.pos
, 0);
6044 /***********************************************************************
6045 Changing an iterator's position
6046 ***********************************************************************/
6048 /* Change IT's current position to POS in current_buffer. If FORCE_P
6049 is non-zero, always check for text properties at the new position.
6050 Otherwise, text properties are only looked up if POS >=
6051 IT->check_charpos of a property. */
6054 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6056 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6058 reseat_1 (it
, pos
, 0);
6060 /* Determine where to check text properties. Avoid doing it
6061 where possible because text property lookup is very expensive. */
6063 || CHARPOS (pos
) > it
->stop_charpos
6064 || CHARPOS (pos
) < original_pos
)
6068 /* For bidi iteration, we need to prime prev_stop and
6069 base_level_stop with our best estimations. */
6070 /* Implementation note: Of course, POS is not necessarily a
6071 stop position, so assigning prev_pos to it is a lie; we
6072 should have called compute_stop_backwards. However, if
6073 the current buffer does not include any R2L characters,
6074 that call would be a waste of cycles, because the
6075 iterator will never move back, and thus never cross this
6076 "fake" stop position. So we delay that backward search
6077 until the time we really need it, in next_element_from_buffer. */
6078 if (CHARPOS (pos
) != it
->prev_stop
)
6079 it
->prev_stop
= CHARPOS (pos
);
6080 if (CHARPOS (pos
) < it
->base_level_stop
)
6081 it
->base_level_stop
= 0; /* meaning it's unknown */
6087 it
->prev_stop
= it
->base_level_stop
= 0;
6096 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6097 IT->stop_pos to POS, also. */
6100 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6102 /* Don't call this function when scanning a C string. */
6103 xassert (it
->s
== NULL
);
6105 /* POS must be a reasonable value. */
6106 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6108 it
->current
.pos
= it
->position
= pos
;
6109 it
->end_charpos
= ZV
;
6111 it
->current
.dpvec_index
= -1;
6112 it
->current
.overlay_string_index
= -1;
6113 IT_STRING_CHARPOS (*it
) = -1;
6114 IT_STRING_BYTEPOS (*it
) = -1;
6116 it
->method
= GET_FROM_BUFFER
;
6117 it
->object
= it
->w
->buffer
;
6118 it
->area
= TEXT_AREA
;
6119 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6121 it
->string_from_display_prop_p
= 0;
6122 it
->string_from_prefix_prop_p
= 0;
6124 it
->from_disp_prop_p
= 0;
6125 it
->face_before_selective_p
= 0;
6128 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6130 bidi_unshelve_cache (NULL
, 0);
6131 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6132 it
->bidi_it
.string
.s
= NULL
;
6133 it
->bidi_it
.string
.lstring
= Qnil
;
6134 it
->bidi_it
.string
.bufpos
= 0;
6135 it
->bidi_it
.string
.unibyte
= 0;
6140 it
->stop_charpos
= CHARPOS (pos
);
6141 it
->base_level_stop
= CHARPOS (pos
);
6146 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6147 If S is non-null, it is a C string to iterate over. Otherwise,
6148 STRING gives a Lisp string to iterate over.
6150 If PRECISION > 0, don't return more then PRECISION number of
6151 characters from the string.
6153 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6154 characters have been returned. FIELD_WIDTH < 0 means an infinite
6157 MULTIBYTE = 0 means disable processing of multibyte characters,
6158 MULTIBYTE > 0 means enable it,
6159 MULTIBYTE < 0 means use IT->multibyte_p.
6161 IT must be initialized via a prior call to init_iterator before
6162 calling this function. */
6165 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6166 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6169 /* No region in strings. */
6170 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6172 /* No text property checks performed by default, but see below. */
6173 it
->stop_charpos
= -1;
6175 /* Set iterator position and end position. */
6176 memset (&it
->current
, 0, sizeof it
->current
);
6177 it
->current
.overlay_string_index
= -1;
6178 it
->current
.dpvec_index
= -1;
6179 xassert (charpos
>= 0);
6181 /* If STRING is specified, use its multibyteness, otherwise use the
6182 setting of MULTIBYTE, if specified. */
6184 it
->multibyte_p
= multibyte
> 0;
6186 /* Bidirectional reordering of strings is controlled by the default
6187 value of bidi-display-reordering. Don't try to reorder while
6188 loading loadup.el, as the necessary character property tables are
6189 not yet available. */
6192 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6196 xassert (STRINGP (string
));
6197 it
->string
= string
;
6199 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6200 it
->method
= GET_FROM_STRING
;
6201 it
->current
.string_pos
= string_pos (charpos
, string
);
6205 it
->bidi_it
.string
.lstring
= string
;
6206 it
->bidi_it
.string
.s
= NULL
;
6207 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6208 it
->bidi_it
.string
.bufpos
= 0;
6209 it
->bidi_it
.string
.from_disp_str
= 0;
6210 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6211 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6212 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6217 it
->s
= (const unsigned char *) s
;
6220 /* Note that we use IT->current.pos, not it->current.string_pos,
6221 for displaying C strings. */
6222 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6223 if (it
->multibyte_p
)
6225 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6226 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6230 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6231 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6236 it
->bidi_it
.string
.lstring
= Qnil
;
6237 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6238 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6239 it
->bidi_it
.string
.bufpos
= 0;
6240 it
->bidi_it
.string
.from_disp_str
= 0;
6241 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6242 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6245 it
->method
= GET_FROM_C_STRING
;
6248 /* PRECISION > 0 means don't return more than PRECISION characters
6250 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6252 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6254 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6257 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6258 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6259 FIELD_WIDTH < 0 means infinite field width. This is useful for
6260 padding with `-' at the end of a mode line. */
6261 if (field_width
< 0)
6262 field_width
= INFINITY
;
6263 /* Implementation note: We deliberately don't enlarge
6264 it->bidi_it.string.schars here to fit it->end_charpos, because
6265 the bidi iterator cannot produce characters out of thin air. */
6266 if (field_width
> it
->end_charpos
- charpos
)
6267 it
->end_charpos
= charpos
+ field_width
;
6269 /* Use the standard display table for displaying strings. */
6270 if (DISP_TABLE_P (Vstandard_display_table
))
6271 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6273 it
->stop_charpos
= charpos
;
6274 it
->prev_stop
= charpos
;
6275 it
->base_level_stop
= 0;
6278 it
->bidi_it
.first_elt
= 1;
6279 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6280 it
->bidi_it
.disp_pos
= -1;
6282 if (s
== NULL
&& it
->multibyte_p
)
6284 EMACS_INT endpos
= SCHARS (it
->string
);
6285 if (endpos
> it
->end_charpos
)
6286 endpos
= it
->end_charpos
;
6287 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6295 /***********************************************************************
6297 ***********************************************************************/
6299 /* Map enum it_method value to corresponding next_element_from_* function. */
6301 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6303 next_element_from_buffer
,
6304 next_element_from_display_vector
,
6305 next_element_from_string
,
6306 next_element_from_c_string
,
6307 next_element_from_image
,
6308 next_element_from_stretch
6311 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6314 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6315 (possibly with the following characters). */
6317 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6318 ((IT)->cmp_it.id >= 0 \
6319 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6320 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6321 END_CHARPOS, (IT)->w, \
6322 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6326 /* Lookup the char-table Vglyphless_char_display for character C (-1
6327 if we want information for no-font case), and return the display
6328 method symbol. By side-effect, update it->what and
6329 it->glyphless_method. This function is called from
6330 get_next_display_element for each character element, and from
6331 x_produce_glyphs when no suitable font was found. */
6334 lookup_glyphless_char_display (int c
, struct it
*it
)
6336 Lisp_Object glyphless_method
= Qnil
;
6338 if (CHAR_TABLE_P (Vglyphless_char_display
)
6339 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6343 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6344 if (CONSP (glyphless_method
))
6345 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6346 ? XCAR (glyphless_method
)
6347 : XCDR (glyphless_method
);
6350 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6354 if (NILP (glyphless_method
))
6357 /* The default is to display the character by a proper font. */
6359 /* The default for the no-font case is to display an empty box. */
6360 glyphless_method
= Qempty_box
;
6362 if (EQ (glyphless_method
, Qzero_width
))
6365 return glyphless_method
;
6366 /* This method can't be used for the no-font case. */
6367 glyphless_method
= Qempty_box
;
6369 if (EQ (glyphless_method
, Qthin_space
))
6370 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6371 else if (EQ (glyphless_method
, Qempty_box
))
6372 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6373 else if (EQ (glyphless_method
, Qhex_code
))
6374 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6375 else if (STRINGP (glyphless_method
))
6376 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6379 /* Invalid value. We use the default method. */
6380 glyphless_method
= Qnil
;
6383 it
->what
= IT_GLYPHLESS
;
6384 return glyphless_method
;
6387 /* Load IT's display element fields with information about the next
6388 display element from the current position of IT. Value is zero if
6389 end of buffer (or C string) is reached. */
6391 static struct frame
*last_escape_glyph_frame
= NULL
;
6392 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6393 static int last_escape_glyph_merged_face_id
= 0;
6395 struct frame
*last_glyphless_glyph_frame
= NULL
;
6396 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6397 int last_glyphless_glyph_merged_face_id
= 0;
6400 get_next_display_element (struct it
*it
)
6402 /* Non-zero means that we found a display element. Zero means that
6403 we hit the end of what we iterate over. Performance note: the
6404 function pointer `method' used here turns out to be faster than
6405 using a sequence of if-statements. */
6409 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6411 if (it
->what
== IT_CHARACTER
)
6413 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6414 and only if (a) the resolved directionality of that character
6416 /* FIXME: Do we need an exception for characters from display
6418 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6419 it
->c
= bidi_mirror_char (it
->c
);
6420 /* Map via display table or translate control characters.
6421 IT->c, IT->len etc. have been set to the next character by
6422 the function call above. If we have a display table, and it
6423 contains an entry for IT->c, translate it. Don't do this if
6424 IT->c itself comes from a display table, otherwise we could
6425 end up in an infinite recursion. (An alternative could be to
6426 count the recursion depth of this function and signal an
6427 error when a certain maximum depth is reached.) Is it worth
6429 if (success_p
&& it
->dpvec
== NULL
)
6432 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6433 int nonascii_space_p
= 0;
6434 int nonascii_hyphen_p
= 0;
6435 int c
= it
->c
; /* This is the character to display. */
6437 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6439 xassert (SINGLE_BYTE_CHAR_P (c
));
6440 if (unibyte_display_via_language_environment
)
6442 c
= DECODE_CHAR (unibyte
, c
);
6444 c
= BYTE8_TO_CHAR (it
->c
);
6447 c
= BYTE8_TO_CHAR (it
->c
);
6451 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6454 struct Lisp_Vector
*v
= XVECTOR (dv
);
6456 /* Return the first character from the display table
6457 entry, if not empty. If empty, don't display the
6458 current character. */
6461 it
->dpvec_char_len
= it
->len
;
6462 it
->dpvec
= v
->contents
;
6463 it
->dpend
= v
->contents
+ v
->header
.size
;
6464 it
->current
.dpvec_index
= 0;
6465 it
->dpvec_face_id
= -1;
6466 it
->saved_face_id
= it
->face_id
;
6467 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6472 set_iterator_to_next (it
, 0);
6477 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6479 if (it
->what
== IT_GLYPHLESS
)
6481 /* Don't display this character. */
6482 set_iterator_to_next (it
, 0);
6486 /* If `nobreak-char-display' is non-nil, we display
6487 non-ASCII spaces and hyphens specially. */
6488 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6491 nonascii_space_p
= 1;
6492 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6493 nonascii_hyphen_p
= 1;
6496 /* Translate control characters into `\003' or `^C' form.
6497 Control characters coming from a display table entry are
6498 currently not translated because we use IT->dpvec to hold
6499 the translation. This could easily be changed but I
6500 don't believe that it is worth doing.
6502 The characters handled by `nobreak-char-display' must be
6505 Non-printable characters and raw-byte characters are also
6506 translated to octal form. */
6507 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6508 ? (it
->area
!= TEXT_AREA
6509 /* In mode line, treat \n, \t like other crl chars. */
6512 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6513 || (c
!= '\n' && c
!= '\t'))
6515 || nonascii_hyphen_p
6517 || ! CHAR_PRINTABLE_P (c
))))
6519 /* C is a control character, non-ASCII space/hyphen,
6520 raw-byte, or a non-printable character which must be
6521 displayed either as '\003' or as `^C' where the '\\'
6522 and '^' can be defined in the display table. Fill
6523 IT->ctl_chars with glyphs for what we have to
6524 display. Then, set IT->dpvec to these glyphs. */
6528 EMACS_INT lface_id
= 0;
6531 /* Handle control characters with ^. */
6533 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6537 g
= '^'; /* default glyph for Control */
6538 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6540 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6541 && GLYPH_CODE_CHAR_VALID_P (gc
))
6543 g
= GLYPH_CODE_CHAR (gc
);
6544 lface_id
= GLYPH_CODE_FACE (gc
);
6548 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6550 else if (it
->f
== last_escape_glyph_frame
6551 && it
->face_id
== last_escape_glyph_face_id
)
6553 face_id
= last_escape_glyph_merged_face_id
;
6557 /* Merge the escape-glyph face into the current face. */
6558 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6560 last_escape_glyph_frame
= it
->f
;
6561 last_escape_glyph_face_id
= it
->face_id
;
6562 last_escape_glyph_merged_face_id
= face_id
;
6565 XSETINT (it
->ctl_chars
[0], g
);
6566 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6568 goto display_control
;
6571 /* Handle non-ascii space in the mode where it only gets
6574 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6576 /* Merge `nobreak-space' into the current face. */
6577 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6579 XSETINT (it
->ctl_chars
[0], ' ');
6581 goto display_control
;
6584 /* Handle sequences that start with the "escape glyph". */
6586 /* the default escape glyph is \. */
6587 escape_glyph
= '\\';
6590 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6591 && GLYPH_CODE_CHAR_VALID_P (gc
))
6593 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6594 lface_id
= GLYPH_CODE_FACE (gc
);
6598 /* The display table specified a face.
6599 Merge it into face_id and also into escape_glyph. */
6600 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6603 else if (it
->f
== last_escape_glyph_frame
6604 && it
->face_id
== last_escape_glyph_face_id
)
6606 face_id
= last_escape_glyph_merged_face_id
;
6610 /* Merge the escape-glyph face into the current face. */
6611 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6613 last_escape_glyph_frame
= it
->f
;
6614 last_escape_glyph_face_id
= it
->face_id
;
6615 last_escape_glyph_merged_face_id
= face_id
;
6618 /* Draw non-ASCII hyphen with just highlighting: */
6620 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6622 XSETINT (it
->ctl_chars
[0], '-');
6624 goto display_control
;
6627 /* Draw non-ASCII space/hyphen with escape glyph: */
6629 if (nonascii_space_p
|| nonascii_hyphen_p
)
6631 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6632 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6634 goto display_control
;
6641 if (CHAR_BYTE8_P (c
))
6642 /* Display \200 instead of \17777600. */
6643 c
= CHAR_TO_BYTE8 (c
);
6644 len
= sprintf (str
, "%03o", c
);
6646 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6647 for (i
= 0; i
< len
; i
++)
6648 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6653 /* Set up IT->dpvec and return first character from it. */
6654 it
->dpvec_char_len
= it
->len
;
6655 it
->dpvec
= it
->ctl_chars
;
6656 it
->dpend
= it
->dpvec
+ ctl_len
;
6657 it
->current
.dpvec_index
= 0;
6658 it
->dpvec_face_id
= face_id
;
6659 it
->saved_face_id
= it
->face_id
;
6660 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6664 it
->char_to_display
= c
;
6668 it
->char_to_display
= it
->c
;
6672 /* Adjust face id for a multibyte character. There are no multibyte
6673 character in unibyte text. */
6674 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6677 && FRAME_WINDOW_P (it
->f
))
6679 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6681 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6683 /* Automatic composition with glyph-string. */
6684 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6686 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6690 EMACS_INT pos
= (it
->s
? -1
6691 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6692 : IT_CHARPOS (*it
));
6695 if (it
->what
== IT_CHARACTER
)
6696 c
= it
->char_to_display
;
6699 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6703 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6704 /* TAB in a composition means display glyphs with
6705 padding space on the left or right. */
6706 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6709 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6714 /* Is this character the last one of a run of characters with
6715 box? If yes, set IT->end_of_box_run_p to 1. */
6719 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6721 int face_id
= underlying_face_id (it
);
6722 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6726 if (face
->box
== FACE_NO_BOX
)
6728 /* If the box comes from face properties in a
6729 display string, check faces in that string. */
6730 int string_face_id
= face_after_it_pos (it
);
6731 it
->end_of_box_run_p
6732 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6735 /* Otherwise, the box comes from the underlying face.
6736 If this is the last string character displayed, check
6737 the next buffer location. */
6738 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6739 && (it
->current
.overlay_string_index
6740 == it
->n_overlay_strings
- 1))
6744 struct text_pos pos
= it
->current
.pos
;
6745 INC_TEXT_POS (pos
, it
->multibyte_p
);
6747 next_face_id
= face_at_buffer_position
6748 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6749 it
->region_end_charpos
, &ignore
,
6750 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6752 it
->end_of_box_run_p
6753 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6760 int face_id
= face_after_it_pos (it
);
6761 it
->end_of_box_run_p
6762 = (face_id
!= it
->face_id
6763 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6767 /* Value is 0 if end of buffer or string reached. */
6772 /* Move IT to the next display element.
6774 RESEAT_P non-zero means if called on a newline in buffer text,
6775 skip to the next visible line start.
6777 Functions get_next_display_element and set_iterator_to_next are
6778 separate because I find this arrangement easier to handle than a
6779 get_next_display_element function that also increments IT's
6780 position. The way it is we can first look at an iterator's current
6781 display element, decide whether it fits on a line, and if it does,
6782 increment the iterator position. The other way around we probably
6783 would either need a flag indicating whether the iterator has to be
6784 incremented the next time, or we would have to implement a
6785 decrement position function which would not be easy to write. */
6788 set_iterator_to_next (struct it
*it
, int reseat_p
)
6790 /* Reset flags indicating start and end of a sequence of characters
6791 with box. Reset them at the start of this function because
6792 moving the iterator to a new position might set them. */
6793 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6797 case GET_FROM_BUFFER
:
6798 /* The current display element of IT is a character from
6799 current_buffer. Advance in the buffer, and maybe skip over
6800 invisible lines that are so because of selective display. */
6801 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6802 reseat_at_next_visible_line_start (it
, 0);
6803 else if (it
->cmp_it
.id
>= 0)
6805 /* We are currently getting glyphs from a composition. */
6810 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6811 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6812 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6814 it
->cmp_it
.from
= it
->cmp_it
.to
;
6819 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6821 it
->end_charpos
, Qnil
);
6824 else if (! it
->cmp_it
.reversed_p
)
6826 /* Composition created while scanning forward. */
6827 /* Update IT's char/byte positions to point to the first
6828 character of the next grapheme cluster, or to the
6829 character visually after the current composition. */
6830 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6831 bidi_move_to_visually_next (&it
->bidi_it
);
6832 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6833 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6835 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6837 /* Proceed to the next grapheme cluster. */
6838 it
->cmp_it
.from
= it
->cmp_it
.to
;
6842 /* No more grapheme clusters in this composition.
6843 Find the next stop position. */
6844 EMACS_INT stop
= it
->end_charpos
;
6845 if (it
->bidi_it
.scan_dir
< 0)
6846 /* Now we are scanning backward and don't know
6849 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6850 IT_BYTEPOS (*it
), stop
, Qnil
);
6855 /* Composition created while scanning backward. */
6856 /* Update IT's char/byte positions to point to the last
6857 character of the previous grapheme cluster, or the
6858 character visually after the current composition. */
6859 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6860 bidi_move_to_visually_next (&it
->bidi_it
);
6861 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6862 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6863 if (it
->cmp_it
.from
> 0)
6865 /* Proceed to the previous grapheme cluster. */
6866 it
->cmp_it
.to
= it
->cmp_it
.from
;
6870 /* No more grapheme clusters in this composition.
6871 Find the next stop position. */
6872 EMACS_INT stop
= it
->end_charpos
;
6873 if (it
->bidi_it
.scan_dir
< 0)
6874 /* Now we are scanning backward and don't know
6877 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6878 IT_BYTEPOS (*it
), stop
, Qnil
);
6884 xassert (it
->len
!= 0);
6888 IT_BYTEPOS (*it
) += it
->len
;
6889 IT_CHARPOS (*it
) += 1;
6893 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6894 /* If this is a new paragraph, determine its base
6895 direction (a.k.a. its base embedding level). */
6896 if (it
->bidi_it
.new_paragraph
)
6897 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6898 bidi_move_to_visually_next (&it
->bidi_it
);
6899 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6900 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6901 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6903 /* As the scan direction was changed, we must
6904 re-compute the stop position for composition. */
6905 EMACS_INT stop
= it
->end_charpos
;
6906 if (it
->bidi_it
.scan_dir
< 0)
6908 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6909 IT_BYTEPOS (*it
), stop
, Qnil
);
6912 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6916 case GET_FROM_C_STRING
:
6917 /* Current display element of IT is from a C string. */
6919 /* If the string position is beyond string's end, it means
6920 next_element_from_c_string is padding the string with
6921 blanks, in which case we bypass the bidi iterator,
6922 because it cannot deal with such virtual characters. */
6923 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6925 IT_BYTEPOS (*it
) += it
->len
;
6926 IT_CHARPOS (*it
) += 1;
6930 bidi_move_to_visually_next (&it
->bidi_it
);
6931 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6932 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6936 case GET_FROM_DISPLAY_VECTOR
:
6937 /* Current display element of IT is from a display table entry.
6938 Advance in the display table definition. Reset it to null if
6939 end reached, and continue with characters from buffers/
6941 ++it
->current
.dpvec_index
;
6943 /* Restore face of the iterator to what they were before the
6944 display vector entry (these entries may contain faces). */
6945 it
->face_id
= it
->saved_face_id
;
6947 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6949 int recheck_faces
= it
->ellipsis_p
;
6952 it
->method
= GET_FROM_C_STRING
;
6953 else if (STRINGP (it
->string
))
6954 it
->method
= GET_FROM_STRING
;
6957 it
->method
= GET_FROM_BUFFER
;
6958 it
->object
= it
->w
->buffer
;
6962 it
->current
.dpvec_index
= -1;
6964 /* Skip over characters which were displayed via IT->dpvec. */
6965 if (it
->dpvec_char_len
< 0)
6966 reseat_at_next_visible_line_start (it
, 1);
6967 else if (it
->dpvec_char_len
> 0)
6969 if (it
->method
== GET_FROM_STRING
6970 && it
->n_overlay_strings
> 0)
6971 it
->ignore_overlay_strings_at_pos_p
= 1;
6972 it
->len
= it
->dpvec_char_len
;
6973 set_iterator_to_next (it
, reseat_p
);
6976 /* Maybe recheck faces after display vector */
6978 it
->stop_charpos
= IT_CHARPOS (*it
);
6982 case GET_FROM_STRING
:
6983 /* Current display element is a character from a Lisp string. */
6984 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6985 if (it
->cmp_it
.id
>= 0)
6991 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6992 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6993 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6994 it
->cmp_it
.from
= it
->cmp_it
.to
;
6998 composition_compute_stop_pos (&it
->cmp_it
,
6999 IT_STRING_CHARPOS (*it
),
7000 IT_STRING_BYTEPOS (*it
),
7001 it
->end_charpos
, it
->string
);
7004 else if (! it
->cmp_it
.reversed_p
)
7006 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7007 bidi_move_to_visually_next (&it
->bidi_it
);
7008 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7009 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7011 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7012 it
->cmp_it
.from
= it
->cmp_it
.to
;
7015 EMACS_INT stop
= it
->end_charpos
;
7016 if (it
->bidi_it
.scan_dir
< 0)
7018 composition_compute_stop_pos (&it
->cmp_it
,
7019 IT_STRING_CHARPOS (*it
),
7020 IT_STRING_BYTEPOS (*it
), stop
,
7026 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7027 bidi_move_to_visually_next (&it
->bidi_it
);
7028 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7029 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7030 if (it
->cmp_it
.from
> 0)
7031 it
->cmp_it
.to
= it
->cmp_it
.from
;
7034 EMACS_INT stop
= it
->end_charpos
;
7035 if (it
->bidi_it
.scan_dir
< 0)
7037 composition_compute_stop_pos (&it
->cmp_it
,
7038 IT_STRING_CHARPOS (*it
),
7039 IT_STRING_BYTEPOS (*it
), stop
,
7047 /* If the string position is beyond string's end, it
7048 means next_element_from_string is padding the string
7049 with blanks, in which case we bypass the bidi
7050 iterator, because it cannot deal with such virtual
7052 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7054 IT_STRING_BYTEPOS (*it
) += it
->len
;
7055 IT_STRING_CHARPOS (*it
) += 1;
7059 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7061 bidi_move_to_visually_next (&it
->bidi_it
);
7062 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7063 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7064 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7066 EMACS_INT stop
= it
->end_charpos
;
7068 if (it
->bidi_it
.scan_dir
< 0)
7070 composition_compute_stop_pos (&it
->cmp_it
,
7071 IT_STRING_CHARPOS (*it
),
7072 IT_STRING_BYTEPOS (*it
), stop
,
7078 consider_string_end
:
7080 if (it
->current
.overlay_string_index
>= 0)
7082 /* IT->string is an overlay string. Advance to the
7083 next, if there is one. */
7084 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7087 next_overlay_string (it
);
7089 setup_for_ellipsis (it
, 0);
7094 /* IT->string is not an overlay string. If we reached
7095 its end, and there is something on IT->stack, proceed
7096 with what is on the stack. This can be either another
7097 string, this time an overlay string, or a buffer. */
7098 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7102 if (it
->method
== GET_FROM_STRING
)
7103 goto consider_string_end
;
7108 case GET_FROM_IMAGE
:
7109 case GET_FROM_STRETCH
:
7110 /* The position etc with which we have to proceed are on
7111 the stack. The position may be at the end of a string,
7112 if the `display' property takes up the whole string. */
7113 xassert (it
->sp
> 0);
7115 if (it
->method
== GET_FROM_STRING
)
7116 goto consider_string_end
;
7120 /* There are no other methods defined, so this should be a bug. */
7124 xassert (it
->method
!= GET_FROM_STRING
7125 || (STRINGP (it
->string
)
7126 && IT_STRING_CHARPOS (*it
) >= 0));
7129 /* Load IT's display element fields with information about the next
7130 display element which comes from a display table entry or from the
7131 result of translating a control character to one of the forms `^C'
7134 IT->dpvec holds the glyphs to return as characters.
7135 IT->saved_face_id holds the face id before the display vector--it
7136 is restored into IT->face_id in set_iterator_to_next. */
7139 next_element_from_display_vector (struct it
*it
)
7144 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7146 it
->face_id
= it
->saved_face_id
;
7148 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7149 That seemed totally bogus - so I changed it... */
7150 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7152 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7154 it
->c
= GLYPH_CODE_CHAR (gc
);
7155 it
->len
= CHAR_BYTES (it
->c
);
7157 /* The entry may contain a face id to use. Such a face id is
7158 the id of a Lisp face, not a realized face. A face id of
7159 zero means no face is specified. */
7160 if (it
->dpvec_face_id
>= 0)
7161 it
->face_id
= it
->dpvec_face_id
;
7164 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7166 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7171 /* Display table entry is invalid. Return a space. */
7172 it
->c
= ' ', it
->len
= 1;
7174 /* Don't change position and object of the iterator here. They are
7175 still the values of the character that had this display table
7176 entry or was translated, and that's what we want. */
7177 it
->what
= IT_CHARACTER
;
7181 /* Get the first element of string/buffer in the visual order, after
7182 being reseated to a new position in a string or a buffer. */
7184 get_visually_first_element (struct it
*it
)
7186 int string_p
= STRINGP (it
->string
) || it
->s
;
7187 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7188 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7190 if (STRINGP (it
->string
))
7192 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7193 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7197 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7198 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7201 if (it
->bidi_it
.charpos
== eob
)
7203 /* Nothing to do, but reset the FIRST_ELT flag, like
7204 bidi_paragraph_init does, because we are not going to
7206 it
->bidi_it
.first_elt
= 0;
7208 else if (it
->bidi_it
.charpos
== bob
7210 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7211 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7213 /* If we are at the beginning of a line/string, we can produce
7214 the next element right away. */
7215 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7216 bidi_move_to_visually_next (&it
->bidi_it
);
7220 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7222 /* We need to prime the bidi iterator starting at the line's or
7223 string's beginning, before we will be able to produce the
7226 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7229 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7231 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7233 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7236 /* Now return to buffer/string position where we were asked
7237 to get the next display element, and produce that. */
7238 bidi_move_to_visually_next (&it
->bidi_it
);
7240 while (it
->bidi_it
.bytepos
!= orig_bytepos
7241 && it
->bidi_it
.charpos
< eob
);
7244 /* Adjust IT's position information to where we ended up. */
7245 if (STRINGP (it
->string
))
7247 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7248 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7252 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7253 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7256 if (STRINGP (it
->string
) || !it
->s
)
7258 EMACS_INT stop
, charpos
, bytepos
;
7260 if (STRINGP (it
->string
))
7263 stop
= SCHARS (it
->string
);
7264 if (stop
> it
->end_charpos
)
7265 stop
= it
->end_charpos
;
7266 charpos
= IT_STRING_CHARPOS (*it
);
7267 bytepos
= IT_STRING_BYTEPOS (*it
);
7271 stop
= it
->end_charpos
;
7272 charpos
= IT_CHARPOS (*it
);
7273 bytepos
= IT_BYTEPOS (*it
);
7275 if (it
->bidi_it
.scan_dir
< 0)
7277 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7282 /* Load IT with the next display element from Lisp string IT->string.
7283 IT->current.string_pos is the current position within the string.
7284 If IT->current.overlay_string_index >= 0, the Lisp string is an
7288 next_element_from_string (struct it
*it
)
7290 struct text_pos position
;
7292 xassert (STRINGP (it
->string
));
7293 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7294 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7295 position
= it
->current
.string_pos
;
7297 /* With bidi reordering, the character to display might not be the
7298 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7299 that we were reseat()ed to a new string, whose paragraph
7300 direction is not known. */
7301 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7303 get_visually_first_element (it
);
7304 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7307 /* Time to check for invisible text? */
7308 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7310 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7313 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7314 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7316 /* With bidi non-linear iteration, we could find
7317 ourselves far beyond the last computed stop_charpos,
7318 with several other stop positions in between that we
7319 missed. Scan them all now, in buffer's logical
7320 order, until we find and handle the last stop_charpos
7321 that precedes our current position. */
7322 handle_stop_backwards (it
, it
->stop_charpos
);
7323 return GET_NEXT_DISPLAY_ELEMENT (it
);
7329 /* Take note of the stop position we just moved
7330 across, for when we will move back across it. */
7331 it
->prev_stop
= it
->stop_charpos
;
7332 /* If we are at base paragraph embedding level, take
7333 note of the last stop position seen at this
7335 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7336 it
->base_level_stop
= it
->stop_charpos
;
7340 /* Since a handler may have changed IT->method, we must
7342 return GET_NEXT_DISPLAY_ELEMENT (it
);
7346 /* If we are before prev_stop, we may have overstepped
7347 on our way backwards a stop_pos, and if so, we need
7348 to handle that stop_pos. */
7349 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7350 /* We can sometimes back up for reasons that have nothing
7351 to do with bidi reordering. E.g., compositions. The
7352 code below is only needed when we are above the base
7353 embedding level, so test for that explicitly. */
7354 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7356 /* If we lost track of base_level_stop, we have no better
7357 place for handle_stop_backwards to start from than string
7358 beginning. This happens, e.g., when we were reseated to
7359 the previous screenful of text by vertical-motion. */
7360 if (it
->base_level_stop
<= 0
7361 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7362 it
->base_level_stop
= 0;
7363 handle_stop_backwards (it
, it
->base_level_stop
);
7364 return GET_NEXT_DISPLAY_ELEMENT (it
);
7368 if (it
->current
.overlay_string_index
>= 0)
7370 /* Get the next character from an overlay string. In overlay
7371 strings, there is no field width or padding with spaces to
7373 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7378 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7379 IT_STRING_BYTEPOS (*it
),
7380 it
->bidi_it
.scan_dir
< 0
7382 : SCHARS (it
->string
))
7383 && next_element_from_composition (it
))
7387 else if (STRING_MULTIBYTE (it
->string
))
7389 const unsigned char *s
= (SDATA (it
->string
)
7390 + IT_STRING_BYTEPOS (*it
));
7391 it
->c
= string_char_and_length (s
, &it
->len
);
7395 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7401 /* Get the next character from a Lisp string that is not an
7402 overlay string. Such strings come from the mode line, for
7403 example. We may have to pad with spaces, or truncate the
7404 string. See also next_element_from_c_string. */
7405 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7410 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7412 /* Pad with spaces. */
7413 it
->c
= ' ', it
->len
= 1;
7414 CHARPOS (position
) = BYTEPOS (position
) = -1;
7416 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7417 IT_STRING_BYTEPOS (*it
),
7418 it
->bidi_it
.scan_dir
< 0
7420 : it
->string_nchars
)
7421 && next_element_from_composition (it
))
7425 else if (STRING_MULTIBYTE (it
->string
))
7427 const unsigned char *s
= (SDATA (it
->string
)
7428 + IT_STRING_BYTEPOS (*it
));
7429 it
->c
= string_char_and_length (s
, &it
->len
);
7433 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7438 /* Record what we have and where it came from. */
7439 it
->what
= IT_CHARACTER
;
7440 it
->object
= it
->string
;
7441 it
->position
= position
;
7446 /* Load IT with next display element from C string IT->s.
7447 IT->string_nchars is the maximum number of characters to return
7448 from the string. IT->end_charpos may be greater than
7449 IT->string_nchars when this function is called, in which case we
7450 may have to return padding spaces. Value is zero if end of string
7451 reached, including padding spaces. */
7454 next_element_from_c_string (struct it
*it
)
7459 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7460 it
->what
= IT_CHARACTER
;
7461 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7464 /* With bidi reordering, the character to display might not be the
7465 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7466 we were reseated to a new string, whose paragraph direction is
7468 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7469 get_visually_first_element (it
);
7471 /* IT's position can be greater than IT->string_nchars in case a
7472 field width or precision has been specified when the iterator was
7474 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7476 /* End of the game. */
7480 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7482 /* Pad with spaces. */
7483 it
->c
= ' ', it
->len
= 1;
7484 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7486 else if (it
->multibyte_p
)
7487 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7489 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7495 /* Set up IT to return characters from an ellipsis, if appropriate.
7496 The definition of the ellipsis glyphs may come from a display table
7497 entry. This function fills IT with the first glyph from the
7498 ellipsis if an ellipsis is to be displayed. */
7501 next_element_from_ellipsis (struct it
*it
)
7503 if (it
->selective_display_ellipsis_p
)
7504 setup_for_ellipsis (it
, it
->len
);
7507 /* The face at the current position may be different from the
7508 face we find after the invisible text. Remember what it
7509 was in IT->saved_face_id, and signal that it's there by
7510 setting face_before_selective_p. */
7511 it
->saved_face_id
= it
->face_id
;
7512 it
->method
= GET_FROM_BUFFER
;
7513 it
->object
= it
->w
->buffer
;
7514 reseat_at_next_visible_line_start (it
, 1);
7515 it
->face_before_selective_p
= 1;
7518 return GET_NEXT_DISPLAY_ELEMENT (it
);
7522 /* Deliver an image display element. The iterator IT is already
7523 filled with image information (done in handle_display_prop). Value
7528 next_element_from_image (struct it
*it
)
7530 it
->what
= IT_IMAGE
;
7531 it
->ignore_overlay_strings_at_pos_p
= 0;
7536 /* Fill iterator IT with next display element from a stretch glyph
7537 property. IT->object is the value of the text property. Value is
7541 next_element_from_stretch (struct it
*it
)
7543 it
->what
= IT_STRETCH
;
7547 /* Scan backwards from IT's current position until we find a stop
7548 position, or until BEGV. This is called when we find ourself
7549 before both the last known prev_stop and base_level_stop while
7550 reordering bidirectional text. */
7553 compute_stop_pos_backwards (struct it
*it
)
7555 const int SCAN_BACK_LIMIT
= 1000;
7556 struct text_pos pos
;
7557 struct display_pos save_current
= it
->current
;
7558 struct text_pos save_position
= it
->position
;
7559 EMACS_INT charpos
= IT_CHARPOS (*it
);
7560 EMACS_INT where_we_are
= charpos
;
7561 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7562 EMACS_INT save_end_pos
= it
->end_charpos
;
7564 xassert (NILP (it
->string
) && !it
->s
);
7565 xassert (it
->bidi_p
);
7569 it
->end_charpos
= min (charpos
+ 1, ZV
);
7570 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7571 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7572 reseat_1 (it
, pos
, 0);
7573 compute_stop_pos (it
);
7574 /* We must advance forward, right? */
7575 if (it
->stop_charpos
<= charpos
)
7578 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7580 if (it
->stop_charpos
<= where_we_are
)
7581 it
->prev_stop
= it
->stop_charpos
;
7583 it
->prev_stop
= BEGV
;
7585 it
->current
= save_current
;
7586 it
->position
= save_position
;
7587 it
->stop_charpos
= save_stop_pos
;
7588 it
->end_charpos
= save_end_pos
;
7591 /* Scan forward from CHARPOS in the current buffer/string, until we
7592 find a stop position > current IT's position. Then handle the stop
7593 position before that. This is called when we bump into a stop
7594 position while reordering bidirectional text. CHARPOS should be
7595 the last previously processed stop_pos (or BEGV/0, if none were
7596 processed yet) whose position is less that IT's current
7600 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7602 int bufp
= !STRINGP (it
->string
);
7603 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7604 struct display_pos save_current
= it
->current
;
7605 struct text_pos save_position
= it
->position
;
7606 struct text_pos pos1
;
7607 EMACS_INT next_stop
;
7609 /* Scan in strict logical order. */
7610 xassert (it
->bidi_p
);
7614 it
->prev_stop
= charpos
;
7617 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7618 reseat_1 (it
, pos1
, 0);
7621 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7622 compute_stop_pos (it
);
7623 /* We must advance forward, right? */
7624 if (it
->stop_charpos
<= it
->prev_stop
)
7626 charpos
= it
->stop_charpos
;
7628 while (charpos
<= where_we_are
);
7631 it
->current
= save_current
;
7632 it
->position
= save_position
;
7633 next_stop
= it
->stop_charpos
;
7634 it
->stop_charpos
= it
->prev_stop
;
7636 it
->stop_charpos
= next_stop
;
7639 /* Load IT with the next display element from current_buffer. Value
7640 is zero if end of buffer reached. IT->stop_charpos is the next
7641 position at which to stop and check for text properties or buffer
7645 next_element_from_buffer (struct it
*it
)
7649 xassert (IT_CHARPOS (*it
) >= BEGV
);
7650 xassert (NILP (it
->string
) && !it
->s
);
7651 xassert (!it
->bidi_p
7652 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7653 && it
->bidi_it
.string
.s
== NULL
));
7655 /* With bidi reordering, the character to display might not be the
7656 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7657 we were reseat()ed to a new buffer position, which is potentially
7658 a different paragraph. */
7659 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7661 get_visually_first_element (it
);
7662 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7665 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7667 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7669 int overlay_strings_follow_p
;
7671 /* End of the game, except when overlay strings follow that
7672 haven't been returned yet. */
7673 if (it
->overlay_strings_at_end_processed_p
)
7674 overlay_strings_follow_p
= 0;
7677 it
->overlay_strings_at_end_processed_p
= 1;
7678 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7681 if (overlay_strings_follow_p
)
7682 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7686 it
->position
= it
->current
.pos
;
7690 else if (!(!it
->bidi_p
7691 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7692 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7694 /* With bidi non-linear iteration, we could find ourselves
7695 far beyond the last computed stop_charpos, with several
7696 other stop positions in between that we missed. Scan
7697 them all now, in buffer's logical order, until we find
7698 and handle the last stop_charpos that precedes our
7699 current position. */
7700 handle_stop_backwards (it
, it
->stop_charpos
);
7701 return GET_NEXT_DISPLAY_ELEMENT (it
);
7707 /* Take note of the stop position we just moved across,
7708 for when we will move back across it. */
7709 it
->prev_stop
= it
->stop_charpos
;
7710 /* If we are at base paragraph embedding level, take
7711 note of the last stop position seen at this
7713 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7714 it
->base_level_stop
= it
->stop_charpos
;
7717 return GET_NEXT_DISPLAY_ELEMENT (it
);
7721 /* If we are before prev_stop, we may have overstepped on
7722 our way backwards a stop_pos, and if so, we need to
7723 handle that stop_pos. */
7724 && IT_CHARPOS (*it
) < it
->prev_stop
7725 /* We can sometimes back up for reasons that have nothing
7726 to do with bidi reordering. E.g., compositions. The
7727 code below is only needed when we are above the base
7728 embedding level, so test for that explicitly. */
7729 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7731 if (it
->base_level_stop
<= 0
7732 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7734 /* If we lost track of base_level_stop, we need to find
7735 prev_stop by looking backwards. This happens, e.g., when
7736 we were reseated to the previous screenful of text by
7738 it
->base_level_stop
= BEGV
;
7739 compute_stop_pos_backwards (it
);
7740 handle_stop_backwards (it
, it
->prev_stop
);
7743 handle_stop_backwards (it
, it
->base_level_stop
);
7744 return GET_NEXT_DISPLAY_ELEMENT (it
);
7748 /* No face changes, overlays etc. in sight, so just return a
7749 character from current_buffer. */
7753 /* Maybe run the redisplay end trigger hook. Performance note:
7754 This doesn't seem to cost measurable time. */
7755 if (it
->redisplay_end_trigger_charpos
7757 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7758 run_redisplay_end_trigger_hook (it
);
7760 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7761 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7763 && next_element_from_composition (it
))
7768 /* Get the next character, maybe multibyte. */
7769 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7770 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7771 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7773 it
->c
= *p
, it
->len
= 1;
7775 /* Record what we have and where it came from. */
7776 it
->what
= IT_CHARACTER
;
7777 it
->object
= it
->w
->buffer
;
7778 it
->position
= it
->current
.pos
;
7780 /* Normally we return the character found above, except when we
7781 really want to return an ellipsis for selective display. */
7786 /* A value of selective > 0 means hide lines indented more
7787 than that number of columns. */
7788 if (it
->selective
> 0
7789 && IT_CHARPOS (*it
) + 1 < ZV
7790 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7791 IT_BYTEPOS (*it
) + 1,
7794 success_p
= next_element_from_ellipsis (it
);
7795 it
->dpvec_char_len
= -1;
7798 else if (it
->c
== '\r' && it
->selective
== -1)
7800 /* A value of selective == -1 means that everything from the
7801 CR to the end of the line is invisible, with maybe an
7802 ellipsis displayed for it. */
7803 success_p
= next_element_from_ellipsis (it
);
7804 it
->dpvec_char_len
= -1;
7809 /* Value is zero if end of buffer reached. */
7810 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7815 /* Run the redisplay end trigger hook for IT. */
7818 run_redisplay_end_trigger_hook (struct it
*it
)
7820 Lisp_Object args
[3];
7822 /* IT->glyph_row should be non-null, i.e. we should be actually
7823 displaying something, or otherwise we should not run the hook. */
7824 xassert (it
->glyph_row
);
7826 /* Set up hook arguments. */
7827 args
[0] = Qredisplay_end_trigger_functions
;
7828 args
[1] = it
->window
;
7829 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7830 it
->redisplay_end_trigger_charpos
= 0;
7832 /* Since we are *trying* to run these functions, don't try to run
7833 them again, even if they get an error. */
7834 it
->w
->redisplay_end_trigger
= Qnil
;
7835 Frun_hook_with_args (3, args
);
7837 /* Notice if it changed the face of the character we are on. */
7838 handle_face_prop (it
);
7842 /* Deliver a composition display element. Unlike the other
7843 next_element_from_XXX, this function is not registered in the array
7844 get_next_element[]. It is called from next_element_from_buffer and
7845 next_element_from_string when necessary. */
7848 next_element_from_composition (struct it
*it
)
7850 it
->what
= IT_COMPOSITION
;
7851 it
->len
= it
->cmp_it
.nbytes
;
7852 if (STRINGP (it
->string
))
7856 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7857 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7860 it
->position
= it
->current
.string_pos
;
7861 it
->object
= it
->string
;
7862 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7863 IT_STRING_BYTEPOS (*it
), it
->string
);
7869 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7870 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7873 if (it
->bidi_it
.new_paragraph
)
7874 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7875 /* Resync the bidi iterator with IT's new position.
7876 FIXME: this doesn't support bidirectional text. */
7877 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7878 bidi_move_to_visually_next (&it
->bidi_it
);
7882 it
->position
= it
->current
.pos
;
7883 it
->object
= it
->w
->buffer
;
7884 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7885 IT_BYTEPOS (*it
), Qnil
);
7892 /***********************************************************************
7893 Moving an iterator without producing glyphs
7894 ***********************************************************************/
7896 /* Check if iterator is at a position corresponding to a valid buffer
7897 position after some move_it_ call. */
7899 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7900 ((it)->method == GET_FROM_STRING \
7901 ? IT_STRING_CHARPOS (*it) == 0 \
7905 /* Move iterator IT to a specified buffer or X position within one
7906 line on the display without producing glyphs.
7908 OP should be a bit mask including some or all of these bits:
7909 MOVE_TO_X: Stop upon reaching x-position TO_X.
7910 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7911 Regardless of OP's value, stop upon reaching the end of the display line.
7913 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7914 This means, in particular, that TO_X includes window's horizontal
7917 The return value has several possible values that
7918 say what condition caused the scan to stop:
7920 MOVE_POS_MATCH_OR_ZV
7921 - when TO_POS or ZV was reached.
7924 -when TO_X was reached before TO_POS or ZV were reached.
7927 - when we reached the end of the display area and the line must
7931 - when we reached the end of the display area and the line is
7935 - when we stopped at a line end, i.e. a newline or a CR and selective
7938 static enum move_it_result
7939 move_it_in_display_line_to (struct it
*it
,
7940 EMACS_INT to_charpos
, int to_x
,
7941 enum move_operation_enum op
)
7943 enum move_it_result result
= MOVE_UNDEFINED
;
7944 struct glyph_row
*saved_glyph_row
;
7945 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7946 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7947 void *ppos_data
= NULL
;
7949 enum it_method prev_method
= it
->method
;
7950 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7951 int saw_smaller_pos
= prev_pos
< to_charpos
;
7953 /* Don't produce glyphs in produce_glyphs. */
7954 saved_glyph_row
= it
->glyph_row
;
7955 it
->glyph_row
= NULL
;
7957 /* Use wrap_it to save a copy of IT wherever a word wrap could
7958 occur. Use atpos_it to save a copy of IT at the desired buffer
7959 position, if found, so that we can scan ahead and check if the
7960 word later overshoots the window edge. Use atx_it similarly, for
7966 /* Use ppos_it under bidi reordering to save a copy of IT for the
7967 position > CHARPOS that is the closest to CHARPOS. We restore
7968 that position in IT when we have scanned the entire display line
7969 without finding a match for CHARPOS and all the character
7970 positions are greater than CHARPOS. */
7973 SAVE_IT (ppos_it
, *it
, ppos_data
);
7974 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7975 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7976 SAVE_IT (ppos_it
, *it
, ppos_data
);
7979 #define BUFFER_POS_REACHED_P() \
7980 ((op & MOVE_TO_POS) != 0 \
7981 && BUFFERP (it->object) \
7982 && (IT_CHARPOS (*it) == to_charpos \
7984 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7985 && IT_CHARPOS (*it) > to_charpos) \
7986 || (it->what == IT_COMPOSITION \
7987 && ((IT_CHARPOS (*it) > to_charpos \
7988 && to_charpos >= it->cmp_it.charpos) \
7989 || (IT_CHARPOS (*it) < to_charpos \
7990 && to_charpos <= it->cmp_it.charpos)))) \
7991 && (it->method == GET_FROM_BUFFER \
7992 || (it->method == GET_FROM_DISPLAY_VECTOR \
7993 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7995 /* If there's a line-/wrap-prefix, handle it. */
7996 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7997 && it
->current_y
< it
->last_visible_y
)
7998 handle_line_prefix (it
);
8000 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8001 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8005 int x
, i
, ascent
= 0, descent
= 0;
8007 /* Utility macro to reset an iterator with x, ascent, and descent. */
8008 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8009 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8010 (IT)->max_descent = descent)
8012 /* Stop if we move beyond TO_CHARPOS (after an image or a
8013 display string or stretch glyph). */
8014 if ((op
& MOVE_TO_POS
) != 0
8015 && BUFFERP (it
->object
)
8016 && it
->method
== GET_FROM_BUFFER
8018 /* When the iterator is at base embedding level, we
8019 are guaranteed that characters are delivered for
8020 display in strictly increasing order of their
8021 buffer positions. */
8022 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8023 && IT_CHARPOS (*it
) > to_charpos
)
8025 && (prev_method
== GET_FROM_IMAGE
8026 || prev_method
== GET_FROM_STRETCH
8027 || prev_method
== GET_FROM_STRING
)
8028 /* Passed TO_CHARPOS from left to right. */
8029 && ((prev_pos
< to_charpos
8030 && IT_CHARPOS (*it
) > to_charpos
)
8031 /* Passed TO_CHARPOS from right to left. */
8032 || (prev_pos
> to_charpos
8033 && IT_CHARPOS (*it
) < to_charpos
)))))
8035 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8037 result
= MOVE_POS_MATCH_OR_ZV
;
8040 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8041 /* If wrap_it is valid, the current position might be in a
8042 word that is wrapped. So, save the iterator in
8043 atpos_it and continue to see if wrapping happens. */
8044 SAVE_IT (atpos_it
, *it
, atpos_data
);
8047 /* Stop when ZV reached.
8048 We used to stop here when TO_CHARPOS reached as well, but that is
8049 too soon if this glyph does not fit on this line. So we handle it
8050 explicitly below. */
8051 if (!get_next_display_element (it
))
8053 result
= MOVE_POS_MATCH_OR_ZV
;
8057 if (it
->line_wrap
== TRUNCATE
)
8059 if (BUFFER_POS_REACHED_P ())
8061 result
= MOVE_POS_MATCH_OR_ZV
;
8067 if (it
->line_wrap
== WORD_WRAP
)
8069 if (IT_DISPLAYING_WHITESPACE (it
))
8073 /* We have reached a glyph that follows one or more
8074 whitespace characters. If the position is
8075 already found, we are done. */
8076 if (atpos_it
.sp
>= 0)
8078 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8079 result
= MOVE_POS_MATCH_OR_ZV
;
8084 RESTORE_IT (it
, &atx_it
, atx_data
);
8085 result
= MOVE_X_REACHED
;
8088 /* Otherwise, we can wrap here. */
8089 SAVE_IT (wrap_it
, *it
, wrap_data
);
8095 /* Remember the line height for the current line, in case
8096 the next element doesn't fit on the line. */
8097 ascent
= it
->max_ascent
;
8098 descent
= it
->max_descent
;
8100 /* The call to produce_glyphs will get the metrics of the
8101 display element IT is loaded with. Record the x-position
8102 before this display element, in case it doesn't fit on the
8106 PRODUCE_GLYPHS (it
);
8108 if (it
->area
!= TEXT_AREA
)
8110 prev_method
= it
->method
;
8111 if (it
->method
== GET_FROM_BUFFER
)
8112 prev_pos
= IT_CHARPOS (*it
);
8113 set_iterator_to_next (it
, 1);
8114 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8115 SET_TEXT_POS (this_line_min_pos
,
8116 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8118 && (op
& MOVE_TO_POS
)
8119 && IT_CHARPOS (*it
) > to_charpos
8120 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8121 SAVE_IT (ppos_it
, *it
, ppos_data
);
8125 /* The number of glyphs we get back in IT->nglyphs will normally
8126 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8127 character on a terminal frame, or (iii) a line end. For the
8128 second case, IT->nglyphs - 1 padding glyphs will be present.
8129 (On X frames, there is only one glyph produced for a
8130 composite character.)
8132 The behavior implemented below means, for continuation lines,
8133 that as many spaces of a TAB as fit on the current line are
8134 displayed there. For terminal frames, as many glyphs of a
8135 multi-glyph character are displayed in the current line, too.
8136 This is what the old redisplay code did, and we keep it that
8137 way. Under X, the whole shape of a complex character must
8138 fit on the line or it will be completely displayed in the
8141 Note that both for tabs and padding glyphs, all glyphs have
8145 /* More than one glyph or glyph doesn't fit on line. All
8146 glyphs have the same width. */
8147 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8149 int x_before_this_char
= x
;
8150 int hpos_before_this_char
= it
->hpos
;
8152 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8154 new_x
= x
+ single_glyph_width
;
8156 /* We want to leave anything reaching TO_X to the caller. */
8157 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8159 if (BUFFER_POS_REACHED_P ())
8161 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8162 goto buffer_pos_reached
;
8163 if (atpos_it
.sp
< 0)
8165 SAVE_IT (atpos_it
, *it
, atpos_data
);
8166 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8171 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8174 result
= MOVE_X_REACHED
;
8179 SAVE_IT (atx_it
, *it
, atx_data
);
8180 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8185 if (/* Lines are continued. */
8186 it
->line_wrap
!= TRUNCATE
8187 && (/* And glyph doesn't fit on the line. */
8188 new_x
> it
->last_visible_x
8189 /* Or it fits exactly and we're on a window
8191 || (new_x
== it
->last_visible_x
8192 && FRAME_WINDOW_P (it
->f
))))
8194 if (/* IT->hpos == 0 means the very first glyph
8195 doesn't fit on the line, e.g. a wide image. */
8197 || (new_x
== it
->last_visible_x
8198 && FRAME_WINDOW_P (it
->f
)))
8201 it
->current_x
= new_x
;
8203 /* The character's last glyph just barely fits
8205 if (i
== it
->nglyphs
- 1)
8207 /* If this is the destination position,
8208 return a position *before* it in this row,
8209 now that we know it fits in this row. */
8210 if (BUFFER_POS_REACHED_P ())
8212 if (it
->line_wrap
!= WORD_WRAP
8215 it
->hpos
= hpos_before_this_char
;
8216 it
->current_x
= x_before_this_char
;
8217 result
= MOVE_POS_MATCH_OR_ZV
;
8220 if (it
->line_wrap
== WORD_WRAP
8223 SAVE_IT (atpos_it
, *it
, atpos_data
);
8224 atpos_it
.current_x
= x_before_this_char
;
8225 atpos_it
.hpos
= hpos_before_this_char
;
8229 prev_method
= it
->method
;
8230 if (it
->method
== GET_FROM_BUFFER
)
8231 prev_pos
= IT_CHARPOS (*it
);
8232 set_iterator_to_next (it
, 1);
8233 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8234 SET_TEXT_POS (this_line_min_pos
,
8235 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8236 /* On graphical terminals, newlines may
8237 "overflow" into the fringe if
8238 overflow-newline-into-fringe is non-nil.
8239 On text-only terminals, newlines may
8240 overflow into the last glyph on the
8242 if (!FRAME_WINDOW_P (it
->f
)
8243 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8245 if (!get_next_display_element (it
))
8247 result
= MOVE_POS_MATCH_OR_ZV
;
8250 if (BUFFER_POS_REACHED_P ())
8252 if (ITERATOR_AT_END_OF_LINE_P (it
))
8253 result
= MOVE_POS_MATCH_OR_ZV
;
8255 result
= MOVE_LINE_CONTINUED
;
8258 if (ITERATOR_AT_END_OF_LINE_P (it
))
8260 result
= MOVE_NEWLINE_OR_CR
;
8267 IT_RESET_X_ASCENT_DESCENT (it
);
8269 if (wrap_it
.sp
>= 0)
8271 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8276 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8278 result
= MOVE_LINE_CONTINUED
;
8282 if (BUFFER_POS_REACHED_P ())
8284 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8285 goto buffer_pos_reached
;
8286 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8288 SAVE_IT (atpos_it
, *it
, atpos_data
);
8289 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8293 if (new_x
> it
->first_visible_x
)
8295 /* Glyph is visible. Increment number of glyphs that
8296 would be displayed. */
8301 if (result
!= MOVE_UNDEFINED
)
8304 else if (BUFFER_POS_REACHED_P ())
8307 IT_RESET_X_ASCENT_DESCENT (it
);
8308 result
= MOVE_POS_MATCH_OR_ZV
;
8311 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8313 /* Stop when TO_X specified and reached. This check is
8314 necessary here because of lines consisting of a line end,
8315 only. The line end will not produce any glyphs and we
8316 would never get MOVE_X_REACHED. */
8317 xassert (it
->nglyphs
== 0);
8318 result
= MOVE_X_REACHED
;
8322 /* Is this a line end? If yes, we're done. */
8323 if (ITERATOR_AT_END_OF_LINE_P (it
))
8325 /* If we are past TO_CHARPOS, but never saw any character
8326 positions smaller than TO_CHARPOS, return
8327 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8329 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8331 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8333 if (IT_CHARPOS (ppos_it
) < ZV
)
8335 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8336 result
= MOVE_POS_MATCH_OR_ZV
;
8339 goto buffer_pos_reached
;
8341 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8342 && IT_CHARPOS (*it
) > to_charpos
)
8343 goto buffer_pos_reached
;
8345 result
= MOVE_NEWLINE_OR_CR
;
8348 result
= MOVE_NEWLINE_OR_CR
;
8352 prev_method
= it
->method
;
8353 if (it
->method
== GET_FROM_BUFFER
)
8354 prev_pos
= IT_CHARPOS (*it
);
8355 /* The current display element has been consumed. Advance
8357 set_iterator_to_next (it
, 1);
8358 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8359 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8360 if (IT_CHARPOS (*it
) < to_charpos
)
8361 saw_smaller_pos
= 1;
8363 && (op
& MOVE_TO_POS
)
8364 && IT_CHARPOS (*it
) >= to_charpos
8365 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8366 SAVE_IT (ppos_it
, *it
, ppos_data
);
8368 /* Stop if lines are truncated and IT's current x-position is
8369 past the right edge of the window now. */
8370 if (it
->line_wrap
== TRUNCATE
8371 && it
->current_x
>= it
->last_visible_x
)
8373 if (!FRAME_WINDOW_P (it
->f
)
8374 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8378 if ((at_eob_p
= !get_next_display_element (it
))
8379 || BUFFER_POS_REACHED_P ()
8380 /* If we are past TO_CHARPOS, but never saw any
8381 character positions smaller than TO_CHARPOS,
8382 return MOVE_POS_MATCH_OR_ZV, like the
8383 unidirectional display did. */
8384 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8386 && IT_CHARPOS (*it
) > to_charpos
))
8389 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8390 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8391 result
= MOVE_POS_MATCH_OR_ZV
;
8394 if (ITERATOR_AT_END_OF_LINE_P (it
))
8396 result
= MOVE_NEWLINE_OR_CR
;
8400 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8402 && IT_CHARPOS (*it
) > to_charpos
)
8404 if (IT_CHARPOS (ppos_it
) < ZV
)
8405 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8406 result
= MOVE_POS_MATCH_OR_ZV
;
8409 result
= MOVE_LINE_TRUNCATED
;
8412 #undef IT_RESET_X_ASCENT_DESCENT
8415 #undef BUFFER_POS_REACHED_P
8417 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8418 restore the saved iterator. */
8419 if (atpos_it
.sp
>= 0)
8420 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8421 else if (atx_it
.sp
>= 0)
8422 RESTORE_IT (it
, &atx_it
, atx_data
);
8427 bidi_unshelve_cache (atpos_data
, 1);
8429 bidi_unshelve_cache (atx_data
, 1);
8431 bidi_unshelve_cache (wrap_data
, 1);
8433 bidi_unshelve_cache (ppos_data
, 1);
8435 /* Restore the iterator settings altered at the beginning of this
8437 it
->glyph_row
= saved_glyph_row
;
8441 /* For external use. */
8443 move_it_in_display_line (struct it
*it
,
8444 EMACS_INT to_charpos
, int to_x
,
8445 enum move_operation_enum op
)
8447 if (it
->line_wrap
== WORD_WRAP
8448 && (op
& MOVE_TO_X
))
8451 void *save_data
= NULL
;
8454 SAVE_IT (save_it
, *it
, save_data
);
8455 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8456 /* When word-wrap is on, TO_X may lie past the end
8457 of a wrapped line. Then it->current is the
8458 character on the next line, so backtrack to the
8459 space before the wrap point. */
8460 if (skip
== MOVE_LINE_CONTINUED
)
8462 int prev_x
= max (it
->current_x
- 1, 0);
8463 RESTORE_IT (it
, &save_it
, save_data
);
8464 move_it_in_display_line_to
8465 (it
, -1, prev_x
, MOVE_TO_X
);
8468 bidi_unshelve_cache (save_data
, 1);
8471 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8475 /* Move IT forward until it satisfies one or more of the criteria in
8476 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8478 OP is a bit-mask that specifies where to stop, and in particular,
8479 which of those four position arguments makes a difference. See the
8480 description of enum move_operation_enum.
8482 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8483 screen line, this function will set IT to the next position that is
8484 displayed to the right of TO_CHARPOS on the screen. */
8487 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8489 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8490 int line_height
, line_start_x
= 0, reached
= 0;
8491 void *backup_data
= NULL
;
8495 if (op
& MOVE_TO_VPOS
)
8497 /* If no TO_CHARPOS and no TO_X specified, stop at the
8498 start of the line TO_VPOS. */
8499 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8501 if (it
->vpos
== to_vpos
)
8507 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8511 /* TO_VPOS >= 0 means stop at TO_X in the line at
8512 TO_VPOS, or at TO_POS, whichever comes first. */
8513 if (it
->vpos
== to_vpos
)
8519 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8521 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8526 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8528 /* We have reached TO_X but not in the line we want. */
8529 skip
= move_it_in_display_line_to (it
, to_charpos
,
8531 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8539 else if (op
& MOVE_TO_Y
)
8541 struct it it_backup
;
8543 if (it
->line_wrap
== WORD_WRAP
)
8544 SAVE_IT (it_backup
, *it
, backup_data
);
8546 /* TO_Y specified means stop at TO_X in the line containing
8547 TO_Y---or at TO_CHARPOS if this is reached first. The
8548 problem is that we can't really tell whether the line
8549 contains TO_Y before we have completely scanned it, and
8550 this may skip past TO_X. What we do is to first scan to
8553 If TO_X is not specified, use a TO_X of zero. The reason
8554 is to make the outcome of this function more predictable.
8555 If we didn't use TO_X == 0, we would stop at the end of
8556 the line which is probably not what a caller would expect
8558 skip
= move_it_in_display_line_to
8559 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8560 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8562 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8563 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8565 else if (skip
== MOVE_X_REACHED
)
8567 /* If TO_X was reached, we want to know whether TO_Y is
8568 in the line. We know this is the case if the already
8569 scanned glyphs make the line tall enough. Otherwise,
8570 we must check by scanning the rest of the line. */
8571 line_height
= it
->max_ascent
+ it
->max_descent
;
8572 if (to_y
>= it
->current_y
8573 && to_y
< it
->current_y
+ line_height
)
8578 SAVE_IT (it_backup
, *it
, backup_data
);
8579 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8580 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8582 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8583 line_height
= it
->max_ascent
+ it
->max_descent
;
8584 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8586 if (to_y
>= it
->current_y
8587 && to_y
< it
->current_y
+ line_height
)
8589 /* If TO_Y is in this line and TO_X was reached
8590 above, we scanned too far. We have to restore
8591 IT's settings to the ones before skipping. */
8592 RESTORE_IT (it
, &it_backup
, backup_data
);
8598 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8604 /* Check whether TO_Y is in this line. */
8605 line_height
= it
->max_ascent
+ it
->max_descent
;
8606 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8608 if (to_y
>= it
->current_y
8609 && to_y
< it
->current_y
+ line_height
)
8611 /* When word-wrap is on, TO_X may lie past the end
8612 of a wrapped line. Then it->current is the
8613 character on the next line, so backtrack to the
8614 space before the wrap point. */
8615 if (skip
== MOVE_LINE_CONTINUED
8616 && it
->line_wrap
== WORD_WRAP
)
8618 int prev_x
= max (it
->current_x
- 1, 0);
8619 RESTORE_IT (it
, &it_backup
, backup_data
);
8620 skip
= move_it_in_display_line_to
8621 (it
, -1, prev_x
, MOVE_TO_X
);
8630 else if (BUFFERP (it
->object
)
8631 && (it
->method
== GET_FROM_BUFFER
8632 || it
->method
== GET_FROM_STRETCH
)
8633 && IT_CHARPOS (*it
) >= to_charpos
8634 /* Under bidi iteration, a call to set_iterator_to_next
8635 can scan far beyond to_charpos if the initial
8636 portion of the next line needs to be reordered. In
8637 that case, give move_it_in_display_line_to another
8640 && it
->bidi_it
.scan_dir
== -1))
8641 skip
= MOVE_POS_MATCH_OR_ZV
;
8643 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8647 case MOVE_POS_MATCH_OR_ZV
:
8651 case MOVE_NEWLINE_OR_CR
:
8652 set_iterator_to_next (it
, 1);
8653 it
->continuation_lines_width
= 0;
8656 case MOVE_LINE_TRUNCATED
:
8657 it
->continuation_lines_width
= 0;
8658 reseat_at_next_visible_line_start (it
, 0);
8659 if ((op
& MOVE_TO_POS
) != 0
8660 && IT_CHARPOS (*it
) > to_charpos
)
8667 case MOVE_LINE_CONTINUED
:
8668 /* For continued lines ending in a tab, some of the glyphs
8669 associated with the tab are displayed on the current
8670 line. Since it->current_x does not include these glyphs,
8671 we use it->last_visible_x instead. */
8674 it
->continuation_lines_width
+= it
->last_visible_x
;
8675 /* When moving by vpos, ensure that the iterator really
8676 advances to the next line (bug#847, bug#969). Fixme:
8677 do we need to do this in other circumstances? */
8678 if (it
->current_x
!= it
->last_visible_x
8679 && (op
& MOVE_TO_VPOS
)
8680 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8682 line_start_x
= it
->current_x
+ it
->pixel_width
8683 - it
->last_visible_x
;
8684 set_iterator_to_next (it
, 0);
8688 it
->continuation_lines_width
+= it
->current_x
;
8695 /* Reset/increment for the next run. */
8696 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8697 it
->current_x
= line_start_x
;
8700 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8702 last_height
= it
->max_ascent
+ it
->max_descent
;
8703 last_max_ascent
= it
->max_ascent
;
8704 it
->max_ascent
= it
->max_descent
= 0;
8709 /* On text terminals, we may stop at the end of a line in the middle
8710 of a multi-character glyph. If the glyph itself is continued,
8711 i.e. it is actually displayed on the next line, don't treat this
8712 stopping point as valid; move to the next line instead (unless
8713 that brings us offscreen). */
8714 if (!FRAME_WINDOW_P (it
->f
)
8716 && IT_CHARPOS (*it
) == to_charpos
8717 && it
->what
== IT_CHARACTER
8719 && it
->line_wrap
== WINDOW_WRAP
8720 && it
->current_x
== it
->last_visible_x
- 1
8723 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8725 it
->continuation_lines_width
+= it
->current_x
;
8726 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8727 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8729 last_height
= it
->max_ascent
+ it
->max_descent
;
8730 last_max_ascent
= it
->max_ascent
;
8734 bidi_unshelve_cache (backup_data
, 1);
8736 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8740 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8742 If DY > 0, move IT backward at least that many pixels. DY = 0
8743 means move IT backward to the preceding line start or BEGV. This
8744 function may move over more than DY pixels if IT->current_y - DY
8745 ends up in the middle of a line; in this case IT->current_y will be
8746 set to the top of the line moved to. */
8749 move_it_vertically_backward (struct it
*it
, int dy
)
8753 void *it2data
= NULL
, *it3data
= NULL
;
8754 EMACS_INT start_pos
;
8759 start_pos
= IT_CHARPOS (*it
);
8761 /* Estimate how many newlines we must move back. */
8762 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8764 /* Set the iterator's position that many lines back. */
8765 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8766 back_to_previous_visible_line_start (it
);
8768 /* Reseat the iterator here. When moving backward, we don't want
8769 reseat to skip forward over invisible text, set up the iterator
8770 to deliver from overlay strings at the new position etc. So,
8771 use reseat_1 here. */
8772 reseat_1 (it
, it
->current
.pos
, 1);
8774 /* We are now surely at a line start. */
8775 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8776 reordering is in effect. */
8777 it
->continuation_lines_width
= 0;
8779 /* Move forward and see what y-distance we moved. First move to the
8780 start of the next line so that we get its height. We need this
8781 height to be able to tell whether we reached the specified
8783 SAVE_IT (it2
, *it
, it2data
);
8784 it2
.max_ascent
= it2
.max_descent
= 0;
8787 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8788 MOVE_TO_POS
| MOVE_TO_VPOS
);
8790 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8791 /* If we are in a display string which starts at START_POS,
8792 and that display string includes a newline, and we are
8793 right after that newline (i.e. at the beginning of a
8794 display line), exit the loop, because otherwise we will
8795 infloop, since move_it_to will see that it is already at
8796 START_POS and will not move. */
8797 || (it2
.method
== GET_FROM_STRING
8798 && IT_CHARPOS (it2
) == start_pos
8799 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8800 xassert (IT_CHARPOS (*it
) >= BEGV
);
8801 SAVE_IT (it3
, it2
, it3data
);
8803 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8804 xassert (IT_CHARPOS (*it
) >= BEGV
);
8805 /* H is the actual vertical distance from the position in *IT
8806 and the starting position. */
8807 h
= it2
.current_y
- it
->current_y
;
8808 /* NLINES is the distance in number of lines. */
8809 nlines
= it2
.vpos
- it
->vpos
;
8811 /* Correct IT's y and vpos position
8812 so that they are relative to the starting point. */
8818 /* DY == 0 means move to the start of the screen line. The
8819 value of nlines is > 0 if continuation lines were involved,
8820 or if the original IT position was at start of a line. */
8821 RESTORE_IT (it
, it
, it2data
);
8823 move_it_by_lines (it
, nlines
);
8824 /* The above code moves us to some position NLINES down,
8825 usually to its first glyph (leftmost in an L2R line), but
8826 that's not necessarily the start of the line, under bidi
8827 reordering. We want to get to the character position
8828 that is immediately after the newline of the previous
8831 && !it
->continuation_lines_width
8832 && !STRINGP (it
->string
)
8833 && IT_CHARPOS (*it
) > BEGV
8834 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8837 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8839 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8841 bidi_unshelve_cache (it3data
, 1);
8845 /* The y-position we try to reach, relative to *IT.
8846 Note that H has been subtracted in front of the if-statement. */
8847 int target_y
= it
->current_y
+ h
- dy
;
8848 int y0
= it3
.current_y
;
8852 RESTORE_IT (&it3
, &it3
, it3data
);
8853 y1
= line_bottom_y (&it3
);
8854 line_height
= y1
- y0
;
8855 RESTORE_IT (it
, it
, it2data
);
8856 /* If we did not reach target_y, try to move further backward if
8857 we can. If we moved too far backward, try to move forward. */
8858 if (target_y
< it
->current_y
8859 /* This is heuristic. In a window that's 3 lines high, with
8860 a line height of 13 pixels each, recentering with point
8861 on the bottom line will try to move -39/2 = 19 pixels
8862 backward. Try to avoid moving into the first line. */
8863 && (it
->current_y
- target_y
8864 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8865 && IT_CHARPOS (*it
) > BEGV
)
8867 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8868 target_y
- it
->current_y
));
8869 dy
= it
->current_y
- target_y
;
8870 goto move_further_back
;
8872 else if (target_y
>= it
->current_y
+ line_height
8873 && IT_CHARPOS (*it
) < ZV
)
8875 /* Should move forward by at least one line, maybe more.
8877 Note: Calling move_it_by_lines can be expensive on
8878 terminal frames, where compute_motion is used (via
8879 vmotion) to do the job, when there are very long lines
8880 and truncate-lines is nil. That's the reason for
8881 treating terminal frames specially here. */
8883 if (!FRAME_WINDOW_P (it
->f
))
8884 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8889 move_it_by_lines (it
, 1);
8891 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8898 /* Move IT by a specified amount of pixel lines DY. DY negative means
8899 move backwards. DY = 0 means move to start of screen line. At the
8900 end, IT will be on the start of a screen line. */
8903 move_it_vertically (struct it
*it
, int dy
)
8906 move_it_vertically_backward (it
, -dy
);
8909 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8910 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8911 MOVE_TO_POS
| MOVE_TO_Y
);
8912 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8914 /* If buffer ends in ZV without a newline, move to the start of
8915 the line to satisfy the post-condition. */
8916 if (IT_CHARPOS (*it
) == ZV
8918 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8919 move_it_by_lines (it
, 0);
8924 /* Move iterator IT past the end of the text line it is in. */
8927 move_it_past_eol (struct it
*it
)
8929 enum move_it_result rc
;
8931 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8932 if (rc
== MOVE_NEWLINE_OR_CR
)
8933 set_iterator_to_next (it
, 0);
8937 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8938 negative means move up. DVPOS == 0 means move to the start of the
8941 Optimization idea: If we would know that IT->f doesn't use
8942 a face with proportional font, we could be faster for
8943 truncate-lines nil. */
8946 move_it_by_lines (struct it
*it
, int dvpos
)
8949 /* The commented-out optimization uses vmotion on terminals. This
8950 gives bad results, because elements like it->what, on which
8951 callers such as pos_visible_p rely, aren't updated. */
8952 /* struct position pos;
8953 if (!FRAME_WINDOW_P (it->f))
8955 struct text_pos textpos;
8957 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8958 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8959 reseat (it, textpos, 1);
8960 it->vpos += pos.vpos;
8961 it->current_y += pos.vpos;
8967 /* DVPOS == 0 means move to the start of the screen line. */
8968 move_it_vertically_backward (it
, 0);
8969 /* Let next call to line_bottom_y calculate real line height */
8974 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8975 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8977 /* Only move to the next buffer position if we ended up in a
8978 string from display property, not in an overlay string
8979 (before-string or after-string). That is because the
8980 latter don't conceal the underlying buffer position, so
8981 we can ask to move the iterator to the exact position we
8982 are interested in. Note that, even if we are already at
8983 IT_CHARPOS (*it), the call below is not a no-op, as it
8984 will detect that we are at the end of the string, pop the
8985 iterator, and compute it->current_x and it->hpos
8987 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
8988 -1, -1, -1, MOVE_TO_POS
);
8994 void *it2data
= NULL
;
8995 EMACS_INT start_charpos
, i
;
8997 /* Start at the beginning of the screen line containing IT's
8998 position. This may actually move vertically backwards,
8999 in case of overlays, so adjust dvpos accordingly. */
9001 move_it_vertically_backward (it
, 0);
9004 /* Go back -DVPOS visible lines and reseat the iterator there. */
9005 start_charpos
= IT_CHARPOS (*it
);
9006 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
9007 back_to_previous_visible_line_start (it
);
9008 reseat (it
, it
->current
.pos
, 1);
9010 /* Move further back if we end up in a string or an image. */
9011 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9013 /* First try to move to start of display line. */
9015 move_it_vertically_backward (it
, 0);
9017 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9019 /* If start of line is still in string or image,
9020 move further back. */
9021 back_to_previous_visible_line_start (it
);
9022 reseat (it
, it
->current
.pos
, 1);
9026 it
->current_x
= it
->hpos
= 0;
9028 /* Above call may have moved too far if continuation lines
9029 are involved. Scan forward and see if it did. */
9030 SAVE_IT (it2
, *it
, it2data
);
9031 it2
.vpos
= it2
.current_y
= 0;
9032 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9033 it
->vpos
-= it2
.vpos
;
9034 it
->current_y
-= it2
.current_y
;
9035 it
->current_x
= it
->hpos
= 0;
9037 /* If we moved too far back, move IT some lines forward. */
9038 if (it2
.vpos
> -dvpos
)
9040 int delta
= it2
.vpos
+ dvpos
;
9042 RESTORE_IT (&it2
, &it2
, it2data
);
9043 SAVE_IT (it2
, *it
, it2data
);
9044 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9045 /* Move back again if we got too far ahead. */
9046 if (IT_CHARPOS (*it
) >= start_charpos
)
9047 RESTORE_IT (it
, &it2
, it2data
);
9049 bidi_unshelve_cache (it2data
, 1);
9052 RESTORE_IT (it
, it
, it2data
);
9056 /* Return 1 if IT points into the middle of a display vector. */
9059 in_display_vector_p (struct it
*it
)
9061 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9062 && it
->current
.dpvec_index
> 0
9063 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9067 /***********************************************************************
9069 ***********************************************************************/
9072 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9076 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9078 Lisp_Object args
[3];
9079 Lisp_Object msg
, fmt
;
9082 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9085 /* Do nothing if called asynchronously. Inserting text into
9086 a buffer may call after-change-functions and alike and
9087 that would means running Lisp asynchronously. */
9088 if (handling_signal
)
9092 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9094 args
[0] = fmt
= build_string (format
);
9097 msg
= Fformat (3, args
);
9099 len
= SBYTES (msg
) + 1;
9100 SAFE_ALLOCA (buffer
, char *, len
);
9101 memcpy (buffer
, SDATA (msg
), len
);
9103 message_dolog (buffer
, len
- 1, 1, 0);
9110 /* Output a newline in the *Messages* buffer if "needs" one. */
9113 message_log_maybe_newline (void)
9115 if (message_log_need_newline
)
9116 message_dolog ("", 0, 1, 0);
9120 /* Add a string M of length NBYTES to the message log, optionally
9121 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9122 nonzero, means interpret the contents of M as multibyte. This
9123 function calls low-level routines in order to bypass text property
9124 hooks, etc. which might not be safe to run.
9126 This may GC (insert may run before/after change hooks),
9127 so the buffer M must NOT point to a Lisp string. */
9130 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9132 const unsigned char *msg
= (const unsigned char *) m
;
9134 if (!NILP (Vmemory_full
))
9137 if (!NILP (Vmessage_log_max
))
9139 struct buffer
*oldbuf
;
9140 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9141 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9142 EMACS_INT point_at_end
= 0;
9143 EMACS_INT zv_at_end
= 0;
9144 Lisp_Object old_deactivate_mark
, tem
;
9145 struct gcpro gcpro1
;
9147 old_deactivate_mark
= Vdeactivate_mark
;
9148 oldbuf
= current_buffer
;
9149 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9150 BVAR (current_buffer
, undo_list
) = Qt
;
9152 oldpoint
= message_dolog_marker1
;
9153 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9154 oldbegv
= message_dolog_marker2
;
9155 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9156 oldzv
= message_dolog_marker3
;
9157 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9158 GCPRO1 (old_deactivate_mark
);
9166 BEGV_BYTE
= BEG_BYTE
;
9169 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9171 /* Insert the string--maybe converting multibyte to single byte
9172 or vice versa, so that all the text fits the buffer. */
9174 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9180 /* Convert a multibyte string to single-byte
9181 for the *Message* buffer. */
9182 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9184 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9185 work
[0] = (ASCII_CHAR_P (c
)
9187 : multibyte_char_to_unibyte (c
));
9188 insert_1_both (work
, 1, 1, 1, 0, 0);
9191 else if (! multibyte
9192 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9196 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9197 /* Convert a single-byte string to multibyte
9198 for the *Message* buffer. */
9199 for (i
= 0; i
< nbytes
; i
++)
9202 MAKE_CHAR_MULTIBYTE (c
);
9203 char_bytes
= CHAR_STRING (c
, str
);
9204 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9208 insert_1 (m
, nbytes
, 1, 0, 0);
9212 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9214 insert_1 ("\n", 1, 1, 0, 0);
9216 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9218 this_bol_byte
= PT_BYTE
;
9220 /* See if this line duplicates the previous one.
9221 If so, combine duplicates. */
9224 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9226 prev_bol_byte
= PT_BYTE
;
9228 dups
= message_log_check_duplicate (prev_bol_byte
,
9232 del_range_both (prev_bol
, prev_bol_byte
,
9233 this_bol
, this_bol_byte
, 0);
9236 char dupstr
[sizeof " [ times]"
9237 + INT_STRLEN_BOUND (printmax_t
)];
9240 /* If you change this format, don't forget to also
9241 change message_log_check_duplicate. */
9242 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9243 duplen
= strlen (dupstr
);
9244 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9245 insert_1 (dupstr
, duplen
, 1, 0, 1);
9250 /* If we have more than the desired maximum number of lines
9251 in the *Messages* buffer now, delete the oldest ones.
9252 This is safe because we don't have undo in this buffer. */
9254 if (NATNUMP (Vmessage_log_max
))
9256 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9257 -XFASTINT (Vmessage_log_max
) - 1, 0);
9258 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9261 BEGV
= XMARKER (oldbegv
)->charpos
;
9262 BEGV_BYTE
= marker_byte_position (oldbegv
);
9271 ZV
= XMARKER (oldzv
)->charpos
;
9272 ZV_BYTE
= marker_byte_position (oldzv
);
9276 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9278 /* We can't do Fgoto_char (oldpoint) because it will run some
9280 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9281 XMARKER (oldpoint
)->bytepos
);
9284 unchain_marker (XMARKER (oldpoint
));
9285 unchain_marker (XMARKER (oldbegv
));
9286 unchain_marker (XMARKER (oldzv
));
9288 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9289 set_buffer_internal (oldbuf
);
9291 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9292 message_log_need_newline
= !nlflag
;
9293 Vdeactivate_mark
= old_deactivate_mark
;
9298 /* We are at the end of the buffer after just having inserted a newline.
9299 (Note: We depend on the fact we won't be crossing the gap.)
9300 Check to see if the most recent message looks a lot like the previous one.
9301 Return 0 if different, 1 if the new one should just replace it, or a
9302 value N > 1 if we should also append " [N times]". */
9305 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9308 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9310 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9311 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9313 for (i
= 0; i
< len
; i
++)
9315 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9323 if (*p1
++ == ' ' && *p1
++ == '[')
9326 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9327 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9334 /* Display an echo area message M with a specified length of NBYTES
9335 bytes. The string may include null characters. If M is 0, clear
9336 out any existing message, and let the mini-buffer text show
9339 This may GC, so the buffer M must NOT point to a Lisp string. */
9342 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9344 /* First flush out any partial line written with print. */
9345 message_log_maybe_newline ();
9347 message_dolog (m
, nbytes
, 1, multibyte
);
9348 message2_nolog (m
, nbytes
, multibyte
);
9352 /* The non-logging counterpart of message2. */
9355 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9357 struct frame
*sf
= SELECTED_FRAME ();
9358 message_enable_multibyte
= multibyte
;
9360 if (FRAME_INITIAL_P (sf
))
9362 if (noninteractive_need_newline
)
9363 putc ('\n', stderr
);
9364 noninteractive_need_newline
= 0;
9366 fwrite (m
, nbytes
, 1, stderr
);
9367 if (cursor_in_echo_area
== 0)
9368 fprintf (stderr
, "\n");
9371 /* A null message buffer means that the frame hasn't really been
9372 initialized yet. Error messages get reported properly by
9373 cmd_error, so this must be just an informative message; toss it. */
9374 else if (INTERACTIVE
9375 && sf
->glyphs_initialized_p
9376 && FRAME_MESSAGE_BUF (sf
))
9378 Lisp_Object mini_window
;
9381 /* Get the frame containing the mini-buffer
9382 that the selected frame is using. */
9383 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9384 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9386 FRAME_SAMPLE_VISIBILITY (f
);
9387 if (FRAME_VISIBLE_P (sf
)
9388 && ! FRAME_VISIBLE_P (f
))
9389 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9393 set_message (m
, Qnil
, nbytes
, multibyte
);
9394 if (minibuffer_auto_raise
)
9395 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9398 clear_message (1, 1);
9400 do_pending_window_change (0);
9401 echo_area_display (1);
9402 do_pending_window_change (0);
9403 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9404 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9409 /* Display an echo area message M with a specified length of NBYTES
9410 bytes. The string may include null characters. If M is not a
9411 string, clear out any existing message, and let the mini-buffer
9414 This function cancels echoing. */
9417 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9419 struct gcpro gcpro1
;
9422 clear_message (1,1);
9425 /* First flush out any partial line written with print. */
9426 message_log_maybe_newline ();
9432 SAFE_ALLOCA (buffer
, char *, nbytes
);
9433 memcpy (buffer
, SDATA (m
), nbytes
);
9434 message_dolog (buffer
, nbytes
, 1, multibyte
);
9437 message3_nolog (m
, nbytes
, multibyte
);
9443 /* The non-logging version of message3.
9444 This does not cancel echoing, because it is used for echoing.
9445 Perhaps we need to make a separate function for echoing
9446 and make this cancel echoing. */
9449 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9451 struct frame
*sf
= SELECTED_FRAME ();
9452 message_enable_multibyte
= multibyte
;
9454 if (FRAME_INITIAL_P (sf
))
9456 if (noninteractive_need_newline
)
9457 putc ('\n', stderr
);
9458 noninteractive_need_newline
= 0;
9460 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9461 if (cursor_in_echo_area
== 0)
9462 fprintf (stderr
, "\n");
9465 /* A null message buffer means that the frame hasn't really been
9466 initialized yet. Error messages get reported properly by
9467 cmd_error, so this must be just an informative message; toss it. */
9468 else if (INTERACTIVE
9469 && sf
->glyphs_initialized_p
9470 && FRAME_MESSAGE_BUF (sf
))
9472 Lisp_Object mini_window
;
9476 /* Get the frame containing the mini-buffer
9477 that the selected frame is using. */
9478 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9479 frame
= XWINDOW (mini_window
)->frame
;
9482 FRAME_SAMPLE_VISIBILITY (f
);
9483 if (FRAME_VISIBLE_P (sf
)
9484 && !FRAME_VISIBLE_P (f
))
9485 Fmake_frame_visible (frame
);
9487 if (STRINGP (m
) && SCHARS (m
) > 0)
9489 set_message (NULL
, m
, nbytes
, multibyte
);
9490 if (minibuffer_auto_raise
)
9491 Fraise_frame (frame
);
9492 /* Assume we are not echoing.
9493 (If we are, echo_now will override this.) */
9494 echo_message_buffer
= Qnil
;
9497 clear_message (1, 1);
9499 do_pending_window_change (0);
9500 echo_area_display (1);
9501 do_pending_window_change (0);
9502 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9503 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9508 /* Display a null-terminated echo area message M. If M is 0, clear
9509 out any existing message, and let the mini-buffer text show through.
9511 The buffer M must continue to exist until after the echo area gets
9512 cleared or some other message gets displayed there. Do not pass
9513 text that is stored in a Lisp string. Do not pass text in a buffer
9514 that was alloca'd. */
9517 message1 (const char *m
)
9519 message2 (m
, (m
? strlen (m
) : 0), 0);
9523 /* The non-logging counterpart of message1. */
9526 message1_nolog (const char *m
)
9528 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9531 /* Display a message M which contains a single %s
9532 which gets replaced with STRING. */
9535 message_with_string (const char *m
, Lisp_Object string
, int log
)
9537 CHECK_STRING (string
);
9543 if (noninteractive_need_newline
)
9544 putc ('\n', stderr
);
9545 noninteractive_need_newline
= 0;
9546 fprintf (stderr
, m
, SDATA (string
));
9547 if (!cursor_in_echo_area
)
9548 fprintf (stderr
, "\n");
9552 else if (INTERACTIVE
)
9554 /* The frame whose minibuffer we're going to display the message on.
9555 It may be larger than the selected frame, so we need
9556 to use its buffer, not the selected frame's buffer. */
9557 Lisp_Object mini_window
;
9558 struct frame
*f
, *sf
= SELECTED_FRAME ();
9560 /* Get the frame containing the minibuffer
9561 that the selected frame is using. */
9562 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9563 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9565 /* A null message buffer means that the frame hasn't really been
9566 initialized yet. Error messages get reported properly by
9567 cmd_error, so this must be just an informative message; toss it. */
9568 if (FRAME_MESSAGE_BUF (f
))
9570 Lisp_Object args
[2], msg
;
9571 struct gcpro gcpro1
, gcpro2
;
9573 args
[0] = build_string (m
);
9574 args
[1] = msg
= string
;
9575 GCPRO2 (args
[0], msg
);
9578 msg
= Fformat (2, args
);
9581 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9583 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9587 /* Print should start at the beginning of the message
9588 buffer next time. */
9589 message_buf_print
= 0;
9595 /* Dump an informative message to the minibuf. If M is 0, clear out
9596 any existing message, and let the mini-buffer text show through. */
9599 vmessage (const char *m
, va_list ap
)
9605 if (noninteractive_need_newline
)
9606 putc ('\n', stderr
);
9607 noninteractive_need_newline
= 0;
9608 vfprintf (stderr
, m
, ap
);
9609 if (cursor_in_echo_area
== 0)
9610 fprintf (stderr
, "\n");
9614 else if (INTERACTIVE
)
9616 /* The frame whose mini-buffer we're going to display the message
9617 on. It may be larger than the selected frame, so we need to
9618 use its buffer, not the selected frame's buffer. */
9619 Lisp_Object mini_window
;
9620 struct frame
*f
, *sf
= SELECTED_FRAME ();
9622 /* Get the frame containing the mini-buffer
9623 that the selected frame is using. */
9624 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9625 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9627 /* A null message buffer means that the frame hasn't really been
9628 initialized yet. Error messages get reported properly by
9629 cmd_error, so this must be just an informative message; toss
9631 if (FRAME_MESSAGE_BUF (f
))
9637 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9638 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9640 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9645 /* Print should start at the beginning of the message
9646 buffer next time. */
9647 message_buf_print
= 0;
9653 message (const char *m
, ...)
9663 /* The non-logging version of message. */
9666 message_nolog (const char *m
, ...)
9668 Lisp_Object old_log_max
;
9671 old_log_max
= Vmessage_log_max
;
9672 Vmessage_log_max
= Qnil
;
9674 Vmessage_log_max
= old_log_max
;
9680 /* Display the current message in the current mini-buffer. This is
9681 only called from error handlers in process.c, and is not time
9685 update_echo_area (void)
9687 if (!NILP (echo_area_buffer
[0]))
9690 string
= Fcurrent_message ();
9691 message3 (string
, SBYTES (string
),
9692 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9697 /* Make sure echo area buffers in `echo_buffers' are live.
9698 If they aren't, make new ones. */
9701 ensure_echo_area_buffers (void)
9705 for (i
= 0; i
< 2; ++i
)
9706 if (!BUFFERP (echo_buffer
[i
])
9707 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9710 Lisp_Object old_buffer
;
9713 old_buffer
= echo_buffer
[i
];
9714 sprintf (name
, " *Echo Area %d*", i
);
9715 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9716 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9717 /* to force word wrap in echo area -
9718 it was decided to postpone this*/
9719 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9721 for (j
= 0; j
< 2; ++j
)
9722 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9723 echo_area_buffer
[j
] = echo_buffer
[i
];
9728 /* Call FN with args A1..A4 with either the current or last displayed
9729 echo_area_buffer as current buffer.
9731 WHICH zero means use the current message buffer
9732 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9733 from echo_buffer[] and clear it.
9735 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9736 suitable buffer from echo_buffer[] and clear it.
9738 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9739 that the current message becomes the last displayed one, make
9740 choose a suitable buffer for echo_area_buffer[0], and clear it.
9742 Value is what FN returns. */
9745 with_echo_area_buffer (struct window
*w
, int which
,
9746 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9747 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9750 int this_one
, the_other
, clear_buffer_p
, rc
;
9751 int count
= SPECPDL_INDEX ();
9753 /* If buffers aren't live, make new ones. */
9754 ensure_echo_area_buffers ();
9759 this_one
= 0, the_other
= 1;
9761 this_one
= 1, the_other
= 0;
9764 this_one
= 0, the_other
= 1;
9767 /* We need a fresh one in case the current echo buffer equals
9768 the one containing the last displayed echo area message. */
9769 if (!NILP (echo_area_buffer
[this_one
])
9770 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9771 echo_area_buffer
[this_one
] = Qnil
;
9774 /* Choose a suitable buffer from echo_buffer[] is we don't
9776 if (NILP (echo_area_buffer
[this_one
]))
9778 echo_area_buffer
[this_one
]
9779 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9780 ? echo_buffer
[the_other
]
9781 : echo_buffer
[this_one
]);
9785 buffer
= echo_area_buffer
[this_one
];
9787 /* Don't get confused by reusing the buffer used for echoing
9788 for a different purpose. */
9789 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9792 record_unwind_protect (unwind_with_echo_area_buffer
,
9793 with_echo_area_buffer_unwind_data (w
));
9795 /* Make the echo area buffer current. Note that for display
9796 purposes, it is not necessary that the displayed window's buffer
9797 == current_buffer, except for text property lookup. So, let's
9798 only set that buffer temporarily here without doing a full
9799 Fset_window_buffer. We must also change w->pointm, though,
9800 because otherwise an assertions in unshow_buffer fails, and Emacs
9802 set_buffer_internal_1 (XBUFFER (buffer
));
9806 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9809 BVAR (current_buffer
, undo_list
) = Qt
;
9810 BVAR (current_buffer
, read_only
) = Qnil
;
9811 specbind (Qinhibit_read_only
, Qt
);
9812 specbind (Qinhibit_modification_hooks
, Qt
);
9814 if (clear_buffer_p
&& Z
> BEG
)
9817 xassert (BEGV
>= BEG
);
9818 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9820 rc
= fn (a1
, a2
, a3
, a4
);
9822 xassert (BEGV
>= BEG
);
9823 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9825 unbind_to (count
, Qnil
);
9830 /* Save state that should be preserved around the call to the function
9831 FN called in with_echo_area_buffer. */
9834 with_echo_area_buffer_unwind_data (struct window
*w
)
9837 Lisp_Object vector
, tmp
;
9839 /* Reduce consing by keeping one vector in
9840 Vwith_echo_area_save_vector. */
9841 vector
= Vwith_echo_area_save_vector
;
9842 Vwith_echo_area_save_vector
= Qnil
;
9845 vector
= Fmake_vector (make_number (7), Qnil
);
9847 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9848 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9849 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9853 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9854 ASET (vector
, i
, w
->buffer
); ++i
;
9855 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9856 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9861 for (; i
< end
; ++i
)
9862 ASET (vector
, i
, Qnil
);
9865 xassert (i
== ASIZE (vector
));
9870 /* Restore global state from VECTOR which was created by
9871 with_echo_area_buffer_unwind_data. */
9874 unwind_with_echo_area_buffer (Lisp_Object vector
)
9876 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9877 Vdeactivate_mark
= AREF (vector
, 1);
9878 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9880 if (WINDOWP (AREF (vector
, 3)))
9883 Lisp_Object buffer
, charpos
, bytepos
;
9885 w
= XWINDOW (AREF (vector
, 3));
9886 buffer
= AREF (vector
, 4);
9887 charpos
= AREF (vector
, 5);
9888 bytepos
= AREF (vector
, 6);
9891 set_marker_both (w
->pointm
, buffer
,
9892 XFASTINT (charpos
), XFASTINT (bytepos
));
9895 Vwith_echo_area_save_vector
= vector
;
9900 /* Set up the echo area for use by print functions. MULTIBYTE_P
9901 non-zero means we will print multibyte. */
9904 setup_echo_area_for_printing (int multibyte_p
)
9906 /* If we can't find an echo area any more, exit. */
9907 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9910 ensure_echo_area_buffers ();
9912 if (!message_buf_print
)
9914 /* A message has been output since the last time we printed.
9915 Choose a fresh echo area buffer. */
9916 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9917 echo_area_buffer
[0] = echo_buffer
[1];
9919 echo_area_buffer
[0] = echo_buffer
[0];
9921 /* Switch to that buffer and clear it. */
9922 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9923 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9927 int count
= SPECPDL_INDEX ();
9928 specbind (Qinhibit_read_only
, Qt
);
9929 /* Note that undo recording is always disabled. */
9931 unbind_to (count
, Qnil
);
9933 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9935 /* Set up the buffer for the multibyteness we need. */
9937 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9938 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9940 /* Raise the frame containing the echo area. */
9941 if (minibuffer_auto_raise
)
9943 struct frame
*sf
= SELECTED_FRAME ();
9944 Lisp_Object mini_window
;
9945 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9946 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9949 message_log_maybe_newline ();
9950 message_buf_print
= 1;
9954 if (NILP (echo_area_buffer
[0]))
9956 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9957 echo_area_buffer
[0] = echo_buffer
[1];
9959 echo_area_buffer
[0] = echo_buffer
[0];
9962 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9964 /* Someone switched buffers between print requests. */
9965 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9966 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9972 /* Display an echo area message in window W. Value is non-zero if W's
9973 height is changed. If display_last_displayed_message_p is
9974 non-zero, display the message that was last displayed, otherwise
9975 display the current message. */
9978 display_echo_area (struct window
*w
)
9980 int i
, no_message_p
, window_height_changed_p
, count
;
9982 /* Temporarily disable garbage collections while displaying the echo
9983 area. This is done because a GC can print a message itself.
9984 That message would modify the echo area buffer's contents while a
9985 redisplay of the buffer is going on, and seriously confuse
9987 count
= inhibit_garbage_collection ();
9989 /* If there is no message, we must call display_echo_area_1
9990 nevertheless because it resizes the window. But we will have to
9991 reset the echo_area_buffer in question to nil at the end because
9992 with_echo_area_buffer will sets it to an empty buffer. */
9993 i
= display_last_displayed_message_p
? 1 : 0;
9994 no_message_p
= NILP (echo_area_buffer
[i
]);
9996 window_height_changed_p
9997 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9998 display_echo_area_1
,
9999 (intptr_t) w
, Qnil
, 0, 0);
10002 echo_area_buffer
[i
] = Qnil
;
10004 unbind_to (count
, Qnil
);
10005 return window_height_changed_p
;
10009 /* Helper for display_echo_area. Display the current buffer which
10010 contains the current echo area message in window W, a mini-window,
10011 a pointer to which is passed in A1. A2..A4 are currently not used.
10012 Change the height of W so that all of the message is displayed.
10013 Value is non-zero if height of W was changed. */
10016 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10019 struct window
*w
= (struct window
*) i1
;
10020 Lisp_Object window
;
10021 struct text_pos start
;
10022 int window_height_changed_p
= 0;
10024 /* Do this before displaying, so that we have a large enough glyph
10025 matrix for the display. If we can't get enough space for the
10026 whole text, display the last N lines. That works by setting w->start. */
10027 window_height_changed_p
= resize_mini_window (w
, 0);
10029 /* Use the starting position chosen by resize_mini_window. */
10030 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10033 clear_glyph_matrix (w
->desired_matrix
);
10034 XSETWINDOW (window
, w
);
10035 try_window (window
, start
, 0);
10037 return window_height_changed_p
;
10041 /* Resize the echo area window to exactly the size needed for the
10042 currently displayed message, if there is one. If a mini-buffer
10043 is active, don't shrink it. */
10046 resize_echo_area_exactly (void)
10048 if (BUFFERP (echo_area_buffer
[0])
10049 && WINDOWP (echo_area_window
))
10051 struct window
*w
= XWINDOW (echo_area_window
);
10053 Lisp_Object resize_exactly
;
10055 if (minibuf_level
== 0)
10056 resize_exactly
= Qt
;
10058 resize_exactly
= Qnil
;
10060 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10061 (intptr_t) w
, resize_exactly
,
10065 ++windows_or_buffers_changed
;
10066 ++update_mode_lines
;
10067 redisplay_internal ();
10073 /* Callback function for with_echo_area_buffer, when used from
10074 resize_echo_area_exactly. A1 contains a pointer to the window to
10075 resize, EXACTLY non-nil means resize the mini-window exactly to the
10076 size of the text displayed. A3 and A4 are not used. Value is what
10077 resize_mini_window returns. */
10080 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10083 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10087 /* Resize mini-window W to fit the size of its contents. EXACT_P
10088 means size the window exactly to the size needed. Otherwise, it's
10089 only enlarged until W's buffer is empty.
10091 Set W->start to the right place to begin display. If the whole
10092 contents fit, start at the beginning. Otherwise, start so as
10093 to make the end of the contents appear. This is particularly
10094 important for y-or-n-p, but seems desirable generally.
10096 Value is non-zero if the window height has been changed. */
10099 resize_mini_window (struct window
*w
, int exact_p
)
10101 struct frame
*f
= XFRAME (w
->frame
);
10102 int window_height_changed_p
= 0;
10104 xassert (MINI_WINDOW_P (w
));
10106 /* By default, start display at the beginning. */
10107 set_marker_both (w
->start
, w
->buffer
,
10108 BUF_BEGV (XBUFFER (w
->buffer
)),
10109 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10111 /* Don't resize windows while redisplaying a window; it would
10112 confuse redisplay functions when the size of the window they are
10113 displaying changes from under them. Such a resizing can happen,
10114 for instance, when which-func prints a long message while
10115 we are running fontification-functions. We're running these
10116 functions with safe_call which binds inhibit-redisplay to t. */
10117 if (!NILP (Vinhibit_redisplay
))
10120 /* Nil means don't try to resize. */
10121 if (NILP (Vresize_mini_windows
)
10122 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10125 if (!FRAME_MINIBUF_ONLY_P (f
))
10128 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10129 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10130 int height
, max_height
;
10131 int unit
= FRAME_LINE_HEIGHT (f
);
10132 struct text_pos start
;
10133 struct buffer
*old_current_buffer
= NULL
;
10135 if (current_buffer
!= XBUFFER (w
->buffer
))
10137 old_current_buffer
= current_buffer
;
10138 set_buffer_internal (XBUFFER (w
->buffer
));
10141 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10143 /* Compute the max. number of lines specified by the user. */
10144 if (FLOATP (Vmax_mini_window_height
))
10145 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10146 else if (INTEGERP (Vmax_mini_window_height
))
10147 max_height
= XINT (Vmax_mini_window_height
);
10149 max_height
= total_height
/ 4;
10151 /* Correct that max. height if it's bogus. */
10152 max_height
= max (1, max_height
);
10153 max_height
= min (total_height
, max_height
);
10155 /* Find out the height of the text in the window. */
10156 if (it
.line_wrap
== TRUNCATE
)
10161 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10162 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10163 height
= it
.current_y
+ last_height
;
10165 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10166 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10167 height
= (height
+ unit
- 1) / unit
;
10170 /* Compute a suitable window start. */
10171 if (height
> max_height
)
10173 height
= max_height
;
10174 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10175 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10176 start
= it
.current
.pos
;
10179 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10180 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10182 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10184 /* Let it grow only, until we display an empty message, in which
10185 case the window shrinks again. */
10186 if (height
> WINDOW_TOTAL_LINES (w
))
10188 int old_height
= WINDOW_TOTAL_LINES (w
);
10189 freeze_window_starts (f
, 1);
10190 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10191 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10193 else if (height
< WINDOW_TOTAL_LINES (w
)
10194 && (exact_p
|| BEGV
== ZV
))
10196 int old_height
= WINDOW_TOTAL_LINES (w
);
10197 freeze_window_starts (f
, 0);
10198 shrink_mini_window (w
);
10199 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10204 /* Always resize to exact size needed. */
10205 if (height
> WINDOW_TOTAL_LINES (w
))
10207 int old_height
= WINDOW_TOTAL_LINES (w
);
10208 freeze_window_starts (f
, 1);
10209 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10210 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10212 else if (height
< WINDOW_TOTAL_LINES (w
))
10214 int old_height
= WINDOW_TOTAL_LINES (w
);
10215 freeze_window_starts (f
, 0);
10216 shrink_mini_window (w
);
10220 freeze_window_starts (f
, 1);
10221 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10224 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10228 if (old_current_buffer
)
10229 set_buffer_internal (old_current_buffer
);
10232 return window_height_changed_p
;
10236 /* Value is the current message, a string, or nil if there is no
10237 current message. */
10240 current_message (void)
10244 if (!BUFFERP (echo_area_buffer
[0]))
10248 with_echo_area_buffer (0, 0, current_message_1
,
10249 (intptr_t) &msg
, Qnil
, 0, 0);
10251 echo_area_buffer
[0] = Qnil
;
10259 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10262 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10265 *msg
= make_buffer_string (BEG
, Z
, 1);
10272 /* Push the current message on Vmessage_stack for later restoration
10273 by restore_message. Value is non-zero if the current message isn't
10274 empty. This is a relatively infrequent operation, so it's not
10275 worth optimizing. */
10278 push_message (void)
10281 msg
= current_message ();
10282 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10283 return STRINGP (msg
);
10287 /* Restore message display from the top of Vmessage_stack. */
10290 restore_message (void)
10294 xassert (CONSP (Vmessage_stack
));
10295 msg
= XCAR (Vmessage_stack
);
10297 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10299 message3_nolog (msg
, 0, 0);
10303 /* Handler for record_unwind_protect calling pop_message. */
10306 pop_message_unwind (Lisp_Object dummy
)
10312 /* Pop the top-most entry off Vmessage_stack. */
10317 xassert (CONSP (Vmessage_stack
));
10318 Vmessage_stack
= XCDR (Vmessage_stack
);
10322 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10323 exits. If the stack is not empty, we have a missing pop_message
10327 check_message_stack (void)
10329 if (!NILP (Vmessage_stack
))
10334 /* Truncate to NCHARS what will be displayed in the echo area the next
10335 time we display it---but don't redisplay it now. */
10338 truncate_echo_area (EMACS_INT nchars
)
10341 echo_area_buffer
[0] = Qnil
;
10342 /* A null message buffer means that the frame hasn't really been
10343 initialized yet. Error messages get reported properly by
10344 cmd_error, so this must be just an informative message; toss it. */
10345 else if (!noninteractive
10347 && !NILP (echo_area_buffer
[0]))
10349 struct frame
*sf
= SELECTED_FRAME ();
10350 if (FRAME_MESSAGE_BUF (sf
))
10351 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10356 /* Helper function for truncate_echo_area. Truncate the current
10357 message to at most NCHARS characters. */
10360 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10362 if (BEG
+ nchars
< Z
)
10363 del_range (BEG
+ nchars
, Z
);
10365 echo_area_buffer
[0] = Qnil
;
10370 /* Set the current message to a substring of S or STRING.
10372 If STRING is a Lisp string, set the message to the first NBYTES
10373 bytes from STRING. NBYTES zero means use the whole string. If
10374 STRING is multibyte, the message will be displayed multibyte.
10376 If S is not null, set the message to the first LEN bytes of S. LEN
10377 zero means use the whole string. MULTIBYTE_P non-zero means S is
10378 multibyte. Display the message multibyte in that case.
10380 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10381 to t before calling set_message_1 (which calls insert).
10385 set_message (const char *s
, Lisp_Object string
,
10386 EMACS_INT nbytes
, int multibyte_p
)
10388 message_enable_multibyte
10389 = ((s
&& multibyte_p
)
10390 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10392 with_echo_area_buffer (0, -1, set_message_1
,
10393 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10394 message_buf_print
= 0;
10395 help_echo_showing_p
= 0;
10399 /* Helper function for set_message. Arguments have the same meaning
10400 as there, with A1 corresponding to S and A2 corresponding to STRING
10401 This function is called with the echo area buffer being
10405 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10408 const char *s
= (const char *) i1
;
10409 const unsigned char *msg
= (const unsigned char *) s
;
10410 Lisp_Object string
= a2
;
10412 /* Change multibyteness of the echo buffer appropriately. */
10413 if (message_enable_multibyte
10414 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10415 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10417 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10418 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10419 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10421 /* Insert new message at BEG. */
10422 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10424 if (STRINGP (string
))
10429 nbytes
= SBYTES (string
);
10430 nchars
= string_byte_to_char (string
, nbytes
);
10432 /* This function takes care of single/multibyte conversion. We
10433 just have to ensure that the echo area buffer has the right
10434 setting of enable_multibyte_characters. */
10435 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10440 nbytes
= strlen (s
);
10442 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10444 /* Convert from multi-byte to single-byte. */
10449 /* Convert a multibyte string to single-byte. */
10450 for (i
= 0; i
< nbytes
; i
+= n
)
10452 c
= string_char_and_length (msg
+ i
, &n
);
10453 work
[0] = (ASCII_CHAR_P (c
)
10455 : multibyte_char_to_unibyte (c
));
10456 insert_1_both (work
, 1, 1, 1, 0, 0);
10459 else if (!multibyte_p
10460 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10462 /* Convert from single-byte to multi-byte. */
10465 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10467 /* Convert a single-byte string to multibyte. */
10468 for (i
= 0; i
< nbytes
; i
++)
10471 MAKE_CHAR_MULTIBYTE (c
);
10472 n
= CHAR_STRING (c
, str
);
10473 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10477 insert_1 (s
, nbytes
, 1, 0, 0);
10484 /* Clear messages. CURRENT_P non-zero means clear the current
10485 message. LAST_DISPLAYED_P non-zero means clear the message
10489 clear_message (int current_p
, int last_displayed_p
)
10493 echo_area_buffer
[0] = Qnil
;
10494 message_cleared_p
= 1;
10497 if (last_displayed_p
)
10498 echo_area_buffer
[1] = Qnil
;
10500 message_buf_print
= 0;
10503 /* Clear garbaged frames.
10505 This function is used where the old redisplay called
10506 redraw_garbaged_frames which in turn called redraw_frame which in
10507 turn called clear_frame. The call to clear_frame was a source of
10508 flickering. I believe a clear_frame is not necessary. It should
10509 suffice in the new redisplay to invalidate all current matrices,
10510 and ensure a complete redisplay of all windows. */
10513 clear_garbaged_frames (void)
10515 if (frame_garbaged
)
10517 Lisp_Object tail
, frame
;
10518 int changed_count
= 0;
10520 FOR_EACH_FRAME (tail
, frame
)
10522 struct frame
*f
= XFRAME (frame
);
10524 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10528 Fredraw_frame (frame
);
10529 f
->force_flush_display_p
= 1;
10531 clear_current_matrices (f
);
10538 frame_garbaged
= 0;
10540 ++windows_or_buffers_changed
;
10545 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10546 is non-zero update selected_frame. Value is non-zero if the
10547 mini-windows height has been changed. */
10550 echo_area_display (int update_frame_p
)
10552 Lisp_Object mini_window
;
10555 int window_height_changed_p
= 0;
10556 struct frame
*sf
= SELECTED_FRAME ();
10558 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10559 w
= XWINDOW (mini_window
);
10560 f
= XFRAME (WINDOW_FRAME (w
));
10562 /* Don't display if frame is invisible or not yet initialized. */
10563 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10566 #ifdef HAVE_WINDOW_SYSTEM
10567 /* When Emacs starts, selected_frame may be the initial terminal
10568 frame. If we let this through, a message would be displayed on
10570 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10572 #endif /* HAVE_WINDOW_SYSTEM */
10574 /* Redraw garbaged frames. */
10575 if (frame_garbaged
)
10576 clear_garbaged_frames ();
10578 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10580 echo_area_window
= mini_window
;
10581 window_height_changed_p
= display_echo_area (w
);
10582 w
->must_be_updated_p
= 1;
10584 /* Update the display, unless called from redisplay_internal.
10585 Also don't update the screen during redisplay itself. The
10586 update will happen at the end of redisplay, and an update
10587 here could cause confusion. */
10588 if (update_frame_p
&& !redisplaying_p
)
10592 /* If the display update has been interrupted by pending
10593 input, update mode lines in the frame. Due to the
10594 pending input, it might have been that redisplay hasn't
10595 been called, so that mode lines above the echo area are
10596 garbaged. This looks odd, so we prevent it here. */
10597 if (!display_completed
)
10598 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10600 if (window_height_changed_p
10601 /* Don't do this if Emacs is shutting down. Redisplay
10602 needs to run hooks. */
10603 && !NILP (Vrun_hooks
))
10605 /* Must update other windows. Likewise as in other
10606 cases, don't let this update be interrupted by
10608 int count
= SPECPDL_INDEX ();
10609 specbind (Qredisplay_dont_pause
, Qt
);
10610 windows_or_buffers_changed
= 1;
10611 redisplay_internal ();
10612 unbind_to (count
, Qnil
);
10614 else if (FRAME_WINDOW_P (f
) && n
== 0)
10616 /* Window configuration is the same as before.
10617 Can do with a display update of the echo area,
10618 unless we displayed some mode lines. */
10619 update_single_window (w
, 1);
10620 FRAME_RIF (f
)->flush_display (f
);
10623 update_frame (f
, 1, 1);
10625 /* If cursor is in the echo area, make sure that the next
10626 redisplay displays the minibuffer, so that the cursor will
10627 be replaced with what the minibuffer wants. */
10628 if (cursor_in_echo_area
)
10629 ++windows_or_buffers_changed
;
10632 else if (!EQ (mini_window
, selected_window
))
10633 windows_or_buffers_changed
++;
10635 /* Last displayed message is now the current message. */
10636 echo_area_buffer
[1] = echo_area_buffer
[0];
10637 /* Inform read_char that we're not echoing. */
10638 echo_message_buffer
= Qnil
;
10640 /* Prevent redisplay optimization in redisplay_internal by resetting
10641 this_line_start_pos. This is done because the mini-buffer now
10642 displays the message instead of its buffer text. */
10643 if (EQ (mini_window
, selected_window
))
10644 CHARPOS (this_line_start_pos
) = 0;
10646 return window_height_changed_p
;
10651 /***********************************************************************
10652 Mode Lines and Frame Titles
10653 ***********************************************************************/
10655 /* A buffer for constructing non-propertized mode-line strings and
10656 frame titles in it; allocated from the heap in init_xdisp and
10657 resized as needed in store_mode_line_noprop_char. */
10659 static char *mode_line_noprop_buf
;
10661 /* The buffer's end, and a current output position in it. */
10663 static char *mode_line_noprop_buf_end
;
10664 static char *mode_line_noprop_ptr
;
10666 #define MODE_LINE_NOPROP_LEN(start) \
10667 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10670 MODE_LINE_DISPLAY
= 0,
10674 } mode_line_target
;
10676 /* Alist that caches the results of :propertize.
10677 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10678 static Lisp_Object mode_line_proptrans_alist
;
10680 /* List of strings making up the mode-line. */
10681 static Lisp_Object mode_line_string_list
;
10683 /* Base face property when building propertized mode line string. */
10684 static Lisp_Object mode_line_string_face
;
10685 static Lisp_Object mode_line_string_face_prop
;
10688 /* Unwind data for mode line strings */
10690 static Lisp_Object Vmode_line_unwind_vector
;
10693 format_mode_line_unwind_data (struct buffer
*obuf
,
10695 int save_proptrans
)
10697 Lisp_Object vector
, tmp
;
10699 /* Reduce consing by keeping one vector in
10700 Vwith_echo_area_save_vector. */
10701 vector
= Vmode_line_unwind_vector
;
10702 Vmode_line_unwind_vector
= Qnil
;
10705 vector
= Fmake_vector (make_number (8), Qnil
);
10707 ASET (vector
, 0, make_number (mode_line_target
));
10708 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10709 ASET (vector
, 2, mode_line_string_list
);
10710 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10711 ASET (vector
, 4, mode_line_string_face
);
10712 ASET (vector
, 5, mode_line_string_face_prop
);
10715 XSETBUFFER (tmp
, obuf
);
10718 ASET (vector
, 6, tmp
);
10719 ASET (vector
, 7, owin
);
10725 unwind_format_mode_line (Lisp_Object vector
)
10727 mode_line_target
= XINT (AREF (vector
, 0));
10728 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10729 mode_line_string_list
= AREF (vector
, 2);
10730 if (! EQ (AREF (vector
, 3), Qt
))
10731 mode_line_proptrans_alist
= AREF (vector
, 3);
10732 mode_line_string_face
= AREF (vector
, 4);
10733 mode_line_string_face_prop
= AREF (vector
, 5);
10735 if (!NILP (AREF (vector
, 7)))
10736 /* Select window before buffer, since it may change the buffer. */
10737 Fselect_window (AREF (vector
, 7), Qt
);
10739 if (!NILP (AREF (vector
, 6)))
10741 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10742 ASET (vector
, 6, Qnil
);
10745 Vmode_line_unwind_vector
= vector
;
10750 /* Store a single character C for the frame title in mode_line_noprop_buf.
10751 Re-allocate mode_line_noprop_buf if necessary. */
10754 store_mode_line_noprop_char (char c
)
10756 /* If output position has reached the end of the allocated buffer,
10757 increase the buffer's size. */
10758 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10760 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10761 ptrdiff_t size
= len
;
10762 mode_line_noprop_buf
=
10763 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10764 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10765 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10768 *mode_line_noprop_ptr
++ = c
;
10772 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10773 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10774 characters that yield more columns than PRECISION; PRECISION <= 0
10775 means copy the whole string. Pad with spaces until FIELD_WIDTH
10776 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10777 pad. Called from display_mode_element when it is used to build a
10781 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10783 const unsigned char *str
= (const unsigned char *) string
;
10785 EMACS_INT dummy
, nbytes
;
10787 /* Copy at most PRECISION chars from STR. */
10788 nbytes
= strlen (string
);
10789 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10791 store_mode_line_noprop_char (*str
++);
10793 /* Fill up with spaces until FIELD_WIDTH reached. */
10794 while (field_width
> 0
10795 && n
< field_width
)
10797 store_mode_line_noprop_char (' ');
10804 /***********************************************************************
10806 ***********************************************************************/
10808 #ifdef HAVE_WINDOW_SYSTEM
10810 /* Set the title of FRAME, if it has changed. The title format is
10811 Vicon_title_format if FRAME is iconified, otherwise it is
10812 frame_title_format. */
10815 x_consider_frame_title (Lisp_Object frame
)
10817 struct frame
*f
= XFRAME (frame
);
10819 if (FRAME_WINDOW_P (f
)
10820 || FRAME_MINIBUF_ONLY_P (f
)
10821 || f
->explicit_name
)
10823 /* Do we have more than one visible frame on this X display? */
10826 ptrdiff_t title_start
;
10830 int count
= SPECPDL_INDEX ();
10832 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10834 Lisp_Object other_frame
= XCAR (tail
);
10835 struct frame
*tf
= XFRAME (other_frame
);
10838 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10839 && !FRAME_MINIBUF_ONLY_P (tf
)
10840 && !EQ (other_frame
, tip_frame
)
10841 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10845 /* Set global variable indicating that multiple frames exist. */
10846 multiple_frames
= CONSP (tail
);
10848 /* Switch to the buffer of selected window of the frame. Set up
10849 mode_line_target so that display_mode_element will output into
10850 mode_line_noprop_buf; then display the title. */
10851 record_unwind_protect (unwind_format_mode_line
,
10852 format_mode_line_unwind_data
10853 (current_buffer
, selected_window
, 0));
10855 Fselect_window (f
->selected_window
, Qt
);
10856 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10857 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10859 mode_line_target
= MODE_LINE_TITLE
;
10860 title_start
= MODE_LINE_NOPROP_LEN (0);
10861 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10862 NULL
, DEFAULT_FACE_ID
);
10863 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10864 len
= MODE_LINE_NOPROP_LEN (title_start
);
10865 title
= mode_line_noprop_buf
+ title_start
;
10866 unbind_to (count
, Qnil
);
10868 /* Set the title only if it's changed. This avoids consing in
10869 the common case where it hasn't. (If it turns out that we've
10870 already wasted too much time by walking through the list with
10871 display_mode_element, then we might need to optimize at a
10872 higher level than this.) */
10873 if (! STRINGP (f
->name
)
10874 || SBYTES (f
->name
) != len
10875 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10876 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10880 #endif /* not HAVE_WINDOW_SYSTEM */
10885 /***********************************************************************
10887 ***********************************************************************/
10890 /* Prepare for redisplay by updating menu-bar item lists when
10891 appropriate. This can call eval. */
10894 prepare_menu_bars (void)
10897 struct gcpro gcpro1
, gcpro2
;
10899 Lisp_Object tooltip_frame
;
10901 #ifdef HAVE_WINDOW_SYSTEM
10902 tooltip_frame
= tip_frame
;
10904 tooltip_frame
= Qnil
;
10907 /* Update all frame titles based on their buffer names, etc. We do
10908 this before the menu bars so that the buffer-menu will show the
10909 up-to-date frame titles. */
10910 #ifdef HAVE_WINDOW_SYSTEM
10911 if (windows_or_buffers_changed
|| update_mode_lines
)
10913 Lisp_Object tail
, frame
;
10915 FOR_EACH_FRAME (tail
, frame
)
10917 f
= XFRAME (frame
);
10918 if (!EQ (frame
, tooltip_frame
)
10919 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10920 x_consider_frame_title (frame
);
10923 #endif /* HAVE_WINDOW_SYSTEM */
10925 /* Update the menu bar item lists, if appropriate. This has to be
10926 done before any actual redisplay or generation of display lines. */
10927 all_windows
= (update_mode_lines
10928 || buffer_shared
> 1
10929 || windows_or_buffers_changed
);
10932 Lisp_Object tail
, frame
;
10933 int count
= SPECPDL_INDEX ();
10934 /* 1 means that update_menu_bar has run its hooks
10935 so any further calls to update_menu_bar shouldn't do so again. */
10936 int menu_bar_hooks_run
= 0;
10938 record_unwind_save_match_data ();
10940 FOR_EACH_FRAME (tail
, frame
)
10942 f
= XFRAME (frame
);
10944 /* Ignore tooltip frame. */
10945 if (EQ (frame
, tooltip_frame
))
10948 /* If a window on this frame changed size, report that to
10949 the user and clear the size-change flag. */
10950 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10952 Lisp_Object functions
;
10954 /* Clear flag first in case we get an error below. */
10955 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10956 functions
= Vwindow_size_change_functions
;
10957 GCPRO2 (tail
, functions
);
10959 while (CONSP (functions
))
10961 if (!EQ (XCAR (functions
), Qt
))
10962 call1 (XCAR (functions
), frame
);
10963 functions
= XCDR (functions
);
10969 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10970 #ifdef HAVE_WINDOW_SYSTEM
10971 update_tool_bar (f
, 0);
10974 if (windows_or_buffers_changed
10976 ns_set_doc_edited (f
, Fbuffer_modified_p
10977 (XWINDOW (f
->selected_window
)->buffer
));
10982 unbind_to (count
, Qnil
);
10986 struct frame
*sf
= SELECTED_FRAME ();
10987 update_menu_bar (sf
, 1, 0);
10988 #ifdef HAVE_WINDOW_SYSTEM
10989 update_tool_bar (sf
, 1);
10995 /* Update the menu bar item list for frame F. This has to be done
10996 before we start to fill in any display lines, because it can call
10999 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11001 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11002 already ran the menu bar hooks for this redisplay, so there
11003 is no need to run them again. The return value is the
11004 updated value of this flag, to pass to the next call. */
11007 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11009 Lisp_Object window
;
11010 register struct window
*w
;
11012 /* If called recursively during a menu update, do nothing. This can
11013 happen when, for instance, an activate-menubar-hook causes a
11015 if (inhibit_menubar_update
)
11018 window
= FRAME_SELECTED_WINDOW (f
);
11019 w
= XWINDOW (window
);
11021 if (FRAME_WINDOW_P (f
)
11023 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11024 || defined (HAVE_NS) || defined (USE_GTK)
11025 FRAME_EXTERNAL_MENU_BAR (f
)
11027 FRAME_MENU_BAR_LINES (f
) > 0
11029 : FRAME_MENU_BAR_LINES (f
) > 0)
11031 /* If the user has switched buffers or windows, we need to
11032 recompute to reflect the new bindings. But we'll
11033 recompute when update_mode_lines is set too; that means
11034 that people can use force-mode-line-update to request
11035 that the menu bar be recomputed. The adverse effect on
11036 the rest of the redisplay algorithm is about the same as
11037 windows_or_buffers_changed anyway. */
11038 if (windows_or_buffers_changed
11039 /* This used to test w->update_mode_line, but we believe
11040 there is no need to recompute the menu in that case. */
11041 || update_mode_lines
11042 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11043 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11044 != !NILP (w
->last_had_star
))
11045 || ((!NILP (Vtransient_mark_mode
)
11046 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11047 != !NILP (w
->region_showing
)))
11049 struct buffer
*prev
= current_buffer
;
11050 int count
= SPECPDL_INDEX ();
11052 specbind (Qinhibit_menubar_update
, Qt
);
11054 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11055 if (save_match_data
)
11056 record_unwind_save_match_data ();
11057 if (NILP (Voverriding_local_map_menu_flag
))
11059 specbind (Qoverriding_terminal_local_map
, Qnil
);
11060 specbind (Qoverriding_local_map
, Qnil
);
11065 /* Run the Lucid hook. */
11066 safe_run_hooks (Qactivate_menubar_hook
);
11068 /* If it has changed current-menubar from previous value,
11069 really recompute the menu-bar from the value. */
11070 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11071 call0 (Qrecompute_lucid_menubar
);
11073 safe_run_hooks (Qmenu_bar_update_hook
);
11078 XSETFRAME (Vmenu_updating_frame
, f
);
11079 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11081 /* Redisplay the menu bar in case we changed it. */
11082 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11083 || defined (HAVE_NS) || defined (USE_GTK)
11084 if (FRAME_WINDOW_P (f
))
11086 #if defined (HAVE_NS)
11087 /* All frames on Mac OS share the same menubar. So only
11088 the selected frame should be allowed to set it. */
11089 if (f
== SELECTED_FRAME ())
11091 set_frame_menubar (f
, 0, 0);
11094 /* On a terminal screen, the menu bar is an ordinary screen
11095 line, and this makes it get updated. */
11096 w
->update_mode_line
= Qt
;
11097 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11098 /* In the non-toolkit version, the menu bar is an ordinary screen
11099 line, and this makes it get updated. */
11100 w
->update_mode_line
= Qt
;
11101 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11103 unbind_to (count
, Qnil
);
11104 set_buffer_internal_1 (prev
);
11113 /***********************************************************************
11115 ***********************************************************************/
11117 #ifdef HAVE_WINDOW_SYSTEM
11120 Nominal cursor position -- where to draw output.
11121 HPOS and VPOS are window relative glyph matrix coordinates.
11122 X and Y are window relative pixel coordinates. */
11124 struct cursor_pos output_cursor
;
11128 Set the global variable output_cursor to CURSOR. All cursor
11129 positions are relative to updated_window. */
11132 set_output_cursor (struct cursor_pos
*cursor
)
11134 output_cursor
.hpos
= cursor
->hpos
;
11135 output_cursor
.vpos
= cursor
->vpos
;
11136 output_cursor
.x
= cursor
->x
;
11137 output_cursor
.y
= cursor
->y
;
11142 Set a nominal cursor position.
11144 HPOS and VPOS are column/row positions in a window glyph matrix. X
11145 and Y are window text area relative pixel positions.
11147 If this is done during an update, updated_window will contain the
11148 window that is being updated and the position is the future output
11149 cursor position for that window. If updated_window is null, use
11150 selected_window and display the cursor at the given position. */
11153 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11157 /* If updated_window is not set, work on selected_window. */
11158 if (updated_window
)
11159 w
= updated_window
;
11161 w
= XWINDOW (selected_window
);
11163 /* Set the output cursor. */
11164 output_cursor
.hpos
= hpos
;
11165 output_cursor
.vpos
= vpos
;
11166 output_cursor
.x
= x
;
11167 output_cursor
.y
= y
;
11169 /* If not called as part of an update, really display the cursor.
11170 This will also set the cursor position of W. */
11171 if (updated_window
== NULL
)
11174 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11175 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11176 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11181 #endif /* HAVE_WINDOW_SYSTEM */
11184 /***********************************************************************
11186 ***********************************************************************/
11188 #ifdef HAVE_WINDOW_SYSTEM
11190 /* Where the mouse was last time we reported a mouse event. */
11192 FRAME_PTR last_mouse_frame
;
11194 /* Tool-bar item index of the item on which a mouse button was pressed
11197 int last_tool_bar_item
;
11201 update_tool_bar_unwind (Lisp_Object frame
)
11203 selected_frame
= frame
;
11207 /* Update the tool-bar item list for frame F. This has to be done
11208 before we start to fill in any display lines. Called from
11209 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11210 and restore it here. */
11213 update_tool_bar (struct frame
*f
, int save_match_data
)
11215 #if defined (USE_GTK) || defined (HAVE_NS)
11216 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11218 int do_update
= WINDOWP (f
->tool_bar_window
)
11219 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11224 Lisp_Object window
;
11227 window
= FRAME_SELECTED_WINDOW (f
);
11228 w
= XWINDOW (window
);
11230 /* If the user has switched buffers or windows, we need to
11231 recompute to reflect the new bindings. But we'll
11232 recompute when update_mode_lines is set too; that means
11233 that people can use force-mode-line-update to request
11234 that the menu bar be recomputed. The adverse effect on
11235 the rest of the redisplay algorithm is about the same as
11236 windows_or_buffers_changed anyway. */
11237 if (windows_or_buffers_changed
11238 || !NILP (w
->update_mode_line
)
11239 || update_mode_lines
11240 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11241 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11242 != !NILP (w
->last_had_star
))
11243 || ((!NILP (Vtransient_mark_mode
)
11244 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11245 != !NILP (w
->region_showing
)))
11247 struct buffer
*prev
= current_buffer
;
11248 int count
= SPECPDL_INDEX ();
11249 Lisp_Object frame
, new_tool_bar
;
11250 int new_n_tool_bar
;
11251 struct gcpro gcpro1
;
11253 /* Set current_buffer to the buffer of the selected
11254 window of the frame, so that we get the right local
11256 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11258 /* Save match data, if we must. */
11259 if (save_match_data
)
11260 record_unwind_save_match_data ();
11262 /* Make sure that we don't accidentally use bogus keymaps. */
11263 if (NILP (Voverriding_local_map_menu_flag
))
11265 specbind (Qoverriding_terminal_local_map
, Qnil
);
11266 specbind (Qoverriding_local_map
, Qnil
);
11269 GCPRO1 (new_tool_bar
);
11271 /* We must temporarily set the selected frame to this frame
11272 before calling tool_bar_items, because the calculation of
11273 the tool-bar keymap uses the selected frame (see
11274 `tool-bar-make-keymap' in tool-bar.el). */
11275 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11276 XSETFRAME (frame
, f
);
11277 selected_frame
= frame
;
11279 /* Build desired tool-bar items from keymaps. */
11280 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11283 /* Redisplay the tool-bar if we changed it. */
11284 if (new_n_tool_bar
!= f
->n_tool_bar_items
11285 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11287 /* Redisplay that happens asynchronously due to an expose event
11288 may access f->tool_bar_items. Make sure we update both
11289 variables within BLOCK_INPUT so no such event interrupts. */
11291 f
->tool_bar_items
= new_tool_bar
;
11292 f
->n_tool_bar_items
= new_n_tool_bar
;
11293 w
->update_mode_line
= Qt
;
11299 unbind_to (count
, Qnil
);
11300 set_buffer_internal_1 (prev
);
11306 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11307 F's desired tool-bar contents. F->tool_bar_items must have
11308 been set up previously by calling prepare_menu_bars. */
11311 build_desired_tool_bar_string (struct frame
*f
)
11313 int i
, size
, size_needed
;
11314 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11315 Lisp_Object image
, plist
, props
;
11317 image
= plist
= props
= Qnil
;
11318 GCPRO3 (image
, plist
, props
);
11320 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11321 Otherwise, make a new string. */
11323 /* The size of the string we might be able to reuse. */
11324 size
= (STRINGP (f
->desired_tool_bar_string
)
11325 ? SCHARS (f
->desired_tool_bar_string
)
11328 /* We need one space in the string for each image. */
11329 size_needed
= f
->n_tool_bar_items
;
11331 /* Reuse f->desired_tool_bar_string, if possible. */
11332 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11333 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11334 make_number (' '));
11337 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11338 Fremove_text_properties (make_number (0), make_number (size
),
11339 props
, f
->desired_tool_bar_string
);
11342 /* Put a `display' property on the string for the images to display,
11343 put a `menu_item' property on tool-bar items with a value that
11344 is the index of the item in F's tool-bar item vector. */
11345 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11347 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11349 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11350 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11351 int hmargin
, vmargin
, relief
, idx
, end
;
11353 /* If image is a vector, choose the image according to the
11355 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11356 if (VECTORP (image
))
11360 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11361 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11364 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11365 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11367 xassert (ASIZE (image
) >= idx
);
11368 image
= AREF (image
, idx
);
11373 /* Ignore invalid image specifications. */
11374 if (!valid_image_p (image
))
11377 /* Display the tool-bar button pressed, or depressed. */
11378 plist
= Fcopy_sequence (XCDR (image
));
11380 /* Compute margin and relief to draw. */
11381 relief
= (tool_bar_button_relief
>= 0
11382 ? tool_bar_button_relief
11383 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11384 hmargin
= vmargin
= relief
;
11386 if (INTEGERP (Vtool_bar_button_margin
)
11387 && XINT (Vtool_bar_button_margin
) > 0)
11389 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11390 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11392 else if (CONSP (Vtool_bar_button_margin
))
11394 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11395 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11396 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11398 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11399 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11400 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11403 if (auto_raise_tool_bar_buttons_p
)
11405 /* Add a `:relief' property to the image spec if the item is
11409 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11416 /* If image is selected, display it pressed, i.e. with a
11417 negative relief. If it's not selected, display it with a
11419 plist
= Fplist_put (plist
, QCrelief
,
11421 ? make_number (-relief
)
11422 : make_number (relief
)));
11427 /* Put a margin around the image. */
11428 if (hmargin
|| vmargin
)
11430 if (hmargin
== vmargin
)
11431 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11433 plist
= Fplist_put (plist
, QCmargin
,
11434 Fcons (make_number (hmargin
),
11435 make_number (vmargin
)));
11438 /* If button is not enabled, and we don't have special images
11439 for the disabled state, make the image appear disabled by
11440 applying an appropriate algorithm to it. */
11441 if (!enabled_p
&& idx
< 0)
11442 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11444 /* Put a `display' text property on the string for the image to
11445 display. Put a `menu-item' property on the string that gives
11446 the start of this item's properties in the tool-bar items
11448 image
= Fcons (Qimage
, plist
);
11449 props
= list4 (Qdisplay
, image
,
11450 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11452 /* Let the last image hide all remaining spaces in the tool bar
11453 string. The string can be longer than needed when we reuse a
11454 previous string. */
11455 if (i
+ 1 == f
->n_tool_bar_items
)
11456 end
= SCHARS (f
->desired_tool_bar_string
);
11459 Fadd_text_properties (make_number (i
), make_number (end
),
11460 props
, f
->desired_tool_bar_string
);
11468 /* Display one line of the tool-bar of frame IT->f.
11470 HEIGHT specifies the desired height of the tool-bar line.
11471 If the actual height of the glyph row is less than HEIGHT, the
11472 row's height is increased to HEIGHT, and the icons are centered
11473 vertically in the new height.
11475 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11476 count a final empty row in case the tool-bar width exactly matches
11481 display_tool_bar_line (struct it
*it
, int height
)
11483 struct glyph_row
*row
= it
->glyph_row
;
11484 int max_x
= it
->last_visible_x
;
11485 struct glyph
*last
;
11487 prepare_desired_row (row
);
11488 row
->y
= it
->current_y
;
11490 /* Note that this isn't made use of if the face hasn't a box,
11491 so there's no need to check the face here. */
11492 it
->start_of_box_run_p
= 1;
11494 while (it
->current_x
< max_x
)
11496 int x
, n_glyphs_before
, i
, nglyphs
;
11497 struct it it_before
;
11499 /* Get the next display element. */
11500 if (!get_next_display_element (it
))
11502 /* Don't count empty row if we are counting needed tool-bar lines. */
11503 if (height
< 0 && !it
->hpos
)
11508 /* Produce glyphs. */
11509 n_glyphs_before
= row
->used
[TEXT_AREA
];
11512 PRODUCE_GLYPHS (it
);
11514 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11516 x
= it_before
.current_x
;
11517 while (i
< nglyphs
)
11519 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11521 if (x
+ glyph
->pixel_width
> max_x
)
11523 /* Glyph doesn't fit on line. Backtrack. */
11524 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11526 /* If this is the only glyph on this line, it will never fit on the
11527 tool-bar, so skip it. But ensure there is at least one glyph,
11528 so we don't accidentally disable the tool-bar. */
11529 if (n_glyphs_before
== 0
11530 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11536 x
+= glyph
->pixel_width
;
11540 /* Stop at line end. */
11541 if (ITERATOR_AT_END_OF_LINE_P (it
))
11544 set_iterator_to_next (it
, 1);
11549 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11551 /* Use default face for the border below the tool bar.
11553 FIXME: When auto-resize-tool-bars is grow-only, there is
11554 no additional border below the possibly empty tool-bar lines.
11555 So to make the extra empty lines look "normal", we have to
11556 use the tool-bar face for the border too. */
11557 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11558 it
->face_id
= DEFAULT_FACE_ID
;
11560 extend_face_to_end_of_line (it
);
11561 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11562 last
->right_box_line_p
= 1;
11563 if (last
== row
->glyphs
[TEXT_AREA
])
11564 last
->left_box_line_p
= 1;
11566 /* Make line the desired height and center it vertically. */
11567 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11569 /* Don't add more than one line height. */
11570 height
%= FRAME_LINE_HEIGHT (it
->f
);
11571 it
->max_ascent
+= height
/ 2;
11572 it
->max_descent
+= (height
+ 1) / 2;
11575 compute_line_metrics (it
);
11577 /* If line is empty, make it occupy the rest of the tool-bar. */
11578 if (!row
->displays_text_p
)
11580 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11581 row
->visible_height
= row
->height
;
11582 row
->ascent
= row
->phys_ascent
= 0;
11583 row
->extra_line_spacing
= 0;
11586 row
->full_width_p
= 1;
11587 row
->continued_p
= 0;
11588 row
->truncated_on_left_p
= 0;
11589 row
->truncated_on_right_p
= 0;
11591 it
->current_x
= it
->hpos
= 0;
11592 it
->current_y
+= row
->height
;
11598 /* Max tool-bar height. */
11600 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11601 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11603 /* Value is the number of screen lines needed to make all tool-bar
11604 items of frame F visible. The number of actual rows needed is
11605 returned in *N_ROWS if non-NULL. */
11608 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11610 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11612 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11613 the desired matrix, so use (unused) mode-line row as temporary row to
11614 avoid destroying the first tool-bar row. */
11615 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11617 /* Initialize an iterator for iteration over
11618 F->desired_tool_bar_string in the tool-bar window of frame F. */
11619 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11620 it
.first_visible_x
= 0;
11621 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11622 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11623 it
.paragraph_embedding
= L2R
;
11625 while (!ITERATOR_AT_END_P (&it
))
11627 clear_glyph_row (temp_row
);
11628 it
.glyph_row
= temp_row
;
11629 display_tool_bar_line (&it
, -1);
11631 clear_glyph_row (temp_row
);
11633 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11635 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11637 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11641 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11643 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11644 (Lisp_Object frame
)
11651 frame
= selected_frame
;
11653 CHECK_FRAME (frame
);
11654 f
= XFRAME (frame
);
11656 if (WINDOWP (f
->tool_bar_window
)
11657 && (w
= XWINDOW (f
->tool_bar_window
),
11658 WINDOW_TOTAL_LINES (w
) > 0))
11660 update_tool_bar (f
, 1);
11661 if (f
->n_tool_bar_items
)
11663 build_desired_tool_bar_string (f
);
11664 nlines
= tool_bar_lines_needed (f
, NULL
);
11668 return make_number (nlines
);
11672 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11673 height should be changed. */
11676 redisplay_tool_bar (struct frame
*f
)
11680 struct glyph_row
*row
;
11682 #if defined (USE_GTK) || defined (HAVE_NS)
11683 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11684 update_frame_tool_bar (f
);
11688 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11689 do anything. This means you must start with tool-bar-lines
11690 non-zero to get the auto-sizing effect. Or in other words, you
11691 can turn off tool-bars by specifying tool-bar-lines zero. */
11692 if (!WINDOWP (f
->tool_bar_window
)
11693 || (w
= XWINDOW (f
->tool_bar_window
),
11694 WINDOW_TOTAL_LINES (w
) == 0))
11697 /* Set up an iterator for the tool-bar window. */
11698 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11699 it
.first_visible_x
= 0;
11700 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11701 row
= it
.glyph_row
;
11703 /* Build a string that represents the contents of the tool-bar. */
11704 build_desired_tool_bar_string (f
);
11705 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11706 /* FIXME: This should be controlled by a user option. But it
11707 doesn't make sense to have an R2L tool bar if the menu bar cannot
11708 be drawn also R2L, and making the menu bar R2L is tricky due
11709 toolkit-specific code that implements it. If an R2L tool bar is
11710 ever supported, display_tool_bar_line should also be augmented to
11711 call unproduce_glyphs like display_line and display_string
11713 it
.paragraph_embedding
= L2R
;
11715 if (f
->n_tool_bar_rows
== 0)
11719 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11720 nlines
!= WINDOW_TOTAL_LINES (w
)))
11723 int old_height
= WINDOW_TOTAL_LINES (w
);
11725 XSETFRAME (frame
, f
);
11726 Fmodify_frame_parameters (frame
,
11727 Fcons (Fcons (Qtool_bar_lines
,
11728 make_number (nlines
)),
11730 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11732 clear_glyph_matrix (w
->desired_matrix
);
11733 fonts_changed_p
= 1;
11739 /* Display as many lines as needed to display all tool-bar items. */
11741 if (f
->n_tool_bar_rows
> 0)
11743 int border
, rows
, height
, extra
;
11745 if (INTEGERP (Vtool_bar_border
))
11746 border
= XINT (Vtool_bar_border
);
11747 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11748 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11749 else if (EQ (Vtool_bar_border
, Qborder_width
))
11750 border
= f
->border_width
;
11756 rows
= f
->n_tool_bar_rows
;
11757 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11758 extra
= it
.last_visible_y
- border
- height
* rows
;
11760 while (it
.current_y
< it
.last_visible_y
)
11763 if (extra
> 0 && rows
-- > 0)
11765 h
= (extra
+ rows
- 1) / rows
;
11768 display_tool_bar_line (&it
, height
+ h
);
11773 while (it
.current_y
< it
.last_visible_y
)
11774 display_tool_bar_line (&it
, 0);
11777 /* It doesn't make much sense to try scrolling in the tool-bar
11778 window, so don't do it. */
11779 w
->desired_matrix
->no_scrolling_p
= 1;
11780 w
->must_be_updated_p
= 1;
11782 if (!NILP (Vauto_resize_tool_bars
))
11784 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11785 int change_height_p
= 0;
11787 /* If we couldn't display everything, change the tool-bar's
11788 height if there is room for more. */
11789 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11790 && it
.current_y
< max_tool_bar_height
)
11791 change_height_p
= 1;
11793 row
= it
.glyph_row
- 1;
11795 /* If there are blank lines at the end, except for a partially
11796 visible blank line at the end that is smaller than
11797 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11798 if (!row
->displays_text_p
11799 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11800 change_height_p
= 1;
11802 /* If row displays tool-bar items, but is partially visible,
11803 change the tool-bar's height. */
11804 if (row
->displays_text_p
11805 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11806 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11807 change_height_p
= 1;
11809 /* Resize windows as needed by changing the `tool-bar-lines'
11810 frame parameter. */
11811 if (change_height_p
)
11814 int old_height
= WINDOW_TOTAL_LINES (w
);
11816 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11818 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11819 && !f
->minimize_tool_bar_window_p
)
11820 ? (nlines
> old_height
)
11821 : (nlines
!= old_height
));
11822 f
->minimize_tool_bar_window_p
= 0;
11824 if (change_height_p
)
11826 XSETFRAME (frame
, f
);
11827 Fmodify_frame_parameters (frame
,
11828 Fcons (Fcons (Qtool_bar_lines
,
11829 make_number (nlines
)),
11831 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11833 clear_glyph_matrix (w
->desired_matrix
);
11834 f
->n_tool_bar_rows
= nrows
;
11835 fonts_changed_p
= 1;
11842 f
->minimize_tool_bar_window_p
= 0;
11847 /* Get information about the tool-bar item which is displayed in GLYPH
11848 on frame F. Return in *PROP_IDX the index where tool-bar item
11849 properties start in F->tool_bar_items. Value is zero if
11850 GLYPH doesn't display a tool-bar item. */
11853 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11859 /* This function can be called asynchronously, which means we must
11860 exclude any possibility that Fget_text_property signals an
11862 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11863 charpos
= max (0, charpos
);
11865 /* Get the text property `menu-item' at pos. The value of that
11866 property is the start index of this item's properties in
11867 F->tool_bar_items. */
11868 prop
= Fget_text_property (make_number (charpos
),
11869 Qmenu_item
, f
->current_tool_bar_string
);
11870 if (INTEGERP (prop
))
11872 *prop_idx
= XINT (prop
);
11882 /* Get information about the tool-bar item at position X/Y on frame F.
11883 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11884 the current matrix of the tool-bar window of F, or NULL if not
11885 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11886 item in F->tool_bar_items. Value is
11888 -1 if X/Y is not on a tool-bar item
11889 0 if X/Y is on the same item that was highlighted before.
11893 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11894 int *hpos
, int *vpos
, int *prop_idx
)
11896 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11897 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11900 /* Find the glyph under X/Y. */
11901 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11902 if (*glyph
== NULL
)
11905 /* Get the start of this tool-bar item's properties in
11906 f->tool_bar_items. */
11907 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11910 /* Is mouse on the highlighted item? */
11911 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11912 && *vpos
>= hlinfo
->mouse_face_beg_row
11913 && *vpos
<= hlinfo
->mouse_face_end_row
11914 && (*vpos
> hlinfo
->mouse_face_beg_row
11915 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11916 && (*vpos
< hlinfo
->mouse_face_end_row
11917 || *hpos
< hlinfo
->mouse_face_end_col
11918 || hlinfo
->mouse_face_past_end
))
11926 Handle mouse button event on the tool-bar of frame F, at
11927 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11928 0 for button release. MODIFIERS is event modifiers for button
11932 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11933 unsigned int modifiers
)
11935 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11936 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11937 int hpos
, vpos
, prop_idx
;
11938 struct glyph
*glyph
;
11939 Lisp_Object enabled_p
;
11941 /* If not on the highlighted tool-bar item, return. */
11942 frame_to_window_pixel_xy (w
, &x
, &y
);
11943 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11946 /* If item is disabled, do nothing. */
11947 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11948 if (NILP (enabled_p
))
11953 /* Show item in pressed state. */
11954 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11955 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11956 last_tool_bar_item
= prop_idx
;
11960 Lisp_Object key
, frame
;
11961 struct input_event event
;
11962 EVENT_INIT (event
);
11964 /* Show item in released state. */
11965 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11966 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11968 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11970 XSETFRAME (frame
, f
);
11971 event
.kind
= TOOL_BAR_EVENT
;
11972 event
.frame_or_window
= frame
;
11974 kbd_buffer_store_event (&event
);
11976 event
.kind
= TOOL_BAR_EVENT
;
11977 event
.frame_or_window
= frame
;
11979 event
.modifiers
= modifiers
;
11980 kbd_buffer_store_event (&event
);
11981 last_tool_bar_item
= -1;
11986 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11987 tool-bar window-relative coordinates X/Y. Called from
11988 note_mouse_highlight. */
11991 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11993 Lisp_Object window
= f
->tool_bar_window
;
11994 struct window
*w
= XWINDOW (window
);
11995 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11996 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11998 struct glyph
*glyph
;
11999 struct glyph_row
*row
;
12001 Lisp_Object enabled_p
;
12003 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12004 int mouse_down_p
, rc
;
12006 /* Function note_mouse_highlight is called with negative X/Y
12007 values when mouse moves outside of the frame. */
12008 if (x
<= 0 || y
<= 0)
12010 clear_mouse_face (hlinfo
);
12014 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12017 /* Not on tool-bar item. */
12018 clear_mouse_face (hlinfo
);
12022 /* On same tool-bar item as before. */
12023 goto set_help_echo
;
12025 clear_mouse_face (hlinfo
);
12027 /* Mouse is down, but on different tool-bar item? */
12028 mouse_down_p
= (dpyinfo
->grabbed
12029 && f
== last_mouse_frame
12030 && FRAME_LIVE_P (f
));
12032 && last_tool_bar_item
!= prop_idx
)
12035 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12036 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12038 /* If tool-bar item is not enabled, don't highlight it. */
12039 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12040 if (!NILP (enabled_p
))
12042 /* Compute the x-position of the glyph. In front and past the
12043 image is a space. We include this in the highlighted area. */
12044 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12045 for (i
= x
= 0; i
< hpos
; ++i
)
12046 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12048 /* Record this as the current active region. */
12049 hlinfo
->mouse_face_beg_col
= hpos
;
12050 hlinfo
->mouse_face_beg_row
= vpos
;
12051 hlinfo
->mouse_face_beg_x
= x
;
12052 hlinfo
->mouse_face_beg_y
= row
->y
;
12053 hlinfo
->mouse_face_past_end
= 0;
12055 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12056 hlinfo
->mouse_face_end_row
= vpos
;
12057 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12058 hlinfo
->mouse_face_end_y
= row
->y
;
12059 hlinfo
->mouse_face_window
= window
;
12060 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12062 /* Display it as active. */
12063 show_mouse_face (hlinfo
, draw
);
12064 hlinfo
->mouse_face_image_state
= draw
;
12069 /* Set help_echo_string to a help string to display for this tool-bar item.
12070 XTread_socket does the rest. */
12071 help_echo_object
= help_echo_window
= Qnil
;
12072 help_echo_pos
= -1;
12073 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12074 if (NILP (help_echo_string
))
12075 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12078 #endif /* HAVE_WINDOW_SYSTEM */
12082 /************************************************************************
12083 Horizontal scrolling
12084 ************************************************************************/
12086 static int hscroll_window_tree (Lisp_Object
);
12087 static int hscroll_windows (Lisp_Object
);
12089 /* For all leaf windows in the window tree rooted at WINDOW, set their
12090 hscroll value so that PT is (i) visible in the window, and (ii) so
12091 that it is not within a certain margin at the window's left and
12092 right border. Value is non-zero if any window's hscroll has been
12096 hscroll_window_tree (Lisp_Object window
)
12098 int hscrolled_p
= 0;
12099 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12100 int hscroll_step_abs
= 0;
12101 double hscroll_step_rel
= 0;
12103 if (hscroll_relative_p
)
12105 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12106 if (hscroll_step_rel
< 0)
12108 hscroll_relative_p
= 0;
12109 hscroll_step_abs
= 0;
12112 else if (INTEGERP (Vhscroll_step
))
12114 hscroll_step_abs
= XINT (Vhscroll_step
);
12115 if (hscroll_step_abs
< 0)
12116 hscroll_step_abs
= 0;
12119 hscroll_step_abs
= 0;
12121 while (WINDOWP (window
))
12123 struct window
*w
= XWINDOW (window
);
12125 if (WINDOWP (w
->hchild
))
12126 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12127 else if (WINDOWP (w
->vchild
))
12128 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12129 else if (w
->cursor
.vpos
>= 0)
12132 int text_area_width
;
12133 struct glyph_row
*current_cursor_row
12134 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12135 struct glyph_row
*desired_cursor_row
12136 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12137 struct glyph_row
*cursor_row
12138 = (desired_cursor_row
->enabled_p
12139 ? desired_cursor_row
12140 : current_cursor_row
);
12141 int row_r2l_p
= cursor_row
->reversed_p
;
12143 text_area_width
= window_box_width (w
, TEXT_AREA
);
12145 /* Scroll when cursor is inside this scroll margin. */
12146 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12148 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12149 /* For left-to-right rows, hscroll when cursor is either
12150 (i) inside the right hscroll margin, or (ii) if it is
12151 inside the left margin and the window is already
12154 && ((XFASTINT (w
->hscroll
)
12155 && w
->cursor
.x
<= h_margin
)
12156 || (cursor_row
->enabled_p
12157 && cursor_row
->truncated_on_right_p
12158 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12159 /* For right-to-left rows, the logic is similar,
12160 except that rules for scrolling to left and right
12161 are reversed. E.g., if cursor.x <= h_margin, we
12162 need to hscroll "to the right" unconditionally,
12163 and that will scroll the screen to the left so as
12164 to reveal the next portion of the row. */
12166 && ((cursor_row
->enabled_p
12167 /* FIXME: It is confusing to set the
12168 truncated_on_right_p flag when R2L rows
12169 are actually truncated on the left. */
12170 && cursor_row
->truncated_on_right_p
12171 && w
->cursor
.x
<= h_margin
)
12172 || (XFASTINT (w
->hscroll
)
12173 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12177 struct buffer
*saved_current_buffer
;
12181 /* Find point in a display of infinite width. */
12182 saved_current_buffer
= current_buffer
;
12183 current_buffer
= XBUFFER (w
->buffer
);
12185 if (w
== XWINDOW (selected_window
))
12189 pt
= marker_position (w
->pointm
);
12190 pt
= max (BEGV
, pt
);
12194 /* Move iterator to pt starting at cursor_row->start in
12195 a line with infinite width. */
12196 init_to_row_start (&it
, w
, cursor_row
);
12197 it
.last_visible_x
= INFINITY
;
12198 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12199 current_buffer
= saved_current_buffer
;
12201 /* Position cursor in window. */
12202 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12203 hscroll
= max (0, (it
.current_x
12204 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12205 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12206 : (text_area_width
/ 2))))
12207 / FRAME_COLUMN_WIDTH (it
.f
);
12208 else if ((!row_r2l_p
12209 && w
->cursor
.x
>= text_area_width
- h_margin
)
12210 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12212 if (hscroll_relative_p
)
12213 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12216 wanted_x
= text_area_width
12217 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12220 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12224 if (hscroll_relative_p
)
12225 wanted_x
= text_area_width
* hscroll_step_rel
12228 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12231 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12233 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12235 /* Don't prevent redisplay optimizations if hscroll
12236 hasn't changed, as it will unnecessarily slow down
12238 if (XFASTINT (w
->hscroll
) != hscroll
)
12240 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12241 w
->hscroll
= make_number (hscroll
);
12250 /* Value is non-zero if hscroll of any leaf window has been changed. */
12251 return hscrolled_p
;
12255 /* Set hscroll so that cursor is visible and not inside horizontal
12256 scroll margins for all windows in the tree rooted at WINDOW. See
12257 also hscroll_window_tree above. Value is non-zero if any window's
12258 hscroll has been changed. If it has, desired matrices on the frame
12259 of WINDOW are cleared. */
12262 hscroll_windows (Lisp_Object window
)
12264 int hscrolled_p
= hscroll_window_tree (window
);
12266 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12267 return hscrolled_p
;
12272 /************************************************************************
12274 ************************************************************************/
12276 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12277 to a non-zero value. This is sometimes handy to have in a debugger
12282 /* First and last unchanged row for try_window_id. */
12284 static int debug_first_unchanged_at_end_vpos
;
12285 static int debug_last_unchanged_at_beg_vpos
;
12287 /* Delta vpos and y. */
12289 static int debug_dvpos
, debug_dy
;
12291 /* Delta in characters and bytes for try_window_id. */
12293 static EMACS_INT debug_delta
, debug_delta_bytes
;
12295 /* Values of window_end_pos and window_end_vpos at the end of
12298 static EMACS_INT debug_end_vpos
;
12300 /* Append a string to W->desired_matrix->method. FMT is a printf
12301 format string. If trace_redisplay_p is non-zero also printf the
12302 resulting string to stderr. */
12304 static void debug_method_add (struct window
*, char const *, ...)
12305 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12308 debug_method_add (struct window
*w
, char const *fmt
, ...)
12311 char *method
= w
->desired_matrix
->method
;
12312 int len
= strlen (method
);
12313 int size
= sizeof w
->desired_matrix
->method
;
12314 int remaining
= size
- len
- 1;
12317 va_start (ap
, fmt
);
12318 vsprintf (buffer
, fmt
, ap
);
12320 if (len
&& remaining
)
12323 --remaining
, ++len
;
12326 strncpy (method
+ len
, buffer
, remaining
);
12328 if (trace_redisplay_p
)
12329 fprintf (stderr
, "%p (%s): %s\n",
12331 ((BUFFERP (w
->buffer
)
12332 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12333 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12338 #endif /* GLYPH_DEBUG */
12341 /* Value is non-zero if all changes in window W, which displays
12342 current_buffer, are in the text between START and END. START is a
12343 buffer position, END is given as a distance from Z. Used in
12344 redisplay_internal for display optimization. */
12347 text_outside_line_unchanged_p (struct window
*w
,
12348 EMACS_INT start
, EMACS_INT end
)
12350 int unchanged_p
= 1;
12352 /* If text or overlays have changed, see where. */
12353 if (XFASTINT (w
->last_modified
) < MODIFF
12354 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12356 /* Gap in the line? */
12357 if (GPT
< start
|| Z
- GPT
< end
)
12360 /* Changes start in front of the line, or end after it? */
12362 && (BEG_UNCHANGED
< start
- 1
12363 || END_UNCHANGED
< end
))
12366 /* If selective display, can't optimize if changes start at the
12367 beginning of the line. */
12369 && INTEGERP (BVAR (current_buffer
, selective_display
))
12370 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12371 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12374 /* If there are overlays at the start or end of the line, these
12375 may have overlay strings with newlines in them. A change at
12376 START, for instance, may actually concern the display of such
12377 overlay strings as well, and they are displayed on different
12378 lines. So, quickly rule out this case. (For the future, it
12379 might be desirable to implement something more telling than
12380 just BEG/END_UNCHANGED.) */
12383 if (BEG
+ BEG_UNCHANGED
== start
12384 && overlay_touches_p (start
))
12386 if (END_UNCHANGED
== end
12387 && overlay_touches_p (Z
- end
))
12391 /* Under bidi reordering, adding or deleting a character in the
12392 beginning of a paragraph, before the first strong directional
12393 character, can change the base direction of the paragraph (unless
12394 the buffer specifies a fixed paragraph direction), which will
12395 require to redisplay the whole paragraph. It might be worthwhile
12396 to find the paragraph limits and widen the range of redisplayed
12397 lines to that, but for now just give up this optimization. */
12398 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12399 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12403 return unchanged_p
;
12407 /* Do a frame update, taking possible shortcuts into account. This is
12408 the main external entry point for redisplay.
12410 If the last redisplay displayed an echo area message and that message
12411 is no longer requested, we clear the echo area or bring back the
12412 mini-buffer if that is in use. */
12417 redisplay_internal ();
12422 overlay_arrow_string_or_property (Lisp_Object var
)
12426 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12429 return Voverlay_arrow_string
;
12432 /* Return 1 if there are any overlay-arrows in current_buffer. */
12434 overlay_arrow_in_current_buffer_p (void)
12438 for (vlist
= Voverlay_arrow_variable_list
;
12440 vlist
= XCDR (vlist
))
12442 Lisp_Object var
= XCAR (vlist
);
12445 if (!SYMBOLP (var
))
12447 val
= find_symbol_value (var
);
12449 && current_buffer
== XMARKER (val
)->buffer
)
12456 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12460 overlay_arrows_changed_p (void)
12464 for (vlist
= Voverlay_arrow_variable_list
;
12466 vlist
= XCDR (vlist
))
12468 Lisp_Object var
= XCAR (vlist
);
12469 Lisp_Object val
, pstr
;
12471 if (!SYMBOLP (var
))
12473 val
= find_symbol_value (var
);
12474 if (!MARKERP (val
))
12476 if (! EQ (COERCE_MARKER (val
),
12477 Fget (var
, Qlast_arrow_position
))
12478 || ! (pstr
= overlay_arrow_string_or_property (var
),
12479 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12485 /* Mark overlay arrows to be updated on next redisplay. */
12488 update_overlay_arrows (int up_to_date
)
12492 for (vlist
= Voverlay_arrow_variable_list
;
12494 vlist
= XCDR (vlist
))
12496 Lisp_Object var
= XCAR (vlist
);
12498 if (!SYMBOLP (var
))
12501 if (up_to_date
> 0)
12503 Lisp_Object val
= find_symbol_value (var
);
12504 Fput (var
, Qlast_arrow_position
,
12505 COERCE_MARKER (val
));
12506 Fput (var
, Qlast_arrow_string
,
12507 overlay_arrow_string_or_property (var
));
12509 else if (up_to_date
< 0
12510 || !NILP (Fget (var
, Qlast_arrow_position
)))
12512 Fput (var
, Qlast_arrow_position
, Qt
);
12513 Fput (var
, Qlast_arrow_string
, Qt
);
12519 /* Return overlay arrow string to display at row.
12520 Return integer (bitmap number) for arrow bitmap in left fringe.
12521 Return nil if no overlay arrow. */
12524 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12528 for (vlist
= Voverlay_arrow_variable_list
;
12530 vlist
= XCDR (vlist
))
12532 Lisp_Object var
= XCAR (vlist
);
12535 if (!SYMBOLP (var
))
12538 val
= find_symbol_value (var
);
12541 && current_buffer
== XMARKER (val
)->buffer
12542 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12544 if (FRAME_WINDOW_P (it
->f
)
12545 /* FIXME: if ROW->reversed_p is set, this should test
12546 the right fringe, not the left one. */
12547 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12549 #ifdef HAVE_WINDOW_SYSTEM
12550 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12553 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12554 return make_number (fringe_bitmap
);
12557 return make_number (-1); /* Use default arrow bitmap */
12559 return overlay_arrow_string_or_property (var
);
12566 /* Return 1 if point moved out of or into a composition. Otherwise
12567 return 0. PREV_BUF and PREV_PT are the last point buffer and
12568 position. BUF and PT are the current point buffer and position. */
12571 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12572 struct buffer
*buf
, EMACS_INT pt
)
12574 EMACS_INT start
, end
;
12576 Lisp_Object buffer
;
12578 XSETBUFFER (buffer
, buf
);
12579 /* Check a composition at the last point if point moved within the
12581 if (prev_buf
== buf
)
12584 /* Point didn't move. */
12587 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12588 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12589 && COMPOSITION_VALID_P (start
, end
, prop
)
12590 && start
< prev_pt
&& end
> prev_pt
)
12591 /* The last point was within the composition. Return 1 iff
12592 point moved out of the composition. */
12593 return (pt
<= start
|| pt
>= end
);
12596 /* Check a composition at the current point. */
12597 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12598 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12599 && COMPOSITION_VALID_P (start
, end
, prop
)
12600 && start
< pt
&& end
> pt
);
12604 /* Reconsider the setting of B->clip_changed which is displayed
12608 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12610 if (b
->clip_changed
12611 && !NILP (w
->window_end_valid
)
12612 && w
->current_matrix
->buffer
== b
12613 && w
->current_matrix
->zv
== BUF_ZV (b
)
12614 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12615 b
->clip_changed
= 0;
12617 /* If display wasn't paused, and W is not a tool bar window, see if
12618 point has been moved into or out of a composition. In that case,
12619 we set b->clip_changed to 1 to force updating the screen. If
12620 b->clip_changed has already been set to 1, we can skip this
12622 if (!b
->clip_changed
12623 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12627 if (w
== XWINDOW (selected_window
))
12630 pt
= marker_position (w
->pointm
);
12632 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12633 || pt
!= XINT (w
->last_point
))
12634 && check_point_in_composition (w
->current_matrix
->buffer
,
12635 XINT (w
->last_point
),
12636 XBUFFER (w
->buffer
), pt
))
12637 b
->clip_changed
= 1;
12642 /* Select FRAME to forward the values of frame-local variables into C
12643 variables so that the redisplay routines can access those values
12647 select_frame_for_redisplay (Lisp_Object frame
)
12649 Lisp_Object tail
, tem
;
12650 Lisp_Object old
= selected_frame
;
12651 struct Lisp_Symbol
*sym
;
12653 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12655 selected_frame
= frame
;
12658 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12659 if (CONSP (XCAR (tail
))
12660 && (tem
= XCAR (XCAR (tail
)),
12662 && (sym
= indirect_variable (XSYMBOL (tem
)),
12663 sym
->redirect
== SYMBOL_LOCALIZED
)
12664 && sym
->val
.blv
->frame_local
)
12665 /* Use find_symbol_value rather than Fsymbol_value
12666 to avoid an error if it is void. */
12667 find_symbol_value (tem
);
12668 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12672 #define STOP_POLLING \
12673 do { if (! polling_stopped_here) stop_polling (); \
12674 polling_stopped_here = 1; } while (0)
12676 #define RESUME_POLLING \
12677 do { if (polling_stopped_here) start_polling (); \
12678 polling_stopped_here = 0; } while (0)
12681 /* Perhaps in the future avoid recentering windows if it
12682 is not necessary; currently that causes some problems. */
12685 redisplay_internal (void)
12687 struct window
*w
= XWINDOW (selected_window
);
12691 int must_finish
= 0;
12692 struct text_pos tlbufpos
, tlendpos
;
12693 int number_of_visible_frames
;
12696 int polling_stopped_here
= 0;
12697 Lisp_Object old_frame
= selected_frame
;
12699 /* Non-zero means redisplay has to consider all windows on all
12700 frames. Zero means, only selected_window is considered. */
12701 int consider_all_windows_p
;
12703 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12705 /* No redisplay if running in batch mode or frame is not yet fully
12706 initialized, or redisplay is explicitly turned off by setting
12707 Vinhibit_redisplay. */
12708 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12709 || !NILP (Vinhibit_redisplay
))
12712 /* Don't examine these until after testing Vinhibit_redisplay.
12713 When Emacs is shutting down, perhaps because its connection to
12714 X has dropped, we should not look at them at all. */
12715 fr
= XFRAME (w
->frame
);
12716 sf
= SELECTED_FRAME ();
12718 if (!fr
->glyphs_initialized_p
)
12721 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12722 if (popup_activated ())
12726 /* I don't think this happens but let's be paranoid. */
12727 if (redisplaying_p
)
12730 /* Record a function that resets redisplaying_p to its old value
12731 when we leave this function. */
12732 count
= SPECPDL_INDEX ();
12733 record_unwind_protect (unwind_redisplay
,
12734 Fcons (make_number (redisplaying_p
), selected_frame
));
12736 specbind (Qinhibit_free_realized_faces
, Qnil
);
12739 Lisp_Object tail
, frame
;
12741 FOR_EACH_FRAME (tail
, frame
)
12743 struct frame
*f
= XFRAME (frame
);
12744 f
->already_hscrolled_p
= 0;
12749 /* Remember the currently selected window. */
12752 if (!EQ (old_frame
, selected_frame
)
12753 && FRAME_LIVE_P (XFRAME (old_frame
)))
12754 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12755 selected_frame and selected_window to be temporarily out-of-sync so
12756 when we come back here via `goto retry', we need to resync because we
12757 may need to run Elisp code (via prepare_menu_bars). */
12758 select_frame_for_redisplay (old_frame
);
12761 reconsider_clip_changes (w
, current_buffer
);
12762 last_escape_glyph_frame
= NULL
;
12763 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12764 last_glyphless_glyph_frame
= NULL
;
12765 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12767 /* If new fonts have been loaded that make a glyph matrix adjustment
12768 necessary, do it. */
12769 if (fonts_changed_p
)
12771 adjust_glyphs (NULL
);
12772 ++windows_or_buffers_changed
;
12773 fonts_changed_p
= 0;
12776 /* If face_change_count is non-zero, init_iterator will free all
12777 realized faces, which includes the faces referenced from current
12778 matrices. So, we can't reuse current matrices in this case. */
12779 if (face_change_count
)
12780 ++windows_or_buffers_changed
;
12782 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12783 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12785 /* Since frames on a single ASCII terminal share the same
12786 display area, displaying a different frame means redisplay
12787 the whole thing. */
12788 windows_or_buffers_changed
++;
12789 SET_FRAME_GARBAGED (sf
);
12791 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12793 FRAME_TTY (sf
)->previous_frame
= sf
;
12796 /* Set the visible flags for all frames. Do this before checking
12797 for resized or garbaged frames; they want to know if their frames
12798 are visible. See the comment in frame.h for
12799 FRAME_SAMPLE_VISIBILITY. */
12801 Lisp_Object tail
, frame
;
12803 number_of_visible_frames
= 0;
12805 FOR_EACH_FRAME (tail
, frame
)
12807 struct frame
*f
= XFRAME (frame
);
12809 FRAME_SAMPLE_VISIBILITY (f
);
12810 if (FRAME_VISIBLE_P (f
))
12811 ++number_of_visible_frames
;
12812 clear_desired_matrices (f
);
12816 /* Notice any pending interrupt request to change frame size. */
12817 do_pending_window_change (1);
12819 /* do_pending_window_change could change the selected_window due to
12820 frame resizing which makes the selected window too small. */
12821 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12824 reconsider_clip_changes (w
, current_buffer
);
12827 /* Clear frames marked as garbaged. */
12828 if (frame_garbaged
)
12829 clear_garbaged_frames ();
12831 /* Build menubar and tool-bar items. */
12832 if (NILP (Vmemory_full
))
12833 prepare_menu_bars ();
12835 if (windows_or_buffers_changed
)
12836 update_mode_lines
++;
12838 /* Detect case that we need to write or remove a star in the mode line. */
12839 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12841 w
->update_mode_line
= Qt
;
12842 if (buffer_shared
> 1)
12843 update_mode_lines
++;
12846 /* Avoid invocation of point motion hooks by `current_column' below. */
12847 count1
= SPECPDL_INDEX ();
12848 specbind (Qinhibit_point_motion_hooks
, Qt
);
12850 /* If %c is in the mode line, update it if needed. */
12851 if (!NILP (w
->column_number_displayed
)
12852 /* This alternative quickly identifies a common case
12853 where no change is needed. */
12854 && !(PT
== XFASTINT (w
->last_point
)
12855 && XFASTINT (w
->last_modified
) >= MODIFF
12856 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12857 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12858 w
->update_mode_line
= Qt
;
12860 unbind_to (count1
, Qnil
);
12862 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12864 /* The variable buffer_shared is set in redisplay_window and
12865 indicates that we redisplay a buffer in different windows. See
12867 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12868 || cursor_type_changed
);
12870 /* If specs for an arrow have changed, do thorough redisplay
12871 to ensure we remove any arrow that should no longer exist. */
12872 if (overlay_arrows_changed_p ())
12873 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12875 /* Normally the message* functions will have already displayed and
12876 updated the echo area, but the frame may have been trashed, or
12877 the update may have been preempted, so display the echo area
12878 again here. Checking message_cleared_p captures the case that
12879 the echo area should be cleared. */
12880 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12881 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12882 || (message_cleared_p
12883 && minibuf_level
== 0
12884 /* If the mini-window is currently selected, this means the
12885 echo-area doesn't show through. */
12886 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12888 int window_height_changed_p
= echo_area_display (0);
12891 /* If we don't display the current message, don't clear the
12892 message_cleared_p flag, because, if we did, we wouldn't clear
12893 the echo area in the next redisplay which doesn't preserve
12895 if (!display_last_displayed_message_p
)
12896 message_cleared_p
= 0;
12898 if (fonts_changed_p
)
12900 else if (window_height_changed_p
)
12902 consider_all_windows_p
= 1;
12903 ++update_mode_lines
;
12904 ++windows_or_buffers_changed
;
12906 /* If window configuration was changed, frames may have been
12907 marked garbaged. Clear them or we will experience
12908 surprises wrt scrolling. */
12909 if (frame_garbaged
)
12910 clear_garbaged_frames ();
12913 else if (EQ (selected_window
, minibuf_window
)
12914 && (current_buffer
->clip_changed
12915 || XFASTINT (w
->last_modified
) < MODIFF
12916 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12917 && resize_mini_window (w
, 0))
12919 /* Resized active mini-window to fit the size of what it is
12920 showing if its contents might have changed. */
12922 /* FIXME: this causes all frames to be updated, which seems unnecessary
12923 since only the current frame needs to be considered. This function needs
12924 to be rewritten with two variables, consider_all_windows and
12925 consider_all_frames. */
12926 consider_all_windows_p
= 1;
12927 ++windows_or_buffers_changed
;
12928 ++update_mode_lines
;
12930 /* If window configuration was changed, frames may have been
12931 marked garbaged. Clear them or we will experience
12932 surprises wrt scrolling. */
12933 if (frame_garbaged
)
12934 clear_garbaged_frames ();
12938 /* If showing the region, and mark has changed, we must redisplay
12939 the whole window. The assignment to this_line_start_pos prevents
12940 the optimization directly below this if-statement. */
12941 if (((!NILP (Vtransient_mark_mode
)
12942 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12943 != !NILP (w
->region_showing
))
12944 || (!NILP (w
->region_showing
)
12945 && !EQ (w
->region_showing
,
12946 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12947 CHARPOS (this_line_start_pos
) = 0;
12949 /* Optimize the case that only the line containing the cursor in the
12950 selected window has changed. Variables starting with this_ are
12951 set in display_line and record information about the line
12952 containing the cursor. */
12953 tlbufpos
= this_line_start_pos
;
12954 tlendpos
= this_line_end_pos
;
12955 if (!consider_all_windows_p
12956 && CHARPOS (tlbufpos
) > 0
12957 && NILP (w
->update_mode_line
)
12958 && !current_buffer
->clip_changed
12959 && !current_buffer
->prevent_redisplay_optimizations_p
12960 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12961 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12962 /* Make sure recorded data applies to current buffer, etc. */
12963 && this_line_buffer
== current_buffer
12964 && current_buffer
== XBUFFER (w
->buffer
)
12965 && NILP (w
->force_start
)
12966 && NILP (w
->optional_new_start
)
12967 /* Point must be on the line that we have info recorded about. */
12968 && PT
>= CHARPOS (tlbufpos
)
12969 && PT
<= Z
- CHARPOS (tlendpos
)
12970 /* All text outside that line, including its final newline,
12971 must be unchanged. */
12972 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12973 CHARPOS (tlendpos
)))
12975 if (CHARPOS (tlbufpos
) > BEGV
12976 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12977 && (CHARPOS (tlbufpos
) == ZV
12978 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12979 /* Former continuation line has disappeared by becoming empty. */
12981 else if (XFASTINT (w
->last_modified
) < MODIFF
12982 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12983 || MINI_WINDOW_P (w
))
12985 /* We have to handle the case of continuation around a
12986 wide-column character (see the comment in indent.c around
12989 For instance, in the following case:
12991 -------- Insert --------
12992 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12993 J_I_ ==> J_I_ `^^' are cursors.
12997 As we have to redraw the line above, we cannot use this
13001 int line_height_before
= this_line_pixel_height
;
13003 /* Note that start_display will handle the case that the
13004 line starting at tlbufpos is a continuation line. */
13005 start_display (&it
, w
, tlbufpos
);
13007 /* Implementation note: It this still necessary? */
13008 if (it
.current_x
!= this_line_start_x
)
13011 TRACE ((stderr
, "trying display optimization 1\n"));
13012 w
->cursor
.vpos
= -1;
13013 overlay_arrow_seen
= 0;
13014 it
.vpos
= this_line_vpos
;
13015 it
.current_y
= this_line_y
;
13016 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13017 display_line (&it
);
13019 /* If line contains point, is not continued,
13020 and ends at same distance from eob as before, we win. */
13021 if (w
->cursor
.vpos
>= 0
13022 /* Line is not continued, otherwise this_line_start_pos
13023 would have been set to 0 in display_line. */
13024 && CHARPOS (this_line_start_pos
)
13025 /* Line ends as before. */
13026 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13027 /* Line has same height as before. Otherwise other lines
13028 would have to be shifted up or down. */
13029 && this_line_pixel_height
== line_height_before
)
13031 /* If this is not the window's last line, we must adjust
13032 the charstarts of the lines below. */
13033 if (it
.current_y
< it
.last_visible_y
)
13035 struct glyph_row
*row
13036 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13037 EMACS_INT delta
, delta_bytes
;
13039 /* We used to distinguish between two cases here,
13040 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13041 when the line ends in a newline or the end of the
13042 buffer's accessible portion. But both cases did
13043 the same, so they were collapsed. */
13045 - CHARPOS (tlendpos
)
13046 - MATRIX_ROW_START_CHARPOS (row
));
13047 delta_bytes
= (Z_BYTE
13048 - BYTEPOS (tlendpos
)
13049 - MATRIX_ROW_START_BYTEPOS (row
));
13051 increment_matrix_positions (w
->current_matrix
,
13052 this_line_vpos
+ 1,
13053 w
->current_matrix
->nrows
,
13054 delta
, delta_bytes
);
13057 /* If this row displays text now but previously didn't,
13058 or vice versa, w->window_end_vpos may have to be
13060 if ((it
.glyph_row
- 1)->displays_text_p
)
13062 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13063 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13065 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13066 && this_line_vpos
> 0)
13067 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13068 w
->window_end_valid
= Qnil
;
13070 /* Update hint: No need to try to scroll in update_window. */
13071 w
->desired_matrix
->no_scrolling_p
= 1;
13074 *w
->desired_matrix
->method
= 0;
13075 debug_method_add (w
, "optimization 1");
13077 #ifdef HAVE_WINDOW_SYSTEM
13078 update_window_fringes (w
, 0);
13085 else if (/* Cursor position hasn't changed. */
13086 PT
== XFASTINT (w
->last_point
)
13087 /* Make sure the cursor was last displayed
13088 in this window. Otherwise we have to reposition it. */
13089 && 0 <= w
->cursor
.vpos
13090 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13094 do_pending_window_change (1);
13095 /* If selected_window changed, redisplay again. */
13096 if (WINDOWP (selected_window
)
13097 && (w
= XWINDOW (selected_window
)) != sw
)
13100 /* We used to always goto end_of_redisplay here, but this
13101 isn't enough if we have a blinking cursor. */
13102 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13103 goto end_of_redisplay
;
13107 /* If highlighting the region, or if the cursor is in the echo area,
13108 then we can't just move the cursor. */
13109 else if (! (!NILP (Vtransient_mark_mode
)
13110 && !NILP (BVAR (current_buffer
, mark_active
)))
13111 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13112 || highlight_nonselected_windows
)
13113 && NILP (w
->region_showing
)
13114 && NILP (Vshow_trailing_whitespace
)
13115 && !cursor_in_echo_area
)
13118 struct glyph_row
*row
;
13120 /* Skip from tlbufpos to PT and see where it is. Note that
13121 PT may be in invisible text. If so, we will end at the
13122 next visible position. */
13123 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13124 NULL
, DEFAULT_FACE_ID
);
13125 it
.current_x
= this_line_start_x
;
13126 it
.current_y
= this_line_y
;
13127 it
.vpos
= this_line_vpos
;
13129 /* The call to move_it_to stops in front of PT, but
13130 moves over before-strings. */
13131 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13133 if (it
.vpos
== this_line_vpos
13134 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13137 xassert (this_line_vpos
== it
.vpos
);
13138 xassert (this_line_y
== it
.current_y
);
13139 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13141 *w
->desired_matrix
->method
= 0;
13142 debug_method_add (w
, "optimization 3");
13151 /* Text changed drastically or point moved off of line. */
13152 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13155 CHARPOS (this_line_start_pos
) = 0;
13156 consider_all_windows_p
|= buffer_shared
> 1;
13157 ++clear_face_cache_count
;
13158 #ifdef HAVE_WINDOW_SYSTEM
13159 ++clear_image_cache_count
;
13162 /* Build desired matrices, and update the display. If
13163 consider_all_windows_p is non-zero, do it for all windows on all
13164 frames. Otherwise do it for selected_window, only. */
13166 if (consider_all_windows_p
)
13168 Lisp_Object tail
, frame
;
13170 FOR_EACH_FRAME (tail
, frame
)
13171 XFRAME (frame
)->updated_p
= 0;
13173 /* Recompute # windows showing selected buffer. This will be
13174 incremented each time such a window is displayed. */
13177 FOR_EACH_FRAME (tail
, frame
)
13179 struct frame
*f
= XFRAME (frame
);
13181 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13183 if (! EQ (frame
, selected_frame
))
13184 /* Select the frame, for the sake of frame-local
13186 select_frame_for_redisplay (frame
);
13188 /* Mark all the scroll bars to be removed; we'll redeem
13189 the ones we want when we redisplay their windows. */
13190 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13191 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13193 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13194 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13196 /* The X error handler may have deleted that frame. */
13197 if (!FRAME_LIVE_P (f
))
13200 /* Any scroll bars which redisplay_windows should have
13201 nuked should now go away. */
13202 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13203 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13205 /* If fonts changed, display again. */
13206 /* ??? rms: I suspect it is a mistake to jump all the way
13207 back to retry here. It should just retry this frame. */
13208 if (fonts_changed_p
)
13211 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13213 /* See if we have to hscroll. */
13214 if (!f
->already_hscrolled_p
)
13216 f
->already_hscrolled_p
= 1;
13217 if (hscroll_windows (f
->root_window
))
13221 /* Prevent various kinds of signals during display
13222 update. stdio is not robust about handling
13223 signals, which can cause an apparent I/O
13225 if (interrupt_input
)
13226 unrequest_sigio ();
13229 /* Update the display. */
13230 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13231 pending
|= update_frame (f
, 0, 0);
13237 if (!EQ (old_frame
, selected_frame
)
13238 && FRAME_LIVE_P (XFRAME (old_frame
)))
13239 /* We played a bit fast-and-loose above and allowed selected_frame
13240 and selected_window to be temporarily out-of-sync but let's make
13241 sure this stays contained. */
13242 select_frame_for_redisplay (old_frame
);
13243 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13247 /* Do the mark_window_display_accurate after all windows have
13248 been redisplayed because this call resets flags in buffers
13249 which are needed for proper redisplay. */
13250 FOR_EACH_FRAME (tail
, frame
)
13252 struct frame
*f
= XFRAME (frame
);
13255 mark_window_display_accurate (f
->root_window
, 1);
13256 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13257 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13262 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13264 Lisp_Object mini_window
;
13265 struct frame
*mini_frame
;
13267 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13268 /* Use list_of_error, not Qerror, so that
13269 we catch only errors and don't run the debugger. */
13270 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13272 redisplay_window_error
);
13274 /* Compare desired and current matrices, perform output. */
13277 /* If fonts changed, display again. */
13278 if (fonts_changed_p
)
13281 /* Prevent various kinds of signals during display update.
13282 stdio is not robust about handling signals,
13283 which can cause an apparent I/O error. */
13284 if (interrupt_input
)
13285 unrequest_sigio ();
13288 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13290 if (hscroll_windows (selected_window
))
13293 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13294 pending
= update_frame (sf
, 0, 0);
13297 /* We may have called echo_area_display at the top of this
13298 function. If the echo area is on another frame, that may
13299 have put text on a frame other than the selected one, so the
13300 above call to update_frame would not have caught it. Catch
13302 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13303 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13305 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13307 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13308 pending
|= update_frame (mini_frame
, 0, 0);
13309 if (!pending
&& hscroll_windows (mini_window
))
13314 /* If display was paused because of pending input, make sure we do a
13315 thorough update the next time. */
13318 /* Prevent the optimization at the beginning of
13319 redisplay_internal that tries a single-line update of the
13320 line containing the cursor in the selected window. */
13321 CHARPOS (this_line_start_pos
) = 0;
13323 /* Let the overlay arrow be updated the next time. */
13324 update_overlay_arrows (0);
13326 /* If we pause after scrolling, some rows in the current
13327 matrices of some windows are not valid. */
13328 if (!WINDOW_FULL_WIDTH_P (w
)
13329 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13330 update_mode_lines
= 1;
13334 if (!consider_all_windows_p
)
13336 /* This has already been done above if
13337 consider_all_windows_p is set. */
13338 mark_window_display_accurate_1 (w
, 1);
13340 /* Say overlay arrows are up to date. */
13341 update_overlay_arrows (1);
13343 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13344 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13347 update_mode_lines
= 0;
13348 windows_or_buffers_changed
= 0;
13349 cursor_type_changed
= 0;
13352 /* Start SIGIO interrupts coming again. Having them off during the
13353 code above makes it less likely one will discard output, but not
13354 impossible, since there might be stuff in the system buffer here.
13355 But it is much hairier to try to do anything about that. */
13356 if (interrupt_input
)
13360 /* If a frame has become visible which was not before, redisplay
13361 again, so that we display it. Expose events for such a frame
13362 (which it gets when becoming visible) don't call the parts of
13363 redisplay constructing glyphs, so simply exposing a frame won't
13364 display anything in this case. So, we have to display these
13365 frames here explicitly. */
13368 Lisp_Object tail
, frame
;
13371 FOR_EACH_FRAME (tail
, frame
)
13373 int this_is_visible
= 0;
13375 if (XFRAME (frame
)->visible
)
13376 this_is_visible
= 1;
13377 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13378 if (XFRAME (frame
)->visible
)
13379 this_is_visible
= 1;
13381 if (this_is_visible
)
13385 if (new_count
!= number_of_visible_frames
)
13386 windows_or_buffers_changed
++;
13389 /* Change frame size now if a change is pending. */
13390 do_pending_window_change (1);
13392 /* If we just did a pending size change, or have additional
13393 visible frames, or selected_window changed, redisplay again. */
13394 if ((windows_or_buffers_changed
&& !pending
)
13395 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13398 /* Clear the face and image caches.
13400 We used to do this only if consider_all_windows_p. But the cache
13401 needs to be cleared if a timer creates images in the current
13402 buffer (e.g. the test case in Bug#6230). */
13404 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13406 clear_face_cache (0);
13407 clear_face_cache_count
= 0;
13410 #ifdef HAVE_WINDOW_SYSTEM
13411 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13413 clear_image_caches (Qnil
);
13414 clear_image_cache_count
= 0;
13416 #endif /* HAVE_WINDOW_SYSTEM */
13419 unbind_to (count
, Qnil
);
13424 /* Redisplay, but leave alone any recent echo area message unless
13425 another message has been requested in its place.
13427 This is useful in situations where you need to redisplay but no
13428 user action has occurred, making it inappropriate for the message
13429 area to be cleared. See tracking_off and
13430 wait_reading_process_output for examples of these situations.
13432 FROM_WHERE is an integer saying from where this function was
13433 called. This is useful for debugging. */
13436 redisplay_preserve_echo_area (int from_where
)
13438 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13440 if (!NILP (echo_area_buffer
[1]))
13442 /* We have a previously displayed message, but no current
13443 message. Redisplay the previous message. */
13444 display_last_displayed_message_p
= 1;
13445 redisplay_internal ();
13446 display_last_displayed_message_p
= 0;
13449 redisplay_internal ();
13451 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13452 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13453 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13457 /* Function registered with record_unwind_protect in
13458 redisplay_internal. Reset redisplaying_p to the value it had
13459 before redisplay_internal was called, and clear
13460 prevent_freeing_realized_faces_p. It also selects the previously
13461 selected frame, unless it has been deleted (by an X connection
13462 failure during redisplay, for example). */
13465 unwind_redisplay (Lisp_Object val
)
13467 Lisp_Object old_redisplaying_p
, old_frame
;
13469 old_redisplaying_p
= XCAR (val
);
13470 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13471 old_frame
= XCDR (val
);
13472 if (! EQ (old_frame
, selected_frame
)
13473 && FRAME_LIVE_P (XFRAME (old_frame
)))
13474 select_frame_for_redisplay (old_frame
);
13479 /* Mark the display of window W as accurate or inaccurate. If
13480 ACCURATE_P is non-zero mark display of W as accurate. If
13481 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13482 redisplay_internal is called. */
13485 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13487 if (BUFFERP (w
->buffer
))
13489 struct buffer
*b
= XBUFFER (w
->buffer
);
13492 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13493 w
->last_overlay_modified
13494 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13496 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13500 b
->clip_changed
= 0;
13501 b
->prevent_redisplay_optimizations_p
= 0;
13503 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13504 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13505 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13506 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13508 w
->current_matrix
->buffer
= b
;
13509 w
->current_matrix
->begv
= BUF_BEGV (b
);
13510 w
->current_matrix
->zv
= BUF_ZV (b
);
13512 w
->last_cursor
= w
->cursor
;
13513 w
->last_cursor_off_p
= w
->cursor_off_p
;
13515 if (w
== XWINDOW (selected_window
))
13516 w
->last_point
= make_number (BUF_PT (b
));
13518 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13524 w
->window_end_valid
= w
->buffer
;
13525 w
->update_mode_line
= Qnil
;
13530 /* Mark the display of windows in the window tree rooted at WINDOW as
13531 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13532 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13533 be redisplayed the next time redisplay_internal is called. */
13536 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13540 for (; !NILP (window
); window
= w
->next
)
13542 w
= XWINDOW (window
);
13543 mark_window_display_accurate_1 (w
, accurate_p
);
13545 if (!NILP (w
->vchild
))
13546 mark_window_display_accurate (w
->vchild
, accurate_p
);
13547 if (!NILP (w
->hchild
))
13548 mark_window_display_accurate (w
->hchild
, accurate_p
);
13553 update_overlay_arrows (1);
13557 /* Force a thorough redisplay the next time by setting
13558 last_arrow_position and last_arrow_string to t, which is
13559 unequal to any useful value of Voverlay_arrow_... */
13560 update_overlay_arrows (-1);
13565 /* Return value in display table DP (Lisp_Char_Table *) for character
13566 C. Since a display table doesn't have any parent, we don't have to
13567 follow parent. Do not call this function directly but use the
13568 macro DISP_CHAR_VECTOR. */
13571 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13575 if (ASCII_CHAR_P (c
))
13578 if (SUB_CHAR_TABLE_P (val
))
13579 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13585 XSETCHAR_TABLE (table
, dp
);
13586 val
= char_table_ref (table
, c
);
13595 /***********************************************************************
13597 ***********************************************************************/
13599 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13602 redisplay_windows (Lisp_Object window
)
13604 while (!NILP (window
))
13606 struct window
*w
= XWINDOW (window
);
13608 if (!NILP (w
->hchild
))
13609 redisplay_windows (w
->hchild
);
13610 else if (!NILP (w
->vchild
))
13611 redisplay_windows (w
->vchild
);
13612 else if (!NILP (w
->buffer
))
13614 displayed_buffer
= XBUFFER (w
->buffer
);
13615 /* Use list_of_error, not Qerror, so that
13616 we catch only errors and don't run the debugger. */
13617 internal_condition_case_1 (redisplay_window_0
, window
,
13619 redisplay_window_error
);
13627 redisplay_window_error (Lisp_Object ignore
)
13629 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13634 redisplay_window_0 (Lisp_Object window
)
13636 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13637 redisplay_window (window
, 0);
13642 redisplay_window_1 (Lisp_Object window
)
13644 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13645 redisplay_window (window
, 1);
13650 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13651 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13652 which positions recorded in ROW differ from current buffer
13655 Return 0 if cursor is not on this row, 1 otherwise. */
13658 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13659 struct glyph_matrix
*matrix
,
13660 EMACS_INT delta
, EMACS_INT delta_bytes
,
13663 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13664 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13665 struct glyph
*cursor
= NULL
;
13666 /* The last known character position in row. */
13667 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13669 EMACS_INT pt_old
= PT
- delta
;
13670 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13671 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13672 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13673 /* A glyph beyond the edge of TEXT_AREA which we should never
13675 struct glyph
*glyphs_end
= end
;
13676 /* Non-zero means we've found a match for cursor position, but that
13677 glyph has the avoid_cursor_p flag set. */
13678 int match_with_avoid_cursor
= 0;
13679 /* Non-zero means we've seen at least one glyph that came from a
13681 int string_seen
= 0;
13682 /* Largest and smallest buffer positions seen so far during scan of
13684 EMACS_INT bpos_max
= pos_before
;
13685 EMACS_INT bpos_min
= pos_after
;
13686 /* Last buffer position covered by an overlay string with an integer
13687 `cursor' property. */
13688 EMACS_INT bpos_covered
= 0;
13689 /* Non-zero means the display string on which to display the cursor
13690 comes from a text property, not from an overlay. */
13691 int string_from_text_prop
= 0;
13693 /* Don't even try doing anything if called for a mode-line or
13694 header-line row, since the rest of the code isn't prepared to
13695 deal with such calamities. */
13696 xassert (!row
->mode_line_p
);
13697 if (row
->mode_line_p
)
13700 /* Skip over glyphs not having an object at the start and the end of
13701 the row. These are special glyphs like truncation marks on
13702 terminal frames. */
13703 if (row
->displays_text_p
)
13705 if (!row
->reversed_p
)
13708 && INTEGERP (glyph
->object
)
13709 && glyph
->charpos
< 0)
13711 x
+= glyph
->pixel_width
;
13715 && INTEGERP ((end
- 1)->object
)
13716 /* CHARPOS is zero for blanks and stretch glyphs
13717 inserted by extend_face_to_end_of_line. */
13718 && (end
- 1)->charpos
<= 0)
13720 glyph_before
= glyph
- 1;
13727 /* If the glyph row is reversed, we need to process it from back
13728 to front, so swap the edge pointers. */
13729 glyphs_end
= end
= glyph
- 1;
13730 glyph
+= row
->used
[TEXT_AREA
] - 1;
13732 while (glyph
> end
+ 1
13733 && INTEGERP (glyph
->object
)
13734 && glyph
->charpos
< 0)
13737 x
-= glyph
->pixel_width
;
13739 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13741 /* By default, in reversed rows we put the cursor on the
13742 rightmost (first in the reading order) glyph. */
13743 for (g
= end
+ 1; g
< glyph
; g
++)
13744 x
+= g
->pixel_width
;
13746 && INTEGERP ((end
+ 1)->object
)
13747 && (end
+ 1)->charpos
<= 0)
13749 glyph_before
= glyph
+ 1;
13753 else if (row
->reversed_p
)
13755 /* In R2L rows that don't display text, put the cursor on the
13756 rightmost glyph. Case in point: an empty last line that is
13757 part of an R2L paragraph. */
13759 /* Avoid placing the cursor on the last glyph of the row, where
13760 on terminal frames we hold the vertical border between
13761 adjacent windows. */
13762 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13763 && !WINDOW_RIGHTMOST_P (w
)
13764 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13766 x
= -1; /* will be computed below, at label compute_x */
13769 /* Step 1: Try to find the glyph whose character position
13770 corresponds to point. If that's not possible, find 2 glyphs
13771 whose character positions are the closest to point, one before
13772 point, the other after it. */
13773 if (!row
->reversed_p
)
13774 while (/* not marched to end of glyph row */
13776 /* glyph was not inserted by redisplay for internal purposes */
13777 && !INTEGERP (glyph
->object
))
13779 if (BUFFERP (glyph
->object
))
13781 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13783 if (glyph
->charpos
> bpos_max
)
13784 bpos_max
= glyph
->charpos
;
13785 if (glyph
->charpos
< bpos_min
)
13786 bpos_min
= glyph
->charpos
;
13787 if (!glyph
->avoid_cursor_p
)
13789 /* If we hit point, we've found the glyph on which to
13790 display the cursor. */
13793 match_with_avoid_cursor
= 0;
13796 /* See if we've found a better approximation to
13797 POS_BEFORE or to POS_AFTER. Note that we want the
13798 first (leftmost) glyph of all those that are the
13799 closest from below, and the last (rightmost) of all
13800 those from above. */
13801 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13803 pos_before
= glyph
->charpos
;
13804 glyph_before
= glyph
;
13806 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13808 pos_after
= glyph
->charpos
;
13809 glyph_after
= glyph
;
13812 else if (dpos
== 0)
13813 match_with_avoid_cursor
= 1;
13815 else if (STRINGP (glyph
->object
))
13817 Lisp_Object chprop
;
13818 EMACS_INT glyph_pos
= glyph
->charpos
;
13820 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13822 if (!NILP (chprop
))
13824 /* If the string came from a `display' text property,
13825 look up the buffer position of that property and
13826 use that position to update bpos_max, as if we
13827 actually saw such a position in one of the row's
13828 glyphs. This helps with supporting integer values
13829 of `cursor' property on the display string in
13830 situations where most or all of the row's buffer
13831 text is completely covered by display properties,
13832 so that no glyph with valid buffer positions is
13833 ever seen in the row. */
13834 EMACS_INT prop_pos
=
13835 string_buffer_position_lim (glyph
->object
, pos_before
,
13838 if (prop_pos
>= pos_before
)
13839 bpos_max
= prop_pos
- 1;
13841 if (INTEGERP (chprop
))
13843 bpos_covered
= bpos_max
+ XINT (chprop
);
13844 /* If the `cursor' property covers buffer positions up
13845 to and including point, we should display cursor on
13846 this glyph. Note that, if a `cursor' property on one
13847 of the string's characters has an integer value, we
13848 will break out of the loop below _before_ we get to
13849 the position match above. IOW, integer values of
13850 the `cursor' property override the "exact match for
13851 point" strategy of positioning the cursor. */
13852 /* Implementation note: bpos_max == pt_old when, e.g.,
13853 we are in an empty line, where bpos_max is set to
13854 MATRIX_ROW_START_CHARPOS, see above. */
13855 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13864 x
+= glyph
->pixel_width
;
13867 else if (glyph
> end
) /* row is reversed */
13868 while (!INTEGERP (glyph
->object
))
13870 if (BUFFERP (glyph
->object
))
13872 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13874 if (glyph
->charpos
> bpos_max
)
13875 bpos_max
= glyph
->charpos
;
13876 if (glyph
->charpos
< bpos_min
)
13877 bpos_min
= glyph
->charpos
;
13878 if (!glyph
->avoid_cursor_p
)
13882 match_with_avoid_cursor
= 0;
13885 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13887 pos_before
= glyph
->charpos
;
13888 glyph_before
= glyph
;
13890 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13892 pos_after
= glyph
->charpos
;
13893 glyph_after
= glyph
;
13896 else if (dpos
== 0)
13897 match_with_avoid_cursor
= 1;
13899 else if (STRINGP (glyph
->object
))
13901 Lisp_Object chprop
;
13902 EMACS_INT glyph_pos
= glyph
->charpos
;
13904 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13906 if (!NILP (chprop
))
13908 EMACS_INT prop_pos
=
13909 string_buffer_position_lim (glyph
->object
, pos_before
,
13912 if (prop_pos
>= pos_before
)
13913 bpos_max
= prop_pos
- 1;
13915 if (INTEGERP (chprop
))
13917 bpos_covered
= bpos_max
+ XINT (chprop
);
13918 /* If the `cursor' property covers buffer positions up
13919 to and including point, we should display cursor on
13921 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13930 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13932 x
--; /* can't use any pixel_width */
13935 x
-= glyph
->pixel_width
;
13938 /* Step 2: If we didn't find an exact match for point, we need to
13939 look for a proper place to put the cursor among glyphs between
13940 GLYPH_BEFORE and GLYPH_AFTER. */
13941 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13942 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13943 && bpos_covered
< pt_old
)
13945 /* An empty line has a single glyph whose OBJECT is zero and
13946 whose CHARPOS is the position of a newline on that line.
13947 Note that on a TTY, there are more glyphs after that, which
13948 were produced by extend_face_to_end_of_line, but their
13949 CHARPOS is zero or negative. */
13951 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13952 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13954 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13956 EMACS_INT ellipsis_pos
;
13958 /* Scan back over the ellipsis glyphs. */
13959 if (!row
->reversed_p
)
13961 ellipsis_pos
= (glyph
- 1)->charpos
;
13962 while (glyph
> row
->glyphs
[TEXT_AREA
]
13963 && (glyph
- 1)->charpos
== ellipsis_pos
)
13964 glyph
--, x
-= glyph
->pixel_width
;
13965 /* That loop always goes one position too far, including
13966 the glyph before the ellipsis. So scan forward over
13968 x
+= glyph
->pixel_width
;
13971 else /* row is reversed */
13973 ellipsis_pos
= (glyph
+ 1)->charpos
;
13974 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13975 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13976 glyph
++, x
+= glyph
->pixel_width
;
13977 x
-= glyph
->pixel_width
;
13981 else if (match_with_avoid_cursor
)
13983 cursor
= glyph_after
;
13986 else if (string_seen
)
13988 int incr
= row
->reversed_p
? -1 : +1;
13990 /* Need to find the glyph that came out of a string which is
13991 present at point. That glyph is somewhere between
13992 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13993 positioned between POS_BEFORE and POS_AFTER in the
13995 struct glyph
*start
, *stop
;
13996 EMACS_INT pos
= pos_before
;
14000 /* If the row ends in a newline from a display string,
14001 reordering could have moved the glyphs belonging to the
14002 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14003 in this case we extend the search to the last glyph in
14004 the row that was not inserted by redisplay. */
14005 if (row
->ends_in_newline_from_string_p
)
14008 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14011 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14012 correspond to POS_BEFORE and POS_AFTER, respectively. We
14013 need START and STOP in the order that corresponds to the
14014 row's direction as given by its reversed_p flag. If the
14015 directionality of characters between POS_BEFORE and
14016 POS_AFTER is the opposite of the row's base direction,
14017 these characters will have been reordered for display,
14018 and we need to reverse START and STOP. */
14019 if (!row
->reversed_p
)
14021 start
= min (glyph_before
, glyph_after
);
14022 stop
= max (glyph_before
, glyph_after
);
14026 start
= max (glyph_before
, glyph_after
);
14027 stop
= min (glyph_before
, glyph_after
);
14029 for (glyph
= start
+ incr
;
14030 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14033 /* Any glyphs that come from the buffer are here because
14034 of bidi reordering. Skip them, and only pay
14035 attention to glyphs that came from some string. */
14036 if (STRINGP (glyph
->object
))
14040 /* If the display property covers the newline, we
14041 need to search for it one position farther. */
14042 EMACS_INT lim
= pos_after
14043 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14045 string_from_text_prop
= 0;
14046 str
= glyph
->object
;
14047 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14048 if (tem
== 0 /* from overlay */
14051 /* If the string from which this glyph came is
14052 found in the buffer at point, then we've
14053 found the glyph we've been looking for. If
14054 it comes from an overlay (tem == 0), and it
14055 has the `cursor' property on one of its
14056 glyphs, record that glyph as a candidate for
14057 displaying the cursor. (As in the
14058 unidirectional version, we will display the
14059 cursor on the last candidate we find.) */
14060 if (tem
== 0 || tem
== pt_old
)
14062 /* The glyphs from this string could have
14063 been reordered. Find the one with the
14064 smallest string position. Or there could
14065 be a character in the string with the
14066 `cursor' property, which means display
14067 cursor on that character's glyph. */
14068 EMACS_INT strpos
= glyph
->charpos
;
14073 string_from_text_prop
= 1;
14076 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14077 && EQ (glyph
->object
, str
);
14081 EMACS_INT gpos
= glyph
->charpos
;
14083 cprop
= Fget_char_property (make_number (gpos
),
14091 if (tem
&& glyph
->charpos
< strpos
)
14093 strpos
= glyph
->charpos
;
14102 pos
= tem
+ 1; /* don't find previous instances */
14104 /* This string is not what we want; skip all of the
14105 glyphs that came from it. */
14106 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14107 && EQ (glyph
->object
, str
))
14114 /* If we reached the end of the line, and END was from a string,
14115 the cursor is not on this line. */
14117 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14118 && STRINGP (end
->object
)
14119 && row
->continued_p
)
14122 /* A truncated row may not include PT among its character positions.
14123 Setting the cursor inside the scroll margin will trigger
14124 recalculation of hscroll in hscroll_window_tree. But if a
14125 display string covers point, defer to the string-handling
14126 code below to figure this out. */
14127 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14129 cursor
= glyph_before
;
14132 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14133 /* Zero-width characters produce no glyphs. */
14135 && (row
->reversed_p
14136 ? glyph_after
> glyphs_end
14137 : glyph_after
< glyphs_end
)))
14139 cursor
= glyph_after
;
14145 if (cursor
!= NULL
)
14151 /* Need to compute x that corresponds to GLYPH. */
14152 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14154 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14156 x
+= g
->pixel_width
;
14160 /* ROW could be part of a continued line, which, under bidi
14161 reordering, might have other rows whose start and end charpos
14162 occlude point. Only set w->cursor if we found a better
14163 approximation to the cursor position than we have from previously
14164 examined candidate rows belonging to the same continued line. */
14165 if (/* we already have a candidate row */
14166 w
->cursor
.vpos
>= 0
14167 /* that candidate is not the row we are processing */
14168 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14169 /* Make sure cursor.vpos specifies a row whose start and end
14170 charpos occlude point, and it is valid candidate for being a
14171 cursor-row. This is because some callers of this function
14172 leave cursor.vpos at the row where the cursor was displayed
14173 during the last redisplay cycle. */
14174 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14175 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14176 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14179 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14181 /* Don't consider glyphs that are outside TEXT_AREA. */
14182 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14184 /* Keep the candidate whose buffer position is the closest to
14185 point or has the `cursor' property. */
14186 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14187 w
->cursor
.hpos
>= 0
14188 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14189 && ((BUFFERP (g1
->object
)
14190 && (g1
->charpos
== pt_old
/* an exact match always wins */
14191 || (BUFFERP (glyph
->object
)
14192 && eabs (g1
->charpos
- pt_old
)
14193 < eabs (glyph
->charpos
- pt_old
))))
14194 /* previous candidate is a glyph from a string that has
14195 a non-nil `cursor' property */
14196 || (STRINGP (g1
->object
)
14197 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14198 Qcursor
, g1
->object
))
14199 /* previous candidate is from the same display
14200 string as this one, and the display string
14201 came from a text property */
14202 || (EQ (g1
->object
, glyph
->object
)
14203 && string_from_text_prop
)
14204 /* this candidate is from newline and its
14205 position is not an exact match */
14206 || (INTEGERP (glyph
->object
)
14207 && glyph
->charpos
!= pt_old
)))))
14209 /* If this candidate gives an exact match, use that. */
14210 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14211 /* If this candidate is a glyph created for the
14212 terminating newline of a line, and point is on that
14213 newline, it wins because it's an exact match. */
14214 || (!row
->continued_p
14215 && INTEGERP (glyph
->object
)
14216 && glyph
->charpos
== 0
14217 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14218 /* Otherwise, keep the candidate that comes from a row
14219 spanning less buffer positions. This may win when one or
14220 both candidate positions are on glyphs that came from
14221 display strings, for which we cannot compare buffer
14223 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14224 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14225 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14228 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14230 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14231 w
->cursor
.y
= row
->y
+ dy
;
14233 if (w
== XWINDOW (selected_window
))
14235 if (!row
->continued_p
14236 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14239 this_line_buffer
= XBUFFER (w
->buffer
);
14241 CHARPOS (this_line_start_pos
)
14242 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14243 BYTEPOS (this_line_start_pos
)
14244 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14246 CHARPOS (this_line_end_pos
)
14247 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14248 BYTEPOS (this_line_end_pos
)
14249 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14251 this_line_y
= w
->cursor
.y
;
14252 this_line_pixel_height
= row
->height
;
14253 this_line_vpos
= w
->cursor
.vpos
;
14254 this_line_start_x
= row
->x
;
14257 CHARPOS (this_line_start_pos
) = 0;
14264 /* Run window scroll functions, if any, for WINDOW with new window
14265 start STARTP. Sets the window start of WINDOW to that position.
14267 We assume that the window's buffer is really current. */
14269 static inline struct text_pos
14270 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14272 struct window
*w
= XWINDOW (window
);
14273 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14275 if (current_buffer
!= XBUFFER (w
->buffer
))
14278 if (!NILP (Vwindow_scroll_functions
))
14280 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14281 make_number (CHARPOS (startp
)));
14282 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14283 /* In case the hook functions switch buffers. */
14284 if (current_buffer
!= XBUFFER (w
->buffer
))
14285 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14292 /* Make sure the line containing the cursor is fully visible.
14293 A value of 1 means there is nothing to be done.
14294 (Either the line is fully visible, or it cannot be made so,
14295 or we cannot tell.)
14297 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14298 is higher than window.
14300 A value of 0 means the caller should do scrolling
14301 as if point had gone off the screen. */
14304 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14306 struct glyph_matrix
*matrix
;
14307 struct glyph_row
*row
;
14310 if (!make_cursor_line_fully_visible_p
)
14313 /* It's not always possible to find the cursor, e.g, when a window
14314 is full of overlay strings. Don't do anything in that case. */
14315 if (w
->cursor
.vpos
< 0)
14318 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14319 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14321 /* If the cursor row is not partially visible, there's nothing to do. */
14322 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14325 /* If the row the cursor is in is taller than the window's height,
14326 it's not clear what to do, so do nothing. */
14327 window_height
= window_box_height (w
);
14328 if (row
->height
>= window_height
)
14330 if (!force_p
|| MINI_WINDOW_P (w
)
14331 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14338 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14339 non-zero means only WINDOW is redisplayed in redisplay_internal.
14340 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14341 in redisplay_window to bring a partially visible line into view in
14342 the case that only the cursor has moved.
14344 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14345 last screen line's vertical height extends past the end of the screen.
14349 1 if scrolling succeeded
14351 0 if scrolling didn't find point.
14353 -1 if new fonts have been loaded so that we must interrupt
14354 redisplay, adjust glyph matrices, and try again. */
14360 SCROLLING_NEED_LARGER_MATRICES
14363 /* If scroll-conservatively is more than this, never recenter.
14365 If you change this, don't forget to update the doc string of
14366 `scroll-conservatively' and the Emacs manual. */
14367 #define SCROLL_LIMIT 100
14370 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14371 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14372 int temp_scroll_step
, int last_line_misfit
)
14374 struct window
*w
= XWINDOW (window
);
14375 struct frame
*f
= XFRAME (w
->frame
);
14376 struct text_pos pos
, startp
;
14378 int this_scroll_margin
, scroll_max
, rc
, height
;
14379 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14380 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14381 Lisp_Object aggressive
;
14382 /* We will never try scrolling more than this number of lines. */
14383 int scroll_limit
= SCROLL_LIMIT
;
14386 debug_method_add (w
, "try_scrolling");
14389 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14391 /* Compute scroll margin height in pixels. We scroll when point is
14392 within this distance from the top or bottom of the window. */
14393 if (scroll_margin
> 0)
14394 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14395 * FRAME_LINE_HEIGHT (f
);
14397 this_scroll_margin
= 0;
14399 /* Force arg_scroll_conservatively to have a reasonable value, to
14400 avoid scrolling too far away with slow move_it_* functions. Note
14401 that the user can supply scroll-conservatively equal to
14402 `most-positive-fixnum', which can be larger than INT_MAX. */
14403 if (arg_scroll_conservatively
> scroll_limit
)
14405 arg_scroll_conservatively
= scroll_limit
+ 1;
14406 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14408 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14409 /* Compute how much we should try to scroll maximally to bring
14410 point into view. */
14411 scroll_max
= (max (scroll_step
,
14412 max (arg_scroll_conservatively
, temp_scroll_step
))
14413 * FRAME_LINE_HEIGHT (f
));
14414 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14415 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14416 /* We're trying to scroll because of aggressive scrolling but no
14417 scroll_step is set. Choose an arbitrary one. */
14418 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14424 /* Decide whether to scroll down. */
14425 if (PT
> CHARPOS (startp
))
14427 int scroll_margin_y
;
14429 /* Compute the pixel ypos of the scroll margin, then move IT to
14430 either that ypos or PT, whichever comes first. */
14431 start_display (&it
, w
, startp
);
14432 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14433 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14434 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14435 (MOVE_TO_POS
| MOVE_TO_Y
));
14437 if (PT
> CHARPOS (it
.current
.pos
))
14439 int y0
= line_bottom_y (&it
);
14440 /* Compute how many pixels below window bottom to stop searching
14441 for PT. This avoids costly search for PT that is far away if
14442 the user limited scrolling by a small number of lines, but
14443 always finds PT if scroll_conservatively is set to a large
14444 number, such as most-positive-fixnum. */
14445 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14446 int y_to_move
= it
.last_visible_y
+ slack
;
14448 /* Compute the distance from the scroll margin to PT or to
14449 the scroll limit, whichever comes first. This should
14450 include the height of the cursor line, to make that line
14452 move_it_to (&it
, PT
, -1, y_to_move
,
14453 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14454 dy
= line_bottom_y (&it
) - y0
;
14456 if (dy
> scroll_max
)
14457 return SCROLLING_FAILED
;
14466 /* Point is in or below the bottom scroll margin, so move the
14467 window start down. If scrolling conservatively, move it just
14468 enough down to make point visible. If scroll_step is set,
14469 move it down by scroll_step. */
14470 if (arg_scroll_conservatively
)
14472 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14473 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14474 else if (scroll_step
|| temp_scroll_step
)
14475 amount_to_scroll
= scroll_max
;
14478 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14479 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14480 if (NUMBERP (aggressive
))
14482 double float_amount
= XFLOATINT (aggressive
) * height
;
14483 amount_to_scroll
= float_amount
;
14484 if (amount_to_scroll
== 0 && float_amount
> 0)
14485 amount_to_scroll
= 1;
14486 /* Don't let point enter the scroll margin near top of
14488 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14489 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14493 if (amount_to_scroll
<= 0)
14494 return SCROLLING_FAILED
;
14496 start_display (&it
, w
, startp
);
14497 if (arg_scroll_conservatively
<= scroll_limit
)
14498 move_it_vertically (&it
, amount_to_scroll
);
14501 /* Extra precision for users who set scroll-conservatively
14502 to a large number: make sure the amount we scroll
14503 the window start is never less than amount_to_scroll,
14504 which was computed as distance from window bottom to
14505 point. This matters when lines at window top and lines
14506 below window bottom have different height. */
14508 void *it1data
= NULL
;
14509 /* We use a temporary it1 because line_bottom_y can modify
14510 its argument, if it moves one line down; see there. */
14513 SAVE_IT (it1
, it
, it1data
);
14514 start_y
= line_bottom_y (&it1
);
14516 RESTORE_IT (&it
, &it
, it1data
);
14517 move_it_by_lines (&it
, 1);
14518 SAVE_IT (it1
, it
, it1data
);
14519 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14522 /* If STARTP is unchanged, move it down another screen line. */
14523 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14524 move_it_by_lines (&it
, 1);
14525 startp
= it
.current
.pos
;
14529 struct text_pos scroll_margin_pos
= startp
;
14531 /* See if point is inside the scroll margin at the top of the
14533 if (this_scroll_margin
)
14535 start_display (&it
, w
, startp
);
14536 move_it_vertically (&it
, this_scroll_margin
);
14537 scroll_margin_pos
= it
.current
.pos
;
14540 if (PT
< CHARPOS (scroll_margin_pos
))
14542 /* Point is in the scroll margin at the top of the window or
14543 above what is displayed in the window. */
14546 /* Compute the vertical distance from PT to the scroll
14547 margin position. Move as far as scroll_max allows, or
14548 one screenful, or 10 screen lines, whichever is largest.
14549 Give up if distance is greater than scroll_max. */
14550 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14551 start_display (&it
, w
, pos
);
14553 y_to_move
= max (it
.last_visible_y
,
14554 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14555 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14557 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14558 dy
= it
.current_y
- y0
;
14559 if (dy
> scroll_max
)
14560 return SCROLLING_FAILED
;
14562 /* Compute new window start. */
14563 start_display (&it
, w
, startp
);
14565 if (arg_scroll_conservatively
)
14566 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14567 max (scroll_step
, temp_scroll_step
));
14568 else if (scroll_step
|| temp_scroll_step
)
14569 amount_to_scroll
= scroll_max
;
14572 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14573 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14574 if (NUMBERP (aggressive
))
14576 double float_amount
= XFLOATINT (aggressive
) * height
;
14577 amount_to_scroll
= float_amount
;
14578 if (amount_to_scroll
== 0 && float_amount
> 0)
14579 amount_to_scroll
= 1;
14580 amount_to_scroll
-=
14581 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14582 /* Don't let point enter the scroll margin near
14583 bottom of the window. */
14584 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14585 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14589 if (amount_to_scroll
<= 0)
14590 return SCROLLING_FAILED
;
14592 move_it_vertically_backward (&it
, amount_to_scroll
);
14593 startp
= it
.current
.pos
;
14597 /* Run window scroll functions. */
14598 startp
= run_window_scroll_functions (window
, startp
);
14600 /* Display the window. Give up if new fonts are loaded, or if point
14602 if (!try_window (window
, startp
, 0))
14603 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14604 else if (w
->cursor
.vpos
< 0)
14606 clear_glyph_matrix (w
->desired_matrix
);
14607 rc
= SCROLLING_FAILED
;
14611 /* Maybe forget recorded base line for line number display. */
14612 if (!just_this_one_p
14613 || current_buffer
->clip_changed
14614 || BEG_UNCHANGED
< CHARPOS (startp
))
14615 w
->base_line_number
= Qnil
;
14617 /* If cursor ends up on a partially visible line,
14618 treat that as being off the bottom of the screen. */
14619 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14620 /* It's possible that the cursor is on the first line of the
14621 buffer, which is partially obscured due to a vscroll
14622 (Bug#7537). In that case, avoid looping forever . */
14623 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14625 clear_glyph_matrix (w
->desired_matrix
);
14626 ++extra_scroll_margin_lines
;
14629 rc
= SCROLLING_SUCCESS
;
14636 /* Compute a suitable window start for window W if display of W starts
14637 on a continuation line. Value is non-zero if a new window start
14640 The new window start will be computed, based on W's width, starting
14641 from the start of the continued line. It is the start of the
14642 screen line with the minimum distance from the old start W->start. */
14645 compute_window_start_on_continuation_line (struct window
*w
)
14647 struct text_pos pos
, start_pos
;
14648 int window_start_changed_p
= 0;
14650 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14652 /* If window start is on a continuation line... Window start may be
14653 < BEGV in case there's invisible text at the start of the
14654 buffer (M-x rmail, for example). */
14655 if (CHARPOS (start_pos
) > BEGV
14656 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14659 struct glyph_row
*row
;
14661 /* Handle the case that the window start is out of range. */
14662 if (CHARPOS (start_pos
) < BEGV
)
14663 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14664 else if (CHARPOS (start_pos
) > ZV
)
14665 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14667 /* Find the start of the continued line. This should be fast
14668 because scan_buffer is fast (newline cache). */
14669 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14670 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14671 row
, DEFAULT_FACE_ID
);
14672 reseat_at_previous_visible_line_start (&it
);
14674 /* If the line start is "too far" away from the window start,
14675 say it takes too much time to compute a new window start. */
14676 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14677 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14679 int min_distance
, distance
;
14681 /* Move forward by display lines to find the new window
14682 start. If window width was enlarged, the new start can
14683 be expected to be > the old start. If window width was
14684 decreased, the new window start will be < the old start.
14685 So, we're looking for the display line start with the
14686 minimum distance from the old window start. */
14687 pos
= it
.current
.pos
;
14688 min_distance
= INFINITY
;
14689 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14690 distance
< min_distance
)
14692 min_distance
= distance
;
14693 pos
= it
.current
.pos
;
14694 move_it_by_lines (&it
, 1);
14697 /* Set the window start there. */
14698 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14699 window_start_changed_p
= 1;
14703 return window_start_changed_p
;
14707 /* Try cursor movement in case text has not changed in window WINDOW,
14708 with window start STARTP. Value is
14710 CURSOR_MOVEMENT_SUCCESS if successful
14712 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14714 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14715 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14716 we want to scroll as if scroll-step were set to 1. See the code.
14718 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14719 which case we have to abort this redisplay, and adjust matrices
14724 CURSOR_MOVEMENT_SUCCESS
,
14725 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14726 CURSOR_MOVEMENT_MUST_SCROLL
,
14727 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14731 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14733 struct window
*w
= XWINDOW (window
);
14734 struct frame
*f
= XFRAME (w
->frame
);
14735 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14738 if (inhibit_try_cursor_movement
)
14742 /* Handle case where text has not changed, only point, and it has
14743 not moved off the frame. */
14744 if (/* Point may be in this window. */
14745 PT
>= CHARPOS (startp
)
14746 /* Selective display hasn't changed. */
14747 && !current_buffer
->clip_changed
14748 /* Function force-mode-line-update is used to force a thorough
14749 redisplay. It sets either windows_or_buffers_changed or
14750 update_mode_lines. So don't take a shortcut here for these
14752 && !update_mode_lines
14753 && !windows_or_buffers_changed
14754 && !cursor_type_changed
14755 /* Can't use this case if highlighting a region. When a
14756 region exists, cursor movement has to do more than just
14758 && !(!NILP (Vtransient_mark_mode
)
14759 && !NILP (BVAR (current_buffer
, mark_active
)))
14760 && NILP (w
->region_showing
)
14761 && NILP (Vshow_trailing_whitespace
)
14762 /* Right after splitting windows, last_point may be nil. */
14763 && INTEGERP (w
->last_point
)
14764 /* This code is not used for mini-buffer for the sake of the case
14765 of redisplaying to replace an echo area message; since in
14766 that case the mini-buffer contents per se are usually
14767 unchanged. This code is of no real use in the mini-buffer
14768 since the handling of this_line_start_pos, etc., in redisplay
14769 handles the same cases. */
14770 && !EQ (window
, minibuf_window
)
14771 /* When splitting windows or for new windows, it happens that
14772 redisplay is called with a nil window_end_vpos or one being
14773 larger than the window. This should really be fixed in
14774 window.c. I don't have this on my list, now, so we do
14775 approximately the same as the old redisplay code. --gerd. */
14776 && INTEGERP (w
->window_end_vpos
)
14777 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14778 && (FRAME_WINDOW_P (f
)
14779 || !overlay_arrow_in_current_buffer_p ()))
14781 int this_scroll_margin
, top_scroll_margin
;
14782 struct glyph_row
*row
= NULL
;
14785 debug_method_add (w
, "cursor movement");
14788 /* Scroll if point within this distance from the top or bottom
14789 of the window. This is a pixel value. */
14790 if (scroll_margin
> 0)
14792 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14793 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14796 this_scroll_margin
= 0;
14798 top_scroll_margin
= this_scroll_margin
;
14799 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14800 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14802 /* Start with the row the cursor was displayed during the last
14803 not paused redisplay. Give up if that row is not valid. */
14804 if (w
->last_cursor
.vpos
< 0
14805 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14806 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14809 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14810 if (row
->mode_line_p
)
14812 if (!row
->enabled_p
)
14813 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14816 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14818 int scroll_p
= 0, must_scroll
= 0;
14819 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14821 if (PT
> XFASTINT (w
->last_point
))
14823 /* Point has moved forward. */
14824 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14825 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14827 xassert (row
->enabled_p
);
14831 /* If the end position of a row equals the start
14832 position of the next row, and PT is at that position,
14833 we would rather display cursor in the next line. */
14834 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14835 && MATRIX_ROW_END_CHARPOS (row
) == PT
14836 && row
< w
->current_matrix
->rows
14837 + w
->current_matrix
->nrows
- 1
14838 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14839 && !cursor_row_p (row
))
14842 /* If within the scroll margin, scroll. Note that
14843 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14844 the next line would be drawn, and that
14845 this_scroll_margin can be zero. */
14846 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14847 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14848 /* Line is completely visible last line in window
14849 and PT is to be set in the next line. */
14850 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14851 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14852 && !row
->ends_at_zv_p
14853 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14856 else if (PT
< XFASTINT (w
->last_point
))
14858 /* Cursor has to be moved backward. Note that PT >=
14859 CHARPOS (startp) because of the outer if-statement. */
14860 while (!row
->mode_line_p
14861 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14862 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14863 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14864 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14865 row
> w
->current_matrix
->rows
14866 && (row
-1)->ends_in_newline_from_string_p
))))
14867 && (row
->y
> top_scroll_margin
14868 || CHARPOS (startp
) == BEGV
))
14870 xassert (row
->enabled_p
);
14874 /* Consider the following case: Window starts at BEGV,
14875 there is invisible, intangible text at BEGV, so that
14876 display starts at some point START > BEGV. It can
14877 happen that we are called with PT somewhere between
14878 BEGV and START. Try to handle that case. */
14879 if (row
< w
->current_matrix
->rows
14880 || row
->mode_line_p
)
14882 row
= w
->current_matrix
->rows
;
14883 if (row
->mode_line_p
)
14887 /* Due to newlines in overlay strings, we may have to
14888 skip forward over overlay strings. */
14889 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14890 && MATRIX_ROW_END_CHARPOS (row
) == PT
14891 && !cursor_row_p (row
))
14894 /* If within the scroll margin, scroll. */
14895 if (row
->y
< top_scroll_margin
14896 && CHARPOS (startp
) != BEGV
)
14901 /* Cursor did not move. So don't scroll even if cursor line
14902 is partially visible, as it was so before. */
14903 rc
= CURSOR_MOVEMENT_SUCCESS
;
14906 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14907 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14909 /* if PT is not in the glyph row, give up. */
14910 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14913 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14914 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14916 struct glyph_row
*row1
;
14918 /* If rows are bidi-reordered and point moved, back up
14919 until we find a row that does not belong to a
14920 continuation line. This is because we must consider
14921 all rows of a continued line as candidates for the
14922 new cursor positioning, since row start and end
14923 positions change non-linearly with vertical position
14925 /* FIXME: Revisit this when glyph ``spilling'' in
14926 continuation lines' rows is implemented for
14927 bidi-reordered rows. */
14928 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
14929 MATRIX_ROW_CONTINUATION_LINE_P (row
);
14932 /* If we hit the beginning of the displayed portion
14933 without finding the first row of a continued
14937 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14940 xassert (row
->enabled_p
);
14945 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14946 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14947 /* Make sure this isn't a header line by any chance, since
14948 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
14949 && !row
->mode_line_p
14950 && make_cursor_line_fully_visible_p
)
14952 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14953 && !row
->ends_at_zv_p
14954 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14955 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14956 else if (row
->height
> window_box_height (w
))
14958 /* If we end up in a partially visible line, let's
14959 make it fully visible, except when it's taller
14960 than the window, in which case we can't do much
14963 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14967 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14968 if (!cursor_row_fully_visible_p (w
, 0, 1))
14969 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14971 rc
= CURSOR_MOVEMENT_SUCCESS
;
14975 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14976 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14977 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14979 /* With bidi-reordered rows, there could be more than
14980 one candidate row whose start and end positions
14981 occlude point. We need to let set_cursor_from_row
14982 find the best candidate. */
14983 /* FIXME: Revisit this when glyph ``spilling'' in
14984 continuation lines' rows is implemented for
14985 bidi-reordered rows. */
14990 int at_zv_p
= 0, exact_match_p
= 0;
14992 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14993 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14994 && cursor_row_p (row
))
14995 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14997 /* As soon as we've found the exact match for point,
14998 or the first suitable row whose ends_at_zv_p flag
14999 is set, we are done. */
15001 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
15003 && w
->cursor
.hpos
>= 0
15004 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15007 struct glyph_row
*candidate
=
15008 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15010 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15011 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15014 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15015 || (INTEGERP (g
->object
)
15016 && (g
->charpos
== PT
15017 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15019 if (rv
&& (at_zv_p
|| exact_match_p
))
15021 rc
= CURSOR_MOVEMENT_SUCCESS
;
15024 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15028 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15029 || row
->continued_p
)
15030 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15031 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15032 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15033 /* If we didn't find any candidate rows, or exited the
15034 loop before all the candidates were examined, signal
15035 to the caller that this method failed. */
15036 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15038 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15039 && !row
->continued_p
))
15040 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15042 rc
= CURSOR_MOVEMENT_SUCCESS
;
15048 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15050 rc
= CURSOR_MOVEMENT_SUCCESS
;
15055 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15056 && MATRIX_ROW_START_CHARPOS (row
) == PT
15057 && cursor_row_p (row
));
15065 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15069 set_vertical_scroll_bar (struct window
*w
)
15071 EMACS_INT start
, end
, whole
;
15073 /* Calculate the start and end positions for the current window.
15074 At some point, it would be nice to choose between scrollbars
15075 which reflect the whole buffer size, with special markers
15076 indicating narrowing, and scrollbars which reflect only the
15079 Note that mini-buffers sometimes aren't displaying any text. */
15080 if (!MINI_WINDOW_P (w
)
15081 || (w
== XWINDOW (minibuf_window
)
15082 && NILP (echo_area_buffer
[0])))
15084 struct buffer
*buf
= XBUFFER (w
->buffer
);
15085 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15086 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15087 /* I don't think this is guaranteed to be right. For the
15088 moment, we'll pretend it is. */
15089 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15093 if (whole
< (end
- start
))
15094 whole
= end
- start
;
15097 start
= end
= whole
= 0;
15099 /* Indicate what this scroll bar ought to be displaying now. */
15100 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15101 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15102 (w
, end
- start
, whole
, start
);
15106 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15107 selected_window is redisplayed.
15109 We can return without actually redisplaying the window if
15110 fonts_changed_p is nonzero. In that case, redisplay_internal will
15114 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15116 struct window
*w
= XWINDOW (window
);
15117 struct frame
*f
= XFRAME (w
->frame
);
15118 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15119 struct buffer
*old
= current_buffer
;
15120 struct text_pos lpoint
, opoint
, startp
;
15121 int update_mode_line
;
15124 /* Record it now because it's overwritten. */
15125 int current_matrix_up_to_date_p
= 0;
15126 int used_current_matrix_p
= 0;
15127 /* This is less strict than current_matrix_up_to_date_p.
15128 It indicates that the buffer contents and narrowing are unchanged. */
15129 int buffer_unchanged_p
= 0;
15130 int temp_scroll_step
= 0;
15131 int count
= SPECPDL_INDEX ();
15133 int centering_position
= -1;
15134 int last_line_misfit
= 0;
15135 EMACS_INT beg_unchanged
, end_unchanged
;
15137 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15140 /* W must be a leaf window here. */
15141 xassert (!NILP (w
->buffer
));
15143 *w
->desired_matrix
->method
= 0;
15147 reconsider_clip_changes (w
, buffer
);
15149 /* Has the mode line to be updated? */
15150 update_mode_line
= (!NILP (w
->update_mode_line
)
15151 || update_mode_lines
15152 || buffer
->clip_changed
15153 || buffer
->prevent_redisplay_optimizations_p
);
15155 if (MINI_WINDOW_P (w
))
15157 if (w
== XWINDOW (echo_area_window
)
15158 && !NILP (echo_area_buffer
[0]))
15160 if (update_mode_line
)
15161 /* We may have to update a tty frame's menu bar or a
15162 tool-bar. Example `M-x C-h C-h C-g'. */
15163 goto finish_menu_bars
;
15165 /* We've already displayed the echo area glyphs in this window. */
15166 goto finish_scroll_bars
;
15168 else if ((w
!= XWINDOW (minibuf_window
)
15169 || minibuf_level
== 0)
15170 /* When buffer is nonempty, redisplay window normally. */
15171 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15172 /* Quail displays non-mini buffers in minibuffer window.
15173 In that case, redisplay the window normally. */
15174 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15176 /* W is a mini-buffer window, but it's not active, so clear
15178 int yb
= window_text_bottom_y (w
);
15179 struct glyph_row
*row
;
15182 for (y
= 0, row
= w
->desired_matrix
->rows
;
15184 y
+= row
->height
, ++row
)
15185 blank_row (w
, row
, y
);
15186 goto finish_scroll_bars
;
15189 clear_glyph_matrix (w
->desired_matrix
);
15192 /* Otherwise set up data on this window; select its buffer and point
15194 /* Really select the buffer, for the sake of buffer-local
15196 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15198 current_matrix_up_to_date_p
15199 = (!NILP (w
->window_end_valid
)
15200 && !current_buffer
->clip_changed
15201 && !current_buffer
->prevent_redisplay_optimizations_p
15202 && XFASTINT (w
->last_modified
) >= MODIFF
15203 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15205 /* Run the window-bottom-change-functions
15206 if it is possible that the text on the screen has changed
15207 (either due to modification of the text, or any other reason). */
15208 if (!current_matrix_up_to_date_p
15209 && !NILP (Vwindow_text_change_functions
))
15211 safe_run_hooks (Qwindow_text_change_functions
);
15215 beg_unchanged
= BEG_UNCHANGED
;
15216 end_unchanged
= END_UNCHANGED
;
15218 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15220 specbind (Qinhibit_point_motion_hooks
, Qt
);
15223 = (!NILP (w
->window_end_valid
)
15224 && !current_buffer
->clip_changed
15225 && XFASTINT (w
->last_modified
) >= MODIFF
15226 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15228 /* When windows_or_buffers_changed is non-zero, we can't rely on
15229 the window end being valid, so set it to nil there. */
15230 if (windows_or_buffers_changed
)
15232 /* If window starts on a continuation line, maybe adjust the
15233 window start in case the window's width changed. */
15234 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15235 compute_window_start_on_continuation_line (w
);
15237 w
->window_end_valid
= Qnil
;
15240 /* Some sanity checks. */
15241 CHECK_WINDOW_END (w
);
15242 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15244 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15247 /* If %c is in mode line, update it if needed. */
15248 if (!NILP (w
->column_number_displayed
)
15249 /* This alternative quickly identifies a common case
15250 where no change is needed. */
15251 && !(PT
== XFASTINT (w
->last_point
)
15252 && XFASTINT (w
->last_modified
) >= MODIFF
15253 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15254 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15255 update_mode_line
= 1;
15257 /* Count number of windows showing the selected buffer. An indirect
15258 buffer counts as its base buffer. */
15259 if (!just_this_one_p
)
15261 struct buffer
*current_base
, *window_base
;
15262 current_base
= current_buffer
;
15263 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15264 if (current_base
->base_buffer
)
15265 current_base
= current_base
->base_buffer
;
15266 if (window_base
->base_buffer
)
15267 window_base
= window_base
->base_buffer
;
15268 if (current_base
== window_base
)
15272 /* Point refers normally to the selected window. For any other
15273 window, set up appropriate value. */
15274 if (!EQ (window
, selected_window
))
15276 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15277 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15281 new_pt_byte
= BEGV_BYTE
;
15282 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15284 else if (new_pt
> (ZV
- 1))
15287 new_pt_byte
= ZV_BYTE
;
15288 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15291 /* We don't use SET_PT so that the point-motion hooks don't run. */
15292 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15295 /* If any of the character widths specified in the display table
15296 have changed, invalidate the width run cache. It's true that
15297 this may be a bit late to catch such changes, but the rest of
15298 redisplay goes (non-fatally) haywire when the display table is
15299 changed, so why should we worry about doing any better? */
15300 if (current_buffer
->width_run_cache
)
15302 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15304 if (! disptab_matches_widthtab (disptab
,
15305 XVECTOR (BVAR (current_buffer
, width_table
))))
15307 invalidate_region_cache (current_buffer
,
15308 current_buffer
->width_run_cache
,
15310 recompute_width_table (current_buffer
, disptab
);
15314 /* If window-start is screwed up, choose a new one. */
15315 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15318 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15320 /* If someone specified a new starting point but did not insist,
15321 check whether it can be used. */
15322 if (!NILP (w
->optional_new_start
)
15323 && CHARPOS (startp
) >= BEGV
15324 && CHARPOS (startp
) <= ZV
)
15326 w
->optional_new_start
= Qnil
;
15327 start_display (&it
, w
, startp
);
15328 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15329 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15330 if (IT_CHARPOS (it
) == PT
)
15331 w
->force_start
= Qt
;
15332 /* IT may overshoot PT if text at PT is invisible. */
15333 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15334 w
->force_start
= Qt
;
15339 /* Handle case where place to start displaying has been specified,
15340 unless the specified location is outside the accessible range. */
15341 if (!NILP (w
->force_start
)
15342 || w
->frozen_window_start_p
)
15344 /* We set this later on if we have to adjust point. */
15347 w
->force_start
= Qnil
;
15349 w
->window_end_valid
= Qnil
;
15351 /* Forget any recorded base line for line number display. */
15352 if (!buffer_unchanged_p
)
15353 w
->base_line_number
= Qnil
;
15355 /* Redisplay the mode line. Select the buffer properly for that.
15356 Also, run the hook window-scroll-functions
15357 because we have scrolled. */
15358 /* Note, we do this after clearing force_start because
15359 if there's an error, it is better to forget about force_start
15360 than to get into an infinite loop calling the hook functions
15361 and having them get more errors. */
15362 if (!update_mode_line
15363 || ! NILP (Vwindow_scroll_functions
))
15365 update_mode_line
= 1;
15366 w
->update_mode_line
= Qt
;
15367 startp
= run_window_scroll_functions (window
, startp
);
15370 w
->last_modified
= make_number (0);
15371 w
->last_overlay_modified
= make_number (0);
15372 if (CHARPOS (startp
) < BEGV
)
15373 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15374 else if (CHARPOS (startp
) > ZV
)
15375 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15377 /* Redisplay, then check if cursor has been set during the
15378 redisplay. Give up if new fonts were loaded. */
15379 /* We used to issue a CHECK_MARGINS argument to try_window here,
15380 but this causes scrolling to fail when point begins inside
15381 the scroll margin (bug#148) -- cyd */
15382 if (!try_window (window
, startp
, 0))
15384 w
->force_start
= Qt
;
15385 clear_glyph_matrix (w
->desired_matrix
);
15386 goto need_larger_matrices
;
15389 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15391 /* If point does not appear, try to move point so it does
15392 appear. The desired matrix has been built above, so we
15393 can use it here. */
15394 new_vpos
= window_box_height (w
) / 2;
15397 if (!cursor_row_fully_visible_p (w
, 0, 0))
15399 /* Point does appear, but on a line partly visible at end of window.
15400 Move it back to a fully-visible line. */
15401 new_vpos
= window_box_height (w
);
15404 /* If we need to move point for either of the above reasons,
15405 now actually do it. */
15408 struct glyph_row
*row
;
15410 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15411 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15414 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15415 MATRIX_ROW_START_BYTEPOS (row
));
15417 if (w
!= XWINDOW (selected_window
))
15418 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15419 else if (current_buffer
== old
)
15420 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15422 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15424 /* If we are highlighting the region, then we just changed
15425 the region, so redisplay to show it. */
15426 if (!NILP (Vtransient_mark_mode
)
15427 && !NILP (BVAR (current_buffer
, mark_active
)))
15429 clear_glyph_matrix (w
->desired_matrix
);
15430 if (!try_window (window
, startp
, 0))
15431 goto need_larger_matrices
;
15436 debug_method_add (w
, "forced window start");
15441 /* Handle case where text has not changed, only point, and it has
15442 not moved off the frame, and we are not retrying after hscroll.
15443 (current_matrix_up_to_date_p is nonzero when retrying.) */
15444 if (current_matrix_up_to_date_p
15445 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15446 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15450 case CURSOR_MOVEMENT_SUCCESS
:
15451 used_current_matrix_p
= 1;
15454 case CURSOR_MOVEMENT_MUST_SCROLL
:
15455 goto try_to_scroll
;
15461 /* If current starting point was originally the beginning of a line
15462 but no longer is, find a new starting point. */
15463 else if (!NILP (w
->start_at_line_beg
)
15464 && !(CHARPOS (startp
) <= BEGV
15465 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15468 debug_method_add (w
, "recenter 1");
15473 /* Try scrolling with try_window_id. Value is > 0 if update has
15474 been done, it is -1 if we know that the same window start will
15475 not work. It is 0 if unsuccessful for some other reason. */
15476 else if ((tem
= try_window_id (w
)) != 0)
15479 debug_method_add (w
, "try_window_id %d", tem
);
15482 if (fonts_changed_p
)
15483 goto need_larger_matrices
;
15487 /* Otherwise try_window_id has returned -1 which means that we
15488 don't want the alternative below this comment to execute. */
15490 else if (CHARPOS (startp
) >= BEGV
15491 && CHARPOS (startp
) <= ZV
15492 && PT
>= CHARPOS (startp
)
15493 && (CHARPOS (startp
) < ZV
15494 /* Avoid starting at end of buffer. */
15495 || CHARPOS (startp
) == BEGV
15496 || (XFASTINT (w
->last_modified
) >= MODIFF
15497 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15499 int d1
, d2
, d3
, d4
, d5
, d6
;
15501 /* If first window line is a continuation line, and window start
15502 is inside the modified region, but the first change is before
15503 current window start, we must select a new window start.
15505 However, if this is the result of a down-mouse event (e.g. by
15506 extending the mouse-drag-overlay), we don't want to select a
15507 new window start, since that would change the position under
15508 the mouse, resulting in an unwanted mouse-movement rather
15509 than a simple mouse-click. */
15510 if (NILP (w
->start_at_line_beg
)
15511 && NILP (do_mouse_tracking
)
15512 && CHARPOS (startp
) > BEGV
15513 && CHARPOS (startp
) > BEG
+ beg_unchanged
15514 && CHARPOS (startp
) <= Z
- end_unchanged
15515 /* Even if w->start_at_line_beg is nil, a new window may
15516 start at a line_beg, since that's how set_buffer_window
15517 sets it. So, we need to check the return value of
15518 compute_window_start_on_continuation_line. (See also
15520 && XMARKER (w
->start
)->buffer
== current_buffer
15521 && compute_window_start_on_continuation_line (w
)
15522 /* It doesn't make sense to force the window start like we
15523 do at label force_start if it is already known that point
15524 will not be visible in the resulting window, because
15525 doing so will move point from its correct position
15526 instead of scrolling the window to bring point into view.
15528 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15530 w
->force_start
= Qt
;
15531 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15536 debug_method_add (w
, "same window start");
15539 /* Try to redisplay starting at same place as before.
15540 If point has not moved off frame, accept the results. */
15541 if (!current_matrix_up_to_date_p
15542 /* Don't use try_window_reusing_current_matrix in this case
15543 because a window scroll function can have changed the
15545 || !NILP (Vwindow_scroll_functions
)
15546 || MINI_WINDOW_P (w
)
15547 || !(used_current_matrix_p
15548 = try_window_reusing_current_matrix (w
)))
15550 IF_DEBUG (debug_method_add (w
, "1"));
15551 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15552 /* -1 means we need to scroll.
15553 0 means we need new matrices, but fonts_changed_p
15554 is set in that case, so we will detect it below. */
15555 goto try_to_scroll
;
15558 if (fonts_changed_p
)
15559 goto need_larger_matrices
;
15561 if (w
->cursor
.vpos
>= 0)
15563 if (!just_this_one_p
15564 || current_buffer
->clip_changed
15565 || BEG_UNCHANGED
< CHARPOS (startp
))
15566 /* Forget any recorded base line for line number display. */
15567 w
->base_line_number
= Qnil
;
15569 if (!cursor_row_fully_visible_p (w
, 1, 0))
15571 clear_glyph_matrix (w
->desired_matrix
);
15572 last_line_misfit
= 1;
15574 /* Drop through and scroll. */
15579 clear_glyph_matrix (w
->desired_matrix
);
15584 w
->last_modified
= make_number (0);
15585 w
->last_overlay_modified
= make_number (0);
15587 /* Redisplay the mode line. Select the buffer properly for that. */
15588 if (!update_mode_line
)
15590 update_mode_line
= 1;
15591 w
->update_mode_line
= Qt
;
15594 /* Try to scroll by specified few lines. */
15595 if ((scroll_conservatively
15596 || emacs_scroll_step
15597 || temp_scroll_step
15598 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15599 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15600 && CHARPOS (startp
) >= BEGV
15601 && CHARPOS (startp
) <= ZV
)
15603 /* The function returns -1 if new fonts were loaded, 1 if
15604 successful, 0 if not successful. */
15605 int ss
= try_scrolling (window
, just_this_one_p
,
15606 scroll_conservatively
,
15608 temp_scroll_step
, last_line_misfit
);
15611 case SCROLLING_SUCCESS
:
15614 case SCROLLING_NEED_LARGER_MATRICES
:
15615 goto need_larger_matrices
;
15617 case SCROLLING_FAILED
:
15625 /* Finally, just choose a place to start which positions point
15626 according to user preferences. */
15631 debug_method_add (w
, "recenter");
15634 /* w->vscroll = 0; */
15636 /* Forget any previously recorded base line for line number display. */
15637 if (!buffer_unchanged_p
)
15638 w
->base_line_number
= Qnil
;
15640 /* Determine the window start relative to point. */
15641 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15642 it
.current_y
= it
.last_visible_y
;
15643 if (centering_position
< 0)
15647 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15649 EMACS_INT margin_pos
= CHARPOS (startp
);
15650 Lisp_Object aggressive
;
15653 /* If there is a scroll margin at the top of the window, find
15654 its character position. */
15656 /* Cannot call start_display if startp is not in the
15657 accessible region of the buffer. This can happen when we
15658 have just switched to a different buffer and/or changed
15659 its restriction. In that case, startp is initialized to
15660 the character position 1 (BEGV) because we did not yet
15661 have chance to display the buffer even once. */
15662 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15665 void *it1data
= NULL
;
15667 SAVE_IT (it1
, it
, it1data
);
15668 start_display (&it1
, w
, startp
);
15669 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15670 margin_pos
= IT_CHARPOS (it1
);
15671 RESTORE_IT (&it
, &it
, it1data
);
15673 scrolling_up
= PT
> margin_pos
;
15676 ? BVAR (current_buffer
, scroll_up_aggressively
)
15677 : BVAR (current_buffer
, scroll_down_aggressively
);
15679 if (!MINI_WINDOW_P (w
)
15680 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15684 /* Setting scroll-conservatively overrides
15685 scroll-*-aggressively. */
15686 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15688 double float_amount
= XFLOATINT (aggressive
);
15690 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15691 if (pt_offset
== 0 && float_amount
> 0)
15693 if (pt_offset
&& margin
> 0)
15696 /* Compute how much to move the window start backward from
15697 point so that point will be displayed where the user
15701 centering_position
= it
.last_visible_y
;
15703 centering_position
-= pt_offset
;
15704 centering_position
-=
15705 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15706 + WINDOW_HEADER_LINE_HEIGHT (w
);
15707 /* Don't let point enter the scroll margin near top of
15709 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15710 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15713 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15716 /* Set the window start half the height of the window backward
15718 centering_position
= window_box_height (w
) / 2;
15720 move_it_vertically_backward (&it
, centering_position
);
15722 xassert (IT_CHARPOS (it
) >= BEGV
);
15724 /* The function move_it_vertically_backward may move over more
15725 than the specified y-distance. If it->w is small, e.g. a
15726 mini-buffer window, we may end up in front of the window's
15727 display area. Start displaying at the start of the line
15728 containing PT in this case. */
15729 if (it
.current_y
<= 0)
15731 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15732 move_it_vertically_backward (&it
, 0);
15736 it
.current_x
= it
.hpos
= 0;
15738 /* Set the window start position here explicitly, to avoid an
15739 infinite loop in case the functions in window-scroll-functions
15741 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15743 /* Run scroll hooks. */
15744 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15746 /* Redisplay the window. */
15747 if (!current_matrix_up_to_date_p
15748 || windows_or_buffers_changed
15749 || cursor_type_changed
15750 /* Don't use try_window_reusing_current_matrix in this case
15751 because it can have changed the buffer. */
15752 || !NILP (Vwindow_scroll_functions
)
15753 || !just_this_one_p
15754 || MINI_WINDOW_P (w
)
15755 || !(used_current_matrix_p
15756 = try_window_reusing_current_matrix (w
)))
15757 try_window (window
, startp
, 0);
15759 /* If new fonts have been loaded (due to fontsets), give up. We
15760 have to start a new redisplay since we need to re-adjust glyph
15762 if (fonts_changed_p
)
15763 goto need_larger_matrices
;
15765 /* If cursor did not appear assume that the middle of the window is
15766 in the first line of the window. Do it again with the next line.
15767 (Imagine a window of height 100, displaying two lines of height
15768 60. Moving back 50 from it->last_visible_y will end in the first
15770 if (w
->cursor
.vpos
< 0)
15772 if (!NILP (w
->window_end_valid
)
15773 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15775 clear_glyph_matrix (w
->desired_matrix
);
15776 move_it_by_lines (&it
, 1);
15777 try_window (window
, it
.current
.pos
, 0);
15779 else if (PT
< IT_CHARPOS (it
))
15781 clear_glyph_matrix (w
->desired_matrix
);
15782 move_it_by_lines (&it
, -1);
15783 try_window (window
, it
.current
.pos
, 0);
15787 /* Not much we can do about it. */
15791 /* Consider the following case: Window starts at BEGV, there is
15792 invisible, intangible text at BEGV, so that display starts at
15793 some point START > BEGV. It can happen that we are called with
15794 PT somewhere between BEGV and START. Try to handle that case. */
15795 if (w
->cursor
.vpos
< 0)
15797 struct glyph_row
*row
= w
->current_matrix
->rows
;
15798 if (row
->mode_line_p
)
15800 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15803 if (!cursor_row_fully_visible_p (w
, 0, 0))
15805 /* If vscroll is enabled, disable it and try again. */
15809 clear_glyph_matrix (w
->desired_matrix
);
15813 /* Users who set scroll-conservatively to a large number want
15814 point just above/below the scroll margin. If we ended up
15815 with point's row partially visible, move the window start to
15816 make that row fully visible and out of the margin. */
15817 if (scroll_conservatively
> SCROLL_LIMIT
)
15821 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15823 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15825 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15826 clear_glyph_matrix (w
->desired_matrix
);
15827 if (1 == try_window (window
, it
.current
.pos
,
15828 TRY_WINDOW_CHECK_MARGINS
))
15832 /* If centering point failed to make the whole line visible,
15833 put point at the top instead. That has to make the whole line
15834 visible, if it can be done. */
15835 if (centering_position
== 0)
15838 clear_glyph_matrix (w
->desired_matrix
);
15839 centering_position
= 0;
15845 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15846 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15847 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15850 /* Display the mode line, if we must. */
15851 if ((update_mode_line
15852 /* If window not full width, must redo its mode line
15853 if (a) the window to its side is being redone and
15854 (b) we do a frame-based redisplay. This is a consequence
15855 of how inverted lines are drawn in frame-based redisplay. */
15856 || (!just_this_one_p
15857 && !FRAME_WINDOW_P (f
)
15858 && !WINDOW_FULL_WIDTH_P (w
))
15859 /* Line number to display. */
15860 || INTEGERP (w
->base_line_pos
)
15861 /* Column number is displayed and different from the one displayed. */
15862 || (!NILP (w
->column_number_displayed
)
15863 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15864 /* This means that the window has a mode line. */
15865 && (WINDOW_WANTS_MODELINE_P (w
)
15866 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15868 display_mode_lines (w
);
15870 /* If mode line height has changed, arrange for a thorough
15871 immediate redisplay using the correct mode line height. */
15872 if (WINDOW_WANTS_MODELINE_P (w
)
15873 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15875 fonts_changed_p
= 1;
15876 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15877 = DESIRED_MODE_LINE_HEIGHT (w
);
15880 /* If header line height has changed, arrange for a thorough
15881 immediate redisplay using the correct header line height. */
15882 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15883 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15885 fonts_changed_p
= 1;
15886 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15887 = DESIRED_HEADER_LINE_HEIGHT (w
);
15890 if (fonts_changed_p
)
15891 goto need_larger_matrices
;
15894 if (!line_number_displayed
15895 && !BUFFERP (w
->base_line_pos
))
15897 w
->base_line_pos
= Qnil
;
15898 w
->base_line_number
= Qnil
;
15903 /* When we reach a frame's selected window, redo the frame's menu bar. */
15904 if (update_mode_line
15905 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15907 int redisplay_menu_p
= 0;
15909 if (FRAME_WINDOW_P (f
))
15911 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15912 || defined (HAVE_NS) || defined (USE_GTK)
15913 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15915 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15919 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15921 if (redisplay_menu_p
)
15922 display_menu_bar (w
);
15924 #ifdef HAVE_WINDOW_SYSTEM
15925 if (FRAME_WINDOW_P (f
))
15927 #if defined (USE_GTK) || defined (HAVE_NS)
15928 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15929 redisplay_tool_bar (f
);
15931 if (WINDOWP (f
->tool_bar_window
)
15932 && (FRAME_TOOL_BAR_LINES (f
) > 0
15933 || !NILP (Vauto_resize_tool_bars
))
15934 && redisplay_tool_bar (f
))
15935 ignore_mouse_drag_p
= 1;
15941 #ifdef HAVE_WINDOW_SYSTEM
15942 if (FRAME_WINDOW_P (f
)
15943 && update_window_fringes (w
, (just_this_one_p
15944 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15945 || w
->pseudo_window_p
)))
15949 if (draw_window_fringes (w
, 1))
15950 x_draw_vertical_border (w
);
15954 #endif /* HAVE_WINDOW_SYSTEM */
15956 /* We go to this label, with fonts_changed_p nonzero,
15957 if it is necessary to try again using larger glyph matrices.
15958 We have to redeem the scroll bar even in this case,
15959 because the loop in redisplay_internal expects that. */
15960 need_larger_matrices
:
15962 finish_scroll_bars
:
15964 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15966 /* Set the thumb's position and size. */
15967 set_vertical_scroll_bar (w
);
15969 /* Note that we actually used the scroll bar attached to this
15970 window, so it shouldn't be deleted at the end of redisplay. */
15971 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15972 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15975 /* Restore current_buffer and value of point in it. The window
15976 update may have changed the buffer, so first make sure `opoint'
15977 is still valid (Bug#6177). */
15978 if (CHARPOS (opoint
) < BEGV
)
15979 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15980 else if (CHARPOS (opoint
) > ZV
)
15981 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15983 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15985 set_buffer_internal_1 (old
);
15986 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15987 shorter. This can be caused by log truncation in *Messages*. */
15988 if (CHARPOS (lpoint
) <= ZV
)
15989 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15991 unbind_to (count
, Qnil
);
15995 /* Build the complete desired matrix of WINDOW with a window start
15996 buffer position POS.
15998 Value is 1 if successful. It is zero if fonts were loaded during
15999 redisplay which makes re-adjusting glyph matrices necessary, and -1
16000 if point would appear in the scroll margins.
16001 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16002 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16006 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16008 struct window
*w
= XWINDOW (window
);
16010 struct glyph_row
*last_text_row
= NULL
;
16011 struct frame
*f
= XFRAME (w
->frame
);
16013 /* Make POS the new window start. */
16014 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16016 /* Mark cursor position as unknown. No overlay arrow seen. */
16017 w
->cursor
.vpos
= -1;
16018 overlay_arrow_seen
= 0;
16020 /* Initialize iterator and info to start at POS. */
16021 start_display (&it
, w
, pos
);
16023 /* Display all lines of W. */
16024 while (it
.current_y
< it
.last_visible_y
)
16026 if (display_line (&it
))
16027 last_text_row
= it
.glyph_row
- 1;
16028 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16032 /* Don't let the cursor end in the scroll margins. */
16033 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16034 && !MINI_WINDOW_P (w
))
16036 int this_scroll_margin
;
16038 if (scroll_margin
> 0)
16040 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16041 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16044 this_scroll_margin
= 0;
16046 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16047 && w
->cursor
.y
< this_scroll_margin
16048 && CHARPOS (pos
) > BEGV
16049 && IT_CHARPOS (it
) < ZV
)
16050 /* rms: considering make_cursor_line_fully_visible_p here
16051 seems to give wrong results. We don't want to recenter
16052 when the last line is partly visible, we want to allow
16053 that case to be handled in the usual way. */
16054 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16056 w
->cursor
.vpos
= -1;
16057 clear_glyph_matrix (w
->desired_matrix
);
16062 /* If bottom moved off end of frame, change mode line percentage. */
16063 if (XFASTINT (w
->window_end_pos
) <= 0
16064 && Z
!= IT_CHARPOS (it
))
16065 w
->update_mode_line
= Qt
;
16067 /* Set window_end_pos to the offset of the last character displayed
16068 on the window from the end of current_buffer. Set
16069 window_end_vpos to its row number. */
16072 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16073 w
->window_end_bytepos
16074 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16076 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16078 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16079 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16080 ->displays_text_p
);
16084 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16085 w
->window_end_pos
= make_number (Z
- ZV
);
16086 w
->window_end_vpos
= make_number (0);
16089 /* But that is not valid info until redisplay finishes. */
16090 w
->window_end_valid
= Qnil
;
16096 /************************************************************************
16097 Window redisplay reusing current matrix when buffer has not changed
16098 ************************************************************************/
16100 /* Try redisplay of window W showing an unchanged buffer with a
16101 different window start than the last time it was displayed by
16102 reusing its current matrix. Value is non-zero if successful.
16103 W->start is the new window start. */
16106 try_window_reusing_current_matrix (struct window
*w
)
16108 struct frame
*f
= XFRAME (w
->frame
);
16109 struct glyph_row
*bottom_row
;
16112 struct text_pos start
, new_start
;
16113 int nrows_scrolled
, i
;
16114 struct glyph_row
*last_text_row
;
16115 struct glyph_row
*last_reused_text_row
;
16116 struct glyph_row
*start_row
;
16117 int start_vpos
, min_y
, max_y
;
16120 if (inhibit_try_window_reusing
)
16124 if (/* This function doesn't handle terminal frames. */
16125 !FRAME_WINDOW_P (f
)
16126 /* Don't try to reuse the display if windows have been split
16128 || windows_or_buffers_changed
16129 || cursor_type_changed
)
16132 /* Can't do this if region may have changed. */
16133 if ((!NILP (Vtransient_mark_mode
)
16134 && !NILP (BVAR (current_buffer
, mark_active
)))
16135 || !NILP (w
->region_showing
)
16136 || !NILP (Vshow_trailing_whitespace
))
16139 /* If top-line visibility has changed, give up. */
16140 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16141 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16144 /* Give up if old or new display is scrolled vertically. We could
16145 make this function handle this, but right now it doesn't. */
16146 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16147 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16150 /* The variable new_start now holds the new window start. The old
16151 start `start' can be determined from the current matrix. */
16152 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16153 start
= start_row
->minpos
;
16154 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16156 /* Clear the desired matrix for the display below. */
16157 clear_glyph_matrix (w
->desired_matrix
);
16159 if (CHARPOS (new_start
) <= CHARPOS (start
))
16161 /* Don't use this method if the display starts with an ellipsis
16162 displayed for invisible text. It's not easy to handle that case
16163 below, and it's certainly not worth the effort since this is
16164 not a frequent case. */
16165 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16168 IF_DEBUG (debug_method_add (w
, "twu1"));
16170 /* Display up to a row that can be reused. The variable
16171 last_text_row is set to the last row displayed that displays
16172 text. Note that it.vpos == 0 if or if not there is a
16173 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16174 start_display (&it
, w
, new_start
);
16175 w
->cursor
.vpos
= -1;
16176 last_text_row
= last_reused_text_row
= NULL
;
16178 while (it
.current_y
< it
.last_visible_y
16179 && !fonts_changed_p
)
16181 /* If we have reached into the characters in the START row,
16182 that means the line boundaries have changed. So we
16183 can't start copying with the row START. Maybe it will
16184 work to start copying with the following row. */
16185 while (IT_CHARPOS (it
) > CHARPOS (start
))
16187 /* Advance to the next row as the "start". */
16189 start
= start_row
->minpos
;
16190 /* If there are no more rows to try, or just one, give up. */
16191 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16192 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16193 || CHARPOS (start
) == ZV
)
16195 clear_glyph_matrix (w
->desired_matrix
);
16199 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16201 /* If we have reached alignment, we can copy the rest of the
16203 if (IT_CHARPOS (it
) == CHARPOS (start
)
16204 /* Don't accept "alignment" inside a display vector,
16205 since start_row could have started in the middle of
16206 that same display vector (thus their character
16207 positions match), and we have no way of telling if
16208 that is the case. */
16209 && it
.current
.dpvec_index
< 0)
16212 if (display_line (&it
))
16213 last_text_row
= it
.glyph_row
- 1;
16217 /* A value of current_y < last_visible_y means that we stopped
16218 at the previous window start, which in turn means that we
16219 have at least one reusable row. */
16220 if (it
.current_y
< it
.last_visible_y
)
16222 struct glyph_row
*row
;
16224 /* IT.vpos always starts from 0; it counts text lines. */
16225 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16227 /* Find PT if not already found in the lines displayed. */
16228 if (w
->cursor
.vpos
< 0)
16230 int dy
= it
.current_y
- start_row
->y
;
16232 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16233 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16235 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16236 dy
, nrows_scrolled
);
16239 clear_glyph_matrix (w
->desired_matrix
);
16244 /* Scroll the display. Do it before the current matrix is
16245 changed. The problem here is that update has not yet
16246 run, i.e. part of the current matrix is not up to date.
16247 scroll_run_hook will clear the cursor, and use the
16248 current matrix to get the height of the row the cursor is
16250 run
.current_y
= start_row
->y
;
16251 run
.desired_y
= it
.current_y
;
16252 run
.height
= it
.last_visible_y
- it
.current_y
;
16254 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16257 FRAME_RIF (f
)->update_window_begin_hook (w
);
16258 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16259 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16260 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16264 /* Shift current matrix down by nrows_scrolled lines. */
16265 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16266 rotate_matrix (w
->current_matrix
,
16268 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16271 /* Disable lines that must be updated. */
16272 for (i
= 0; i
< nrows_scrolled
; ++i
)
16273 (start_row
+ i
)->enabled_p
= 0;
16275 /* Re-compute Y positions. */
16276 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16277 max_y
= it
.last_visible_y
;
16278 for (row
= start_row
+ nrows_scrolled
;
16282 row
->y
= it
.current_y
;
16283 row
->visible_height
= row
->height
;
16285 if (row
->y
< min_y
)
16286 row
->visible_height
-= min_y
- row
->y
;
16287 if (row
->y
+ row
->height
> max_y
)
16288 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16289 if (row
->fringe_bitmap_periodic_p
)
16290 row
->redraw_fringe_bitmaps_p
= 1;
16292 it
.current_y
+= row
->height
;
16294 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16295 last_reused_text_row
= row
;
16296 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16300 /* Disable lines in the current matrix which are now
16301 below the window. */
16302 for (++row
; row
< bottom_row
; ++row
)
16303 row
->enabled_p
= row
->mode_line_p
= 0;
16306 /* Update window_end_pos etc.; last_reused_text_row is the last
16307 reused row from the current matrix containing text, if any.
16308 The value of last_text_row is the last displayed line
16309 containing text. */
16310 if (last_reused_text_row
)
16312 w
->window_end_bytepos
16313 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16315 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16317 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16318 w
->current_matrix
));
16320 else if (last_text_row
)
16322 w
->window_end_bytepos
16323 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16325 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16327 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16331 /* This window must be completely empty. */
16332 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16333 w
->window_end_pos
= make_number (Z
- ZV
);
16334 w
->window_end_vpos
= make_number (0);
16336 w
->window_end_valid
= Qnil
;
16338 /* Update hint: don't try scrolling again in update_window. */
16339 w
->desired_matrix
->no_scrolling_p
= 1;
16342 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16346 else if (CHARPOS (new_start
) > CHARPOS (start
))
16348 struct glyph_row
*pt_row
, *row
;
16349 struct glyph_row
*first_reusable_row
;
16350 struct glyph_row
*first_row_to_display
;
16352 int yb
= window_text_bottom_y (w
);
16354 /* Find the row starting at new_start, if there is one. Don't
16355 reuse a partially visible line at the end. */
16356 first_reusable_row
= start_row
;
16357 while (first_reusable_row
->enabled_p
16358 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16359 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16360 < CHARPOS (new_start
)))
16361 ++first_reusable_row
;
16363 /* Give up if there is no row to reuse. */
16364 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16365 || !first_reusable_row
->enabled_p
16366 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16367 != CHARPOS (new_start
)))
16370 /* We can reuse fully visible rows beginning with
16371 first_reusable_row to the end of the window. Set
16372 first_row_to_display to the first row that cannot be reused.
16373 Set pt_row to the row containing point, if there is any. */
16375 for (first_row_to_display
= first_reusable_row
;
16376 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16377 ++first_row_to_display
)
16379 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16380 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16381 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16382 && first_row_to_display
->ends_at_zv_p
16383 && pt_row
== NULL
)))
16384 pt_row
= first_row_to_display
;
16387 /* Start displaying at the start of first_row_to_display. */
16388 xassert (first_row_to_display
->y
< yb
);
16389 init_to_row_start (&it
, w
, first_row_to_display
);
16391 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16393 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16395 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16396 + WINDOW_HEADER_LINE_HEIGHT (w
));
16398 /* Display lines beginning with first_row_to_display in the
16399 desired matrix. Set last_text_row to the last row displayed
16400 that displays text. */
16401 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16402 if (pt_row
== NULL
)
16403 w
->cursor
.vpos
= -1;
16404 last_text_row
= NULL
;
16405 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16406 if (display_line (&it
))
16407 last_text_row
= it
.glyph_row
- 1;
16409 /* If point is in a reused row, adjust y and vpos of the cursor
16413 w
->cursor
.vpos
-= nrows_scrolled
;
16414 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16417 /* Give up if point isn't in a row displayed or reused. (This
16418 also handles the case where w->cursor.vpos < nrows_scrolled
16419 after the calls to display_line, which can happen with scroll
16420 margins. See bug#1295.) */
16421 if (w
->cursor
.vpos
< 0)
16423 clear_glyph_matrix (w
->desired_matrix
);
16427 /* Scroll the display. */
16428 run
.current_y
= first_reusable_row
->y
;
16429 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16430 run
.height
= it
.last_visible_y
- run
.current_y
;
16431 dy
= run
.current_y
- run
.desired_y
;
16436 FRAME_RIF (f
)->update_window_begin_hook (w
);
16437 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16438 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16439 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16443 /* Adjust Y positions of reused rows. */
16444 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16445 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16446 max_y
= it
.last_visible_y
;
16447 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16450 row
->visible_height
= row
->height
;
16451 if (row
->y
< min_y
)
16452 row
->visible_height
-= min_y
- row
->y
;
16453 if (row
->y
+ row
->height
> max_y
)
16454 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16455 if (row
->fringe_bitmap_periodic_p
)
16456 row
->redraw_fringe_bitmaps_p
= 1;
16459 /* Scroll the current matrix. */
16460 xassert (nrows_scrolled
> 0);
16461 rotate_matrix (w
->current_matrix
,
16463 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16466 /* Disable rows not reused. */
16467 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16468 row
->enabled_p
= 0;
16470 /* Point may have moved to a different line, so we cannot assume that
16471 the previous cursor position is valid; locate the correct row. */
16474 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16476 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16477 && !row
->ends_at_zv_p
;
16481 w
->cursor
.y
= row
->y
;
16483 if (row
< bottom_row
)
16485 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16486 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16488 /* Can't use this optimization with bidi-reordered glyph
16489 rows, unless cursor is already at point. */
16490 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16492 if (!(w
->cursor
.hpos
>= 0
16493 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16494 && BUFFERP (glyph
->object
)
16495 && glyph
->charpos
== PT
))
16500 && (!BUFFERP (glyph
->object
)
16501 || glyph
->charpos
< PT
);
16505 w
->cursor
.x
+= glyph
->pixel_width
;
16510 /* Adjust window end. A null value of last_text_row means that
16511 the window end is in reused rows which in turn means that
16512 only its vpos can have changed. */
16515 w
->window_end_bytepos
16516 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16518 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16520 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16525 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16528 w
->window_end_valid
= Qnil
;
16529 w
->desired_matrix
->no_scrolling_p
= 1;
16532 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16542 /************************************************************************
16543 Window redisplay reusing current matrix when buffer has changed
16544 ************************************************************************/
16546 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16547 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16548 EMACS_INT
*, EMACS_INT
*);
16549 static struct glyph_row
*
16550 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16551 struct glyph_row
*);
16554 /* Return the last row in MATRIX displaying text. If row START is
16555 non-null, start searching with that row. IT gives the dimensions
16556 of the display. Value is null if matrix is empty; otherwise it is
16557 a pointer to the row found. */
16559 static struct glyph_row
*
16560 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16561 struct glyph_row
*start
)
16563 struct glyph_row
*row
, *row_found
;
16565 /* Set row_found to the last row in IT->w's current matrix
16566 displaying text. The loop looks funny but think of partially
16569 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16570 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16572 xassert (row
->enabled_p
);
16574 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16583 /* Return the last row in the current matrix of W that is not affected
16584 by changes at the start of current_buffer that occurred since W's
16585 current matrix was built. Value is null if no such row exists.
16587 BEG_UNCHANGED us the number of characters unchanged at the start of
16588 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16589 first changed character in current_buffer. Characters at positions <
16590 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16591 when the current matrix was built. */
16593 static struct glyph_row
*
16594 find_last_unchanged_at_beg_row (struct window
*w
)
16596 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16597 struct glyph_row
*row
;
16598 struct glyph_row
*row_found
= NULL
;
16599 int yb
= window_text_bottom_y (w
);
16601 /* Find the last row displaying unchanged text. */
16602 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16603 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16604 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16607 if (/* If row ends before first_changed_pos, it is unchanged,
16608 except in some case. */
16609 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16610 /* When row ends in ZV and we write at ZV it is not
16612 && !row
->ends_at_zv_p
16613 /* When first_changed_pos is the end of a continued line,
16614 row is not unchanged because it may be no longer
16616 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16617 && (row
->continued_p
16618 || row
->exact_window_width_line_p
))
16619 /* If ROW->end is beyond ZV, then ROW->end is outdated and
16620 needs to be recomputed, so don't consider this row as
16621 unchanged. This happens when the last line was
16622 bidi-reordered and was killed immediately before this
16623 redisplay cycle. In that case, ROW->end stores the
16624 buffer position of the first visual-order character of
16625 the killed text, which is now beyond ZV. */
16626 && CHARPOS (row
->end
.pos
) <= ZV
)
16629 /* Stop if last visible row. */
16630 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16638 /* Find the first glyph row in the current matrix of W that is not
16639 affected by changes at the end of current_buffer since the
16640 time W's current matrix was built.
16642 Return in *DELTA the number of chars by which buffer positions in
16643 unchanged text at the end of current_buffer must be adjusted.
16645 Return in *DELTA_BYTES the corresponding number of bytes.
16647 Value is null if no such row exists, i.e. all rows are affected by
16650 static struct glyph_row
*
16651 find_first_unchanged_at_end_row (struct window
*w
,
16652 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16654 struct glyph_row
*row
;
16655 struct glyph_row
*row_found
= NULL
;
16657 *delta
= *delta_bytes
= 0;
16659 /* Display must not have been paused, otherwise the current matrix
16660 is not up to date. */
16661 eassert (!NILP (w
->window_end_valid
));
16663 /* A value of window_end_pos >= END_UNCHANGED means that the window
16664 end is in the range of changed text. If so, there is no
16665 unchanged row at the end of W's current matrix. */
16666 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16669 /* Set row to the last row in W's current matrix displaying text. */
16670 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16672 /* If matrix is entirely empty, no unchanged row exists. */
16673 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16675 /* The value of row is the last glyph row in the matrix having a
16676 meaningful buffer position in it. The end position of row
16677 corresponds to window_end_pos. This allows us to translate
16678 buffer positions in the current matrix to current buffer
16679 positions for characters not in changed text. */
16681 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16682 EMACS_INT Z_BYTE_old
=
16683 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16684 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16685 struct glyph_row
*first_text_row
16686 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16688 *delta
= Z
- Z_old
;
16689 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16691 /* Set last_unchanged_pos to the buffer position of the last
16692 character in the buffer that has not been changed. Z is the
16693 index + 1 of the last character in current_buffer, i.e. by
16694 subtracting END_UNCHANGED we get the index of the last
16695 unchanged character, and we have to add BEG to get its buffer
16697 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16698 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16700 /* Search backward from ROW for a row displaying a line that
16701 starts at a minimum position >= last_unchanged_pos_old. */
16702 for (; row
> first_text_row
; --row
)
16704 /* This used to abort, but it can happen.
16705 It is ok to just stop the search instead here. KFS. */
16706 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16709 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16714 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16720 /* Make sure that glyph rows in the current matrix of window W
16721 reference the same glyph memory as corresponding rows in the
16722 frame's frame matrix. This function is called after scrolling W's
16723 current matrix on a terminal frame in try_window_id and
16724 try_window_reusing_current_matrix. */
16727 sync_frame_with_window_matrix_rows (struct window
*w
)
16729 struct frame
*f
= XFRAME (w
->frame
);
16730 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16732 /* Preconditions: W must be a leaf window and full-width. Its frame
16733 must have a frame matrix. */
16734 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16735 xassert (WINDOW_FULL_WIDTH_P (w
));
16736 xassert (!FRAME_WINDOW_P (f
));
16738 /* If W is a full-width window, glyph pointers in W's current matrix
16739 have, by definition, to be the same as glyph pointers in the
16740 corresponding frame matrix. Note that frame matrices have no
16741 marginal areas (see build_frame_matrix). */
16742 window_row
= w
->current_matrix
->rows
;
16743 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16744 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16745 while (window_row
< window_row_end
)
16747 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16748 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16750 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16751 frame_row
->glyphs
[TEXT_AREA
] = start
;
16752 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16753 frame_row
->glyphs
[LAST_AREA
] = end
;
16755 /* Disable frame rows whose corresponding window rows have
16756 been disabled in try_window_id. */
16757 if (!window_row
->enabled_p
)
16758 frame_row
->enabled_p
= 0;
16760 ++window_row
, ++frame_row
;
16765 /* Find the glyph row in window W containing CHARPOS. Consider all
16766 rows between START and END (not inclusive). END null means search
16767 all rows to the end of the display area of W. Value is the row
16768 containing CHARPOS or null. */
16771 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16772 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16774 struct glyph_row
*row
= start
;
16775 struct glyph_row
*best_row
= NULL
;
16776 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16779 /* If we happen to start on a header-line, skip that. */
16780 if (row
->mode_line_p
)
16783 if ((end
&& row
>= end
) || !row
->enabled_p
)
16786 last_y
= window_text_bottom_y (w
) - dy
;
16790 /* Give up if we have gone too far. */
16791 if (end
&& row
>= end
)
16793 /* This formerly returned if they were equal.
16794 I think that both quantities are of a "last plus one" type;
16795 if so, when they are equal, the row is within the screen. -- rms. */
16796 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16799 /* If it is in this row, return this row. */
16800 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16801 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16802 /* The end position of a row equals the start
16803 position of the next row. If CHARPOS is there, we
16804 would rather display it in the next line, except
16805 when this line ends in ZV. */
16806 && !row
->ends_at_zv_p
16807 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16808 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16812 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16813 || (!best_row
&& !row
->continued_p
))
16815 /* In bidi-reordered rows, there could be several rows
16816 occluding point, all of them belonging to the same
16817 continued line. We need to find the row which fits
16818 CHARPOS the best. */
16819 for (g
= row
->glyphs
[TEXT_AREA
];
16820 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16823 if (!STRINGP (g
->object
))
16825 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16827 mindif
= eabs (g
->charpos
- charpos
);
16829 /* Exact match always wins. */
16836 else if (best_row
&& !row
->continued_p
)
16843 /* Try to redisplay window W by reusing its existing display. W's
16844 current matrix must be up to date when this function is called,
16845 i.e. window_end_valid must not be nil.
16849 1 if display has been updated
16850 0 if otherwise unsuccessful
16851 -1 if redisplay with same window start is known not to succeed
16853 The following steps are performed:
16855 1. Find the last row in the current matrix of W that is not
16856 affected by changes at the start of current_buffer. If no such row
16859 2. Find the first row in W's current matrix that is not affected by
16860 changes at the end of current_buffer. Maybe there is no such row.
16862 3. Display lines beginning with the row + 1 found in step 1 to the
16863 row found in step 2 or, if step 2 didn't find a row, to the end of
16866 4. If cursor is not known to appear on the window, give up.
16868 5. If display stopped at the row found in step 2, scroll the
16869 display and current matrix as needed.
16871 6. Maybe display some lines at the end of W, if we must. This can
16872 happen under various circumstances, like a partially visible line
16873 becoming fully visible, or because newly displayed lines are displayed
16874 in smaller font sizes.
16876 7. Update W's window end information. */
16879 try_window_id (struct window
*w
)
16881 struct frame
*f
= XFRAME (w
->frame
);
16882 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16883 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16884 struct glyph_row
*last_unchanged_at_beg_row
;
16885 struct glyph_row
*first_unchanged_at_end_row
;
16886 struct glyph_row
*row
;
16887 struct glyph_row
*bottom_row
;
16890 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16892 struct text_pos start_pos
;
16894 int first_unchanged_at_end_vpos
= 0;
16895 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16896 struct text_pos start
;
16897 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16900 if (inhibit_try_window_id
)
16904 /* This is handy for debugging. */
16906 #define GIVE_UP(X) \
16908 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16912 #define GIVE_UP(X) return 0
16915 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16917 /* Don't use this for mini-windows because these can show
16918 messages and mini-buffers, and we don't handle that here. */
16919 if (MINI_WINDOW_P (w
))
16922 /* This flag is used to prevent redisplay optimizations. */
16923 if (windows_or_buffers_changed
|| cursor_type_changed
)
16926 /* Verify that narrowing has not changed.
16927 Also verify that we were not told to prevent redisplay optimizations.
16928 It would be nice to further
16929 reduce the number of cases where this prevents try_window_id. */
16930 if (current_buffer
->clip_changed
16931 || current_buffer
->prevent_redisplay_optimizations_p
)
16934 /* Window must either use window-based redisplay or be full width. */
16935 if (!FRAME_WINDOW_P (f
)
16936 && (!FRAME_LINE_INS_DEL_OK (f
)
16937 || !WINDOW_FULL_WIDTH_P (w
)))
16940 /* Give up if point is known NOT to appear in W. */
16941 if (PT
< CHARPOS (start
))
16944 /* Another way to prevent redisplay optimizations. */
16945 if (XFASTINT (w
->last_modified
) == 0)
16948 /* Verify that window is not hscrolled. */
16949 if (XFASTINT (w
->hscroll
) != 0)
16952 /* Verify that display wasn't paused. */
16953 if (NILP (w
->window_end_valid
))
16956 /* Can't use this if highlighting a region because a cursor movement
16957 will do more than just set the cursor. */
16958 if (!NILP (Vtransient_mark_mode
)
16959 && !NILP (BVAR (current_buffer
, mark_active
)))
16962 /* Likewise if highlighting trailing whitespace. */
16963 if (!NILP (Vshow_trailing_whitespace
))
16966 /* Likewise if showing a region. */
16967 if (!NILP (w
->region_showing
))
16970 /* Can't use this if overlay arrow position and/or string have
16972 if (overlay_arrows_changed_p ())
16975 /* When word-wrap is on, adding a space to the first word of a
16976 wrapped line can change the wrap position, altering the line
16977 above it. It might be worthwhile to handle this more
16978 intelligently, but for now just redisplay from scratch. */
16979 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16982 /* Under bidi reordering, adding or deleting a character in the
16983 beginning of a paragraph, before the first strong directional
16984 character, can change the base direction of the paragraph (unless
16985 the buffer specifies a fixed paragraph direction), which will
16986 require to redisplay the whole paragraph. It might be worthwhile
16987 to find the paragraph limits and widen the range of redisplayed
16988 lines to that, but for now just give up this optimization and
16989 redisplay from scratch. */
16990 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16991 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16994 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16995 only if buffer has really changed. The reason is that the gap is
16996 initially at Z for freshly visited files. The code below would
16997 set end_unchanged to 0 in that case. */
16998 if (MODIFF
> SAVE_MODIFF
16999 /* This seems to happen sometimes after saving a buffer. */
17000 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17002 if (GPT
- BEG
< BEG_UNCHANGED
)
17003 BEG_UNCHANGED
= GPT
- BEG
;
17004 if (Z
- GPT
< END_UNCHANGED
)
17005 END_UNCHANGED
= Z
- GPT
;
17008 /* The position of the first and last character that has been changed. */
17009 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17010 last_changed_charpos
= Z
- END_UNCHANGED
;
17012 /* If window starts after a line end, and the last change is in
17013 front of that newline, then changes don't affect the display.
17014 This case happens with stealth-fontification. Note that although
17015 the display is unchanged, glyph positions in the matrix have to
17016 be adjusted, of course. */
17017 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
17018 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17019 && ((last_changed_charpos
< CHARPOS (start
)
17020 && CHARPOS (start
) == BEGV
)
17021 || (last_changed_charpos
< CHARPOS (start
) - 1
17022 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17024 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17025 struct glyph_row
*r0
;
17027 /* Compute how many chars/bytes have been added to or removed
17028 from the buffer. */
17029 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
17030 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17031 Z_delta
= Z
- Z_old
;
17032 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17034 /* Give up if PT is not in the window. Note that it already has
17035 been checked at the start of try_window_id that PT is not in
17036 front of the window start. */
17037 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17040 /* If window start is unchanged, we can reuse the whole matrix
17041 as is, after adjusting glyph positions. No need to compute
17042 the window end again, since its offset from Z hasn't changed. */
17043 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17044 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17045 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17046 /* PT must not be in a partially visible line. */
17047 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17048 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17050 /* Adjust positions in the glyph matrix. */
17051 if (Z_delta
|| Z_delta_bytes
)
17053 struct glyph_row
*r1
17054 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17055 increment_matrix_positions (w
->current_matrix
,
17056 MATRIX_ROW_VPOS (r0
, current_matrix
),
17057 MATRIX_ROW_VPOS (r1
, current_matrix
),
17058 Z_delta
, Z_delta_bytes
);
17061 /* Set the cursor. */
17062 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17064 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17071 /* Handle the case that changes are all below what is displayed in
17072 the window, and that PT is in the window. This shortcut cannot
17073 be taken if ZV is visible in the window, and text has been added
17074 there that is visible in the window. */
17075 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17076 /* ZV is not visible in the window, or there are no
17077 changes at ZV, actually. */
17078 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17079 || first_changed_charpos
== last_changed_charpos
))
17081 struct glyph_row
*r0
;
17083 /* Give up if PT is not in the window. Note that it already has
17084 been checked at the start of try_window_id that PT is not in
17085 front of the window start. */
17086 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17089 /* If window start is unchanged, we can reuse the whole matrix
17090 as is, without changing glyph positions since no text has
17091 been added/removed in front of the window end. */
17092 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17093 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17094 /* PT must not be in a partially visible line. */
17095 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17096 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17098 /* We have to compute the window end anew since text
17099 could have been added/removed after it. */
17101 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17102 w
->window_end_bytepos
17103 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17105 /* Set the cursor. */
17106 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17108 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17115 /* Give up if window start is in the changed area.
17117 The condition used to read
17119 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17121 but why that was tested escapes me at the moment. */
17122 if (CHARPOS (start
) >= first_changed_charpos
17123 && CHARPOS (start
) <= last_changed_charpos
)
17126 /* Check that window start agrees with the start of the first glyph
17127 row in its current matrix. Check this after we know the window
17128 start is not in changed text, otherwise positions would not be
17130 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17131 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17134 /* Give up if the window ends in strings. Overlay strings
17135 at the end are difficult to handle, so don't try. */
17136 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17137 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17140 /* Compute the position at which we have to start displaying new
17141 lines. Some of the lines at the top of the window might be
17142 reusable because they are not displaying changed text. Find the
17143 last row in W's current matrix not affected by changes at the
17144 start of current_buffer. Value is null if changes start in the
17145 first line of window. */
17146 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17147 if (last_unchanged_at_beg_row
)
17149 /* Avoid starting to display in the middle of a character, a TAB
17150 for instance. This is easier than to set up the iterator
17151 exactly, and it's not a frequent case, so the additional
17152 effort wouldn't really pay off. */
17153 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17154 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17155 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17156 --last_unchanged_at_beg_row
;
17158 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17161 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17163 start_pos
= it
.current
.pos
;
17165 /* Start displaying new lines in the desired matrix at the same
17166 vpos we would use in the current matrix, i.e. below
17167 last_unchanged_at_beg_row. */
17168 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17170 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17171 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17173 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17177 /* There are no reusable lines at the start of the window.
17178 Start displaying in the first text line. */
17179 start_display (&it
, w
, start
);
17180 it
.vpos
= it
.first_vpos
;
17181 start_pos
= it
.current
.pos
;
17184 /* Find the first row that is not affected by changes at the end of
17185 the buffer. Value will be null if there is no unchanged row, in
17186 which case we must redisplay to the end of the window. delta
17187 will be set to the value by which buffer positions beginning with
17188 first_unchanged_at_end_row have to be adjusted due to text
17190 first_unchanged_at_end_row
17191 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17192 IF_DEBUG (debug_delta
= delta
);
17193 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17195 /* Set stop_pos to the buffer position up to which we will have to
17196 display new lines. If first_unchanged_at_end_row != NULL, this
17197 is the buffer position of the start of the line displayed in that
17198 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17199 that we don't stop at a buffer position. */
17201 if (first_unchanged_at_end_row
)
17203 xassert (last_unchanged_at_beg_row
== NULL
17204 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17206 /* If this is a continuation line, move forward to the next one
17207 that isn't. Changes in lines above affect this line.
17208 Caution: this may move first_unchanged_at_end_row to a row
17209 not displaying text. */
17210 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17211 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17212 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17213 < it
.last_visible_y
))
17214 ++first_unchanged_at_end_row
;
17216 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17217 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17218 >= it
.last_visible_y
))
17219 first_unchanged_at_end_row
= NULL
;
17222 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17224 first_unchanged_at_end_vpos
17225 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17226 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17229 else if (last_unchanged_at_beg_row
== NULL
)
17235 /* Either there is no unchanged row at the end, or the one we have
17236 now displays text. This is a necessary condition for the window
17237 end pos calculation at the end of this function. */
17238 xassert (first_unchanged_at_end_row
== NULL
17239 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17241 debug_last_unchanged_at_beg_vpos
17242 = (last_unchanged_at_beg_row
17243 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17245 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17247 #endif /* GLYPH_DEBUG != 0 */
17250 /* Display new lines. Set last_text_row to the last new line
17251 displayed which has text on it, i.e. might end up as being the
17252 line where the window_end_vpos is. */
17253 w
->cursor
.vpos
= -1;
17254 last_text_row
= NULL
;
17255 overlay_arrow_seen
= 0;
17256 while (it
.current_y
< it
.last_visible_y
17257 && !fonts_changed_p
17258 && (first_unchanged_at_end_row
== NULL
17259 || IT_CHARPOS (it
) < stop_pos
))
17261 if (display_line (&it
))
17262 last_text_row
= it
.glyph_row
- 1;
17265 if (fonts_changed_p
)
17269 /* Compute differences in buffer positions, y-positions etc. for
17270 lines reused at the bottom of the window. Compute what we can
17272 if (first_unchanged_at_end_row
17273 /* No lines reused because we displayed everything up to the
17274 bottom of the window. */
17275 && it
.current_y
< it
.last_visible_y
)
17278 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17280 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17281 run
.current_y
= first_unchanged_at_end_row
->y
;
17282 run
.desired_y
= run
.current_y
+ dy
;
17283 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17287 delta
= delta_bytes
= dvpos
= dy
17288 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17289 first_unchanged_at_end_row
= NULL
;
17291 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17294 /* Find the cursor if not already found. We have to decide whether
17295 PT will appear on this window (it sometimes doesn't, but this is
17296 not a very frequent case.) This decision has to be made before
17297 the current matrix is altered. A value of cursor.vpos < 0 means
17298 that PT is either in one of the lines beginning at
17299 first_unchanged_at_end_row or below the window. Don't care for
17300 lines that might be displayed later at the window end; as
17301 mentioned, this is not a frequent case. */
17302 if (w
->cursor
.vpos
< 0)
17304 /* Cursor in unchanged rows at the top? */
17305 if (PT
< CHARPOS (start_pos
)
17306 && last_unchanged_at_beg_row
)
17308 row
= row_containing_pos (w
, PT
,
17309 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17310 last_unchanged_at_beg_row
+ 1, 0);
17312 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17315 /* Start from first_unchanged_at_end_row looking for PT. */
17316 else if (first_unchanged_at_end_row
)
17318 row
= row_containing_pos (w
, PT
- delta
,
17319 first_unchanged_at_end_row
, NULL
, 0);
17321 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17322 delta_bytes
, dy
, dvpos
);
17325 /* Give up if cursor was not found. */
17326 if (w
->cursor
.vpos
< 0)
17328 clear_glyph_matrix (w
->desired_matrix
);
17333 /* Don't let the cursor end in the scroll margins. */
17335 int this_scroll_margin
, cursor_height
;
17337 this_scroll_margin
=
17338 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17339 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17340 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17342 if ((w
->cursor
.y
< this_scroll_margin
17343 && CHARPOS (start
) > BEGV
)
17344 /* Old redisplay didn't take scroll margin into account at the bottom,
17345 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17346 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17347 ? cursor_height
+ this_scroll_margin
17348 : 1)) > it
.last_visible_y
)
17350 w
->cursor
.vpos
= -1;
17351 clear_glyph_matrix (w
->desired_matrix
);
17356 /* Scroll the display. Do it before changing the current matrix so
17357 that xterm.c doesn't get confused about where the cursor glyph is
17359 if (dy
&& run
.height
)
17363 if (FRAME_WINDOW_P (f
))
17365 FRAME_RIF (f
)->update_window_begin_hook (w
);
17366 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17367 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17368 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17372 /* Terminal frame. In this case, dvpos gives the number of
17373 lines to scroll by; dvpos < 0 means scroll up. */
17375 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17376 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17377 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17378 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17379 + window_internal_height (w
));
17381 #if defined (HAVE_GPM) || defined (MSDOS)
17382 x_clear_window_mouse_face (w
);
17384 /* Perform the operation on the screen. */
17387 /* Scroll last_unchanged_at_beg_row to the end of the
17388 window down dvpos lines. */
17389 set_terminal_window (f
, end
);
17391 /* On dumb terminals delete dvpos lines at the end
17392 before inserting dvpos empty lines. */
17393 if (!FRAME_SCROLL_REGION_OK (f
))
17394 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17396 /* Insert dvpos empty lines in front of
17397 last_unchanged_at_beg_row. */
17398 ins_del_lines (f
, from
, dvpos
);
17400 else if (dvpos
< 0)
17402 /* Scroll up last_unchanged_at_beg_vpos to the end of
17403 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17404 set_terminal_window (f
, end
);
17406 /* Delete dvpos lines in front of
17407 last_unchanged_at_beg_vpos. ins_del_lines will set
17408 the cursor to the given vpos and emit |dvpos| delete
17410 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17412 /* On a dumb terminal insert dvpos empty lines at the
17414 if (!FRAME_SCROLL_REGION_OK (f
))
17415 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17418 set_terminal_window (f
, 0);
17424 /* Shift reused rows of the current matrix to the right position.
17425 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17427 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17428 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17431 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17432 bottom_vpos
, dvpos
);
17433 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17436 else if (dvpos
> 0)
17438 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17439 bottom_vpos
, dvpos
);
17440 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17441 first_unchanged_at_end_vpos
+ dvpos
, 0);
17444 /* For frame-based redisplay, make sure that current frame and window
17445 matrix are in sync with respect to glyph memory. */
17446 if (!FRAME_WINDOW_P (f
))
17447 sync_frame_with_window_matrix_rows (w
);
17449 /* Adjust buffer positions in reused rows. */
17450 if (delta
|| delta_bytes
)
17451 increment_matrix_positions (current_matrix
,
17452 first_unchanged_at_end_vpos
+ dvpos
,
17453 bottom_vpos
, delta
, delta_bytes
);
17455 /* Adjust Y positions. */
17457 shift_glyph_matrix (w
, current_matrix
,
17458 first_unchanged_at_end_vpos
+ dvpos
,
17461 if (first_unchanged_at_end_row
)
17463 first_unchanged_at_end_row
+= dvpos
;
17464 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17465 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17466 first_unchanged_at_end_row
= NULL
;
17469 /* If scrolling up, there may be some lines to display at the end of
17471 last_text_row_at_end
= NULL
;
17474 /* Scrolling up can leave for example a partially visible line
17475 at the end of the window to be redisplayed. */
17476 /* Set last_row to the glyph row in the current matrix where the
17477 window end line is found. It has been moved up or down in
17478 the matrix by dvpos. */
17479 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17480 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17482 /* If last_row is the window end line, it should display text. */
17483 xassert (last_row
->displays_text_p
);
17485 /* If window end line was partially visible before, begin
17486 displaying at that line. Otherwise begin displaying with the
17487 line following it. */
17488 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17490 init_to_row_start (&it
, w
, last_row
);
17491 it
.vpos
= last_vpos
;
17492 it
.current_y
= last_row
->y
;
17496 init_to_row_end (&it
, w
, last_row
);
17497 it
.vpos
= 1 + last_vpos
;
17498 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17502 /* We may start in a continuation line. If so, we have to
17503 get the right continuation_lines_width and current_x. */
17504 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17505 it
.hpos
= it
.current_x
= 0;
17507 /* Display the rest of the lines at the window end. */
17508 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17509 while (it
.current_y
< it
.last_visible_y
17510 && !fonts_changed_p
)
17512 /* Is it always sure that the display agrees with lines in
17513 the current matrix? I don't think so, so we mark rows
17514 displayed invalid in the current matrix by setting their
17515 enabled_p flag to zero. */
17516 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17517 if (display_line (&it
))
17518 last_text_row_at_end
= it
.glyph_row
- 1;
17522 /* Update window_end_pos and window_end_vpos. */
17523 if (first_unchanged_at_end_row
17524 && !last_text_row_at_end
)
17526 /* Window end line if one of the preserved rows from the current
17527 matrix. Set row to the last row displaying text in current
17528 matrix starting at first_unchanged_at_end_row, after
17530 xassert (first_unchanged_at_end_row
->displays_text_p
);
17531 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17532 first_unchanged_at_end_row
);
17533 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17535 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17536 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17538 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17539 xassert (w
->window_end_bytepos
>= 0);
17540 IF_DEBUG (debug_method_add (w
, "A"));
17542 else if (last_text_row_at_end
)
17545 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17546 w
->window_end_bytepos
17547 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17549 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17550 xassert (w
->window_end_bytepos
>= 0);
17551 IF_DEBUG (debug_method_add (w
, "B"));
17553 else if (last_text_row
)
17555 /* We have displayed either to the end of the window or at the
17556 end of the window, i.e. the last row with text is to be found
17557 in the desired matrix. */
17559 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17560 w
->window_end_bytepos
17561 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17563 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17564 xassert (w
->window_end_bytepos
>= 0);
17566 else if (first_unchanged_at_end_row
== NULL
17567 && last_text_row
== NULL
17568 && last_text_row_at_end
== NULL
)
17570 /* Displayed to end of window, but no line containing text was
17571 displayed. Lines were deleted at the end of the window. */
17572 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17573 int vpos
= XFASTINT (w
->window_end_vpos
);
17574 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17575 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17578 row
== NULL
&& vpos
>= first_vpos
;
17579 --vpos
, --current_row
, --desired_row
)
17581 if (desired_row
->enabled_p
)
17583 if (desired_row
->displays_text_p
)
17586 else if (current_row
->displays_text_p
)
17590 xassert (row
!= NULL
);
17591 w
->window_end_vpos
= make_number (vpos
+ 1);
17592 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17593 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17594 xassert (w
->window_end_bytepos
>= 0);
17595 IF_DEBUG (debug_method_add (w
, "C"));
17600 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17601 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17603 /* Record that display has not been completed. */
17604 w
->window_end_valid
= Qnil
;
17605 w
->desired_matrix
->no_scrolling_p
= 1;
17613 /***********************************************************************
17614 More debugging support
17615 ***********************************************************************/
17619 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17620 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17621 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17624 /* Dump the contents of glyph matrix MATRIX on stderr.
17626 GLYPHS 0 means don't show glyph contents.
17627 GLYPHS 1 means show glyphs in short form
17628 GLYPHS > 1 means show glyphs in long form. */
17631 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17634 for (i
= 0; i
< matrix
->nrows
; ++i
)
17635 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17639 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17640 the glyph row and area where the glyph comes from. */
17643 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17645 if (glyph
->type
== CHAR_GLYPH
)
17648 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17649 glyph
- row
->glyphs
[TEXT_AREA
],
17652 (BUFFERP (glyph
->object
)
17654 : (STRINGP (glyph
->object
)
17657 glyph
->pixel_width
,
17659 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17663 glyph
->left_box_line_p
,
17664 glyph
->right_box_line_p
);
17666 else if (glyph
->type
== STRETCH_GLYPH
)
17669 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17670 glyph
- row
->glyphs
[TEXT_AREA
],
17673 (BUFFERP (glyph
->object
)
17675 : (STRINGP (glyph
->object
)
17678 glyph
->pixel_width
,
17682 glyph
->left_box_line_p
,
17683 glyph
->right_box_line_p
);
17685 else if (glyph
->type
== IMAGE_GLYPH
)
17688 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17689 glyph
- row
->glyphs
[TEXT_AREA
],
17692 (BUFFERP (glyph
->object
)
17694 : (STRINGP (glyph
->object
)
17697 glyph
->pixel_width
,
17701 glyph
->left_box_line_p
,
17702 glyph
->right_box_line_p
);
17704 else if (glyph
->type
== COMPOSITE_GLYPH
)
17707 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17708 glyph
- row
->glyphs
[TEXT_AREA
],
17711 (BUFFERP (glyph
->object
)
17713 : (STRINGP (glyph
->object
)
17716 glyph
->pixel_width
,
17718 if (glyph
->u
.cmp
.automatic
)
17721 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17722 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17724 glyph
->left_box_line_p
,
17725 glyph
->right_box_line_p
);
17730 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17731 GLYPHS 0 means don't show glyph contents.
17732 GLYPHS 1 means show glyphs in short form
17733 GLYPHS > 1 means show glyphs in long form. */
17736 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17740 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17741 fprintf (stderr
, "======================================================================\n");
17743 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17744 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17746 MATRIX_ROW_START_CHARPOS (row
),
17747 MATRIX_ROW_END_CHARPOS (row
),
17748 row
->used
[TEXT_AREA
],
17749 row
->contains_overlapping_glyphs_p
,
17751 row
->truncated_on_left_p
,
17752 row
->truncated_on_right_p
,
17754 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17755 row
->displays_text_p
,
17758 row
->ends_in_middle_of_char_p
,
17759 row
->starts_in_middle_of_char_p
,
17765 row
->visible_height
,
17768 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17769 row
->end
.overlay_string_index
,
17770 row
->continuation_lines_width
);
17771 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17772 CHARPOS (row
->start
.string_pos
),
17773 CHARPOS (row
->end
.string_pos
));
17774 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17775 row
->end
.dpvec_index
);
17782 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17784 struct glyph
*glyph
= row
->glyphs
[area
];
17785 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17787 /* Glyph for a line end in text. */
17788 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17791 if (glyph
< glyph_end
)
17792 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17794 for (; glyph
< glyph_end
; ++glyph
)
17795 dump_glyph (row
, glyph
, area
);
17798 else if (glyphs
== 1)
17802 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17804 char *s
= (char *) alloca (row
->used
[area
] + 1);
17807 for (i
= 0; i
< row
->used
[area
]; ++i
)
17809 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17810 if (glyph
->type
== CHAR_GLYPH
17811 && glyph
->u
.ch
< 0x80
17812 && glyph
->u
.ch
>= ' ')
17813 s
[i
] = glyph
->u
.ch
;
17819 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17825 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17826 Sdump_glyph_matrix
, 0, 1, "p",
17827 doc
: /* Dump the current matrix of the selected window to stderr.
17828 Shows contents of glyph row structures. With non-nil
17829 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17830 glyphs in short form, otherwise show glyphs in long form. */)
17831 (Lisp_Object glyphs
)
17833 struct window
*w
= XWINDOW (selected_window
);
17834 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17836 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17837 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17838 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17839 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17840 fprintf (stderr
, "=============================================\n");
17841 dump_glyph_matrix (w
->current_matrix
,
17842 NILP (glyphs
) ? 0 : XINT (glyphs
));
17847 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17848 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17851 struct frame
*f
= XFRAME (selected_frame
);
17852 dump_glyph_matrix (f
->current_matrix
, 1);
17857 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17858 doc
: /* Dump glyph row ROW to stderr.
17859 GLYPH 0 means don't dump glyphs.
17860 GLYPH 1 means dump glyphs in short form.
17861 GLYPH > 1 or omitted means dump glyphs in long form. */)
17862 (Lisp_Object row
, Lisp_Object glyphs
)
17864 struct glyph_matrix
*matrix
;
17867 CHECK_NUMBER (row
);
17868 matrix
= XWINDOW (selected_window
)->current_matrix
;
17870 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17871 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17873 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17878 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17879 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17880 GLYPH 0 means don't dump glyphs.
17881 GLYPH 1 means dump glyphs in short form.
17882 GLYPH > 1 or omitted means dump glyphs in long form. */)
17883 (Lisp_Object row
, Lisp_Object glyphs
)
17885 struct frame
*sf
= SELECTED_FRAME ();
17886 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17889 CHECK_NUMBER (row
);
17891 if (vpos
>= 0 && vpos
< m
->nrows
)
17892 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17893 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17898 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17899 doc
: /* Toggle tracing of redisplay.
17900 With ARG, turn tracing on if and only if ARG is positive. */)
17904 trace_redisplay_p
= !trace_redisplay_p
;
17907 arg
= Fprefix_numeric_value (arg
);
17908 trace_redisplay_p
= XINT (arg
) > 0;
17915 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17916 doc
: /* Like `format', but print result to stderr.
17917 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17918 (ptrdiff_t nargs
, Lisp_Object
*args
)
17920 Lisp_Object s
= Fformat (nargs
, args
);
17921 fprintf (stderr
, "%s", SDATA (s
));
17925 #endif /* GLYPH_DEBUG */
17929 /***********************************************************************
17930 Building Desired Matrix Rows
17931 ***********************************************************************/
17933 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17934 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17936 static struct glyph_row
*
17937 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17939 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17940 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17941 struct buffer
*old
= current_buffer
;
17942 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17943 int arrow_len
= SCHARS (overlay_arrow_string
);
17944 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17945 const unsigned char *p
;
17948 int n_glyphs_before
;
17950 set_buffer_temp (buffer
);
17951 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17952 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17953 SET_TEXT_POS (it
.position
, 0, 0);
17955 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17957 while (p
< arrow_end
)
17959 Lisp_Object face
, ilisp
;
17961 /* Get the next character. */
17963 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17966 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17967 if (! ASCII_CHAR_P (it
.c
))
17968 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17972 /* Get its face. */
17973 ilisp
= make_number (p
- arrow_string
);
17974 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17975 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17977 /* Compute its width, get its glyphs. */
17978 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17979 SET_TEXT_POS (it
.position
, -1, -1);
17980 PRODUCE_GLYPHS (&it
);
17982 /* If this character doesn't fit any more in the line, we have
17983 to remove some glyphs. */
17984 if (it
.current_x
> it
.last_visible_x
)
17986 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17991 set_buffer_temp (old
);
17992 return it
.glyph_row
;
17996 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17997 glyphs are only inserted for terminal frames since we can't really
17998 win with truncation glyphs when partially visible glyphs are
17999 involved. Which glyphs to insert is determined by
18000 produce_special_glyphs. */
18003 insert_left_trunc_glyphs (struct it
*it
)
18005 struct it truncate_it
;
18006 struct glyph
*from
, *end
, *to
, *toend
;
18008 xassert (!FRAME_WINDOW_P (it
->f
));
18010 /* Get the truncation glyphs. */
18012 truncate_it
.current_x
= 0;
18013 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18014 truncate_it
.glyph_row
= &scratch_glyph_row
;
18015 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18016 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18017 truncate_it
.object
= make_number (0);
18018 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18020 /* Overwrite glyphs from IT with truncation glyphs. */
18021 if (!it
->glyph_row
->reversed_p
)
18023 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18024 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
18025 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18026 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18031 /* There may be padding glyphs left over. Overwrite them too. */
18032 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18034 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18040 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18044 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18045 that back to front. */
18046 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18047 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18048 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18049 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18051 while (from
>= end
&& to
>= toend
)
18053 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18056 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18057 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18058 while (from
>= end
&& to
>= toend
)
18063 /* Need to free some room before prepending additional
18065 int move_by
= from
- end
+ 1;
18066 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18067 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18069 for ( ; g
>= g0
; g
--)
18071 while (from
>= end
)
18073 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18078 /* Compute the hash code for ROW. */
18080 row_hash (struct glyph_row
*row
)
18083 unsigned hashval
= 0;
18085 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18086 for (k
= 0; k
< row
->used
[area
]; ++k
)
18087 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18088 + row
->glyphs
[area
][k
].u
.val
18089 + row
->glyphs
[area
][k
].face_id
18090 + row
->glyphs
[area
][k
].padding_p
18091 + (row
->glyphs
[area
][k
].type
<< 2));
18096 /* Compute the pixel height and width of IT->glyph_row.
18098 Most of the time, ascent and height of a display line will be equal
18099 to the max_ascent and max_height values of the display iterator
18100 structure. This is not the case if
18102 1. We hit ZV without displaying anything. In this case, max_ascent
18103 and max_height will be zero.
18105 2. We have some glyphs that don't contribute to the line height.
18106 (The glyph row flag contributes_to_line_height_p is for future
18107 pixmap extensions).
18109 The first case is easily covered by using default values because in
18110 these cases, the line height does not really matter, except that it
18111 must not be zero. */
18114 compute_line_metrics (struct it
*it
)
18116 struct glyph_row
*row
= it
->glyph_row
;
18118 if (FRAME_WINDOW_P (it
->f
))
18120 int i
, min_y
, max_y
;
18122 /* The line may consist of one space only, that was added to
18123 place the cursor on it. If so, the row's height hasn't been
18125 if (row
->height
== 0)
18127 if (it
->max_ascent
+ it
->max_descent
== 0)
18128 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18129 row
->ascent
= it
->max_ascent
;
18130 row
->height
= it
->max_ascent
+ it
->max_descent
;
18131 row
->phys_ascent
= it
->max_phys_ascent
;
18132 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18133 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18136 /* Compute the width of this line. */
18137 row
->pixel_width
= row
->x
;
18138 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18139 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18141 xassert (row
->pixel_width
>= 0);
18142 xassert (row
->ascent
>= 0 && row
->height
> 0);
18144 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18145 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18147 /* If first line's physical ascent is larger than its logical
18148 ascent, use the physical ascent, and make the row taller.
18149 This makes accented characters fully visible. */
18150 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18151 && row
->phys_ascent
> row
->ascent
)
18153 row
->height
+= row
->phys_ascent
- row
->ascent
;
18154 row
->ascent
= row
->phys_ascent
;
18157 /* Compute how much of the line is visible. */
18158 row
->visible_height
= row
->height
;
18160 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18161 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18163 if (row
->y
< min_y
)
18164 row
->visible_height
-= min_y
- row
->y
;
18165 if (row
->y
+ row
->height
> max_y
)
18166 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18170 row
->pixel_width
= row
->used
[TEXT_AREA
];
18171 if (row
->continued_p
)
18172 row
->pixel_width
-= it
->continuation_pixel_width
;
18173 else if (row
->truncated_on_right_p
)
18174 row
->pixel_width
-= it
->truncation_pixel_width
;
18175 row
->ascent
= row
->phys_ascent
= 0;
18176 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18177 row
->extra_line_spacing
= 0;
18180 /* Compute a hash code for this row. */
18181 row
->hash
= row_hash (row
);
18183 it
->max_ascent
= it
->max_descent
= 0;
18184 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18188 /* Append one space to the glyph row of iterator IT if doing a
18189 window-based redisplay. The space has the same face as
18190 IT->face_id. Value is non-zero if a space was added.
18192 This function is called to make sure that there is always one glyph
18193 at the end of a glyph row that the cursor can be set on under
18194 window-systems. (If there weren't such a glyph we would not know
18195 how wide and tall a box cursor should be displayed).
18197 At the same time this space let's a nicely handle clearing to the
18198 end of the line if the row ends in italic text. */
18201 append_space_for_newline (struct it
*it
, int default_face_p
)
18203 if (FRAME_WINDOW_P (it
->f
))
18205 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18207 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18208 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18210 /* Save some values that must not be changed.
18211 Must save IT->c and IT->len because otherwise
18212 ITERATOR_AT_END_P wouldn't work anymore after
18213 append_space_for_newline has been called. */
18214 enum display_element_type saved_what
= it
->what
;
18215 int saved_c
= it
->c
, saved_len
= it
->len
;
18216 int saved_char_to_display
= it
->char_to_display
;
18217 int saved_x
= it
->current_x
;
18218 int saved_face_id
= it
->face_id
;
18219 struct text_pos saved_pos
;
18220 Lisp_Object saved_object
;
18223 saved_object
= it
->object
;
18224 saved_pos
= it
->position
;
18226 it
->what
= IT_CHARACTER
;
18227 memset (&it
->position
, 0, sizeof it
->position
);
18228 it
->object
= make_number (0);
18229 it
->c
= it
->char_to_display
= ' ';
18232 /* If the default face was remapped, be sure to use the
18233 remapped face for the appended newline. */
18234 if (default_face_p
)
18235 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18236 else if (it
->face_before_selective_p
)
18237 it
->face_id
= it
->saved_face_id
;
18238 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18239 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18241 PRODUCE_GLYPHS (it
);
18243 it
->override_ascent
= -1;
18244 it
->constrain_row_ascent_descent_p
= 0;
18245 it
->current_x
= saved_x
;
18246 it
->object
= saved_object
;
18247 it
->position
= saved_pos
;
18248 it
->what
= saved_what
;
18249 it
->face_id
= saved_face_id
;
18250 it
->len
= saved_len
;
18252 it
->char_to_display
= saved_char_to_display
;
18261 /* Extend the face of the last glyph in the text area of IT->glyph_row
18262 to the end of the display line. Called from display_line. If the
18263 glyph row is empty, add a space glyph to it so that we know the
18264 face to draw. Set the glyph row flag fill_line_p. If the glyph
18265 row is R2L, prepend a stretch glyph to cover the empty space to the
18266 left of the leftmost glyph. */
18269 extend_face_to_end_of_line (struct it
*it
)
18271 struct face
*face
, *default_face
;
18272 struct frame
*f
= it
->f
;
18274 /* If line is already filled, do nothing. Non window-system frames
18275 get a grace of one more ``pixel'' because their characters are
18276 1-``pixel'' wide, so they hit the equality too early. This grace
18277 is needed only for R2L rows that are not continued, to produce
18278 one extra blank where we could display the cursor. */
18279 if (it
->current_x
>= it
->last_visible_x
18280 + (!FRAME_WINDOW_P (f
)
18281 && it
->glyph_row
->reversed_p
18282 && !it
->glyph_row
->continued_p
))
18285 /* The default face, possibly remapped. */
18286 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18288 /* Face extension extends the background and box of IT->face_id
18289 to the end of the line. If the background equals the background
18290 of the frame, we don't have to do anything. */
18291 if (it
->face_before_selective_p
)
18292 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18294 face
= FACE_FROM_ID (f
, it
->face_id
);
18296 if (FRAME_WINDOW_P (f
)
18297 && it
->glyph_row
->displays_text_p
18298 && face
->box
== FACE_NO_BOX
18299 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18301 && !it
->glyph_row
->reversed_p
)
18304 /* Set the glyph row flag indicating that the face of the last glyph
18305 in the text area has to be drawn to the end of the text area. */
18306 it
->glyph_row
->fill_line_p
= 1;
18308 /* If current character of IT is not ASCII, make sure we have the
18309 ASCII face. This will be automatically undone the next time
18310 get_next_display_element returns a multibyte character. Note
18311 that the character will always be single byte in unibyte
18313 if (!ASCII_CHAR_P (it
->c
))
18315 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18318 if (FRAME_WINDOW_P (f
))
18320 /* If the row is empty, add a space with the current face of IT,
18321 so that we know which face to draw. */
18322 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18324 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18325 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18326 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18328 #ifdef HAVE_WINDOW_SYSTEM
18329 if (it
->glyph_row
->reversed_p
)
18331 /* Prepend a stretch glyph to the row, such that the
18332 rightmost glyph will be drawn flushed all the way to the
18333 right margin of the window. The stretch glyph that will
18334 occupy the empty space, if any, to the left of the
18336 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18337 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18338 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18340 int row_width
, stretch_ascent
, stretch_width
;
18341 struct text_pos saved_pos
;
18342 int saved_face_id
, saved_avoid_cursor
;
18344 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18345 row_width
+= g
->pixel_width
;
18346 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18347 if (stretch_width
> 0)
18350 (((it
->ascent
+ it
->descent
)
18351 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18352 saved_pos
= it
->position
;
18353 memset (&it
->position
, 0, sizeof it
->position
);
18354 saved_avoid_cursor
= it
->avoid_cursor_p
;
18355 it
->avoid_cursor_p
= 1;
18356 saved_face_id
= it
->face_id
;
18357 /* The last row's stretch glyph should get the default
18358 face, to avoid painting the rest of the window with
18359 the region face, if the region ends at ZV. */
18360 if (it
->glyph_row
->ends_at_zv_p
)
18361 it
->face_id
= default_face
->id
;
18363 it
->face_id
= face
->id
;
18364 append_stretch_glyph (it
, make_number (0), stretch_width
,
18365 it
->ascent
+ it
->descent
, stretch_ascent
);
18366 it
->position
= saved_pos
;
18367 it
->avoid_cursor_p
= saved_avoid_cursor
;
18368 it
->face_id
= saved_face_id
;
18371 #endif /* HAVE_WINDOW_SYSTEM */
18375 /* Save some values that must not be changed. */
18376 int saved_x
= it
->current_x
;
18377 struct text_pos saved_pos
;
18378 Lisp_Object saved_object
;
18379 enum display_element_type saved_what
= it
->what
;
18380 int saved_face_id
= it
->face_id
;
18382 saved_object
= it
->object
;
18383 saved_pos
= it
->position
;
18385 it
->what
= IT_CHARACTER
;
18386 memset (&it
->position
, 0, sizeof it
->position
);
18387 it
->object
= make_number (0);
18388 it
->c
= it
->char_to_display
= ' ';
18390 /* The last row's blank glyphs should get the default face, to
18391 avoid painting the rest of the window with the region face,
18392 if the region ends at ZV. */
18393 if (it
->glyph_row
->ends_at_zv_p
)
18394 it
->face_id
= default_face
->id
;
18396 it
->face_id
= face
->id
;
18398 PRODUCE_GLYPHS (it
);
18400 while (it
->current_x
<= it
->last_visible_x
)
18401 PRODUCE_GLYPHS (it
);
18403 /* Don't count these blanks really. It would let us insert a left
18404 truncation glyph below and make us set the cursor on them, maybe. */
18405 it
->current_x
= saved_x
;
18406 it
->object
= saved_object
;
18407 it
->position
= saved_pos
;
18408 it
->what
= saved_what
;
18409 it
->face_id
= saved_face_id
;
18414 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18415 trailing whitespace. */
18418 trailing_whitespace_p (EMACS_INT charpos
)
18420 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18423 while (bytepos
< ZV_BYTE
18424 && (c
= FETCH_CHAR (bytepos
),
18425 c
== ' ' || c
== '\t'))
18428 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18430 if (bytepos
!= PT_BYTE
)
18437 /* Highlight trailing whitespace, if any, in ROW. */
18440 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18442 int used
= row
->used
[TEXT_AREA
];
18446 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18447 struct glyph
*glyph
= start
+ used
- 1;
18449 if (row
->reversed_p
)
18451 /* Right-to-left rows need to be processed in the opposite
18452 direction, so swap the edge pointers. */
18454 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18457 /* Skip over glyphs inserted to display the cursor at the
18458 end of a line, for extending the face of the last glyph
18459 to the end of the line on terminals, and for truncation
18460 and continuation glyphs. */
18461 if (!row
->reversed_p
)
18463 while (glyph
>= start
18464 && glyph
->type
== CHAR_GLYPH
18465 && INTEGERP (glyph
->object
))
18470 while (glyph
<= start
18471 && glyph
->type
== CHAR_GLYPH
18472 && INTEGERP (glyph
->object
))
18476 /* If last glyph is a space or stretch, and it's trailing
18477 whitespace, set the face of all trailing whitespace glyphs in
18478 IT->glyph_row to `trailing-whitespace'. */
18479 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18480 && BUFFERP (glyph
->object
)
18481 && (glyph
->type
== STRETCH_GLYPH
18482 || (glyph
->type
== CHAR_GLYPH
18483 && glyph
->u
.ch
== ' '))
18484 && trailing_whitespace_p (glyph
->charpos
))
18486 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18490 if (!row
->reversed_p
)
18492 while (glyph
>= start
18493 && BUFFERP (glyph
->object
)
18494 && (glyph
->type
== STRETCH_GLYPH
18495 || (glyph
->type
== CHAR_GLYPH
18496 && glyph
->u
.ch
== ' ')))
18497 (glyph
--)->face_id
= face_id
;
18501 while (glyph
<= start
18502 && BUFFERP (glyph
->object
)
18503 && (glyph
->type
== STRETCH_GLYPH
18504 || (glyph
->type
== CHAR_GLYPH
18505 && glyph
->u
.ch
== ' ')))
18506 (glyph
++)->face_id
= face_id
;
18513 /* Value is non-zero if glyph row ROW should be
18514 used to hold the cursor. */
18517 cursor_row_p (struct glyph_row
*row
)
18521 if (PT
== CHARPOS (row
->end
.pos
)
18522 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18524 /* Suppose the row ends on a string.
18525 Unless the row is continued, that means it ends on a newline
18526 in the string. If it's anything other than a display string
18527 (e.g., a before-string from an overlay), we don't want the
18528 cursor there. (This heuristic seems to give the optimal
18529 behavior for the various types of multi-line strings.)
18530 One exception: if the string has `cursor' property on one of
18531 its characters, we _do_ want the cursor there. */
18532 if (CHARPOS (row
->end
.string_pos
) >= 0)
18534 if (row
->continued_p
)
18538 /* Check for `display' property. */
18539 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18540 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18541 struct glyph
*glyph
;
18544 for (glyph
= end
; glyph
>= beg
; --glyph
)
18545 if (STRINGP (glyph
->object
))
18548 = Fget_char_property (make_number (PT
),
18552 && display_prop_string_p (prop
, glyph
->object
));
18553 /* If there's a `cursor' property on one of the
18554 string's characters, this row is a cursor row,
18555 even though this is not a display string. */
18558 Lisp_Object s
= glyph
->object
;
18560 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18562 EMACS_INT gpos
= glyph
->charpos
;
18564 if (!NILP (Fget_char_property (make_number (gpos
),
18576 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18578 /* If the row ends in middle of a real character,
18579 and the line is continued, we want the cursor here.
18580 That's because CHARPOS (ROW->end.pos) would equal
18581 PT if PT is before the character. */
18582 if (!row
->ends_in_ellipsis_p
)
18583 result
= row
->continued_p
;
18585 /* If the row ends in an ellipsis, then
18586 CHARPOS (ROW->end.pos) will equal point after the
18587 invisible text. We want that position to be displayed
18588 after the ellipsis. */
18591 /* If the row ends at ZV, display the cursor at the end of that
18592 row instead of at the start of the row below. */
18593 else if (row
->ends_at_zv_p
)
18604 /* Push the property PROP so that it will be rendered at the current
18605 position in IT. Return 1 if PROP was successfully pushed, 0
18606 otherwise. Called from handle_line_prefix to handle the
18607 `line-prefix' and `wrap-prefix' properties. */
18610 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18612 struct text_pos pos
=
18613 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18615 xassert (it
->method
== GET_FROM_BUFFER
18616 || it
->method
== GET_FROM_DISPLAY_VECTOR
18617 || it
->method
== GET_FROM_STRING
);
18619 /* We need to save the current buffer/string position, so it will be
18620 restored by pop_it, because iterate_out_of_display_property
18621 depends on that being set correctly, but some situations leave
18622 it->position not yet set when this function is called. */
18623 push_it (it
, &pos
);
18625 if (STRINGP (prop
))
18627 if (SCHARS (prop
) == 0)
18634 it
->string_from_prefix_prop_p
= 1;
18635 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18636 it
->current
.overlay_string_index
= -1;
18637 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18638 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18639 it
->method
= GET_FROM_STRING
;
18640 it
->stop_charpos
= 0;
18642 it
->base_level_stop
= 0;
18644 /* Force paragraph direction to be that of the parent
18646 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18647 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18649 it
->paragraph_embedding
= L2R
;
18651 /* Set up the bidi iterator for this display string. */
18654 it
->bidi_it
.string
.lstring
= it
->string
;
18655 it
->bidi_it
.string
.s
= NULL
;
18656 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18657 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18658 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18659 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18660 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18663 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18665 it
->method
= GET_FROM_STRETCH
;
18668 #ifdef HAVE_WINDOW_SYSTEM
18669 else if (IMAGEP (prop
))
18671 it
->what
= IT_IMAGE
;
18672 it
->image_id
= lookup_image (it
->f
, prop
);
18673 it
->method
= GET_FROM_IMAGE
;
18675 #endif /* HAVE_WINDOW_SYSTEM */
18678 pop_it (it
); /* bogus display property, give up */
18685 /* Return the character-property PROP at the current position in IT. */
18688 get_it_property (struct it
*it
, Lisp_Object prop
)
18690 Lisp_Object position
;
18692 if (STRINGP (it
->object
))
18693 position
= make_number (IT_STRING_CHARPOS (*it
));
18694 else if (BUFFERP (it
->object
))
18695 position
= make_number (IT_CHARPOS (*it
));
18699 return Fget_char_property (position
, prop
, it
->object
);
18702 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18705 handle_line_prefix (struct it
*it
)
18707 Lisp_Object prefix
;
18709 if (it
->continuation_lines_width
> 0)
18711 prefix
= get_it_property (it
, Qwrap_prefix
);
18713 prefix
= Vwrap_prefix
;
18717 prefix
= get_it_property (it
, Qline_prefix
);
18719 prefix
= Vline_prefix
;
18721 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
18723 /* If the prefix is wider than the window, and we try to wrap
18724 it, it would acquire its own wrap prefix, and so on till the
18725 iterator stack overflows. So, don't wrap the prefix. */
18726 it
->line_wrap
= TRUNCATE
;
18727 it
->avoid_cursor_p
= 1;
18733 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18734 only for R2L lines from display_line and display_string, when they
18735 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18736 the line/string needs to be continued on the next glyph row. */
18738 unproduce_glyphs (struct it
*it
, int n
)
18740 struct glyph
*glyph
, *end
;
18742 xassert (it
->glyph_row
);
18743 xassert (it
->glyph_row
->reversed_p
);
18744 xassert (it
->area
== TEXT_AREA
);
18745 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18747 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18748 n
= it
->glyph_row
->used
[TEXT_AREA
];
18749 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18750 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18751 for ( ; glyph
< end
; glyph
++)
18752 glyph
[-n
] = *glyph
;
18755 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18756 and ROW->maxpos. */
18758 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18759 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18760 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18762 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18763 lines' rows is implemented for bidi-reordered rows. */
18765 /* ROW->minpos is the value of min_pos, the minimal buffer position
18766 we have in ROW, or ROW->start.pos if that is smaller. */
18767 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18768 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18770 /* We didn't find buffer positions smaller than ROW->start, or
18771 didn't find _any_ valid buffer positions in any of the glyphs,
18772 so we must trust the iterator's computed positions. */
18773 row
->minpos
= row
->start
.pos
;
18776 max_pos
= CHARPOS (it
->current
.pos
);
18777 max_bpos
= BYTEPOS (it
->current
.pos
);
18780 /* Here are the various use-cases for ending the row, and the
18781 corresponding values for ROW->maxpos:
18783 Line ends in a newline from buffer eol_pos + 1
18784 Line is continued from buffer max_pos + 1
18785 Line is truncated on right it->current.pos
18786 Line ends in a newline from string max_pos + 1(*)
18787 (*) + 1 only when line ends in a forward scan
18788 Line is continued from string max_pos
18789 Line is continued from display vector max_pos
18790 Line is entirely from a string min_pos == max_pos
18791 Line is entirely from a display vector min_pos == max_pos
18792 Line that ends at ZV ZV
18794 If you discover other use-cases, please add them here as
18796 if (row
->ends_at_zv_p
)
18797 row
->maxpos
= it
->current
.pos
;
18798 else if (row
->used
[TEXT_AREA
])
18800 int seen_this_string
= 0;
18801 struct glyph_row
*r1
= row
- 1;
18803 /* Did we see the same display string on the previous row? */
18804 if (STRINGP (it
->object
)
18805 /* this is not the first row */
18806 && row
> it
->w
->desired_matrix
->rows
18807 /* previous row is not the header line */
18808 && !r1
->mode_line_p
18809 /* previous row also ends in a newline from a string */
18810 && r1
->ends_in_newline_from_string_p
)
18812 struct glyph
*start
, *end
;
18814 /* Search for the last glyph of the previous row that came
18815 from buffer or string. Depending on whether the row is
18816 L2R or R2L, we need to process it front to back or the
18817 other way round. */
18818 if (!r1
->reversed_p
)
18820 start
= r1
->glyphs
[TEXT_AREA
];
18821 end
= start
+ r1
->used
[TEXT_AREA
];
18822 /* Glyphs inserted by redisplay have an integer (zero)
18823 as their object. */
18825 && INTEGERP ((end
- 1)->object
)
18826 && (end
- 1)->charpos
<= 0)
18830 if (EQ ((end
- 1)->object
, it
->object
))
18831 seen_this_string
= 1;
18834 /* If all the glyphs of the previous row were inserted
18835 by redisplay, it means the previous row was
18836 produced from a single newline, which is only
18837 possible if that newline came from the same string
18838 as the one which produced this ROW. */
18839 seen_this_string
= 1;
18843 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18844 start
= end
+ r1
->used
[TEXT_AREA
];
18846 && INTEGERP ((end
+ 1)->object
)
18847 && (end
+ 1)->charpos
<= 0)
18851 if (EQ ((end
+ 1)->object
, it
->object
))
18852 seen_this_string
= 1;
18855 seen_this_string
= 1;
18858 /* Take note of each display string that covers a newline only
18859 once, the first time we see it. This is for when a display
18860 string includes more than one newline in it. */
18861 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18863 /* If we were scanning the buffer forward when we displayed
18864 the string, we want to account for at least one buffer
18865 position that belongs to this row (position covered by
18866 the display string), so that cursor positioning will
18867 consider this row as a candidate when point is at the end
18868 of the visual line represented by this row. This is not
18869 required when scanning back, because max_pos will already
18870 have a much larger value. */
18871 if (CHARPOS (row
->end
.pos
) > max_pos
)
18872 INC_BOTH (max_pos
, max_bpos
);
18873 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18875 else if (CHARPOS (it
->eol_pos
) > 0)
18876 SET_TEXT_POS (row
->maxpos
,
18877 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18878 else if (row
->continued_p
)
18880 /* If max_pos is different from IT's current position, it
18881 means IT->method does not belong to the display element
18882 at max_pos. However, it also means that the display
18883 element at max_pos was displayed in its entirety on this
18884 line, which is equivalent to saying that the next line
18885 starts at the next buffer position. */
18886 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18887 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18890 INC_BOTH (max_pos
, max_bpos
);
18891 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18894 else if (row
->truncated_on_right_p
)
18895 /* display_line already called reseat_at_next_visible_line_start,
18896 which puts the iterator at the beginning of the next line, in
18897 the logical order. */
18898 row
->maxpos
= it
->current
.pos
;
18899 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18900 /* A line that is entirely from a string/image/stretch... */
18901 row
->maxpos
= row
->minpos
;
18906 row
->maxpos
= it
->current
.pos
;
18909 /* Construct the glyph row IT->glyph_row in the desired matrix of
18910 IT->w from text at the current position of IT. See dispextern.h
18911 for an overview of struct it. Value is non-zero if
18912 IT->glyph_row displays text, as opposed to a line displaying ZV
18916 display_line (struct it
*it
)
18918 struct glyph_row
*row
= it
->glyph_row
;
18919 Lisp_Object overlay_arrow_string
;
18921 void *wrap_data
= NULL
;
18922 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18923 int wrap_row_used
= -1;
18924 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18925 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18926 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18927 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18928 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18930 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18931 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18933 /* We always start displaying at hpos zero even if hscrolled. */
18934 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18936 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18937 >= it
->w
->desired_matrix
->nrows
)
18939 it
->w
->nrows_scale_factor
++;
18940 fonts_changed_p
= 1;
18944 /* Is IT->w showing the region? */
18945 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18947 /* Clear the result glyph row and enable it. */
18948 prepare_desired_row (row
);
18950 row
->y
= it
->current_y
;
18951 row
->start
= it
->start
;
18952 row
->continuation_lines_width
= it
->continuation_lines_width
;
18953 row
->displays_text_p
= 1;
18954 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18955 it
->starts_in_middle_of_char_p
= 0;
18957 /* Arrange the overlays nicely for our purposes. Usually, we call
18958 display_line on only one line at a time, in which case this
18959 can't really hurt too much, or we call it on lines which appear
18960 one after another in the buffer, in which case all calls to
18961 recenter_overlay_lists but the first will be pretty cheap. */
18962 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18964 /* Move over display elements that are not visible because we are
18965 hscrolled. This may stop at an x-position < IT->first_visible_x
18966 if the first glyph is partially visible or if we hit a line end. */
18967 if (it
->current_x
< it
->first_visible_x
)
18969 this_line_min_pos
= row
->start
.pos
;
18970 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18971 MOVE_TO_POS
| MOVE_TO_X
);
18972 /* Record the smallest positions seen while we moved over
18973 display elements that are not visible. This is needed by
18974 redisplay_internal for optimizing the case where the cursor
18975 stays inside the same line. The rest of this function only
18976 considers positions that are actually displayed, so
18977 RECORD_MAX_MIN_POS will not otherwise record positions that
18978 are hscrolled to the left of the left edge of the window. */
18979 min_pos
= CHARPOS (this_line_min_pos
);
18980 min_bpos
= BYTEPOS (this_line_min_pos
);
18984 /* We only do this when not calling `move_it_in_display_line_to'
18985 above, because move_it_in_display_line_to calls
18986 handle_line_prefix itself. */
18987 handle_line_prefix (it
);
18990 /* Get the initial row height. This is either the height of the
18991 text hscrolled, if there is any, or zero. */
18992 row
->ascent
= it
->max_ascent
;
18993 row
->height
= it
->max_ascent
+ it
->max_descent
;
18994 row
->phys_ascent
= it
->max_phys_ascent
;
18995 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18996 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18998 /* Utility macro to record max and min buffer positions seen until now. */
18999 #define RECORD_MAX_MIN_POS(IT) \
19002 int composition_p = !STRINGP ((IT)->string) \
19003 && ((IT)->what == IT_COMPOSITION); \
19004 EMACS_INT current_pos = \
19005 composition_p ? (IT)->cmp_it.charpos \
19006 : IT_CHARPOS (*(IT)); \
19007 EMACS_INT current_bpos = \
19008 composition_p ? CHAR_TO_BYTE (current_pos) \
19009 : IT_BYTEPOS (*(IT)); \
19010 if (current_pos < min_pos) \
19012 min_pos = current_pos; \
19013 min_bpos = current_bpos; \
19015 if (IT_CHARPOS (*it) > max_pos) \
19017 max_pos = IT_CHARPOS (*it); \
19018 max_bpos = IT_BYTEPOS (*it); \
19023 /* Loop generating characters. The loop is left with IT on the next
19024 character to display. */
19027 int n_glyphs_before
, hpos_before
, x_before
;
19029 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19031 /* Retrieve the next thing to display. Value is zero if end of
19033 if (!get_next_display_element (it
))
19035 /* Maybe add a space at the end of this line that is used to
19036 display the cursor there under X. Set the charpos of the
19037 first glyph of blank lines not corresponding to any text
19039 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19040 row
->exact_window_width_line_p
= 1;
19041 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19042 || row
->used
[TEXT_AREA
] == 0)
19044 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19045 row
->displays_text_p
= 0;
19047 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19048 && (!MINI_WINDOW_P (it
->w
)
19049 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19050 row
->indicate_empty_line_p
= 1;
19053 it
->continuation_lines_width
= 0;
19054 row
->ends_at_zv_p
= 1;
19055 /* A row that displays right-to-left text must always have
19056 its last face extended all the way to the end of line,
19057 even if this row ends in ZV, because we still write to
19058 the screen left to right. We also need to extend the
19059 last face if the default face is remapped to some
19060 different face, otherwise the functions that clear
19061 portions of the screen will clear with the default face's
19062 background color. */
19063 if (row
->reversed_p
19064 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19065 extend_face_to_end_of_line (it
);
19069 /* Now, get the metrics of what we want to display. This also
19070 generates glyphs in `row' (which is IT->glyph_row). */
19071 n_glyphs_before
= row
->used
[TEXT_AREA
];
19074 /* Remember the line height so far in case the next element doesn't
19075 fit on the line. */
19076 if (it
->line_wrap
!= TRUNCATE
)
19078 ascent
= it
->max_ascent
;
19079 descent
= it
->max_descent
;
19080 phys_ascent
= it
->max_phys_ascent
;
19081 phys_descent
= it
->max_phys_descent
;
19083 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19085 if (IT_DISPLAYING_WHITESPACE (it
))
19089 SAVE_IT (wrap_it
, *it
, wrap_data
);
19091 wrap_row_used
= row
->used
[TEXT_AREA
];
19092 wrap_row_ascent
= row
->ascent
;
19093 wrap_row_height
= row
->height
;
19094 wrap_row_phys_ascent
= row
->phys_ascent
;
19095 wrap_row_phys_height
= row
->phys_height
;
19096 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19097 wrap_row_min_pos
= min_pos
;
19098 wrap_row_min_bpos
= min_bpos
;
19099 wrap_row_max_pos
= max_pos
;
19100 wrap_row_max_bpos
= max_bpos
;
19106 PRODUCE_GLYPHS (it
);
19108 /* If this display element was in marginal areas, continue with
19110 if (it
->area
!= TEXT_AREA
)
19112 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19113 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19114 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19115 row
->phys_height
= max (row
->phys_height
,
19116 it
->max_phys_ascent
+ it
->max_phys_descent
);
19117 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19118 it
->max_extra_line_spacing
);
19119 set_iterator_to_next (it
, 1);
19123 /* Does the display element fit on the line? If we truncate
19124 lines, we should draw past the right edge of the window. If
19125 we don't truncate, we want to stop so that we can display the
19126 continuation glyph before the right margin. If lines are
19127 continued, there are two possible strategies for characters
19128 resulting in more than 1 glyph (e.g. tabs): Display as many
19129 glyphs as possible in this line and leave the rest for the
19130 continuation line, or display the whole element in the next
19131 line. Original redisplay did the former, so we do it also. */
19132 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19133 hpos_before
= it
->hpos
;
19136 if (/* Not a newline. */
19138 /* Glyphs produced fit entirely in the line. */
19139 && it
->current_x
< it
->last_visible_x
)
19141 it
->hpos
+= nglyphs
;
19142 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19143 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19144 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19145 row
->phys_height
= max (row
->phys_height
,
19146 it
->max_phys_ascent
+ it
->max_phys_descent
);
19147 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19148 it
->max_extra_line_spacing
);
19149 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19150 row
->x
= x
- it
->first_visible_x
;
19151 /* Record the maximum and minimum buffer positions seen so
19152 far in glyphs that will be displayed by this row. */
19154 RECORD_MAX_MIN_POS (it
);
19159 struct glyph
*glyph
;
19161 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19163 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19164 new_x
= x
+ glyph
->pixel_width
;
19166 if (/* Lines are continued. */
19167 it
->line_wrap
!= TRUNCATE
19168 && (/* Glyph doesn't fit on the line. */
19169 new_x
> it
->last_visible_x
19170 /* Or it fits exactly on a window system frame. */
19171 || (new_x
== it
->last_visible_x
19172 && FRAME_WINDOW_P (it
->f
))))
19174 /* End of a continued line. */
19177 || (new_x
== it
->last_visible_x
19178 && FRAME_WINDOW_P (it
->f
)))
19180 /* Current glyph is the only one on the line or
19181 fits exactly on the line. We must continue
19182 the line because we can't draw the cursor
19183 after the glyph. */
19184 row
->continued_p
= 1;
19185 it
->current_x
= new_x
;
19186 it
->continuation_lines_width
+= new_x
;
19188 if (i
== nglyphs
- 1)
19190 /* If line-wrap is on, check if a previous
19191 wrap point was found. */
19192 if (wrap_row_used
> 0
19193 /* Even if there is a previous wrap
19194 point, continue the line here as
19195 usual, if (i) the previous character
19196 was a space or tab AND (ii) the
19197 current character is not. */
19199 || IT_DISPLAYING_WHITESPACE (it
)))
19202 /* Record the maximum and minimum buffer
19203 positions seen so far in glyphs that will be
19204 displayed by this row. */
19206 RECORD_MAX_MIN_POS (it
);
19207 set_iterator_to_next (it
, 1);
19208 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19210 if (!get_next_display_element (it
))
19212 row
->exact_window_width_line_p
= 1;
19213 it
->continuation_lines_width
= 0;
19214 row
->continued_p
= 0;
19215 row
->ends_at_zv_p
= 1;
19217 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19219 row
->continued_p
= 0;
19220 row
->exact_window_width_line_p
= 1;
19224 else if (it
->bidi_p
)
19225 RECORD_MAX_MIN_POS (it
);
19227 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19228 && !FRAME_WINDOW_P (it
->f
))
19230 /* A padding glyph that doesn't fit on this line.
19231 This means the whole character doesn't fit
19233 if (row
->reversed_p
)
19234 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19235 - n_glyphs_before
);
19236 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19238 /* Fill the rest of the row with continuation
19239 glyphs like in 20.x. */
19240 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19241 < row
->glyphs
[1 + TEXT_AREA
])
19242 produce_special_glyphs (it
, IT_CONTINUATION
);
19244 row
->continued_p
= 1;
19245 it
->current_x
= x_before
;
19246 it
->continuation_lines_width
+= x_before
;
19248 /* Restore the height to what it was before the
19249 element not fitting on the line. */
19250 it
->max_ascent
= ascent
;
19251 it
->max_descent
= descent
;
19252 it
->max_phys_ascent
= phys_ascent
;
19253 it
->max_phys_descent
= phys_descent
;
19255 else if (wrap_row_used
> 0)
19258 if (row
->reversed_p
)
19259 unproduce_glyphs (it
,
19260 row
->used
[TEXT_AREA
] - wrap_row_used
);
19261 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19262 it
->continuation_lines_width
+= wrap_x
;
19263 row
->used
[TEXT_AREA
] = wrap_row_used
;
19264 row
->ascent
= wrap_row_ascent
;
19265 row
->height
= wrap_row_height
;
19266 row
->phys_ascent
= wrap_row_phys_ascent
;
19267 row
->phys_height
= wrap_row_phys_height
;
19268 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19269 min_pos
= wrap_row_min_pos
;
19270 min_bpos
= wrap_row_min_bpos
;
19271 max_pos
= wrap_row_max_pos
;
19272 max_bpos
= wrap_row_max_bpos
;
19273 row
->continued_p
= 1;
19274 row
->ends_at_zv_p
= 0;
19275 row
->exact_window_width_line_p
= 0;
19276 it
->continuation_lines_width
+= x
;
19278 /* Make sure that a non-default face is extended
19279 up to the right margin of the window. */
19280 extend_face_to_end_of_line (it
);
19282 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19284 /* A TAB that extends past the right edge of the
19285 window. This produces a single glyph on
19286 window system frames. We leave the glyph in
19287 this row and let it fill the row, but don't
19288 consume the TAB. */
19289 it
->continuation_lines_width
+= it
->last_visible_x
;
19290 row
->ends_in_middle_of_char_p
= 1;
19291 row
->continued_p
= 1;
19292 glyph
->pixel_width
= it
->last_visible_x
- x
;
19293 it
->starts_in_middle_of_char_p
= 1;
19297 /* Something other than a TAB that draws past
19298 the right edge of the window. Restore
19299 positions to values before the element. */
19300 if (row
->reversed_p
)
19301 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19302 - (n_glyphs_before
+ i
));
19303 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19305 /* Display continuation glyphs. */
19306 if (!FRAME_WINDOW_P (it
->f
))
19307 produce_special_glyphs (it
, IT_CONTINUATION
);
19308 row
->continued_p
= 1;
19310 it
->current_x
= x_before
;
19311 it
->continuation_lines_width
+= x
;
19312 extend_face_to_end_of_line (it
);
19314 if (nglyphs
> 1 && i
> 0)
19316 row
->ends_in_middle_of_char_p
= 1;
19317 it
->starts_in_middle_of_char_p
= 1;
19320 /* Restore the height to what it was before the
19321 element not fitting on the line. */
19322 it
->max_ascent
= ascent
;
19323 it
->max_descent
= descent
;
19324 it
->max_phys_ascent
= phys_ascent
;
19325 it
->max_phys_descent
= phys_descent
;
19330 else if (new_x
> it
->first_visible_x
)
19332 /* Increment number of glyphs actually displayed. */
19335 /* Record the maximum and minimum buffer positions
19336 seen so far in glyphs that will be displayed by
19339 RECORD_MAX_MIN_POS (it
);
19341 if (x
< it
->first_visible_x
)
19342 /* Glyph is partially visible, i.e. row starts at
19343 negative X position. */
19344 row
->x
= x
- it
->first_visible_x
;
19348 /* Glyph is completely off the left margin of the
19349 window. This should not happen because of the
19350 move_it_in_display_line at the start of this
19351 function, unless the text display area of the
19352 window is empty. */
19353 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19356 /* Even if this display element produced no glyphs at all,
19357 we want to record its position. */
19358 if (it
->bidi_p
&& nglyphs
== 0)
19359 RECORD_MAX_MIN_POS (it
);
19361 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19362 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19363 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19364 row
->phys_height
= max (row
->phys_height
,
19365 it
->max_phys_ascent
+ it
->max_phys_descent
);
19366 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19367 it
->max_extra_line_spacing
);
19369 /* End of this display line if row is continued. */
19370 if (row
->continued_p
|| row
->ends_at_zv_p
)
19375 /* Is this a line end? If yes, we're also done, after making
19376 sure that a non-default face is extended up to the right
19377 margin of the window. */
19378 if (ITERATOR_AT_END_OF_LINE_P (it
))
19380 int used_before
= row
->used
[TEXT_AREA
];
19382 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19384 /* Add a space at the end of the line that is used to
19385 display the cursor there. */
19386 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19387 append_space_for_newline (it
, 0);
19389 /* Extend the face to the end of the line. */
19390 extend_face_to_end_of_line (it
);
19392 /* Make sure we have the position. */
19393 if (used_before
== 0)
19394 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19396 /* Record the position of the newline, for use in
19398 it
->eol_pos
= it
->current
.pos
;
19400 /* Consume the line end. This skips over invisible lines. */
19401 set_iterator_to_next (it
, 1);
19402 it
->continuation_lines_width
= 0;
19406 /* Proceed with next display element. Note that this skips
19407 over lines invisible because of selective display. */
19408 set_iterator_to_next (it
, 1);
19410 /* If we truncate lines, we are done when the last displayed
19411 glyphs reach past the right margin of the window. */
19412 if (it
->line_wrap
== TRUNCATE
19413 && (FRAME_WINDOW_P (it
->f
)
19414 ? (it
->current_x
>= it
->last_visible_x
)
19415 : (it
->current_x
> it
->last_visible_x
)))
19417 /* Maybe add truncation glyphs. */
19418 if (!FRAME_WINDOW_P (it
->f
))
19422 if (!row
->reversed_p
)
19424 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19425 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19430 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19431 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19433 /* Remove any padding glyphs at the front of ROW, to
19434 make room for the truncation glyphs we will be
19435 adding below. The loop below always inserts at
19436 least one truncation glyph, so also remove the
19437 last glyph added to ROW. */
19438 unproduce_glyphs (it
, i
+ 1);
19439 /* Adjust i for the loop below. */
19440 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19443 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19445 row
->used
[TEXT_AREA
] = i
;
19446 produce_special_glyphs (it
, IT_TRUNCATION
);
19449 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19451 /* Don't truncate if we can overflow newline into fringe. */
19452 if (!get_next_display_element (it
))
19454 it
->continuation_lines_width
= 0;
19455 row
->ends_at_zv_p
= 1;
19456 row
->exact_window_width_line_p
= 1;
19459 if (ITERATOR_AT_END_OF_LINE_P (it
))
19461 row
->exact_window_width_line_p
= 1;
19462 goto at_end_of_line
;
19466 row
->truncated_on_right_p
= 1;
19467 it
->continuation_lines_width
= 0;
19468 reseat_at_next_visible_line_start (it
, 0);
19469 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19470 it
->hpos
= hpos_before
;
19471 it
->current_x
= x_before
;
19477 bidi_unshelve_cache (wrap_data
, 1);
19479 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19480 at the left window margin. */
19481 if (it
->first_visible_x
19482 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19484 if (!FRAME_WINDOW_P (it
->f
))
19485 insert_left_trunc_glyphs (it
);
19486 row
->truncated_on_left_p
= 1;
19489 /* Remember the position at which this line ends.
19491 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19492 cannot be before the call to find_row_edges below, since that is
19493 where these positions are determined. */
19494 row
->end
= it
->current
;
19497 row
->minpos
= row
->start
.pos
;
19498 row
->maxpos
= row
->end
.pos
;
19502 /* ROW->minpos and ROW->maxpos must be the smallest and
19503 `1 + the largest' buffer positions in ROW. But if ROW was
19504 bidi-reordered, these two positions can be anywhere in the
19505 row, so we must determine them now. */
19506 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19509 /* If the start of this line is the overlay arrow-position, then
19510 mark this glyph row as the one containing the overlay arrow.
19511 This is clearly a mess with variable size fonts. It would be
19512 better to let it be displayed like cursors under X. */
19513 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19514 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19515 !NILP (overlay_arrow_string
)))
19517 /* Overlay arrow in window redisplay is a fringe bitmap. */
19518 if (STRINGP (overlay_arrow_string
))
19520 struct glyph_row
*arrow_row
19521 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19522 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19523 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19524 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19525 struct glyph
*p2
, *end
;
19527 /* Copy the arrow glyphs. */
19528 while (glyph
< arrow_end
)
19531 /* Throw away padding glyphs. */
19533 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19534 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19540 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19545 xassert (INTEGERP (overlay_arrow_string
));
19546 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19548 overlay_arrow_seen
= 1;
19551 /* Highlight trailing whitespace. */
19552 if (!NILP (Vshow_trailing_whitespace
))
19553 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19555 /* Compute pixel dimensions of this line. */
19556 compute_line_metrics (it
);
19558 /* Implementation note: No changes in the glyphs of ROW or in their
19559 faces can be done past this point, because compute_line_metrics
19560 computes ROW's hash value and stores it within the glyph_row
19563 /* Record whether this row ends inside an ellipsis. */
19564 row
->ends_in_ellipsis_p
19565 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19566 && it
->ellipsis_p
);
19568 /* Save fringe bitmaps in this row. */
19569 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19570 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19571 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19572 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19574 it
->left_user_fringe_bitmap
= 0;
19575 it
->left_user_fringe_face_id
= 0;
19576 it
->right_user_fringe_bitmap
= 0;
19577 it
->right_user_fringe_face_id
= 0;
19579 /* Maybe set the cursor. */
19580 cvpos
= it
->w
->cursor
.vpos
;
19582 /* In bidi-reordered rows, keep checking for proper cursor
19583 position even if one has been found already, because buffer
19584 positions in such rows change non-linearly with ROW->VPOS,
19585 when a line is continued. One exception: when we are at ZV,
19586 display cursor on the first suitable glyph row, since all
19587 the empty rows after that also have their position set to ZV. */
19588 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19589 lines' rows is implemented for bidi-reordered rows. */
19591 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19592 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19593 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19594 && cursor_row_p (row
))
19595 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19597 /* Prepare for the next line. This line starts horizontally at (X
19598 HPOS) = (0 0). Vertical positions are incremented. As a
19599 convenience for the caller, IT->glyph_row is set to the next
19601 it
->current_x
= it
->hpos
= 0;
19602 it
->current_y
+= row
->height
;
19603 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19606 /* The next row should by default use the same value of the
19607 reversed_p flag as this one. set_iterator_to_next decides when
19608 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19609 the flag accordingly. */
19610 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19611 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19612 it
->start
= row
->end
;
19613 return row
->displays_text_p
;
19615 #undef RECORD_MAX_MIN_POS
19618 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19619 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19620 doc
: /* Return paragraph direction at point in BUFFER.
19621 Value is either `left-to-right' or `right-to-left'.
19622 If BUFFER is omitted or nil, it defaults to the current buffer.
19624 Paragraph direction determines how the text in the paragraph is displayed.
19625 In left-to-right paragraphs, text begins at the left margin of the window
19626 and the reading direction is generally left to right. In right-to-left
19627 paragraphs, text begins at the right margin and is read from right to left.
19629 See also `bidi-paragraph-direction'. */)
19630 (Lisp_Object buffer
)
19632 struct buffer
*buf
= current_buffer
;
19633 struct buffer
*old
= buf
;
19635 if (! NILP (buffer
))
19637 CHECK_BUFFER (buffer
);
19638 buf
= XBUFFER (buffer
);
19641 if (NILP (BVAR (buf
, bidi_display_reordering
))
19642 || NILP (BVAR (buf
, enable_multibyte_characters
))
19643 /* When we are loading loadup.el, the character property tables
19644 needed for bidi iteration are not yet available. */
19645 || !NILP (Vpurify_flag
))
19646 return Qleft_to_right
;
19647 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19648 return BVAR (buf
, bidi_paragraph_direction
);
19651 /* Determine the direction from buffer text. We could try to
19652 use current_matrix if it is up to date, but this seems fast
19653 enough as it is. */
19654 struct bidi_it itb
;
19655 EMACS_INT pos
= BUF_PT (buf
);
19656 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19658 void *itb_data
= bidi_shelve_cache ();
19660 set_buffer_temp (buf
);
19661 /* bidi_paragraph_init finds the base direction of the paragraph
19662 by searching forward from paragraph start. We need the base
19663 direction of the current or _previous_ paragraph, so we need
19664 to make sure we are within that paragraph. To that end, find
19665 the previous non-empty line. */
19666 if (pos
>= ZV
&& pos
> BEGV
)
19669 bytepos
= CHAR_TO_BYTE (pos
);
19671 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19672 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19674 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19675 || c
== ' ' || c
== '\t' || c
== '\f')
19677 if (bytepos
<= BEGV_BYTE
)
19682 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19685 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19686 itb
.paragraph_dir
= NEUTRAL_DIR
;
19687 itb
.string
.s
= NULL
;
19688 itb
.string
.lstring
= Qnil
;
19689 itb
.string
.bufpos
= 0;
19690 itb
.string
.unibyte
= 0;
19691 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19692 bidi_unshelve_cache (itb_data
, 0);
19693 set_buffer_temp (old
);
19694 switch (itb
.paragraph_dir
)
19697 return Qleft_to_right
;
19700 return Qright_to_left
;
19710 /***********************************************************************
19712 ***********************************************************************/
19714 /* Redisplay the menu bar in the frame for window W.
19716 The menu bar of X frames that don't have X toolkit support is
19717 displayed in a special window W->frame->menu_bar_window.
19719 The menu bar of terminal frames is treated specially as far as
19720 glyph matrices are concerned. Menu bar lines are not part of
19721 windows, so the update is done directly on the frame matrix rows
19722 for the menu bar. */
19725 display_menu_bar (struct window
*w
)
19727 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19732 /* Don't do all this for graphical frames. */
19734 if (FRAME_W32_P (f
))
19737 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19743 if (FRAME_NS_P (f
))
19745 #endif /* HAVE_NS */
19747 #ifdef USE_X_TOOLKIT
19748 xassert (!FRAME_WINDOW_P (f
));
19749 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19750 it
.first_visible_x
= 0;
19751 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19752 #else /* not USE_X_TOOLKIT */
19753 if (FRAME_WINDOW_P (f
))
19755 /* Menu bar lines are displayed in the desired matrix of the
19756 dummy window menu_bar_window. */
19757 struct window
*menu_w
;
19758 xassert (WINDOWP (f
->menu_bar_window
));
19759 menu_w
= XWINDOW (f
->menu_bar_window
);
19760 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19762 it
.first_visible_x
= 0;
19763 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19767 /* This is a TTY frame, i.e. character hpos/vpos are used as
19769 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19771 it
.first_visible_x
= 0;
19772 it
.last_visible_x
= FRAME_COLS (f
);
19774 #endif /* not USE_X_TOOLKIT */
19776 /* FIXME: This should be controlled by a user option. See the
19777 comments in redisplay_tool_bar and display_mode_line about
19779 it
.paragraph_embedding
= L2R
;
19781 if (! mode_line_inverse_video
)
19782 /* Force the menu-bar to be displayed in the default face. */
19783 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19785 /* Clear all rows of the menu bar. */
19786 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19788 struct glyph_row
*row
= it
.glyph_row
+ i
;
19789 clear_glyph_row (row
);
19790 row
->enabled_p
= 1;
19791 row
->full_width_p
= 1;
19794 /* Display all items of the menu bar. */
19795 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19796 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19798 Lisp_Object string
;
19800 /* Stop at nil string. */
19801 string
= AREF (items
, i
+ 1);
19805 /* Remember where item was displayed. */
19806 ASET (items
, i
+ 3, make_number (it
.hpos
));
19808 /* Display the item, pad with one space. */
19809 if (it
.current_x
< it
.last_visible_x
)
19810 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19811 SCHARS (string
) + 1, 0, 0, -1);
19814 /* Fill out the line with spaces. */
19815 if (it
.current_x
< it
.last_visible_x
)
19816 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19818 /* Compute the total height of the lines. */
19819 compute_line_metrics (&it
);
19824 /***********************************************************************
19826 ***********************************************************************/
19828 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19829 FORCE is non-zero, redisplay mode lines unconditionally.
19830 Otherwise, redisplay only mode lines that are garbaged. Value is
19831 the number of windows whose mode lines were redisplayed. */
19834 redisplay_mode_lines (Lisp_Object window
, int force
)
19838 while (!NILP (window
))
19840 struct window
*w
= XWINDOW (window
);
19842 if (WINDOWP (w
->hchild
))
19843 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19844 else if (WINDOWP (w
->vchild
))
19845 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19847 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19848 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19850 struct text_pos lpoint
;
19851 struct buffer
*old
= current_buffer
;
19853 /* Set the window's buffer for the mode line display. */
19854 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19855 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19857 /* Point refers normally to the selected window. For any
19858 other window, set up appropriate value. */
19859 if (!EQ (window
, selected_window
))
19861 struct text_pos pt
;
19863 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19864 if (CHARPOS (pt
) < BEGV
)
19865 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19866 else if (CHARPOS (pt
) > (ZV
- 1))
19867 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19869 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19872 /* Display mode lines. */
19873 clear_glyph_matrix (w
->desired_matrix
);
19874 if (display_mode_lines (w
))
19877 w
->must_be_updated_p
= 1;
19880 /* Restore old settings. */
19881 set_buffer_internal_1 (old
);
19882 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19892 /* Display the mode and/or header line of window W. Value is the
19893 sum number of mode lines and header lines displayed. */
19896 display_mode_lines (struct window
*w
)
19898 Lisp_Object old_selected_window
, old_selected_frame
;
19901 old_selected_frame
= selected_frame
;
19902 selected_frame
= w
->frame
;
19903 old_selected_window
= selected_window
;
19904 XSETWINDOW (selected_window
, w
);
19906 /* These will be set while the mode line specs are processed. */
19907 line_number_displayed
= 0;
19908 w
->column_number_displayed
= Qnil
;
19910 if (WINDOW_WANTS_MODELINE_P (w
))
19912 struct window
*sel_w
= XWINDOW (old_selected_window
);
19914 /* Select mode line face based on the real selected window. */
19915 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19916 BVAR (current_buffer
, mode_line_format
));
19920 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19922 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19923 BVAR (current_buffer
, header_line_format
));
19927 selected_frame
= old_selected_frame
;
19928 selected_window
= old_selected_window
;
19933 /* Display mode or header line of window W. FACE_ID specifies which
19934 line to display; it is either MODE_LINE_FACE_ID or
19935 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19936 display. Value is the pixel height of the mode/header line
19940 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19944 int count
= SPECPDL_INDEX ();
19946 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19947 /* Don't extend on a previously drawn mode-line.
19948 This may happen if called from pos_visible_p. */
19949 it
.glyph_row
->enabled_p
= 0;
19950 prepare_desired_row (it
.glyph_row
);
19952 it
.glyph_row
->mode_line_p
= 1;
19954 if (! mode_line_inverse_video
)
19955 /* Force the mode-line to be displayed in the default face. */
19956 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19958 /* FIXME: This should be controlled by a user option. But
19959 supporting such an option is not trivial, since the mode line is
19960 made up of many separate strings. */
19961 it
.paragraph_embedding
= L2R
;
19963 record_unwind_protect (unwind_format_mode_line
,
19964 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19966 mode_line_target
= MODE_LINE_DISPLAY
;
19968 /* Temporarily make frame's keyboard the current kboard so that
19969 kboard-local variables in the mode_line_format will get the right
19971 push_kboard (FRAME_KBOARD (it
.f
));
19972 record_unwind_save_match_data ();
19973 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19976 unbind_to (count
, Qnil
);
19978 /* Fill up with spaces. */
19979 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19981 compute_line_metrics (&it
);
19982 it
.glyph_row
->full_width_p
= 1;
19983 it
.glyph_row
->continued_p
= 0;
19984 it
.glyph_row
->truncated_on_left_p
= 0;
19985 it
.glyph_row
->truncated_on_right_p
= 0;
19987 /* Make a 3D mode-line have a shadow at its right end. */
19988 face
= FACE_FROM_ID (it
.f
, face_id
);
19989 extend_face_to_end_of_line (&it
);
19990 if (face
->box
!= FACE_NO_BOX
)
19992 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19993 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19994 last
->right_box_line_p
= 1;
19997 return it
.glyph_row
->height
;
20000 /* Move element ELT in LIST to the front of LIST.
20001 Return the updated list. */
20004 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
20006 register Lisp_Object tail
, prev
;
20007 register Lisp_Object tem
;
20011 while (CONSP (tail
))
20017 /* Splice out the link TAIL. */
20019 list
= XCDR (tail
);
20021 Fsetcdr (prev
, XCDR (tail
));
20023 /* Now make it the first. */
20024 Fsetcdr (tail
, list
);
20029 tail
= XCDR (tail
);
20033 /* Not found--return unchanged LIST. */
20037 /* Contribute ELT to the mode line for window IT->w. How it
20038 translates into text depends on its data type.
20040 IT describes the display environment in which we display, as usual.
20042 DEPTH is the depth in recursion. It is used to prevent
20043 infinite recursion here.
20045 FIELD_WIDTH is the number of characters the display of ELT should
20046 occupy in the mode line, and PRECISION is the maximum number of
20047 characters to display from ELT's representation. See
20048 display_string for details.
20050 Returns the hpos of the end of the text generated by ELT.
20052 PROPS is a property list to add to any string we encounter.
20054 If RISKY is nonzero, remove (disregard) any properties in any string
20055 we encounter, and ignore :eval and :propertize.
20057 The global variable `mode_line_target' determines whether the
20058 output is passed to `store_mode_line_noprop',
20059 `store_mode_line_string', or `display_string'. */
20062 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20063 Lisp_Object elt
, Lisp_Object props
, int risky
)
20065 int n
= 0, field
, prec
;
20070 elt
= build_string ("*too-deep*");
20074 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
20078 /* A string: output it and check for %-constructs within it. */
20080 EMACS_INT offset
= 0;
20082 if (SCHARS (elt
) > 0
20083 && (!NILP (props
) || risky
))
20085 Lisp_Object oprops
, aelt
;
20086 oprops
= Ftext_properties_at (make_number (0), elt
);
20088 /* If the starting string's properties are not what
20089 we want, translate the string. Also, if the string
20090 is risky, do that anyway. */
20092 if (NILP (Fequal (props
, oprops
)) || risky
)
20094 /* If the starting string has properties,
20095 merge the specified ones onto the existing ones. */
20096 if (! NILP (oprops
) && !risky
)
20100 oprops
= Fcopy_sequence (oprops
);
20102 while (CONSP (tem
))
20104 oprops
= Fplist_put (oprops
, XCAR (tem
),
20105 XCAR (XCDR (tem
)));
20106 tem
= XCDR (XCDR (tem
));
20111 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20112 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20114 /* AELT is what we want. Move it to the front
20115 without consing. */
20117 mode_line_proptrans_alist
20118 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20124 /* If AELT has the wrong props, it is useless.
20125 so get rid of it. */
20127 mode_line_proptrans_alist
20128 = Fdelq (aelt
, mode_line_proptrans_alist
);
20130 elt
= Fcopy_sequence (elt
);
20131 Fset_text_properties (make_number (0), Flength (elt
),
20133 /* Add this item to mode_line_proptrans_alist. */
20134 mode_line_proptrans_alist
20135 = Fcons (Fcons (elt
, props
),
20136 mode_line_proptrans_alist
);
20137 /* Truncate mode_line_proptrans_alist
20138 to at most 50 elements. */
20139 tem
= Fnthcdr (make_number (50),
20140 mode_line_proptrans_alist
);
20142 XSETCDR (tem
, Qnil
);
20151 prec
= precision
- n
;
20152 switch (mode_line_target
)
20154 case MODE_LINE_NOPROP
:
20155 case MODE_LINE_TITLE
:
20156 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20158 case MODE_LINE_STRING
:
20159 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20161 case MODE_LINE_DISPLAY
:
20162 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20163 0, prec
, 0, STRING_MULTIBYTE (elt
));
20170 /* Handle the non-literal case. */
20172 while ((precision
<= 0 || n
< precision
)
20173 && SREF (elt
, offset
) != 0
20174 && (mode_line_target
!= MODE_LINE_DISPLAY
20175 || it
->current_x
< it
->last_visible_x
))
20177 EMACS_INT last_offset
= offset
;
20179 /* Advance to end of string or next format specifier. */
20180 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20183 if (offset
- 1 != last_offset
)
20185 EMACS_INT nchars
, nbytes
;
20187 /* Output to end of string or up to '%'. Field width
20188 is length of string. Don't output more than
20189 PRECISION allows us. */
20192 prec
= c_string_width (SDATA (elt
) + last_offset
,
20193 offset
- last_offset
, precision
- n
,
20196 switch (mode_line_target
)
20198 case MODE_LINE_NOPROP
:
20199 case MODE_LINE_TITLE
:
20200 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20202 case MODE_LINE_STRING
:
20204 EMACS_INT bytepos
= last_offset
;
20205 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20206 EMACS_INT endpos
= (precision
<= 0
20207 ? string_byte_to_char (elt
, offset
)
20208 : charpos
+ nchars
);
20210 n
+= store_mode_line_string (NULL
,
20211 Fsubstring (elt
, make_number (charpos
),
20212 make_number (endpos
)),
20216 case MODE_LINE_DISPLAY
:
20218 EMACS_INT bytepos
= last_offset
;
20219 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20221 if (precision
<= 0)
20222 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20223 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20225 STRING_MULTIBYTE (elt
));
20230 else /* c == '%' */
20232 EMACS_INT percent_position
= offset
;
20234 /* Get the specified minimum width. Zero means
20237 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20238 field
= field
* 10 + c
- '0';
20240 /* Don't pad beyond the total padding allowed. */
20241 if (field_width
- n
> 0 && field
> field_width
- n
)
20242 field
= field_width
- n
;
20244 /* Note that either PRECISION <= 0 or N < PRECISION. */
20245 prec
= precision
- n
;
20248 n
+= display_mode_element (it
, depth
, field
, prec
,
20249 Vglobal_mode_string
, props
,
20254 EMACS_INT bytepos
, charpos
;
20256 Lisp_Object string
;
20258 bytepos
= percent_position
;
20259 charpos
= (STRING_MULTIBYTE (elt
)
20260 ? string_byte_to_char (elt
, bytepos
)
20262 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20263 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20265 switch (mode_line_target
)
20267 case MODE_LINE_NOPROP
:
20268 case MODE_LINE_TITLE
:
20269 n
+= store_mode_line_noprop (spec
, field
, prec
);
20271 case MODE_LINE_STRING
:
20273 Lisp_Object tem
= build_string (spec
);
20274 props
= Ftext_properties_at (make_number (charpos
), elt
);
20275 /* Should only keep face property in props */
20276 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20279 case MODE_LINE_DISPLAY
:
20281 int nglyphs_before
, nwritten
;
20283 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20284 nwritten
= display_string (spec
, string
, elt
,
20289 /* Assign to the glyphs written above the
20290 string where the `%x' came from, position
20294 struct glyph
*glyph
20295 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20299 for (i
= 0; i
< nwritten
; ++i
)
20301 glyph
[i
].object
= elt
;
20302 glyph
[i
].charpos
= charpos
;
20319 /* A symbol: process the value of the symbol recursively
20320 as if it appeared here directly. Avoid error if symbol void.
20321 Special case: if value of symbol is a string, output the string
20324 register Lisp_Object tem
;
20326 /* If the variable is not marked as risky to set
20327 then its contents are risky to use. */
20328 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20331 tem
= Fboundp (elt
);
20334 tem
= Fsymbol_value (elt
);
20335 /* If value is a string, output that string literally:
20336 don't check for % within it. */
20340 if (!EQ (tem
, elt
))
20342 /* Give up right away for nil or t. */
20352 register Lisp_Object car
, tem
;
20354 /* A cons cell: five distinct cases.
20355 If first element is :eval or :propertize, do something special.
20356 If first element is a string or a cons, process all the elements
20357 and effectively concatenate them.
20358 If first element is a negative number, truncate displaying cdr to
20359 at most that many characters. If positive, pad (with spaces)
20360 to at least that many characters.
20361 If first element is a symbol, process the cadr or caddr recursively
20362 according to whether the symbol's value is non-nil or nil. */
20364 if (EQ (car
, QCeval
))
20366 /* An element of the form (:eval FORM) means evaluate FORM
20367 and use the result as mode line elements. */
20372 if (CONSP (XCDR (elt
)))
20375 spec
= safe_eval (XCAR (XCDR (elt
)));
20376 n
+= display_mode_element (it
, depth
, field_width
- n
,
20377 precision
- n
, spec
, props
,
20381 else if (EQ (car
, QCpropertize
))
20383 /* An element of the form (:propertize ELT PROPS...)
20384 means display ELT but applying properties PROPS. */
20389 if (CONSP (XCDR (elt
)))
20390 n
+= display_mode_element (it
, depth
, field_width
- n
,
20391 precision
- n
, XCAR (XCDR (elt
)),
20392 XCDR (XCDR (elt
)), risky
);
20394 else if (SYMBOLP (car
))
20396 tem
= Fboundp (car
);
20400 /* elt is now the cdr, and we know it is a cons cell.
20401 Use its car if CAR has a non-nil value. */
20404 tem
= Fsymbol_value (car
);
20411 /* Symbol's value is nil (or symbol is unbound)
20412 Get the cddr of the original list
20413 and if possible find the caddr and use that. */
20417 else if (!CONSP (elt
))
20422 else if (INTEGERP (car
))
20424 register int lim
= XINT (car
);
20428 /* Negative int means reduce maximum width. */
20429 if (precision
<= 0)
20432 precision
= min (precision
, -lim
);
20436 /* Padding specified. Don't let it be more than
20437 current maximum. */
20439 lim
= min (precision
, lim
);
20441 /* If that's more padding than already wanted, queue it.
20442 But don't reduce padding already specified even if
20443 that is beyond the current truncation point. */
20444 field_width
= max (lim
, field_width
);
20448 else if (STRINGP (car
) || CONSP (car
))
20450 Lisp_Object halftail
= elt
;
20454 && (precision
<= 0 || n
< precision
))
20456 n
+= display_mode_element (it
, depth
,
20457 /* Do padding only after the last
20458 element in the list. */
20459 (! CONSP (XCDR (elt
))
20462 precision
- n
, XCAR (elt
),
20466 if ((len
& 1) == 0)
20467 halftail
= XCDR (halftail
);
20468 /* Check for cycle. */
20469 if (EQ (halftail
, elt
))
20478 elt
= build_string ("*invalid*");
20482 /* Pad to FIELD_WIDTH. */
20483 if (field_width
> 0 && n
< field_width
)
20485 switch (mode_line_target
)
20487 case MODE_LINE_NOPROP
:
20488 case MODE_LINE_TITLE
:
20489 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20491 case MODE_LINE_STRING
:
20492 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20494 case MODE_LINE_DISPLAY
:
20495 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20504 /* Store a mode-line string element in mode_line_string_list.
20506 If STRING is non-null, display that C string. Otherwise, the Lisp
20507 string LISP_STRING is displayed.
20509 FIELD_WIDTH is the minimum number of output glyphs to produce.
20510 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20511 with spaces. FIELD_WIDTH <= 0 means don't pad.
20513 PRECISION is the maximum number of characters to output from
20514 STRING. PRECISION <= 0 means don't truncate the string.
20516 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20517 properties to the string.
20519 PROPS are the properties to add to the string.
20520 The mode_line_string_face face property is always added to the string.
20524 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20525 int field_width
, int precision
, Lisp_Object props
)
20530 if (string
!= NULL
)
20532 len
= strlen (string
);
20533 if (precision
> 0 && len
> precision
)
20535 lisp_string
= make_string (string
, len
);
20537 props
= mode_line_string_face_prop
;
20538 else if (!NILP (mode_line_string_face
))
20540 Lisp_Object face
= Fplist_get (props
, Qface
);
20541 props
= Fcopy_sequence (props
);
20543 face
= mode_line_string_face
;
20545 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20546 props
= Fplist_put (props
, Qface
, face
);
20548 Fadd_text_properties (make_number (0), make_number (len
),
20549 props
, lisp_string
);
20553 len
= XFASTINT (Flength (lisp_string
));
20554 if (precision
> 0 && len
> precision
)
20557 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20560 if (!NILP (mode_line_string_face
))
20564 props
= Ftext_properties_at (make_number (0), lisp_string
);
20565 face
= Fplist_get (props
, Qface
);
20567 face
= mode_line_string_face
;
20569 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20570 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20572 lisp_string
= Fcopy_sequence (lisp_string
);
20575 Fadd_text_properties (make_number (0), make_number (len
),
20576 props
, lisp_string
);
20581 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20585 if (field_width
> len
)
20587 field_width
-= len
;
20588 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20590 Fadd_text_properties (make_number (0), make_number (field_width
),
20591 props
, lisp_string
);
20592 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20600 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20602 doc
: /* Format a string out of a mode line format specification.
20603 First arg FORMAT specifies the mode line format (see `mode-line-format'
20604 for details) to use.
20606 By default, the format is evaluated for the currently selected window.
20608 Optional second arg FACE specifies the face property to put on all
20609 characters for which no face is specified. The value nil means the
20610 default face. The value t means whatever face the window's mode line
20611 currently uses (either `mode-line' or `mode-line-inactive',
20612 depending on whether the window is the selected window or not).
20613 An integer value means the value string has no text
20616 Optional third and fourth args WINDOW and BUFFER specify the window
20617 and buffer to use as the context for the formatting (defaults
20618 are the selected window and the WINDOW's buffer). */)
20619 (Lisp_Object format
, Lisp_Object face
,
20620 Lisp_Object window
, Lisp_Object buffer
)
20625 struct buffer
*old_buffer
= NULL
;
20627 int no_props
= INTEGERP (face
);
20628 int count
= SPECPDL_INDEX ();
20630 int string_start
= 0;
20633 window
= selected_window
;
20634 CHECK_WINDOW (window
);
20635 w
= XWINDOW (window
);
20638 buffer
= w
->buffer
;
20639 CHECK_BUFFER (buffer
);
20641 /* Make formatting the modeline a non-op when noninteractive, otherwise
20642 there will be problems later caused by a partially initialized frame. */
20643 if (NILP (format
) || noninteractive
)
20644 return empty_unibyte_string
;
20649 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20650 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20651 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20652 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20653 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20654 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20655 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20658 if (XBUFFER (buffer
) != current_buffer
)
20659 old_buffer
= current_buffer
;
20661 /* Save things including mode_line_proptrans_alist,
20662 and set that to nil so that we don't alter the outer value. */
20663 record_unwind_protect (unwind_format_mode_line
,
20664 format_mode_line_unwind_data
20665 (old_buffer
, selected_window
, 1));
20666 mode_line_proptrans_alist
= Qnil
;
20668 Fselect_window (window
, Qt
);
20670 set_buffer_internal_1 (XBUFFER (buffer
));
20672 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20676 mode_line_target
= MODE_LINE_NOPROP
;
20677 mode_line_string_face_prop
= Qnil
;
20678 mode_line_string_list
= Qnil
;
20679 string_start
= MODE_LINE_NOPROP_LEN (0);
20683 mode_line_target
= MODE_LINE_STRING
;
20684 mode_line_string_list
= Qnil
;
20685 mode_line_string_face
= face
;
20686 mode_line_string_face_prop
20687 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20690 push_kboard (FRAME_KBOARD (it
.f
));
20691 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20696 len
= MODE_LINE_NOPROP_LEN (string_start
);
20697 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20701 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20702 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20703 empty_unibyte_string
);
20706 unbind_to (count
, Qnil
);
20710 /* Write a null-terminated, right justified decimal representation of
20711 the positive integer D to BUF using a minimal field width WIDTH. */
20714 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20716 register char *p
= buf
;
20724 *p
++ = d
% 10 + '0';
20729 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20740 /* Write a null-terminated, right justified decimal and "human
20741 readable" representation of the nonnegative integer D to BUF using
20742 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20744 static const char power_letter
[] =
20758 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20760 /* We aim to represent the nonnegative integer D as
20761 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20762 EMACS_INT quotient
= d
;
20764 /* -1 means: do not use TENTHS. */
20768 /* Length of QUOTIENT.TENTHS as a string. */
20774 if (1000 <= quotient
)
20776 /* Scale to the appropriate EXPONENT. */
20779 remainder
= quotient
% 1000;
20783 while (1000 <= quotient
);
20785 /* Round to nearest and decide whether to use TENTHS or not. */
20788 tenths
= remainder
/ 100;
20789 if (50 <= remainder
% 100)
20796 if (quotient
== 10)
20804 if (500 <= remainder
)
20806 if (quotient
< 999)
20817 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20818 if (tenths
== -1 && quotient
<= 99)
20825 p
= psuffix
= buf
+ max (width
, length
);
20827 /* Print EXPONENT. */
20828 *psuffix
++ = power_letter
[exponent
];
20831 /* Print TENTHS. */
20834 *--p
= '0' + tenths
;
20838 /* Print QUOTIENT. */
20841 int digit
= quotient
% 10;
20842 *--p
= '0' + digit
;
20844 while ((quotient
/= 10) != 0);
20846 /* Print leading spaces. */
20851 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20852 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20853 type of CODING_SYSTEM. Return updated pointer into BUF. */
20855 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20858 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20861 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20862 const unsigned char *eol_str
;
20864 /* The EOL conversion we are using. */
20865 Lisp_Object eoltype
;
20867 val
= CODING_SYSTEM_SPEC (coding_system
);
20870 if (!VECTORP (val
)) /* Not yet decided. */
20875 eoltype
= eol_mnemonic_undecided
;
20876 /* Don't mention EOL conversion if it isn't decided. */
20881 Lisp_Object eolvalue
;
20883 attrs
= AREF (val
, 0);
20884 eolvalue
= AREF (val
, 2);
20887 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20891 /* The EOL conversion that is normal on this system. */
20893 if (NILP (eolvalue
)) /* Not yet decided. */
20894 eoltype
= eol_mnemonic_undecided
;
20895 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20896 eoltype
= eol_mnemonic_undecided
;
20897 else /* eolvalue is Qunix, Qdos, or Qmac. */
20898 eoltype
= (EQ (eolvalue
, Qunix
)
20899 ? eol_mnemonic_unix
20900 : (EQ (eolvalue
, Qdos
) == 1
20901 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20907 /* Mention the EOL conversion if it is not the usual one. */
20908 if (STRINGP (eoltype
))
20910 eol_str
= SDATA (eoltype
);
20911 eol_str_len
= SBYTES (eoltype
);
20913 else if (CHARACTERP (eoltype
))
20915 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20916 int c
= XFASTINT (eoltype
);
20917 eol_str_len
= CHAR_STRING (c
, tmp
);
20922 eol_str
= invalid_eol_type
;
20923 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20925 memcpy (buf
, eol_str
, eol_str_len
);
20926 buf
+= eol_str_len
;
20932 /* Return a string for the output of a mode line %-spec for window W,
20933 generated by character C. FIELD_WIDTH > 0 means pad the string
20934 returned with spaces to that value. Return a Lisp string in
20935 *STRING if the resulting string is taken from that Lisp string.
20937 Note we operate on the current buffer for most purposes,
20938 the exception being w->base_line_pos. */
20940 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20942 static const char *
20943 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20944 Lisp_Object
*string
)
20947 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20948 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20949 struct buffer
*b
= current_buffer
;
20957 if (!NILP (BVAR (b
, read_only
)))
20959 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20964 /* This differs from %* only for a modified read-only buffer. */
20965 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20967 if (!NILP (BVAR (b
, read_only
)))
20972 /* This differs from %* in ignoring read-only-ness. */
20973 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20985 if (command_loop_level
> 5)
20987 p
= decode_mode_spec_buf
;
20988 for (i
= 0; i
< command_loop_level
; i
++)
20991 return decode_mode_spec_buf
;
20999 if (command_loop_level
> 5)
21001 p
= decode_mode_spec_buf
;
21002 for (i
= 0; i
< command_loop_level
; i
++)
21005 return decode_mode_spec_buf
;
21012 /* Let lots_of_dashes be a string of infinite length. */
21013 if (mode_line_target
== MODE_LINE_NOPROP
||
21014 mode_line_target
== MODE_LINE_STRING
)
21016 if (field_width
<= 0
21017 || field_width
> sizeof (lots_of_dashes
))
21019 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
21020 decode_mode_spec_buf
[i
] = '-';
21021 decode_mode_spec_buf
[i
] = '\0';
21022 return decode_mode_spec_buf
;
21025 return lots_of_dashes
;
21029 obj
= BVAR (b
, name
);
21033 /* %c and %l are ignored in `frame-title-format'.
21034 (In redisplay_internal, the frame title is drawn _before_ the
21035 windows are updated, so the stuff which depends on actual
21036 window contents (such as %l) may fail to render properly, or
21037 even crash emacs.) */
21038 if (mode_line_target
== MODE_LINE_TITLE
)
21042 EMACS_INT col
= current_column ();
21043 w
->column_number_displayed
= make_number (col
);
21044 pint2str (decode_mode_spec_buf
, field_width
, col
);
21045 return decode_mode_spec_buf
;
21049 #ifndef SYSTEM_MALLOC
21051 if (NILP (Vmemory_full
))
21054 return "!MEM FULL! ";
21061 /* %F displays the frame name. */
21062 if (!NILP (f
->title
))
21063 return SSDATA (f
->title
);
21064 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21065 return SSDATA (f
->name
);
21069 obj
= BVAR (b
, filename
);
21074 EMACS_INT size
= ZV
- BEGV
;
21075 pint2str (decode_mode_spec_buf
, field_width
, size
);
21076 return decode_mode_spec_buf
;
21081 EMACS_INT size
= ZV
- BEGV
;
21082 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21083 return decode_mode_spec_buf
;
21088 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21089 EMACS_INT topline
, nlines
, height
;
21092 /* %c and %l are ignored in `frame-title-format'. */
21093 if (mode_line_target
== MODE_LINE_TITLE
)
21096 startpos
= XMARKER (w
->start
)->charpos
;
21097 startpos_byte
= marker_byte_position (w
->start
);
21098 height
= WINDOW_TOTAL_LINES (w
);
21100 /* If we decided that this buffer isn't suitable for line numbers,
21101 don't forget that too fast. */
21102 if (EQ (w
->base_line_pos
, w
->buffer
))
21104 /* But do forget it, if the window shows a different buffer now. */
21105 else if (BUFFERP (w
->base_line_pos
))
21106 w
->base_line_pos
= Qnil
;
21108 /* If the buffer is very big, don't waste time. */
21109 if (INTEGERP (Vline_number_display_limit
)
21110 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21112 w
->base_line_pos
= Qnil
;
21113 w
->base_line_number
= Qnil
;
21117 if (INTEGERP (w
->base_line_number
)
21118 && INTEGERP (w
->base_line_pos
)
21119 && XFASTINT (w
->base_line_pos
) <= startpos
)
21121 line
= XFASTINT (w
->base_line_number
);
21122 linepos
= XFASTINT (w
->base_line_pos
);
21123 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21128 linepos
= BUF_BEGV (b
);
21129 linepos_byte
= BUF_BEGV_BYTE (b
);
21132 /* Count lines from base line to window start position. */
21133 nlines
= display_count_lines (linepos_byte
,
21137 topline
= nlines
+ line
;
21139 /* Determine a new base line, if the old one is too close
21140 or too far away, or if we did not have one.
21141 "Too close" means it's plausible a scroll-down would
21142 go back past it. */
21143 if (startpos
== BUF_BEGV (b
))
21145 w
->base_line_number
= make_number (topline
);
21146 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21148 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21149 || linepos
== BUF_BEGV (b
))
21151 EMACS_INT limit
= BUF_BEGV (b
);
21152 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
21153 EMACS_INT position
;
21154 EMACS_INT distance
=
21155 (height
* 2 + 30) * line_number_display_limit_width
;
21157 if (startpos
- distance
> limit
)
21159 limit
= startpos
- distance
;
21160 limit_byte
= CHAR_TO_BYTE (limit
);
21163 nlines
= display_count_lines (startpos_byte
,
21165 - (height
* 2 + 30),
21167 /* If we couldn't find the lines we wanted within
21168 line_number_display_limit_width chars per line,
21169 give up on line numbers for this window. */
21170 if (position
== limit_byte
&& limit
== startpos
- distance
)
21172 w
->base_line_pos
= w
->buffer
;
21173 w
->base_line_number
= Qnil
;
21177 w
->base_line_number
= make_number (topline
- nlines
);
21178 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21181 /* Now count lines from the start pos to point. */
21182 nlines
= display_count_lines (startpos_byte
,
21183 PT_BYTE
, PT
, &junk
);
21185 /* Record that we did display the line number. */
21186 line_number_displayed
= 1;
21188 /* Make the string to show. */
21189 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21190 return decode_mode_spec_buf
;
21193 char* p
= decode_mode_spec_buf
;
21194 int pad
= field_width
- 2;
21200 return decode_mode_spec_buf
;
21206 obj
= BVAR (b
, mode_name
);
21210 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21216 EMACS_INT pos
= marker_position (w
->start
);
21217 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21219 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21221 if (pos
<= BUF_BEGV (b
))
21226 else if (pos
<= BUF_BEGV (b
))
21230 if (total
> 1000000)
21231 /* Do it differently for a large value, to avoid overflow. */
21232 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21234 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21235 /* We can't normally display a 3-digit number,
21236 so get us a 2-digit number that is close. */
21239 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21240 return decode_mode_spec_buf
;
21244 /* Display percentage of size above the bottom of the screen. */
21247 EMACS_INT toppos
= marker_position (w
->start
);
21248 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21249 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21251 if (botpos
>= BUF_ZV (b
))
21253 if (toppos
<= BUF_BEGV (b
))
21260 if (total
> 1000000)
21261 /* Do it differently for a large value, to avoid overflow. */
21262 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21264 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21265 /* We can't normally display a 3-digit number,
21266 so get us a 2-digit number that is close. */
21269 if (toppos
<= BUF_BEGV (b
))
21270 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21272 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21273 return decode_mode_spec_buf
;
21278 /* status of process */
21279 obj
= Fget_buffer_process (Fcurrent_buffer ());
21281 return "no process";
21283 obj
= Fsymbol_name (Fprocess_status (obj
));
21289 int count
= inhibit_garbage_collection ();
21290 Lisp_Object val
= call1 (intern ("file-remote-p"),
21291 BVAR (current_buffer
, directory
));
21292 unbind_to (count
, Qnil
);
21300 case 't': /* indicate TEXT or BINARY */
21304 /* coding-system (not including end-of-line format) */
21306 /* coding-system (including end-of-line type) */
21308 int eol_flag
= (c
== 'Z');
21309 char *p
= decode_mode_spec_buf
;
21311 if (! FRAME_WINDOW_P (f
))
21313 /* No need to mention EOL here--the terminal never needs
21314 to do EOL conversion. */
21315 p
= decode_mode_spec_coding (CODING_ID_NAME
21316 (FRAME_KEYBOARD_CODING (f
)->id
),
21318 p
= decode_mode_spec_coding (CODING_ID_NAME
21319 (FRAME_TERMINAL_CODING (f
)->id
),
21322 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21325 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21326 #ifdef subprocesses
21327 obj
= Fget_buffer_process (Fcurrent_buffer ());
21328 if (PROCESSP (obj
))
21330 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21332 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21335 #endif /* subprocesses */
21338 return decode_mode_spec_buf
;
21345 return SSDATA (obj
);
21352 /* Count up to COUNT lines starting from START_BYTE.
21353 But don't go beyond LIMIT_BYTE.
21354 Return the number of lines thus found (always nonnegative).
21356 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21359 display_count_lines (EMACS_INT start_byte
,
21360 EMACS_INT limit_byte
, EMACS_INT count
,
21361 EMACS_INT
*byte_pos_ptr
)
21363 register unsigned char *cursor
;
21364 unsigned char *base
;
21366 register EMACS_INT ceiling
;
21367 register unsigned char *ceiling_addr
;
21368 EMACS_INT orig_count
= count
;
21370 /* If we are not in selective display mode,
21371 check only for newlines. */
21372 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21373 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21377 while (start_byte
< limit_byte
)
21379 ceiling
= BUFFER_CEILING_OF (start_byte
);
21380 ceiling
= min (limit_byte
- 1, ceiling
);
21381 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21382 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21385 if (selective_display
)
21386 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21389 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21392 if (cursor
!= ceiling_addr
)
21396 start_byte
+= cursor
- base
+ 1;
21397 *byte_pos_ptr
= start_byte
;
21401 if (++cursor
== ceiling_addr
)
21407 start_byte
+= cursor
- base
;
21412 while (start_byte
> limit_byte
)
21414 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21415 ceiling
= max (limit_byte
, ceiling
);
21416 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21417 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21420 if (selective_display
)
21421 while (--cursor
!= ceiling_addr
21422 && *cursor
!= '\n' && *cursor
!= 015)
21425 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21428 if (cursor
!= ceiling_addr
)
21432 start_byte
+= cursor
- base
+ 1;
21433 *byte_pos_ptr
= start_byte
;
21434 /* When scanning backwards, we should
21435 not count the newline posterior to which we stop. */
21436 return - orig_count
- 1;
21442 /* Here we add 1 to compensate for the last decrement
21443 of CURSOR, which took it past the valid range. */
21444 start_byte
+= cursor
- base
+ 1;
21448 *byte_pos_ptr
= limit_byte
;
21451 return - orig_count
+ count
;
21452 return orig_count
- count
;
21458 /***********************************************************************
21460 ***********************************************************************/
21462 /* Display a NUL-terminated string, starting with index START.
21464 If STRING is non-null, display that C string. Otherwise, the Lisp
21465 string LISP_STRING is displayed. There's a case that STRING is
21466 non-null and LISP_STRING is not nil. It means STRING is a string
21467 data of LISP_STRING. In that case, we display LISP_STRING while
21468 ignoring its text properties.
21470 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21471 FACE_STRING. Display STRING or LISP_STRING with the face at
21472 FACE_STRING_POS in FACE_STRING:
21474 Display the string in the environment given by IT, but use the
21475 standard display table, temporarily.
21477 FIELD_WIDTH is the minimum number of output glyphs to produce.
21478 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21479 with spaces. If STRING has more characters, more than FIELD_WIDTH
21480 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21482 PRECISION is the maximum number of characters to output from
21483 STRING. PRECISION < 0 means don't truncate the string.
21485 This is roughly equivalent to printf format specifiers:
21487 FIELD_WIDTH PRECISION PRINTF
21488 ----------------------------------------
21494 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21495 display them, and < 0 means obey the current buffer's value of
21496 enable_multibyte_characters.
21498 Value is the number of columns displayed. */
21501 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21502 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21503 int field_width
, int precision
, int max_x
, int multibyte
)
21505 int hpos_at_start
= it
->hpos
;
21506 int saved_face_id
= it
->face_id
;
21507 struct glyph_row
*row
= it
->glyph_row
;
21508 EMACS_INT it_charpos
;
21510 /* Initialize the iterator IT for iteration over STRING beginning
21511 with index START. */
21512 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21513 precision
, field_width
, multibyte
);
21514 if (string
&& STRINGP (lisp_string
))
21515 /* LISP_STRING is the one returned by decode_mode_spec. We should
21516 ignore its text properties. */
21517 it
->stop_charpos
= it
->end_charpos
;
21519 /* If displaying STRING, set up the face of the iterator from
21520 FACE_STRING, if that's given. */
21521 if (STRINGP (face_string
))
21527 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21528 0, it
->region_beg_charpos
,
21529 it
->region_end_charpos
,
21530 &endptr
, it
->base_face_id
, 0);
21531 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21532 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21535 /* Set max_x to the maximum allowed X position. Don't let it go
21536 beyond the right edge of the window. */
21538 max_x
= it
->last_visible_x
;
21540 max_x
= min (max_x
, it
->last_visible_x
);
21542 /* Skip over display elements that are not visible. because IT->w is
21544 if (it
->current_x
< it
->first_visible_x
)
21545 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21546 MOVE_TO_POS
| MOVE_TO_X
);
21548 row
->ascent
= it
->max_ascent
;
21549 row
->height
= it
->max_ascent
+ it
->max_descent
;
21550 row
->phys_ascent
= it
->max_phys_ascent
;
21551 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21552 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21554 if (STRINGP (it
->string
))
21555 it_charpos
= IT_STRING_CHARPOS (*it
);
21557 it_charpos
= IT_CHARPOS (*it
);
21559 /* This condition is for the case that we are called with current_x
21560 past last_visible_x. */
21561 while (it
->current_x
< max_x
)
21563 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21565 /* Get the next display element. */
21566 if (!get_next_display_element (it
))
21569 /* Produce glyphs. */
21570 x_before
= it
->current_x
;
21571 n_glyphs_before
= row
->used
[TEXT_AREA
];
21572 PRODUCE_GLYPHS (it
);
21574 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21577 while (i
< nglyphs
)
21579 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21581 if (it
->line_wrap
!= TRUNCATE
21582 && x
+ glyph
->pixel_width
> max_x
)
21584 /* End of continued line or max_x reached. */
21585 if (CHAR_GLYPH_PADDING_P (*glyph
))
21587 /* A wide character is unbreakable. */
21588 if (row
->reversed_p
)
21589 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21590 - n_glyphs_before
);
21591 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21592 it
->current_x
= x_before
;
21596 if (row
->reversed_p
)
21597 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21598 - (n_glyphs_before
+ i
));
21599 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21604 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21606 /* Glyph is at least partially visible. */
21608 if (x
< it
->first_visible_x
)
21609 row
->x
= x
- it
->first_visible_x
;
21613 /* Glyph is off the left margin of the display area.
21614 Should not happen. */
21618 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21619 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21620 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21621 row
->phys_height
= max (row
->phys_height
,
21622 it
->max_phys_ascent
+ it
->max_phys_descent
);
21623 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21624 it
->max_extra_line_spacing
);
21625 x
+= glyph
->pixel_width
;
21629 /* Stop if max_x reached. */
21633 /* Stop at line ends. */
21634 if (ITERATOR_AT_END_OF_LINE_P (it
))
21636 it
->continuation_lines_width
= 0;
21640 set_iterator_to_next (it
, 1);
21641 if (STRINGP (it
->string
))
21642 it_charpos
= IT_STRING_CHARPOS (*it
);
21644 it_charpos
= IT_CHARPOS (*it
);
21646 /* Stop if truncating at the right edge. */
21647 if (it
->line_wrap
== TRUNCATE
21648 && it
->current_x
>= it
->last_visible_x
)
21650 /* Add truncation mark, but don't do it if the line is
21651 truncated at a padding space. */
21652 if (it_charpos
< it
->string_nchars
)
21654 if (!FRAME_WINDOW_P (it
->f
))
21658 if (it
->current_x
> it
->last_visible_x
)
21660 if (!row
->reversed_p
)
21662 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21663 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21668 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21669 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21671 unproduce_glyphs (it
, ii
+ 1);
21672 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21674 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21676 row
->used
[TEXT_AREA
] = ii
;
21677 produce_special_glyphs (it
, IT_TRUNCATION
);
21680 produce_special_glyphs (it
, IT_TRUNCATION
);
21682 row
->truncated_on_right_p
= 1;
21688 /* Maybe insert a truncation at the left. */
21689 if (it
->first_visible_x
21692 if (!FRAME_WINDOW_P (it
->f
))
21693 insert_left_trunc_glyphs (it
);
21694 row
->truncated_on_left_p
= 1;
21697 it
->face_id
= saved_face_id
;
21699 /* Value is number of columns displayed. */
21700 return it
->hpos
- hpos_at_start
;
21705 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21706 appears as an element of LIST or as the car of an element of LIST.
21707 If PROPVAL is a list, compare each element against LIST in that
21708 way, and return 1/2 if any element of PROPVAL is found in LIST.
21709 Otherwise return 0. This function cannot quit.
21710 The return value is 2 if the text is invisible but with an ellipsis
21711 and 1 if it's invisible and without an ellipsis. */
21714 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21716 register Lisp_Object tail
, proptail
;
21718 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21720 register Lisp_Object tem
;
21722 if (EQ (propval
, tem
))
21724 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21725 return NILP (XCDR (tem
)) ? 1 : 2;
21728 if (CONSP (propval
))
21730 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21732 Lisp_Object propelt
;
21733 propelt
= XCAR (proptail
);
21734 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21736 register Lisp_Object tem
;
21738 if (EQ (propelt
, tem
))
21740 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21741 return NILP (XCDR (tem
)) ? 1 : 2;
21749 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21750 doc
: /* Non-nil if the property makes the text invisible.
21751 POS-OR-PROP can be a marker or number, in which case it is taken to be
21752 a position in the current buffer and the value of the `invisible' property
21753 is checked; or it can be some other value, which is then presumed to be the
21754 value of the `invisible' property of the text of interest.
21755 The non-nil value returned can be t for truly invisible text or something
21756 else if the text is replaced by an ellipsis. */)
21757 (Lisp_Object pos_or_prop
)
21760 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21761 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21763 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21764 return (invis
== 0 ? Qnil
21766 : make_number (invis
));
21769 /* Calculate a width or height in pixels from a specification using
21770 the following elements:
21773 NUM - a (fractional) multiple of the default font width/height
21774 (NUM) - specifies exactly NUM pixels
21775 UNIT - a fixed number of pixels, see below.
21776 ELEMENT - size of a display element in pixels, see below.
21777 (NUM . SPEC) - equals NUM * SPEC
21778 (+ SPEC SPEC ...) - add pixel values
21779 (- SPEC SPEC ...) - subtract pixel values
21780 (- SPEC) - negate pixel value
21783 INT or FLOAT - a number constant
21784 SYMBOL - use symbol's (buffer local) variable binding.
21787 in - pixels per inch *)
21788 mm - pixels per 1/1000 meter *)
21789 cm - pixels per 1/100 meter *)
21790 width - width of current font in pixels.
21791 height - height of current font in pixels.
21793 *) using the ratio(s) defined in display-pixels-per-inch.
21797 left-fringe - left fringe width in pixels
21798 right-fringe - right fringe width in pixels
21800 left-margin - left margin width in pixels
21801 right-margin - right margin width in pixels
21803 scroll-bar - scroll-bar area width in pixels
21807 Pixels corresponding to 5 inches:
21810 Total width of non-text areas on left side of window (if scroll-bar is on left):
21811 '(space :width (+ left-fringe left-margin scroll-bar))
21813 Align to first text column (in header line):
21814 '(space :align-to 0)
21816 Align to middle of text area minus half the width of variable `my-image'
21817 containing a loaded image:
21818 '(space :align-to (0.5 . (- text my-image)))
21820 Width of left margin minus width of 1 character in the default font:
21821 '(space :width (- left-margin 1))
21823 Width of left margin minus width of 2 characters in the current font:
21824 '(space :width (- left-margin (2 . width)))
21826 Center 1 character over left-margin (in header line):
21827 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21829 Different ways to express width of left fringe plus left margin minus one pixel:
21830 '(space :width (- (+ left-fringe left-margin) (1)))
21831 '(space :width (+ left-fringe left-margin (- (1))))
21832 '(space :width (+ left-fringe left-margin (-1)))
21836 #define NUMVAL(X) \
21837 ((INTEGERP (X) || FLOATP (X)) \
21842 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21843 struct font
*font
, int width_p
, int *align_to
)
21847 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21848 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21851 return OK_PIXELS (0);
21853 xassert (FRAME_LIVE_P (it
->f
));
21855 if (SYMBOLP (prop
))
21857 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21859 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21861 if (unit
[0] == 'i' && unit
[1] == 'n')
21863 else if (unit
[0] == 'm' && unit
[1] == 'm')
21865 else if (unit
[0] == 'c' && unit
[1] == 'm')
21872 #ifdef HAVE_WINDOW_SYSTEM
21873 if (FRAME_WINDOW_P (it
->f
)
21875 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21876 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21878 return OK_PIXELS (ppi
/ pixels
);
21881 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21882 || (CONSP (Vdisplay_pixels_per_inch
)
21884 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21885 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21887 return OK_PIXELS (ppi
/ pixels
);
21893 #ifdef HAVE_WINDOW_SYSTEM
21894 if (EQ (prop
, Qheight
))
21895 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21896 if (EQ (prop
, Qwidth
))
21897 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21899 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21900 return OK_PIXELS (1);
21903 if (EQ (prop
, Qtext
))
21904 return OK_PIXELS (width_p
21905 ? window_box_width (it
->w
, TEXT_AREA
)
21906 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21908 if (align_to
&& *align_to
< 0)
21911 if (EQ (prop
, Qleft
))
21912 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21913 if (EQ (prop
, Qright
))
21914 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21915 if (EQ (prop
, Qcenter
))
21916 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21917 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21918 if (EQ (prop
, Qleft_fringe
))
21919 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21920 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21921 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21922 if (EQ (prop
, Qright_fringe
))
21923 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21924 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21925 : window_box_right_offset (it
->w
, TEXT_AREA
));
21926 if (EQ (prop
, Qleft_margin
))
21927 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21928 if (EQ (prop
, Qright_margin
))
21929 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21930 if (EQ (prop
, Qscroll_bar
))
21931 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21933 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21934 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21935 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21940 if (EQ (prop
, Qleft_fringe
))
21941 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21942 if (EQ (prop
, Qright_fringe
))
21943 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21944 if (EQ (prop
, Qleft_margin
))
21945 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21946 if (EQ (prop
, Qright_margin
))
21947 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21948 if (EQ (prop
, Qscroll_bar
))
21949 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21952 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21955 if (INTEGERP (prop
) || FLOATP (prop
))
21957 int base_unit
= (width_p
21958 ? FRAME_COLUMN_WIDTH (it
->f
)
21959 : FRAME_LINE_HEIGHT (it
->f
));
21960 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21965 Lisp_Object car
= XCAR (prop
);
21966 Lisp_Object cdr
= XCDR (prop
);
21970 #ifdef HAVE_WINDOW_SYSTEM
21971 if (FRAME_WINDOW_P (it
->f
)
21972 && valid_image_p (prop
))
21974 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21975 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21977 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21980 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21986 while (CONSP (cdr
))
21988 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21989 font
, width_p
, align_to
))
21992 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21997 if (EQ (car
, Qminus
))
21999 return OK_PIXELS (pixels
);
22002 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
22005 if (INTEGERP (car
) || FLOATP (car
))
22008 pixels
= XFLOATINT (car
);
22010 return OK_PIXELS (pixels
);
22011 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
22012 font
, width_p
, align_to
))
22013 return OK_PIXELS (pixels
* fact
);
22024 /***********************************************************************
22026 ***********************************************************************/
22028 #ifdef HAVE_WINDOW_SYSTEM
22033 dump_glyph_string (struct glyph_string
*s
)
22035 fprintf (stderr
, "glyph string\n");
22036 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22037 s
->x
, s
->y
, s
->width
, s
->height
);
22038 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22039 fprintf (stderr
, " hl = %d\n", s
->hl
);
22040 fprintf (stderr
, " left overhang = %d, right = %d\n",
22041 s
->left_overhang
, s
->right_overhang
);
22042 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22043 fprintf (stderr
, " extends to end of line = %d\n",
22044 s
->extends_to_end_of_line_p
);
22045 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22046 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22049 #endif /* GLYPH_DEBUG */
22051 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22052 of XChar2b structures for S; it can't be allocated in
22053 init_glyph_string because it must be allocated via `alloca'. W
22054 is the window on which S is drawn. ROW and AREA are the glyph row
22055 and area within the row from which S is constructed. START is the
22056 index of the first glyph structure covered by S. HL is a
22057 face-override for drawing S. */
22060 #define OPTIONAL_HDC(hdc) HDC hdc,
22061 #define DECLARE_HDC(hdc) HDC hdc;
22062 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22063 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22066 #ifndef OPTIONAL_HDC
22067 #define OPTIONAL_HDC(hdc)
22068 #define DECLARE_HDC(hdc)
22069 #define ALLOCATE_HDC(hdc, f)
22070 #define RELEASE_HDC(hdc, f)
22074 init_glyph_string (struct glyph_string
*s
,
22076 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22077 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22079 memset (s
, 0, sizeof *s
);
22081 s
->f
= XFRAME (w
->frame
);
22085 s
->display
= FRAME_X_DISPLAY (s
->f
);
22086 s
->window
= FRAME_X_WINDOW (s
->f
);
22087 s
->char2b
= char2b
;
22091 s
->first_glyph
= row
->glyphs
[area
] + start
;
22092 s
->height
= row
->height
;
22093 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22094 s
->ybase
= s
->y
+ row
->ascent
;
22098 /* Append the list of glyph strings with head H and tail T to the list
22099 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22102 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22103 struct glyph_string
*h
, struct glyph_string
*t
)
22117 /* Prepend the list of glyph strings with head H and tail T to the
22118 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22122 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22123 struct glyph_string
*h
, struct glyph_string
*t
)
22137 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22138 Set *HEAD and *TAIL to the resulting list. */
22141 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22142 struct glyph_string
*s
)
22144 s
->next
= s
->prev
= NULL
;
22145 append_glyph_string_lists (head
, tail
, s
, s
);
22149 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22150 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22151 make sure that X resources for the face returned are allocated.
22152 Value is a pointer to a realized face that is ready for display if
22153 DISPLAY_P is non-zero. */
22155 static inline struct face
*
22156 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22157 XChar2b
*char2b
, int display_p
)
22159 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22163 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22165 if (code
!= FONT_INVALID_CODE
)
22166 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22168 STORE_XCHAR2B (char2b
, 0, 0);
22171 /* Make sure X resources of the face are allocated. */
22172 #ifdef HAVE_X_WINDOWS
22176 xassert (face
!= NULL
);
22177 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22184 /* Get face and two-byte form of character glyph GLYPH on frame F.
22185 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22186 a pointer to a realized face that is ready for display. */
22188 static inline struct face
*
22189 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22190 XChar2b
*char2b
, int *two_byte_p
)
22194 xassert (glyph
->type
== CHAR_GLYPH
);
22195 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22204 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22205 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22207 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22209 if (code
!= FONT_INVALID_CODE
)
22210 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22212 STORE_XCHAR2B (char2b
, 0, 0);
22215 /* Make sure X resources of the face are allocated. */
22216 xassert (face
!= NULL
);
22217 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22222 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22223 Return 1 if FONT has a glyph for C, otherwise return 0. */
22226 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22230 if (CHAR_BYTE8_P (c
))
22231 code
= CHAR_TO_BYTE8 (c
);
22233 code
= font
->driver
->encode_char (font
, c
);
22235 if (code
== FONT_INVALID_CODE
)
22237 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22242 /* Fill glyph string S with composition components specified by S->cmp.
22244 BASE_FACE is the base face of the composition.
22245 S->cmp_from is the index of the first component for S.
22247 OVERLAPS non-zero means S should draw the foreground only, and use
22248 its physical height for clipping. See also draw_glyphs.
22250 Value is the index of a component not in S. */
22253 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22257 /* For all glyphs of this composition, starting at the offset
22258 S->cmp_from, until we reach the end of the definition or encounter a
22259 glyph that requires the different face, add it to S. */
22264 s
->for_overlaps
= overlaps
;
22267 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22269 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22271 /* TAB in a composition means display glyphs with padding space
22272 on the left or right. */
22275 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22278 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22285 s
->font
= s
->face
->font
;
22287 else if (s
->face
!= face
)
22295 if (s
->face
== NULL
)
22297 s
->face
= base_face
->ascii_face
;
22298 s
->font
= s
->face
->font
;
22301 /* All glyph strings for the same composition has the same width,
22302 i.e. the width set for the first component of the composition. */
22303 s
->width
= s
->first_glyph
->pixel_width
;
22305 /* If the specified font could not be loaded, use the frame's
22306 default font, but record the fact that we couldn't load it in
22307 the glyph string so that we can draw rectangles for the
22308 characters of the glyph string. */
22309 if (s
->font
== NULL
)
22311 s
->font_not_found_p
= 1;
22312 s
->font
= FRAME_FONT (s
->f
);
22315 /* Adjust base line for subscript/superscript text. */
22316 s
->ybase
+= s
->first_glyph
->voffset
;
22318 /* This glyph string must always be drawn with 16-bit functions. */
22325 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22326 int start
, int end
, int overlaps
)
22328 struct glyph
*glyph
, *last
;
22329 Lisp_Object lgstring
;
22332 s
->for_overlaps
= overlaps
;
22333 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22334 last
= s
->row
->glyphs
[s
->area
] + end
;
22335 s
->cmp_id
= glyph
->u
.cmp
.id
;
22336 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22337 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22338 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22339 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22340 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22342 while (glyph
< last
22343 && glyph
->u
.cmp
.automatic
22344 && glyph
->u
.cmp
.id
== s
->cmp_id
22345 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22346 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22348 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22350 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22351 unsigned code
= LGLYPH_CODE (lglyph
);
22353 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22355 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22356 return glyph
- s
->row
->glyphs
[s
->area
];
22360 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22361 See the comment of fill_glyph_string for arguments.
22362 Value is the index of the first glyph not in S. */
22366 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22367 int start
, int end
, int overlaps
)
22369 struct glyph
*glyph
, *last
;
22372 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22373 s
->for_overlaps
= overlaps
;
22374 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22375 last
= s
->row
->glyphs
[s
->area
] + end
;
22376 voffset
= glyph
->voffset
;
22377 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22378 s
->font
= s
->face
->font
;
22380 s
->width
= glyph
->pixel_width
;
22382 while (glyph
< last
22383 && glyph
->type
== GLYPHLESS_GLYPH
22384 && glyph
->voffset
== voffset
22385 && glyph
->face_id
== face_id
)
22388 s
->width
+= glyph
->pixel_width
;
22391 s
->ybase
+= voffset
;
22392 return glyph
- s
->row
->glyphs
[s
->area
];
22396 /* Fill glyph string S from a sequence of character glyphs.
22398 FACE_ID is the face id of the string. START is the index of the
22399 first glyph to consider, END is the index of the last + 1.
22400 OVERLAPS non-zero means S should draw the foreground only, and use
22401 its physical height for clipping. See also draw_glyphs.
22403 Value is the index of the first glyph not in S. */
22406 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22407 int start
, int end
, int overlaps
)
22409 struct glyph
*glyph
, *last
;
22411 int glyph_not_available_p
;
22413 xassert (s
->f
== XFRAME (s
->w
->frame
));
22414 xassert (s
->nchars
== 0);
22415 xassert (start
>= 0 && end
> start
);
22417 s
->for_overlaps
= overlaps
;
22418 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22419 last
= s
->row
->glyphs
[s
->area
] + end
;
22420 voffset
= glyph
->voffset
;
22421 s
->padding_p
= glyph
->padding_p
;
22422 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22424 while (glyph
< last
22425 && glyph
->type
== CHAR_GLYPH
22426 && glyph
->voffset
== voffset
22427 /* Same face id implies same font, nowadays. */
22428 && glyph
->face_id
== face_id
22429 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22433 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22434 s
->char2b
+ s
->nchars
,
22436 s
->two_byte_p
= two_byte_p
;
22438 xassert (s
->nchars
<= end
- start
);
22439 s
->width
+= glyph
->pixel_width
;
22440 if (glyph
++->padding_p
!= s
->padding_p
)
22444 s
->font
= s
->face
->font
;
22446 /* If the specified font could not be loaded, use the frame's font,
22447 but record the fact that we couldn't load it in
22448 S->font_not_found_p so that we can draw rectangles for the
22449 characters of the glyph string. */
22450 if (s
->font
== NULL
|| glyph_not_available_p
)
22452 s
->font_not_found_p
= 1;
22453 s
->font
= FRAME_FONT (s
->f
);
22456 /* Adjust base line for subscript/superscript text. */
22457 s
->ybase
+= voffset
;
22459 xassert (s
->face
&& s
->face
->gc
);
22460 return glyph
- s
->row
->glyphs
[s
->area
];
22464 /* Fill glyph string S from image glyph S->first_glyph. */
22467 fill_image_glyph_string (struct glyph_string
*s
)
22469 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22470 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22472 s
->slice
= s
->first_glyph
->slice
.img
;
22473 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22474 s
->font
= s
->face
->font
;
22475 s
->width
= s
->first_glyph
->pixel_width
;
22477 /* Adjust base line for subscript/superscript text. */
22478 s
->ybase
+= s
->first_glyph
->voffset
;
22482 /* Fill glyph string S from a sequence of stretch glyphs.
22484 START is the index of the first glyph to consider,
22485 END is the index of the last + 1.
22487 Value is the index of the first glyph not in S. */
22490 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22492 struct glyph
*glyph
, *last
;
22493 int voffset
, face_id
;
22495 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22497 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22498 last
= s
->row
->glyphs
[s
->area
] + end
;
22499 face_id
= glyph
->face_id
;
22500 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22501 s
->font
= s
->face
->font
;
22502 s
->width
= glyph
->pixel_width
;
22504 voffset
= glyph
->voffset
;
22508 && glyph
->type
== STRETCH_GLYPH
22509 && glyph
->voffset
== voffset
22510 && glyph
->face_id
== face_id
);
22512 s
->width
+= glyph
->pixel_width
;
22514 /* Adjust base line for subscript/superscript text. */
22515 s
->ybase
+= voffset
;
22517 /* The case that face->gc == 0 is handled when drawing the glyph
22518 string by calling PREPARE_FACE_FOR_DISPLAY. */
22520 return glyph
- s
->row
->glyphs
[s
->area
];
22523 static struct font_metrics
*
22524 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22526 static struct font_metrics metrics
;
22527 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22529 if (! font
|| code
== FONT_INVALID_CODE
)
22531 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22536 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22537 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22538 assumed to be zero. */
22541 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22543 *left
= *right
= 0;
22545 if (glyph
->type
== CHAR_GLYPH
)
22549 struct font_metrics
*pcm
;
22551 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22552 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22554 if (pcm
->rbearing
> pcm
->width
)
22555 *right
= pcm
->rbearing
- pcm
->width
;
22556 if (pcm
->lbearing
< 0)
22557 *left
= -pcm
->lbearing
;
22560 else if (glyph
->type
== COMPOSITE_GLYPH
)
22562 if (! glyph
->u
.cmp
.automatic
)
22564 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22566 if (cmp
->rbearing
> cmp
->pixel_width
)
22567 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22568 if (cmp
->lbearing
< 0)
22569 *left
= - cmp
->lbearing
;
22573 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22574 struct font_metrics metrics
;
22576 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22577 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22578 if (metrics
.rbearing
> metrics
.width
)
22579 *right
= metrics
.rbearing
- metrics
.width
;
22580 if (metrics
.lbearing
< 0)
22581 *left
= - metrics
.lbearing
;
22587 /* Return the index of the first glyph preceding glyph string S that
22588 is overwritten by S because of S's left overhang. Value is -1
22589 if no glyphs are overwritten. */
22592 left_overwritten (struct glyph_string
*s
)
22596 if (s
->left_overhang
)
22599 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22600 int first
= s
->first_glyph
- glyphs
;
22602 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22603 x
-= glyphs
[i
].pixel_width
;
22614 /* Return the index of the first glyph preceding glyph string S that
22615 is overwriting S because of its right overhang. Value is -1 if no
22616 glyph in front of S overwrites S. */
22619 left_overwriting (struct glyph_string
*s
)
22622 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22623 int first
= s
->first_glyph
- glyphs
;
22627 for (i
= first
- 1; i
>= 0; --i
)
22630 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22633 x
-= glyphs
[i
].pixel_width
;
22640 /* Return the index of the last glyph following glyph string S that is
22641 overwritten by S because of S's right overhang. Value is -1 if
22642 no such glyph is found. */
22645 right_overwritten (struct glyph_string
*s
)
22649 if (s
->right_overhang
)
22652 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22653 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22654 int end
= s
->row
->used
[s
->area
];
22656 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22657 x
+= glyphs
[i
].pixel_width
;
22666 /* Return the index of the last glyph following glyph string S that
22667 overwrites S because of its left overhang. Value is negative
22668 if no such glyph is found. */
22671 right_overwriting (struct glyph_string
*s
)
22674 int end
= s
->row
->used
[s
->area
];
22675 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22676 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22680 for (i
= first
; i
< end
; ++i
)
22683 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22686 x
+= glyphs
[i
].pixel_width
;
22693 /* Set background width of glyph string S. START is the index of the
22694 first glyph following S. LAST_X is the right-most x-position + 1
22695 in the drawing area. */
22698 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22700 /* If the face of this glyph string has to be drawn to the end of
22701 the drawing area, set S->extends_to_end_of_line_p. */
22703 if (start
== s
->row
->used
[s
->area
]
22704 && s
->area
== TEXT_AREA
22705 && ((s
->row
->fill_line_p
22706 && (s
->hl
== DRAW_NORMAL_TEXT
22707 || s
->hl
== DRAW_IMAGE_RAISED
22708 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22709 || s
->hl
== DRAW_MOUSE_FACE
))
22710 s
->extends_to_end_of_line_p
= 1;
22712 /* If S extends its face to the end of the line, set its
22713 background_width to the distance to the right edge of the drawing
22715 if (s
->extends_to_end_of_line_p
)
22716 s
->background_width
= last_x
- s
->x
+ 1;
22718 s
->background_width
= s
->width
;
22722 /* Compute overhangs and x-positions for glyph string S and its
22723 predecessors, or successors. X is the starting x-position for S.
22724 BACKWARD_P non-zero means process predecessors. */
22727 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22733 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22734 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22744 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22745 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22755 /* The following macros are only called from draw_glyphs below.
22756 They reference the following parameters of that function directly:
22757 `w', `row', `area', and `overlap_p'
22758 as well as the following local variables:
22759 `s', `f', and `hdc' (in W32) */
22762 /* On W32, silently add local `hdc' variable to argument list of
22763 init_glyph_string. */
22764 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22765 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22767 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22768 init_glyph_string (s, char2b, w, row, area, start, hl)
22771 /* Add a glyph string for a stretch glyph to the list of strings
22772 between HEAD and TAIL. START is the index of the stretch glyph in
22773 row area AREA of glyph row ROW. END is the index of the last glyph
22774 in that glyph row area. X is the current output position assigned
22775 to the new glyph string constructed. HL overrides that face of the
22776 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22777 is the right-most x-position of the drawing area. */
22779 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22780 and below -- keep them on one line. */
22781 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22784 s = (struct glyph_string *) alloca (sizeof *s); \
22785 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22786 START = fill_stretch_glyph_string (s, START, END); \
22787 append_glyph_string (&HEAD, &TAIL, s); \
22793 /* Add a glyph string for an image glyph to the list of strings
22794 between HEAD and TAIL. START is the index of the image glyph in
22795 row area AREA of glyph row ROW. END is the index of the last glyph
22796 in that glyph row area. X is the current output position assigned
22797 to the new glyph string constructed. HL overrides that face of the
22798 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22799 is the right-most x-position of the drawing area. */
22801 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22804 s = (struct glyph_string *) alloca (sizeof *s); \
22805 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22806 fill_image_glyph_string (s); \
22807 append_glyph_string (&HEAD, &TAIL, s); \
22814 /* Add a glyph string for a sequence of character glyphs to the list
22815 of strings between HEAD and TAIL. START is the index of the first
22816 glyph in row area AREA of glyph row ROW that is part of the new
22817 glyph string. END is the index of the last glyph in that glyph row
22818 area. X is the current output position assigned to the new glyph
22819 string constructed. HL overrides that face of the glyph; e.g. it
22820 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22821 right-most x-position of the drawing area. */
22823 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22829 face_id = (row)->glyphs[area][START].face_id; \
22831 s = (struct glyph_string *) alloca (sizeof *s); \
22832 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22833 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22834 append_glyph_string (&HEAD, &TAIL, s); \
22836 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22841 /* Add a glyph string for a composite sequence to the list of strings
22842 between HEAD and TAIL. START is the index of the first glyph in
22843 row area AREA of glyph row ROW that is part of the new glyph
22844 string. END is the index of the last glyph in that glyph row area.
22845 X is the current output position assigned to the new glyph string
22846 constructed. HL overrides that face of the glyph; e.g. it is
22847 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22848 x-position of the drawing area. */
22850 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22852 int face_id = (row)->glyphs[area][START].face_id; \
22853 struct face *base_face = FACE_FROM_ID (f, face_id); \
22854 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22855 struct composition *cmp = composition_table[cmp_id]; \
22857 struct glyph_string *first_s = NULL; \
22860 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22862 /* Make glyph_strings for each glyph sequence that is drawable by \
22863 the same face, and append them to HEAD/TAIL. */ \
22864 for (n = 0; n < cmp->glyph_len;) \
22866 s = (struct glyph_string *) alloca (sizeof *s); \
22867 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22868 append_glyph_string (&(HEAD), &(TAIL), s); \
22874 n = fill_composite_glyph_string (s, base_face, overlaps); \
22882 /* Add a glyph string for a glyph-string sequence to the list of strings
22883 between HEAD and TAIL. */
22885 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22889 Lisp_Object gstring; \
22891 face_id = (row)->glyphs[area][START].face_id; \
22892 gstring = (composition_gstring_from_id \
22893 ((row)->glyphs[area][START].u.cmp.id)); \
22894 s = (struct glyph_string *) alloca (sizeof *s); \
22895 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22896 * LGSTRING_GLYPH_LEN (gstring)); \
22897 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22898 append_glyph_string (&(HEAD), &(TAIL), s); \
22900 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22904 /* Add a glyph string for a sequence of glyphless character's glyphs
22905 to the list of strings between HEAD and TAIL. The meanings of
22906 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22908 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22913 face_id = (row)->glyphs[area][START].face_id; \
22915 s = (struct glyph_string *) alloca (sizeof *s); \
22916 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22917 append_glyph_string (&HEAD, &TAIL, s); \
22919 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22925 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22926 of AREA of glyph row ROW on window W between indices START and END.
22927 HL overrides the face for drawing glyph strings, e.g. it is
22928 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22929 x-positions of the drawing area.
22931 This is an ugly monster macro construct because we must use alloca
22932 to allocate glyph strings (because draw_glyphs can be called
22933 asynchronously). */
22935 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22938 HEAD = TAIL = NULL; \
22939 while (START < END) \
22941 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22942 switch (first_glyph->type) \
22945 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22949 case COMPOSITE_GLYPH: \
22950 if (first_glyph->u.cmp.automatic) \
22951 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22954 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22958 case STRETCH_GLYPH: \
22959 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22963 case IMAGE_GLYPH: \
22964 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22968 case GLYPHLESS_GLYPH: \
22969 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22979 set_glyph_string_background_width (s, START, LAST_X); \
22986 /* Draw glyphs between START and END in AREA of ROW on window W,
22987 starting at x-position X. X is relative to AREA in W. HL is a
22988 face-override with the following meaning:
22990 DRAW_NORMAL_TEXT draw normally
22991 DRAW_CURSOR draw in cursor face
22992 DRAW_MOUSE_FACE draw in mouse face.
22993 DRAW_INVERSE_VIDEO draw in mode line face
22994 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22995 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22997 If OVERLAPS is non-zero, draw only the foreground of characters and
22998 clip to the physical height of ROW. Non-zero value also defines
22999 the overlapping part to be drawn:
23001 OVERLAPS_PRED overlap with preceding rows
23002 OVERLAPS_SUCC overlap with succeeding rows
23003 OVERLAPS_BOTH overlap with both preceding/succeeding rows
23004 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
23006 Value is the x-position reached, relative to AREA of W. */
23009 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
23010 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
23011 enum draw_glyphs_face hl
, int overlaps
)
23013 struct glyph_string
*head
, *tail
;
23014 struct glyph_string
*s
;
23015 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
23016 int i
, j
, x_reached
, last_x
, area_left
= 0;
23017 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
23020 ALLOCATE_HDC (hdc
, f
);
23022 /* Let's rather be paranoid than getting a SEGV. */
23023 end
= min (end
, row
->used
[area
]);
23024 start
= max (0, start
);
23025 start
= min (end
, start
);
23027 /* Translate X to frame coordinates. Set last_x to the right
23028 end of the drawing area. */
23029 if (row
->full_width_p
)
23031 /* X is relative to the left edge of W, without scroll bars
23033 area_left
= WINDOW_LEFT_EDGE_X (w
);
23034 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23038 area_left
= window_box_left (w
, area
);
23039 last_x
= area_left
+ window_box_width (w
, area
);
23043 /* Build a doubly-linked list of glyph_string structures between
23044 head and tail from what we have to draw. Note that the macro
23045 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23046 the reason we use a separate variable `i'. */
23048 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23050 x_reached
= tail
->x
+ tail
->background_width
;
23054 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23055 the row, redraw some glyphs in front or following the glyph
23056 strings built above. */
23057 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23059 struct glyph_string
*h
, *t
;
23060 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23061 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23062 int check_mouse_face
= 0;
23065 /* If mouse highlighting is on, we may need to draw adjacent
23066 glyphs using mouse-face highlighting. */
23067 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23069 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23071 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23072 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23074 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23076 check_mouse_face
= 1;
23077 mouse_beg_col
= (row
== mouse_beg_row
)
23078 ? hlinfo
->mouse_face_beg_col
: 0;
23079 mouse_end_col
= (row
== mouse_end_row
)
23080 ? hlinfo
->mouse_face_end_col
23081 : row
->used
[TEXT_AREA
];
23085 /* Compute overhangs for all glyph strings. */
23086 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23087 for (s
= head
; s
; s
= s
->next
)
23088 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23090 /* Prepend glyph strings for glyphs in front of the first glyph
23091 string that are overwritten because of the first glyph
23092 string's left overhang. The background of all strings
23093 prepended must be drawn because the first glyph string
23095 i
= left_overwritten (head
);
23098 enum draw_glyphs_face overlap_hl
;
23100 /* If this row contains mouse highlighting, attempt to draw
23101 the overlapped glyphs with the correct highlight. This
23102 code fails if the overlap encompasses more than one glyph
23103 and mouse-highlight spans only some of these glyphs.
23104 However, making it work perfectly involves a lot more
23105 code, and I don't know if the pathological case occurs in
23106 practice, so we'll stick to this for now. --- cyd */
23107 if (check_mouse_face
23108 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23109 overlap_hl
= DRAW_MOUSE_FACE
;
23111 overlap_hl
= DRAW_NORMAL_TEXT
;
23114 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23115 overlap_hl
, dummy_x
, last_x
);
23117 compute_overhangs_and_x (t
, head
->x
, 1);
23118 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23122 /* Prepend glyph strings for glyphs in front of the first glyph
23123 string that overwrite that glyph string because of their
23124 right overhang. For these strings, only the foreground must
23125 be drawn, because it draws over the glyph string at `head'.
23126 The background must not be drawn because this would overwrite
23127 right overhangs of preceding glyphs for which no glyph
23129 i
= left_overwriting (head
);
23132 enum draw_glyphs_face overlap_hl
;
23134 if (check_mouse_face
23135 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23136 overlap_hl
= DRAW_MOUSE_FACE
;
23138 overlap_hl
= DRAW_NORMAL_TEXT
;
23141 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23142 overlap_hl
, dummy_x
, last_x
);
23143 for (s
= h
; s
; s
= s
->next
)
23144 s
->background_filled_p
= 1;
23145 compute_overhangs_and_x (t
, head
->x
, 1);
23146 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23149 /* Append glyphs strings for glyphs following the last glyph
23150 string tail that are overwritten by tail. The background of
23151 these strings has to be drawn because tail's foreground draws
23153 i
= right_overwritten (tail
);
23156 enum draw_glyphs_face overlap_hl
;
23158 if (check_mouse_face
23159 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23160 overlap_hl
= DRAW_MOUSE_FACE
;
23162 overlap_hl
= DRAW_NORMAL_TEXT
;
23164 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23165 overlap_hl
, x
, last_x
);
23166 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23167 we don't have `end = i;' here. */
23168 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23169 append_glyph_string_lists (&head
, &tail
, h
, t
);
23173 /* Append glyph strings for glyphs following the last glyph
23174 string tail that overwrite tail. The foreground of such
23175 glyphs has to be drawn because it writes into the background
23176 of tail. The background must not be drawn because it could
23177 paint over the foreground of following glyphs. */
23178 i
= right_overwriting (tail
);
23181 enum draw_glyphs_face overlap_hl
;
23182 if (check_mouse_face
23183 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23184 overlap_hl
= DRAW_MOUSE_FACE
;
23186 overlap_hl
= DRAW_NORMAL_TEXT
;
23189 i
++; /* We must include the Ith glyph. */
23190 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23191 overlap_hl
, x
, last_x
);
23192 for (s
= h
; s
; s
= s
->next
)
23193 s
->background_filled_p
= 1;
23194 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23195 append_glyph_string_lists (&head
, &tail
, h
, t
);
23197 if (clip_head
|| clip_tail
)
23198 for (s
= head
; s
; s
= s
->next
)
23200 s
->clip_head
= clip_head
;
23201 s
->clip_tail
= clip_tail
;
23205 /* Draw all strings. */
23206 for (s
= head
; s
; s
= s
->next
)
23207 FRAME_RIF (f
)->draw_glyph_string (s
);
23210 /* When focus a sole frame and move horizontally, this sets on_p to 0
23211 causing a failure to erase prev cursor position. */
23212 if (area
== TEXT_AREA
23213 && !row
->full_width_p
23214 /* When drawing overlapping rows, only the glyph strings'
23215 foreground is drawn, which doesn't erase a cursor
23219 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23220 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23221 : (tail
? tail
->x
+ tail
->background_width
: x
));
23225 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23226 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23230 /* Value is the x-position up to which drawn, relative to AREA of W.
23231 This doesn't include parts drawn because of overhangs. */
23232 if (row
->full_width_p
)
23233 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23235 x_reached
-= area_left
;
23237 RELEASE_HDC (hdc
, f
);
23242 /* Expand row matrix if too narrow. Don't expand if area
23245 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23247 if (!fonts_changed_p \
23248 && (it->glyph_row->glyphs[area] \
23249 < it->glyph_row->glyphs[area + 1])) \
23251 it->w->ncols_scale_factor++; \
23252 fonts_changed_p = 1; \
23256 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23257 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23260 append_glyph (struct it
*it
)
23262 struct glyph
*glyph
;
23263 enum glyph_row_area area
= it
->area
;
23265 xassert (it
->glyph_row
);
23266 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23268 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23269 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23271 /* If the glyph row is reversed, we need to prepend the glyph
23272 rather than append it. */
23273 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23277 /* Make room for the additional glyph. */
23278 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23280 glyph
= it
->glyph_row
->glyphs
[area
];
23282 glyph
->charpos
= CHARPOS (it
->position
);
23283 glyph
->object
= it
->object
;
23284 if (it
->pixel_width
> 0)
23286 glyph
->pixel_width
= it
->pixel_width
;
23287 glyph
->padding_p
= 0;
23291 /* Assure at least 1-pixel width. Otherwise, cursor can't
23292 be displayed correctly. */
23293 glyph
->pixel_width
= 1;
23294 glyph
->padding_p
= 1;
23296 glyph
->ascent
= it
->ascent
;
23297 glyph
->descent
= it
->descent
;
23298 glyph
->voffset
= it
->voffset
;
23299 glyph
->type
= CHAR_GLYPH
;
23300 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23301 glyph
->multibyte_p
= it
->multibyte_p
;
23302 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23303 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23304 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23305 || it
->phys_descent
> it
->descent
);
23306 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23307 glyph
->face_id
= it
->face_id
;
23308 glyph
->u
.ch
= it
->char_to_display
;
23309 glyph
->slice
.img
= null_glyph_slice
;
23310 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23313 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23314 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23316 glyph
->bidi_type
= it
->bidi_it
.type
;
23320 glyph
->resolved_level
= 0;
23321 glyph
->bidi_type
= UNKNOWN_BT
;
23323 ++it
->glyph_row
->used
[area
];
23326 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23329 /* Store one glyph for the composition IT->cmp_it.id in
23330 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23334 append_composite_glyph (struct it
*it
)
23336 struct glyph
*glyph
;
23337 enum glyph_row_area area
= it
->area
;
23339 xassert (it
->glyph_row
);
23341 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23342 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23344 /* If the glyph row is reversed, we need to prepend the glyph
23345 rather than append it. */
23346 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23350 /* Make room for the new glyph. */
23351 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23353 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23355 glyph
->charpos
= it
->cmp_it
.charpos
;
23356 glyph
->object
= it
->object
;
23357 glyph
->pixel_width
= it
->pixel_width
;
23358 glyph
->ascent
= it
->ascent
;
23359 glyph
->descent
= it
->descent
;
23360 glyph
->voffset
= it
->voffset
;
23361 glyph
->type
= COMPOSITE_GLYPH
;
23362 if (it
->cmp_it
.ch
< 0)
23364 glyph
->u
.cmp
.automatic
= 0;
23365 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23366 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23370 glyph
->u
.cmp
.automatic
= 1;
23371 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23372 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23373 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23375 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23376 glyph
->multibyte_p
= it
->multibyte_p
;
23377 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23378 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23379 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23380 || it
->phys_descent
> it
->descent
);
23381 glyph
->padding_p
= 0;
23382 glyph
->glyph_not_available_p
= 0;
23383 glyph
->face_id
= it
->face_id
;
23384 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23387 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23388 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23390 glyph
->bidi_type
= it
->bidi_it
.type
;
23392 ++it
->glyph_row
->used
[area
];
23395 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23399 /* Change IT->ascent and IT->height according to the setting of
23403 take_vertical_position_into_account (struct it
*it
)
23407 if (it
->voffset
< 0)
23408 /* Increase the ascent so that we can display the text higher
23410 it
->ascent
-= it
->voffset
;
23412 /* Increase the descent so that we can display the text lower
23414 it
->descent
+= it
->voffset
;
23419 /* Produce glyphs/get display metrics for the image IT is loaded with.
23420 See the description of struct display_iterator in dispextern.h for
23421 an overview of struct display_iterator. */
23424 produce_image_glyph (struct it
*it
)
23428 int glyph_ascent
, crop
;
23429 struct glyph_slice slice
;
23431 xassert (it
->what
== IT_IMAGE
);
23433 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23435 /* Make sure X resources of the face is loaded. */
23436 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23438 if (it
->image_id
< 0)
23440 /* Fringe bitmap. */
23441 it
->ascent
= it
->phys_ascent
= 0;
23442 it
->descent
= it
->phys_descent
= 0;
23443 it
->pixel_width
= 0;
23448 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23450 /* Make sure X resources of the image is loaded. */
23451 prepare_image_for_display (it
->f
, img
);
23453 slice
.x
= slice
.y
= 0;
23454 slice
.width
= img
->width
;
23455 slice
.height
= img
->height
;
23457 if (INTEGERP (it
->slice
.x
))
23458 slice
.x
= XINT (it
->slice
.x
);
23459 else if (FLOATP (it
->slice
.x
))
23460 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23462 if (INTEGERP (it
->slice
.y
))
23463 slice
.y
= XINT (it
->slice
.y
);
23464 else if (FLOATP (it
->slice
.y
))
23465 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23467 if (INTEGERP (it
->slice
.width
))
23468 slice
.width
= XINT (it
->slice
.width
);
23469 else if (FLOATP (it
->slice
.width
))
23470 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23472 if (INTEGERP (it
->slice
.height
))
23473 slice
.height
= XINT (it
->slice
.height
);
23474 else if (FLOATP (it
->slice
.height
))
23475 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23477 if (slice
.x
>= img
->width
)
23478 slice
.x
= img
->width
;
23479 if (slice
.y
>= img
->height
)
23480 slice
.y
= img
->height
;
23481 if (slice
.x
+ slice
.width
>= img
->width
)
23482 slice
.width
= img
->width
- slice
.x
;
23483 if (slice
.y
+ slice
.height
> img
->height
)
23484 slice
.height
= img
->height
- slice
.y
;
23486 if (slice
.width
== 0 || slice
.height
== 0)
23489 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23491 it
->descent
= slice
.height
- glyph_ascent
;
23493 it
->descent
+= img
->vmargin
;
23494 if (slice
.y
+ slice
.height
== img
->height
)
23495 it
->descent
+= img
->vmargin
;
23496 it
->phys_descent
= it
->descent
;
23498 it
->pixel_width
= slice
.width
;
23500 it
->pixel_width
+= img
->hmargin
;
23501 if (slice
.x
+ slice
.width
== img
->width
)
23502 it
->pixel_width
+= img
->hmargin
;
23504 /* It's quite possible for images to have an ascent greater than
23505 their height, so don't get confused in that case. */
23506 if (it
->descent
< 0)
23511 if (face
->box
!= FACE_NO_BOX
)
23513 if (face
->box_line_width
> 0)
23516 it
->ascent
+= face
->box_line_width
;
23517 if (slice
.y
+ slice
.height
== img
->height
)
23518 it
->descent
+= face
->box_line_width
;
23521 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23522 it
->pixel_width
+= eabs (face
->box_line_width
);
23523 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23524 it
->pixel_width
+= eabs (face
->box_line_width
);
23527 take_vertical_position_into_account (it
);
23529 /* Automatically crop wide image glyphs at right edge so we can
23530 draw the cursor on same display row. */
23531 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23532 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23534 it
->pixel_width
-= crop
;
23535 slice
.width
-= crop
;
23540 struct glyph
*glyph
;
23541 enum glyph_row_area area
= it
->area
;
23543 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23544 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23546 glyph
->charpos
= CHARPOS (it
->position
);
23547 glyph
->object
= it
->object
;
23548 glyph
->pixel_width
= it
->pixel_width
;
23549 glyph
->ascent
= glyph_ascent
;
23550 glyph
->descent
= it
->descent
;
23551 glyph
->voffset
= it
->voffset
;
23552 glyph
->type
= IMAGE_GLYPH
;
23553 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23554 glyph
->multibyte_p
= it
->multibyte_p
;
23555 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23556 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23557 glyph
->overlaps_vertically_p
= 0;
23558 glyph
->padding_p
= 0;
23559 glyph
->glyph_not_available_p
= 0;
23560 glyph
->face_id
= it
->face_id
;
23561 glyph
->u
.img_id
= img
->id
;
23562 glyph
->slice
.img
= slice
;
23563 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23566 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23567 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23569 glyph
->bidi_type
= it
->bidi_it
.type
;
23571 ++it
->glyph_row
->used
[area
];
23574 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23579 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23580 of the glyph, WIDTH and HEIGHT are the width and height of the
23581 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23584 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23585 int width
, int height
, int ascent
)
23587 struct glyph
*glyph
;
23588 enum glyph_row_area area
= it
->area
;
23590 xassert (ascent
>= 0 && ascent
<= height
);
23592 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23593 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23595 /* If the glyph row is reversed, we need to prepend the glyph
23596 rather than append it. */
23597 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23601 /* Make room for the additional glyph. */
23602 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23604 glyph
= it
->glyph_row
->glyphs
[area
];
23606 glyph
->charpos
= CHARPOS (it
->position
);
23607 glyph
->object
= object
;
23608 glyph
->pixel_width
= width
;
23609 glyph
->ascent
= ascent
;
23610 glyph
->descent
= height
- ascent
;
23611 glyph
->voffset
= it
->voffset
;
23612 glyph
->type
= STRETCH_GLYPH
;
23613 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23614 glyph
->multibyte_p
= it
->multibyte_p
;
23615 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23616 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23617 glyph
->overlaps_vertically_p
= 0;
23618 glyph
->padding_p
= 0;
23619 glyph
->glyph_not_available_p
= 0;
23620 glyph
->face_id
= it
->face_id
;
23621 glyph
->u
.stretch
.ascent
= ascent
;
23622 glyph
->u
.stretch
.height
= height
;
23623 glyph
->slice
.img
= null_glyph_slice
;
23624 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23627 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23628 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23630 glyph
->bidi_type
= it
->bidi_it
.type
;
23634 glyph
->resolved_level
= 0;
23635 glyph
->bidi_type
= UNKNOWN_BT
;
23637 ++it
->glyph_row
->used
[area
];
23640 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23643 #endif /* HAVE_WINDOW_SYSTEM */
23645 /* Produce a stretch glyph for iterator IT. IT->object is the value
23646 of the glyph property displayed. The value must be a list
23647 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23650 1. `:width WIDTH' specifies that the space should be WIDTH *
23651 canonical char width wide. WIDTH may be an integer or floating
23654 2. `:relative-width FACTOR' specifies that the width of the stretch
23655 should be computed from the width of the first character having the
23656 `glyph' property, and should be FACTOR times that width.
23658 3. `:align-to HPOS' specifies that the space should be wide enough
23659 to reach HPOS, a value in canonical character units.
23661 Exactly one of the above pairs must be present.
23663 4. `:height HEIGHT' specifies that the height of the stretch produced
23664 should be HEIGHT, measured in canonical character units.
23666 5. `:relative-height FACTOR' specifies that the height of the
23667 stretch should be FACTOR times the height of the characters having
23668 the glyph property.
23670 Either none or exactly one of 4 or 5 must be present.
23672 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23673 of the stretch should be used for the ascent of the stretch.
23674 ASCENT must be in the range 0 <= ASCENT <= 100. */
23677 produce_stretch_glyph (struct it
*it
)
23679 /* (space :width WIDTH :height HEIGHT ...) */
23680 Lisp_Object prop
, plist
;
23681 int width
= 0, height
= 0, align_to
= -1;
23682 int zero_width_ok_p
= 0;
23685 struct face
*face
= NULL
;
23686 struct font
*font
= NULL
;
23688 #ifdef HAVE_WINDOW_SYSTEM
23689 int zero_height_ok_p
= 0;
23691 if (FRAME_WINDOW_P (it
->f
))
23693 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23694 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23695 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23699 /* List should start with `space'. */
23700 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23701 plist
= XCDR (it
->object
);
23703 /* Compute the width of the stretch. */
23704 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23705 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23707 /* Absolute width `:width WIDTH' specified and valid. */
23708 zero_width_ok_p
= 1;
23711 #ifdef HAVE_WINDOW_SYSTEM
23712 else if (FRAME_WINDOW_P (it
->f
)
23713 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23715 /* Relative width `:relative-width FACTOR' specified and valid.
23716 Compute the width of the characters having the `glyph'
23719 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23722 if (it
->multibyte_p
)
23723 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23726 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23727 if (! ASCII_CHAR_P (it2
.c
))
23728 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23731 it2
.glyph_row
= NULL
;
23732 it2
.what
= IT_CHARACTER
;
23733 x_produce_glyphs (&it2
);
23734 width
= NUMVAL (prop
) * it2
.pixel_width
;
23736 #endif /* HAVE_WINDOW_SYSTEM */
23737 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23738 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23740 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23741 align_to
= (align_to
< 0
23743 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23744 else if (align_to
< 0)
23745 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23746 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23747 zero_width_ok_p
= 1;
23750 /* Nothing specified -> width defaults to canonical char width. */
23751 width
= FRAME_COLUMN_WIDTH (it
->f
);
23753 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23756 #ifdef HAVE_WINDOW_SYSTEM
23757 /* Compute height. */
23758 if (FRAME_WINDOW_P (it
->f
))
23760 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23761 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23764 zero_height_ok_p
= 1;
23766 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23768 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23770 height
= FONT_HEIGHT (font
);
23772 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23775 /* Compute percentage of height used for ascent. If
23776 `:ascent ASCENT' is present and valid, use that. Otherwise,
23777 derive the ascent from the font in use. */
23778 if (prop
= Fplist_get (plist
, QCascent
),
23779 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23780 ascent
= height
* NUMVAL (prop
) / 100.0;
23781 else if (!NILP (prop
)
23782 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23783 ascent
= min (max (0, (int)tem
), height
);
23785 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23788 #endif /* HAVE_WINDOW_SYSTEM */
23791 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23792 && it
->current_x
+ width
> it
->last_visible_x
)
23794 width
= it
->last_visible_x
- it
->current_x
;
23795 #ifdef HAVE_WINDOW_SYSTEM
23796 /* Subtract one more pixel from the stretch width, but only on
23797 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23798 width
-= FRAME_WINDOW_P (it
->f
);
23802 if (width
> 0 && height
> 0 && it
->glyph_row
)
23804 Lisp_Object o_object
= it
->object
;
23805 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23808 if (!STRINGP (object
))
23809 object
= it
->w
->buffer
;
23810 #ifdef HAVE_WINDOW_SYSTEM
23811 if (FRAME_WINDOW_P (it
->f
))
23812 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23816 it
->object
= object
;
23817 it
->char_to_display
= ' ';
23818 it
->pixel_width
= it
->len
= 1;
23820 tty_append_glyph (it
);
23821 it
->object
= o_object
;
23825 it
->pixel_width
= width
;
23826 #ifdef HAVE_WINDOW_SYSTEM
23827 if (FRAME_WINDOW_P (it
->f
))
23829 it
->ascent
= it
->phys_ascent
= ascent
;
23830 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23831 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23832 take_vertical_position_into_account (it
);
23836 it
->nglyphs
= width
;
23839 #ifdef HAVE_WINDOW_SYSTEM
23841 /* Calculate line-height and line-spacing properties.
23842 An integer value specifies explicit pixel value.
23843 A float value specifies relative value to current face height.
23844 A cons (float . face-name) specifies relative value to
23845 height of specified face font.
23847 Returns height in pixels, or nil. */
23851 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23852 int boff
, int override
)
23854 Lisp_Object face_name
= Qnil
;
23855 int ascent
, descent
, height
;
23857 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23862 face_name
= XCAR (val
);
23864 if (!NUMBERP (val
))
23865 val
= make_number (1);
23866 if (NILP (face_name
))
23868 height
= it
->ascent
+ it
->descent
;
23873 if (NILP (face_name
))
23875 font
= FRAME_FONT (it
->f
);
23876 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23878 else if (EQ (face_name
, Qt
))
23887 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23889 return make_number (-1);
23891 face
= FACE_FROM_ID (it
->f
, face_id
);
23894 return make_number (-1);
23895 boff
= font
->baseline_offset
;
23896 if (font
->vertical_centering
)
23897 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23900 ascent
= FONT_BASE (font
) + boff
;
23901 descent
= FONT_DESCENT (font
) - boff
;
23905 it
->override_ascent
= ascent
;
23906 it
->override_descent
= descent
;
23907 it
->override_boff
= boff
;
23910 height
= ascent
+ descent
;
23914 height
= (int)(XFLOAT_DATA (val
) * height
);
23915 else if (INTEGERP (val
))
23916 height
*= XINT (val
);
23918 return make_number (height
);
23922 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23923 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23924 and only if this is for a character for which no font was found.
23926 If the display method (it->glyphless_method) is
23927 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23928 length of the acronym or the hexadecimal string, UPPER_XOFF and
23929 UPPER_YOFF are pixel offsets for the upper part of the string,
23930 LOWER_XOFF and LOWER_YOFF are for the lower part.
23932 For the other display methods, LEN through LOWER_YOFF are zero. */
23935 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23936 short upper_xoff
, short upper_yoff
,
23937 short lower_xoff
, short lower_yoff
)
23939 struct glyph
*glyph
;
23940 enum glyph_row_area area
= it
->area
;
23942 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23943 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23945 /* If the glyph row is reversed, we need to prepend the glyph
23946 rather than append it. */
23947 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23951 /* Make room for the additional glyph. */
23952 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23954 glyph
= it
->glyph_row
->glyphs
[area
];
23956 glyph
->charpos
= CHARPOS (it
->position
);
23957 glyph
->object
= it
->object
;
23958 glyph
->pixel_width
= it
->pixel_width
;
23959 glyph
->ascent
= it
->ascent
;
23960 glyph
->descent
= it
->descent
;
23961 glyph
->voffset
= it
->voffset
;
23962 glyph
->type
= GLYPHLESS_GLYPH
;
23963 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23964 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23965 glyph
->u
.glyphless
.len
= len
;
23966 glyph
->u
.glyphless
.ch
= it
->c
;
23967 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23968 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23969 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23970 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23971 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23972 glyph
->multibyte_p
= it
->multibyte_p
;
23973 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23974 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23975 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23976 || it
->phys_descent
> it
->descent
);
23977 glyph
->padding_p
= 0;
23978 glyph
->glyph_not_available_p
= 0;
23979 glyph
->face_id
= face_id
;
23980 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23983 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23984 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23986 glyph
->bidi_type
= it
->bidi_it
.type
;
23988 ++it
->glyph_row
->used
[area
];
23991 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23995 /* Produce a glyph for a glyphless character for iterator IT.
23996 IT->glyphless_method specifies which method to use for displaying
23997 the character. See the description of enum
23998 glyphless_display_method in dispextern.h for the detail.
24000 FOR_NO_FONT is nonzero if and only if this is for a character for
24001 which no font was found. ACRONYM, if non-nil, is an acronym string
24002 for the character. */
24005 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
24010 int base_width
, base_height
, width
, height
;
24011 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
24014 /* Get the metrics of the base font. We always refer to the current
24016 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
24017 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24018 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
24019 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
24020 base_height
= it
->ascent
+ it
->descent
;
24021 base_width
= font
->average_width
;
24023 /* Get a face ID for the glyph by utilizing a cache (the same way as
24024 done for `escape-glyph' in get_next_display_element). */
24025 if (it
->f
== last_glyphless_glyph_frame
24026 && it
->face_id
== last_glyphless_glyph_face_id
)
24028 face_id
= last_glyphless_glyph_merged_face_id
;
24032 /* Merge the `glyphless-char' face into the current face. */
24033 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24034 last_glyphless_glyph_frame
= it
->f
;
24035 last_glyphless_glyph_face_id
= it
->face_id
;
24036 last_glyphless_glyph_merged_face_id
= face_id
;
24039 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24041 it
->pixel_width
= THIN_SPACE_WIDTH
;
24043 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24045 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24047 width
= CHAR_WIDTH (it
->c
);
24050 else if (width
> 4)
24052 it
->pixel_width
= base_width
* width
;
24054 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24060 unsigned int code
[6];
24062 int ascent
, descent
;
24063 struct font_metrics metrics_upper
, metrics_lower
;
24065 face
= FACE_FROM_ID (it
->f
, face_id
);
24066 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24067 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24069 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24071 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24072 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24073 if (CONSP (acronym
))
24074 acronym
= XCAR (acronym
);
24075 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24079 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24080 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24083 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24084 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24085 upper_len
= (len
+ 1) / 2;
24086 font
->driver
->text_extents (font
, code
, upper_len
,
24088 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24093 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24094 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24095 upper_xoff
= upper_yoff
= 2; /* the typical case */
24096 if (base_width
>= width
)
24098 /* Align the upper to the left, the lower to the right. */
24099 it
->pixel_width
= base_width
;
24100 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24104 /* Center the shorter one. */
24105 it
->pixel_width
= width
;
24106 if (metrics_upper
.width
>= metrics_lower
.width
)
24107 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24110 /* FIXME: This code doesn't look right. It formerly was
24111 missing the "lower_xoff = 0;", which couldn't have
24112 been right since it left lower_xoff uninitialized. */
24114 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24118 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24119 top, bottom, and between upper and lower strings. */
24120 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24121 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24122 /* Center vertically.
24123 H:base_height, D:base_descent
24124 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24126 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24127 descent = D - H/2 + h/2;
24128 lower_yoff = descent - 2 - ld;
24129 upper_yoff = lower_yoff - la - 1 - ud; */
24130 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24131 descent
= it
->descent
- (base_height
- height
) / 2;
24132 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24133 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24134 - metrics_upper
.descent
);
24135 /* Don't make the height shorter than the base height. */
24136 if (height
> base_height
)
24138 it
->ascent
= ascent
;
24139 it
->descent
= descent
;
24143 it
->phys_ascent
= it
->ascent
;
24144 it
->phys_descent
= it
->descent
;
24146 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24147 upper_xoff
, upper_yoff
,
24148 lower_xoff
, lower_yoff
);
24150 take_vertical_position_into_account (it
);
24155 Produce glyphs/get display metrics for the display element IT is
24156 loaded with. See the description of struct it in dispextern.h
24157 for an overview of struct it. */
24160 x_produce_glyphs (struct it
*it
)
24162 int extra_line_spacing
= it
->extra_line_spacing
;
24164 it
->glyph_not_available_p
= 0;
24166 if (it
->what
== IT_CHARACTER
)
24169 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24170 struct font
*font
= face
->font
;
24171 struct font_metrics
*pcm
= NULL
;
24172 int boff
; /* baseline offset */
24176 /* When no suitable font is found, display this character by
24177 the method specified in the first extra slot of
24178 Vglyphless_char_display. */
24179 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24181 xassert (it
->what
== IT_GLYPHLESS
);
24182 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24186 boff
= font
->baseline_offset
;
24187 if (font
->vertical_centering
)
24188 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24190 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24196 if (it
->override_ascent
>= 0)
24198 it
->ascent
= it
->override_ascent
;
24199 it
->descent
= it
->override_descent
;
24200 boff
= it
->override_boff
;
24204 it
->ascent
= FONT_BASE (font
) + boff
;
24205 it
->descent
= FONT_DESCENT (font
) - boff
;
24208 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24210 pcm
= get_per_char_metric (font
, &char2b
);
24211 if (pcm
->width
== 0
24212 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24218 it
->phys_ascent
= pcm
->ascent
+ boff
;
24219 it
->phys_descent
= pcm
->descent
- boff
;
24220 it
->pixel_width
= pcm
->width
;
24224 it
->glyph_not_available_p
= 1;
24225 it
->phys_ascent
= it
->ascent
;
24226 it
->phys_descent
= it
->descent
;
24227 it
->pixel_width
= font
->space_width
;
24230 if (it
->constrain_row_ascent_descent_p
)
24232 if (it
->descent
> it
->max_descent
)
24234 it
->ascent
+= it
->descent
- it
->max_descent
;
24235 it
->descent
= it
->max_descent
;
24237 if (it
->ascent
> it
->max_ascent
)
24239 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24240 it
->ascent
= it
->max_ascent
;
24242 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24243 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24244 extra_line_spacing
= 0;
24247 /* If this is a space inside a region of text with
24248 `space-width' property, change its width. */
24249 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24251 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24253 /* If face has a box, add the box thickness to the character
24254 height. If character has a box line to the left and/or
24255 right, add the box line width to the character's width. */
24256 if (face
->box
!= FACE_NO_BOX
)
24258 int thick
= face
->box_line_width
;
24262 it
->ascent
+= thick
;
24263 it
->descent
+= thick
;
24268 if (it
->start_of_box_run_p
)
24269 it
->pixel_width
+= thick
;
24270 if (it
->end_of_box_run_p
)
24271 it
->pixel_width
+= thick
;
24274 /* If face has an overline, add the height of the overline
24275 (1 pixel) and a 1 pixel margin to the character height. */
24276 if (face
->overline_p
)
24277 it
->ascent
+= overline_margin
;
24279 if (it
->constrain_row_ascent_descent_p
)
24281 if (it
->ascent
> it
->max_ascent
)
24282 it
->ascent
= it
->max_ascent
;
24283 if (it
->descent
> it
->max_descent
)
24284 it
->descent
= it
->max_descent
;
24287 take_vertical_position_into_account (it
);
24289 /* If we have to actually produce glyphs, do it. */
24294 /* Translate a space with a `space-width' property
24295 into a stretch glyph. */
24296 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24297 / FONT_HEIGHT (font
));
24298 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24299 it
->ascent
+ it
->descent
, ascent
);
24304 /* If characters with lbearing or rbearing are displayed
24305 in this line, record that fact in a flag of the
24306 glyph row. This is used to optimize X output code. */
24307 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24308 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24310 if (! stretched_p
&& it
->pixel_width
== 0)
24311 /* We assure that all visible glyphs have at least 1-pixel
24313 it
->pixel_width
= 1;
24315 else if (it
->char_to_display
== '\n')
24317 /* A newline has no width, but we need the height of the
24318 line. But if previous part of the line sets a height,
24319 don't increase that height */
24321 Lisp_Object height
;
24322 Lisp_Object total_height
= Qnil
;
24324 it
->override_ascent
= -1;
24325 it
->pixel_width
= 0;
24328 height
= get_it_property (it
, Qline_height
);
24329 /* Split (line-height total-height) list */
24331 && CONSP (XCDR (height
))
24332 && NILP (XCDR (XCDR (height
))))
24334 total_height
= XCAR (XCDR (height
));
24335 height
= XCAR (height
);
24337 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24339 if (it
->override_ascent
>= 0)
24341 it
->ascent
= it
->override_ascent
;
24342 it
->descent
= it
->override_descent
;
24343 boff
= it
->override_boff
;
24347 it
->ascent
= FONT_BASE (font
) + boff
;
24348 it
->descent
= FONT_DESCENT (font
) - boff
;
24351 if (EQ (height
, Qt
))
24353 if (it
->descent
> it
->max_descent
)
24355 it
->ascent
+= it
->descent
- it
->max_descent
;
24356 it
->descent
= it
->max_descent
;
24358 if (it
->ascent
> it
->max_ascent
)
24360 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24361 it
->ascent
= it
->max_ascent
;
24363 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24364 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24365 it
->constrain_row_ascent_descent_p
= 1;
24366 extra_line_spacing
= 0;
24370 Lisp_Object spacing
;
24372 it
->phys_ascent
= it
->ascent
;
24373 it
->phys_descent
= it
->descent
;
24375 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24376 && face
->box
!= FACE_NO_BOX
24377 && face
->box_line_width
> 0)
24379 it
->ascent
+= face
->box_line_width
;
24380 it
->descent
+= face
->box_line_width
;
24383 && XINT (height
) > it
->ascent
+ it
->descent
)
24384 it
->ascent
= XINT (height
) - it
->descent
;
24386 if (!NILP (total_height
))
24387 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24390 spacing
= get_it_property (it
, Qline_spacing
);
24391 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24393 if (INTEGERP (spacing
))
24395 extra_line_spacing
= XINT (spacing
);
24396 if (!NILP (total_height
))
24397 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24401 else /* i.e. (it->char_to_display == '\t') */
24403 if (font
->space_width
> 0)
24405 int tab_width
= it
->tab_width
* font
->space_width
;
24406 int x
= it
->current_x
+ it
->continuation_lines_width
;
24407 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24409 /* If the distance from the current position to the next tab
24410 stop is less than a space character width, use the
24411 tab stop after that. */
24412 if (next_tab_x
- x
< font
->space_width
)
24413 next_tab_x
+= tab_width
;
24415 it
->pixel_width
= next_tab_x
- x
;
24417 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24418 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24422 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24423 it
->ascent
+ it
->descent
, it
->ascent
);
24428 it
->pixel_width
= 0;
24433 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24435 /* A static composition.
24437 Note: A composition is represented as one glyph in the
24438 glyph matrix. There are no padding glyphs.
24440 Important note: pixel_width, ascent, and descent are the
24441 values of what is drawn by draw_glyphs (i.e. the values of
24442 the overall glyphs composed). */
24443 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24444 int boff
; /* baseline offset */
24445 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24446 int glyph_len
= cmp
->glyph_len
;
24447 struct font
*font
= face
->font
;
24451 /* If we have not yet calculated pixel size data of glyphs of
24452 the composition for the current face font, calculate them
24453 now. Theoretically, we have to check all fonts for the
24454 glyphs, but that requires much time and memory space. So,
24455 here we check only the font of the first glyph. This may
24456 lead to incorrect display, but it's very rare, and C-l
24457 (recenter-top-bottom) can correct the display anyway. */
24458 if (! cmp
->font
|| cmp
->font
!= font
)
24460 /* Ascent and descent of the font of the first character
24461 of this composition (adjusted by baseline offset).
24462 Ascent and descent of overall glyphs should not be less
24463 than these, respectively. */
24464 int font_ascent
, font_descent
, font_height
;
24465 /* Bounding box of the overall glyphs. */
24466 int leftmost
, rightmost
, lowest
, highest
;
24467 int lbearing
, rbearing
;
24468 int i
, width
, ascent
, descent
;
24469 int left_padded
= 0, right_padded
= 0;
24470 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24472 struct font_metrics
*pcm
;
24473 int font_not_found_p
;
24476 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24477 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24479 if (glyph_len
< cmp
->glyph_len
)
24481 for (i
= 0; i
< glyph_len
; i
++)
24483 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24485 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24490 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24491 : IT_CHARPOS (*it
));
24492 /* If no suitable font is found, use the default font. */
24493 font_not_found_p
= font
== NULL
;
24494 if (font_not_found_p
)
24496 face
= face
->ascii_face
;
24499 boff
= font
->baseline_offset
;
24500 if (font
->vertical_centering
)
24501 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24502 font_ascent
= FONT_BASE (font
) + boff
;
24503 font_descent
= FONT_DESCENT (font
) - boff
;
24504 font_height
= FONT_HEIGHT (font
);
24506 cmp
->font
= (void *) font
;
24509 if (! font_not_found_p
)
24511 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24513 pcm
= get_per_char_metric (font
, &char2b
);
24516 /* Initialize the bounding box. */
24519 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24520 ascent
= pcm
->ascent
;
24521 descent
= pcm
->descent
;
24522 lbearing
= pcm
->lbearing
;
24523 rbearing
= pcm
->rbearing
;
24527 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24528 ascent
= FONT_BASE (font
);
24529 descent
= FONT_DESCENT (font
);
24536 lowest
= - descent
+ boff
;
24537 highest
= ascent
+ boff
;
24539 if (! font_not_found_p
24540 && font
->default_ascent
24541 && CHAR_TABLE_P (Vuse_default_ascent
)
24542 && !NILP (Faref (Vuse_default_ascent
,
24543 make_number (it
->char_to_display
))))
24544 highest
= font
->default_ascent
+ boff
;
24546 /* Draw the first glyph at the normal position. It may be
24547 shifted to right later if some other glyphs are drawn
24549 cmp
->offsets
[i
* 2] = 0;
24550 cmp
->offsets
[i
* 2 + 1] = boff
;
24551 cmp
->lbearing
= lbearing
;
24552 cmp
->rbearing
= rbearing
;
24554 /* Set cmp->offsets for the remaining glyphs. */
24555 for (i
++; i
< glyph_len
; i
++)
24557 int left
, right
, btm
, top
;
24558 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24560 struct face
*this_face
;
24564 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24565 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24566 font
= this_face
->font
;
24572 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24574 pcm
= get_per_char_metric (font
, &char2b
);
24577 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24580 width
= pcm
->width
;
24581 ascent
= pcm
->ascent
;
24582 descent
= pcm
->descent
;
24583 lbearing
= pcm
->lbearing
;
24584 rbearing
= pcm
->rbearing
;
24585 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24587 /* Relative composition with or without
24588 alternate chars. */
24589 left
= (leftmost
+ rightmost
- width
) / 2;
24590 btm
= - descent
+ boff
;
24591 if (font
->relative_compose
24592 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24593 || NILP (Faref (Vignore_relative_composition
,
24594 make_number (ch
)))))
24597 if (- descent
>= font
->relative_compose
)
24598 /* One extra pixel between two glyphs. */
24600 else if (ascent
<= 0)
24601 /* One extra pixel between two glyphs. */
24602 btm
= lowest
- 1 - ascent
- descent
;
24607 /* A composition rule is specified by an integer
24608 value that encodes global and new reference
24609 points (GREF and NREF). GREF and NREF are
24610 specified by numbers as below:
24612 0---1---2 -- ascent
24616 9--10--11 -- center
24618 ---3---4---5--- baseline
24620 6---7---8 -- descent
24622 int rule
= COMPOSITION_RULE (cmp
, i
);
24623 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24625 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24626 grefx
= gref
% 3, nrefx
= nref
% 3;
24627 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24629 xoff
= font_height
* (xoff
- 128) / 256;
24631 yoff
= font_height
* (yoff
- 128) / 256;
24634 + grefx
* (rightmost
- leftmost
) / 2
24635 - nrefx
* width
/ 2
24638 btm
= ((grefy
== 0 ? highest
24640 : grefy
== 2 ? lowest
24641 : (highest
+ lowest
) / 2)
24642 - (nrefy
== 0 ? ascent
+ descent
24643 : nrefy
== 1 ? descent
- boff
24645 : (ascent
+ descent
) / 2)
24649 cmp
->offsets
[i
* 2] = left
;
24650 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24652 /* Update the bounding box of the overall glyphs. */
24655 right
= left
+ width
;
24656 if (left
< leftmost
)
24658 if (right
> rightmost
)
24661 top
= btm
+ descent
+ ascent
;
24667 if (cmp
->lbearing
> left
+ lbearing
)
24668 cmp
->lbearing
= left
+ lbearing
;
24669 if (cmp
->rbearing
< left
+ rbearing
)
24670 cmp
->rbearing
= left
+ rbearing
;
24674 /* If there are glyphs whose x-offsets are negative,
24675 shift all glyphs to the right and make all x-offsets
24679 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24680 cmp
->offsets
[i
* 2] -= leftmost
;
24681 rightmost
-= leftmost
;
24682 cmp
->lbearing
-= leftmost
;
24683 cmp
->rbearing
-= leftmost
;
24686 if (left_padded
&& cmp
->lbearing
< 0)
24688 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24689 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24690 rightmost
-= cmp
->lbearing
;
24691 cmp
->rbearing
-= cmp
->lbearing
;
24694 if (right_padded
&& rightmost
< cmp
->rbearing
)
24696 rightmost
= cmp
->rbearing
;
24699 cmp
->pixel_width
= rightmost
;
24700 cmp
->ascent
= highest
;
24701 cmp
->descent
= - lowest
;
24702 if (cmp
->ascent
< font_ascent
)
24703 cmp
->ascent
= font_ascent
;
24704 if (cmp
->descent
< font_descent
)
24705 cmp
->descent
= font_descent
;
24709 && (cmp
->lbearing
< 0
24710 || cmp
->rbearing
> cmp
->pixel_width
))
24711 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24713 it
->pixel_width
= cmp
->pixel_width
;
24714 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24715 it
->descent
= it
->phys_descent
= cmp
->descent
;
24716 if (face
->box
!= FACE_NO_BOX
)
24718 int thick
= face
->box_line_width
;
24722 it
->ascent
+= thick
;
24723 it
->descent
+= thick
;
24728 if (it
->start_of_box_run_p
)
24729 it
->pixel_width
+= thick
;
24730 if (it
->end_of_box_run_p
)
24731 it
->pixel_width
+= thick
;
24734 /* If face has an overline, add the height of the overline
24735 (1 pixel) and a 1 pixel margin to the character height. */
24736 if (face
->overline_p
)
24737 it
->ascent
+= overline_margin
;
24739 take_vertical_position_into_account (it
);
24740 if (it
->ascent
< 0)
24742 if (it
->descent
< 0)
24745 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
24746 append_composite_glyph (it
);
24748 else if (it
->what
== IT_COMPOSITION
)
24750 /* A dynamic (automatic) composition. */
24751 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24752 Lisp_Object gstring
;
24753 struct font_metrics metrics
;
24757 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24759 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24762 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24763 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24764 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24765 it
->descent
= it
->phys_descent
= metrics
.descent
;
24766 if (face
->box
!= FACE_NO_BOX
)
24768 int thick
= face
->box_line_width
;
24772 it
->ascent
+= thick
;
24773 it
->descent
+= thick
;
24778 if (it
->start_of_box_run_p
)
24779 it
->pixel_width
+= thick
;
24780 if (it
->end_of_box_run_p
)
24781 it
->pixel_width
+= thick
;
24783 /* If face has an overline, add the height of the overline
24784 (1 pixel) and a 1 pixel margin to the character height. */
24785 if (face
->overline_p
)
24786 it
->ascent
+= overline_margin
;
24787 take_vertical_position_into_account (it
);
24788 if (it
->ascent
< 0)
24790 if (it
->descent
< 0)
24794 append_composite_glyph (it
);
24796 else if (it
->what
== IT_GLYPHLESS
)
24797 produce_glyphless_glyph (it
, 0, Qnil
);
24798 else if (it
->what
== IT_IMAGE
)
24799 produce_image_glyph (it
);
24800 else if (it
->what
== IT_STRETCH
)
24801 produce_stretch_glyph (it
);
24804 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24805 because this isn't true for images with `:ascent 100'. */
24806 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24807 if (it
->area
== TEXT_AREA
)
24808 it
->current_x
+= it
->pixel_width
;
24810 if (extra_line_spacing
> 0)
24812 it
->descent
+= extra_line_spacing
;
24813 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24814 it
->max_extra_line_spacing
= extra_line_spacing
;
24817 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24818 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24819 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24820 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24824 Output LEN glyphs starting at START at the nominal cursor position.
24825 Advance the nominal cursor over the text. The global variable
24826 updated_window contains the window being updated, updated_row is
24827 the glyph row being updated, and updated_area is the area of that
24828 row being updated. */
24831 x_write_glyphs (struct glyph
*start
, int len
)
24833 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
24835 xassert (updated_window
&& updated_row
);
24836 /* When the window is hscrolled, cursor hpos can legitimately be out
24837 of bounds, but we draw the cursor at the corresponding window
24838 margin in that case. */
24839 if (!updated_row
->reversed_p
&& chpos
< 0)
24841 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
24842 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
24846 /* Write glyphs. */
24848 hpos
= start
- updated_row
->glyphs
[updated_area
];
24849 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24850 updated_row
, updated_area
,
24852 DRAW_NORMAL_TEXT
, 0);
24854 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24855 if (updated_area
== TEXT_AREA
24856 && updated_window
->phys_cursor_on_p
24857 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24859 && chpos
< hpos
+ len
)
24860 updated_window
->phys_cursor_on_p
= 0;
24864 /* Advance the output cursor. */
24865 output_cursor
.hpos
+= len
;
24866 output_cursor
.x
= x
;
24871 Insert LEN glyphs from START at the nominal cursor position. */
24874 x_insert_glyphs (struct glyph
*start
, int len
)
24878 int line_height
, shift_by_width
, shifted_region_width
;
24879 struct glyph_row
*row
;
24880 struct glyph
*glyph
;
24881 int frame_x
, frame_y
;
24884 xassert (updated_window
&& updated_row
);
24886 w
= updated_window
;
24887 f
= XFRAME (WINDOW_FRAME (w
));
24889 /* Get the height of the line we are in. */
24891 line_height
= row
->height
;
24893 /* Get the width of the glyphs to insert. */
24894 shift_by_width
= 0;
24895 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24896 shift_by_width
+= glyph
->pixel_width
;
24898 /* Get the width of the region to shift right. */
24899 shifted_region_width
= (window_box_width (w
, updated_area
)
24904 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24905 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24907 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24908 line_height
, shift_by_width
);
24910 /* Write the glyphs. */
24911 hpos
= start
- row
->glyphs
[updated_area
];
24912 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24914 DRAW_NORMAL_TEXT
, 0);
24916 /* Advance the output cursor. */
24917 output_cursor
.hpos
+= len
;
24918 output_cursor
.x
+= shift_by_width
;
24924 Erase the current text line from the nominal cursor position
24925 (inclusive) to pixel column TO_X (exclusive). The idea is that
24926 everything from TO_X onward is already erased.
24928 TO_X is a pixel position relative to updated_area of
24929 updated_window. TO_X == -1 means clear to the end of this area. */
24932 x_clear_end_of_line (int to_x
)
24935 struct window
*w
= updated_window
;
24936 int max_x
, min_y
, max_y
;
24937 int from_x
, from_y
, to_y
;
24939 xassert (updated_window
&& updated_row
);
24940 f
= XFRAME (w
->frame
);
24942 if (updated_row
->full_width_p
)
24943 max_x
= WINDOW_TOTAL_WIDTH (w
);
24945 max_x
= window_box_width (w
, updated_area
);
24946 max_y
= window_text_bottom_y (w
);
24948 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24949 of window. For TO_X > 0, truncate to end of drawing area. */
24955 to_x
= min (to_x
, max_x
);
24957 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24959 /* Notice if the cursor will be cleared by this operation. */
24960 if (!updated_row
->full_width_p
)
24961 notice_overwritten_cursor (w
, updated_area
,
24962 output_cursor
.x
, -1,
24964 MATRIX_ROW_BOTTOM_Y (updated_row
));
24966 from_x
= output_cursor
.x
;
24968 /* Translate to frame coordinates. */
24969 if (updated_row
->full_width_p
)
24971 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24972 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24976 int area_left
= window_box_left (w
, updated_area
);
24977 from_x
+= area_left
;
24981 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24982 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24983 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24985 /* Prevent inadvertently clearing to end of the X window. */
24986 if (to_x
> from_x
&& to_y
> from_y
)
24989 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24990 to_x
- from_x
, to_y
- from_y
);
24995 #endif /* HAVE_WINDOW_SYSTEM */
24999 /***********************************************************************
25001 ***********************************************************************/
25003 /* Value is the internal representation of the specified cursor type
25004 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
25005 of the bar cursor. */
25007 static enum text_cursor_kinds
25008 get_specified_cursor_type (Lisp_Object arg
, int *width
)
25010 enum text_cursor_kinds type
;
25015 if (EQ (arg
, Qbox
))
25016 return FILLED_BOX_CURSOR
;
25018 if (EQ (arg
, Qhollow
))
25019 return HOLLOW_BOX_CURSOR
;
25021 if (EQ (arg
, Qbar
))
25028 && EQ (XCAR (arg
), Qbar
)
25029 && INTEGERP (XCDR (arg
))
25030 && XINT (XCDR (arg
)) >= 0)
25032 *width
= XINT (XCDR (arg
));
25036 if (EQ (arg
, Qhbar
))
25039 return HBAR_CURSOR
;
25043 && EQ (XCAR (arg
), Qhbar
)
25044 && INTEGERP (XCDR (arg
))
25045 && XINT (XCDR (arg
)) >= 0)
25047 *width
= XINT (XCDR (arg
));
25048 return HBAR_CURSOR
;
25051 /* Treat anything unknown as "hollow box cursor".
25052 It was bad to signal an error; people have trouble fixing
25053 .Xdefaults with Emacs, when it has something bad in it. */
25054 type
= HOLLOW_BOX_CURSOR
;
25059 /* Set the default cursor types for specified frame. */
25061 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25066 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25067 FRAME_CURSOR_WIDTH (f
) = width
;
25069 /* By default, set up the blink-off state depending on the on-state. */
25071 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25074 FRAME_BLINK_OFF_CURSOR (f
)
25075 = get_specified_cursor_type (XCDR (tem
), &width
);
25076 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25079 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25083 #ifdef HAVE_WINDOW_SYSTEM
25085 /* Return the cursor we want to be displayed in window W. Return
25086 width of bar/hbar cursor through WIDTH arg. Return with
25087 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25088 (i.e. if the `system caret' should track this cursor).
25090 In a mini-buffer window, we want the cursor only to appear if we
25091 are reading input from this window. For the selected window, we
25092 want the cursor type given by the frame parameter or buffer local
25093 setting of cursor-type. If explicitly marked off, draw no cursor.
25094 In all other cases, we want a hollow box cursor. */
25096 static enum text_cursor_kinds
25097 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25098 int *active_cursor
)
25100 struct frame
*f
= XFRAME (w
->frame
);
25101 struct buffer
*b
= XBUFFER (w
->buffer
);
25102 int cursor_type
= DEFAULT_CURSOR
;
25103 Lisp_Object alt_cursor
;
25104 int non_selected
= 0;
25106 *active_cursor
= 1;
25109 if (cursor_in_echo_area
25110 && FRAME_HAS_MINIBUF_P (f
)
25111 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25113 if (w
== XWINDOW (echo_area_window
))
25115 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25117 *width
= FRAME_CURSOR_WIDTH (f
);
25118 return FRAME_DESIRED_CURSOR (f
);
25121 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25124 *active_cursor
= 0;
25128 /* Detect a nonselected window or nonselected frame. */
25129 else if (w
!= XWINDOW (f
->selected_window
)
25130 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25132 *active_cursor
= 0;
25134 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25140 /* Never display a cursor in a window in which cursor-type is nil. */
25141 if (NILP (BVAR (b
, cursor_type
)))
25144 /* Get the normal cursor type for this window. */
25145 if (EQ (BVAR (b
, cursor_type
), Qt
))
25147 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25148 *width
= FRAME_CURSOR_WIDTH (f
);
25151 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25153 /* Use cursor-in-non-selected-windows instead
25154 for non-selected window or frame. */
25157 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25158 if (!EQ (Qt
, alt_cursor
))
25159 return get_specified_cursor_type (alt_cursor
, width
);
25160 /* t means modify the normal cursor type. */
25161 if (cursor_type
== FILLED_BOX_CURSOR
)
25162 cursor_type
= HOLLOW_BOX_CURSOR
;
25163 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25165 return cursor_type
;
25168 /* Use normal cursor if not blinked off. */
25169 if (!w
->cursor_off_p
)
25171 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25173 if (cursor_type
== FILLED_BOX_CURSOR
)
25175 /* Using a block cursor on large images can be very annoying.
25176 So use a hollow cursor for "large" images.
25177 If image is not transparent (no mask), also use hollow cursor. */
25178 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25179 if (img
!= NULL
&& IMAGEP (img
->spec
))
25181 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25182 where N = size of default frame font size.
25183 This should cover most of the "tiny" icons people may use. */
25185 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25186 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25187 cursor_type
= HOLLOW_BOX_CURSOR
;
25190 else if (cursor_type
!= NO_CURSOR
)
25192 /* Display current only supports BOX and HOLLOW cursors for images.
25193 So for now, unconditionally use a HOLLOW cursor when cursor is
25194 not a solid box cursor. */
25195 cursor_type
= HOLLOW_BOX_CURSOR
;
25198 return cursor_type
;
25201 /* Cursor is blinked off, so determine how to "toggle" it. */
25203 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25204 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25205 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25207 /* Then see if frame has specified a specific blink off cursor type. */
25208 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25210 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25211 return FRAME_BLINK_OFF_CURSOR (f
);
25215 /* Some people liked having a permanently visible blinking cursor,
25216 while others had very strong opinions against it. So it was
25217 decided to remove it. KFS 2003-09-03 */
25219 /* Finally perform built-in cursor blinking:
25220 filled box <-> hollow box
25221 wide [h]bar <-> narrow [h]bar
25222 narrow [h]bar <-> no cursor
25223 other type <-> no cursor */
25225 if (cursor_type
== FILLED_BOX_CURSOR
)
25226 return HOLLOW_BOX_CURSOR
;
25228 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25231 return cursor_type
;
25239 /* Notice when the text cursor of window W has been completely
25240 overwritten by a drawing operation that outputs glyphs in AREA
25241 starting at X0 and ending at X1 in the line starting at Y0 and
25242 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25243 the rest of the line after X0 has been written. Y coordinates
25244 are window-relative. */
25247 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25248 int x0
, int x1
, int y0
, int y1
)
25250 int cx0
, cx1
, cy0
, cy1
;
25251 struct glyph_row
*row
;
25253 if (!w
->phys_cursor_on_p
)
25255 if (area
!= TEXT_AREA
)
25258 if (w
->phys_cursor
.vpos
< 0
25259 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25260 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25261 !(row
->enabled_p
&& row
->displays_text_p
)))
25264 if (row
->cursor_in_fringe_p
)
25266 row
->cursor_in_fringe_p
= 0;
25267 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25268 w
->phys_cursor_on_p
= 0;
25272 cx0
= w
->phys_cursor
.x
;
25273 cx1
= cx0
+ w
->phys_cursor_width
;
25274 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25277 /* The cursor image will be completely removed from the
25278 screen if the output area intersects the cursor area in
25279 y-direction. When we draw in [y0 y1[, and some part of
25280 the cursor is at y < y0, that part must have been drawn
25281 before. When scrolling, the cursor is erased before
25282 actually scrolling, so we don't come here. When not
25283 scrolling, the rows above the old cursor row must have
25284 changed, and in this case these rows must have written
25285 over the cursor image.
25287 Likewise if part of the cursor is below y1, with the
25288 exception of the cursor being in the first blank row at
25289 the buffer and window end because update_text_area
25290 doesn't draw that row. (Except when it does, but
25291 that's handled in update_text_area.) */
25293 cy0
= w
->phys_cursor
.y
;
25294 cy1
= cy0
+ w
->phys_cursor_height
;
25295 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25298 w
->phys_cursor_on_p
= 0;
25301 #endif /* HAVE_WINDOW_SYSTEM */
25304 /************************************************************************
25306 ************************************************************************/
25308 #ifdef HAVE_WINDOW_SYSTEM
25311 Fix the display of area AREA of overlapping row ROW in window W
25312 with respect to the overlapping part OVERLAPS. */
25315 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25316 enum glyph_row_area area
, int overlaps
)
25323 for (i
= 0; i
< row
->used
[area
];)
25325 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25327 int start
= i
, start_x
= x
;
25331 x
+= row
->glyphs
[area
][i
].pixel_width
;
25334 while (i
< row
->used
[area
]
25335 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25337 draw_glyphs (w
, start_x
, row
, area
,
25339 DRAW_NORMAL_TEXT
, overlaps
);
25343 x
+= row
->glyphs
[area
][i
].pixel_width
;
25353 Draw the cursor glyph of window W in glyph row ROW. See the
25354 comment of draw_glyphs for the meaning of HL. */
25357 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25358 enum draw_glyphs_face hl
)
25360 /* If cursor hpos is out of bounds, don't draw garbage. This can
25361 happen in mini-buffer windows when switching between echo area
25362 glyphs and mini-buffer. */
25363 if ((row
->reversed_p
25364 ? (w
->phys_cursor
.hpos
>= 0)
25365 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25367 int on_p
= w
->phys_cursor_on_p
;
25369 int hpos
= w
->phys_cursor
.hpos
;
25371 /* When the window is hscrolled, cursor hpos can legitimately be
25372 out of bounds, but we draw the cursor at the corresponding
25373 window margin in that case. */
25374 if (!row
->reversed_p
&& hpos
< 0)
25376 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25377 hpos
= row
->used
[TEXT_AREA
] - 1;
25379 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25381 w
->phys_cursor_on_p
= on_p
;
25383 if (hl
== DRAW_CURSOR
)
25384 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25385 /* When we erase the cursor, and ROW is overlapped by other
25386 rows, make sure that these overlapping parts of other rows
25388 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25390 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25392 if (row
> w
->current_matrix
->rows
25393 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25394 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25395 OVERLAPS_ERASED_CURSOR
);
25397 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25398 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25399 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25400 OVERLAPS_ERASED_CURSOR
);
25407 Erase the image of a cursor of window W from the screen. */
25410 erase_phys_cursor (struct window
*w
)
25412 struct frame
*f
= XFRAME (w
->frame
);
25413 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25414 int hpos
= w
->phys_cursor
.hpos
;
25415 int vpos
= w
->phys_cursor
.vpos
;
25416 int mouse_face_here_p
= 0;
25417 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25418 struct glyph_row
*cursor_row
;
25419 struct glyph
*cursor_glyph
;
25420 enum draw_glyphs_face hl
;
25422 /* No cursor displayed or row invalidated => nothing to do on the
25424 if (w
->phys_cursor_type
== NO_CURSOR
)
25425 goto mark_cursor_off
;
25427 /* VPOS >= active_glyphs->nrows means that window has been resized.
25428 Don't bother to erase the cursor. */
25429 if (vpos
>= active_glyphs
->nrows
)
25430 goto mark_cursor_off
;
25432 /* If row containing cursor is marked invalid, there is nothing we
25434 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25435 if (!cursor_row
->enabled_p
)
25436 goto mark_cursor_off
;
25438 /* If line spacing is > 0, old cursor may only be partially visible in
25439 window after split-window. So adjust visible height. */
25440 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25441 window_text_bottom_y (w
) - cursor_row
->y
);
25443 /* If row is completely invisible, don't attempt to delete a cursor which
25444 isn't there. This can happen if cursor is at top of a window, and
25445 we switch to a buffer with a header line in that window. */
25446 if (cursor_row
->visible_height
<= 0)
25447 goto mark_cursor_off
;
25449 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25450 if (cursor_row
->cursor_in_fringe_p
)
25452 cursor_row
->cursor_in_fringe_p
= 0;
25453 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25454 goto mark_cursor_off
;
25457 /* This can happen when the new row is shorter than the old one.
25458 In this case, either draw_glyphs or clear_end_of_line
25459 should have cleared the cursor. Note that we wouldn't be
25460 able to erase the cursor in this case because we don't have a
25461 cursor glyph at hand. */
25462 if ((cursor_row
->reversed_p
25463 ? (w
->phys_cursor
.hpos
< 0)
25464 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25465 goto mark_cursor_off
;
25467 /* When the window is hscrolled, cursor hpos can legitimately be out
25468 of bounds, but we draw the cursor at the corresponding window
25469 margin in that case. */
25470 if (!cursor_row
->reversed_p
&& hpos
< 0)
25472 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25473 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25475 /* If the cursor is in the mouse face area, redisplay that when
25476 we clear the cursor. */
25477 if (! NILP (hlinfo
->mouse_face_window
)
25478 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25479 /* Don't redraw the cursor's spot in mouse face if it is at the
25480 end of a line (on a newline). The cursor appears there, but
25481 mouse highlighting does not. */
25482 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25483 mouse_face_here_p
= 1;
25485 /* Maybe clear the display under the cursor. */
25486 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25489 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25492 cursor_glyph
= get_phys_cursor_glyph (w
);
25493 if (cursor_glyph
== NULL
)
25494 goto mark_cursor_off
;
25496 width
= cursor_glyph
->pixel_width
;
25497 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25498 x
= w
->phys_cursor
.x
;
25500 width
-= left_x
- x
;
25501 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25502 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25503 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25506 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25509 /* Erase the cursor by redrawing the character underneath it. */
25510 if (mouse_face_here_p
)
25511 hl
= DRAW_MOUSE_FACE
;
25513 hl
= DRAW_NORMAL_TEXT
;
25514 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25517 w
->phys_cursor_on_p
= 0;
25518 w
->phys_cursor_type
= NO_CURSOR
;
25523 Display or clear cursor of window W. If ON is zero, clear the
25524 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25525 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25528 display_and_set_cursor (struct window
*w
, int on
,
25529 int hpos
, int vpos
, int x
, int y
)
25531 struct frame
*f
= XFRAME (w
->frame
);
25532 int new_cursor_type
;
25533 int new_cursor_width
;
25535 struct glyph_row
*glyph_row
;
25536 struct glyph
*glyph
;
25538 /* This is pointless on invisible frames, and dangerous on garbaged
25539 windows and frames; in the latter case, the frame or window may
25540 be in the midst of changing its size, and x and y may be off the
25542 if (! FRAME_VISIBLE_P (f
)
25543 || FRAME_GARBAGED_P (f
)
25544 || vpos
>= w
->current_matrix
->nrows
25545 || hpos
>= w
->current_matrix
->matrix_w
)
25548 /* If cursor is off and we want it off, return quickly. */
25549 if (!on
&& !w
->phys_cursor_on_p
)
25552 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25553 /* If cursor row is not enabled, we don't really know where to
25554 display the cursor. */
25555 if (!glyph_row
->enabled_p
)
25557 w
->phys_cursor_on_p
= 0;
25562 if (!glyph_row
->exact_window_width_line_p
25563 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25564 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25566 xassert (interrupt_input_blocked
);
25568 /* Set new_cursor_type to the cursor we want to be displayed. */
25569 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25570 &new_cursor_width
, &active_cursor
);
25572 /* If cursor is currently being shown and we don't want it to be or
25573 it is in the wrong place, or the cursor type is not what we want,
25575 if (w
->phys_cursor_on_p
25577 || w
->phys_cursor
.x
!= x
25578 || w
->phys_cursor
.y
!= y
25579 || new_cursor_type
!= w
->phys_cursor_type
25580 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25581 && new_cursor_width
!= w
->phys_cursor_width
)))
25582 erase_phys_cursor (w
);
25584 /* Don't check phys_cursor_on_p here because that flag is only set
25585 to zero in some cases where we know that the cursor has been
25586 completely erased, to avoid the extra work of erasing the cursor
25587 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25588 still not be visible, or it has only been partly erased. */
25591 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25592 w
->phys_cursor_height
= glyph_row
->height
;
25594 /* Set phys_cursor_.* before x_draw_.* is called because some
25595 of them may need the information. */
25596 w
->phys_cursor
.x
= x
;
25597 w
->phys_cursor
.y
= glyph_row
->y
;
25598 w
->phys_cursor
.hpos
= hpos
;
25599 w
->phys_cursor
.vpos
= vpos
;
25602 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25603 new_cursor_type
, new_cursor_width
,
25604 on
, active_cursor
);
25608 /* Switch the display of W's cursor on or off, according to the value
25612 update_window_cursor (struct window
*w
, int on
)
25614 /* Don't update cursor in windows whose frame is in the process
25615 of being deleted. */
25616 if (w
->current_matrix
)
25618 int hpos
= w
->phys_cursor
.hpos
;
25619 int vpos
= w
->phys_cursor
.vpos
;
25620 struct glyph_row
*row
;
25622 if (vpos
>= w
->current_matrix
->nrows
25623 || hpos
>= w
->current_matrix
->matrix_w
)
25626 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25628 /* When the window is hscrolled, cursor hpos can legitimately be
25629 out of bounds, but we draw the cursor at the corresponding
25630 window margin in that case. */
25631 if (!row
->reversed_p
&& hpos
< 0)
25633 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25634 hpos
= row
->used
[TEXT_AREA
] - 1;
25637 display_and_set_cursor (w
, on
, hpos
, vpos
,
25638 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25644 /* Call update_window_cursor with parameter ON_P on all leaf windows
25645 in the window tree rooted at W. */
25648 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25652 if (!NILP (w
->hchild
))
25653 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25654 else if (!NILP (w
->vchild
))
25655 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25657 update_window_cursor (w
, on_p
);
25659 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25665 Display the cursor on window W, or clear it, according to ON_P.
25666 Don't change the cursor's position. */
25669 x_update_cursor (struct frame
*f
, int on_p
)
25671 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25676 Clear the cursor of window W to background color, and mark the
25677 cursor as not shown. This is used when the text where the cursor
25678 is about to be rewritten. */
25681 x_clear_cursor (struct window
*w
)
25683 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25684 update_window_cursor (w
, 0);
25687 #endif /* HAVE_WINDOW_SYSTEM */
25689 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25692 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25693 int start_hpos
, int end_hpos
,
25694 enum draw_glyphs_face draw
)
25696 #ifdef HAVE_WINDOW_SYSTEM
25697 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25699 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25703 #if defined (HAVE_GPM) || defined (MSDOS)
25704 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25708 /* Display the active region described by mouse_face_* according to DRAW. */
25711 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25713 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25714 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25716 if (/* If window is in the process of being destroyed, don't bother
25718 w
->current_matrix
!= NULL
25719 /* Don't update mouse highlight if hidden */
25720 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25721 /* Recognize when we are called to operate on rows that don't exist
25722 anymore. This can happen when a window is split. */
25723 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25725 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25726 struct glyph_row
*row
, *first
, *last
;
25728 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25729 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25731 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25733 int start_hpos
, end_hpos
, start_x
;
25735 /* For all but the first row, the highlight starts at column 0. */
25738 /* R2L rows have BEG and END in reversed order, but the
25739 screen drawing geometry is always left to right. So
25740 we need to mirror the beginning and end of the
25741 highlighted area in R2L rows. */
25742 if (!row
->reversed_p
)
25744 start_hpos
= hlinfo
->mouse_face_beg_col
;
25745 start_x
= hlinfo
->mouse_face_beg_x
;
25747 else if (row
== last
)
25749 start_hpos
= hlinfo
->mouse_face_end_col
;
25750 start_x
= hlinfo
->mouse_face_end_x
;
25758 else if (row
->reversed_p
&& row
== last
)
25760 start_hpos
= hlinfo
->mouse_face_end_col
;
25761 start_x
= hlinfo
->mouse_face_end_x
;
25771 if (!row
->reversed_p
)
25772 end_hpos
= hlinfo
->mouse_face_end_col
;
25773 else if (row
== first
)
25774 end_hpos
= hlinfo
->mouse_face_beg_col
;
25777 end_hpos
= row
->used
[TEXT_AREA
];
25778 if (draw
== DRAW_NORMAL_TEXT
)
25779 row
->fill_line_p
= 1; /* Clear to end of line */
25782 else if (row
->reversed_p
&& row
== first
)
25783 end_hpos
= hlinfo
->mouse_face_beg_col
;
25786 end_hpos
= row
->used
[TEXT_AREA
];
25787 if (draw
== DRAW_NORMAL_TEXT
)
25788 row
->fill_line_p
= 1; /* Clear to end of line */
25791 if (end_hpos
> start_hpos
)
25793 draw_row_with_mouse_face (w
, start_x
, row
,
25794 start_hpos
, end_hpos
, draw
);
25797 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25801 #ifdef HAVE_WINDOW_SYSTEM
25802 /* When we've written over the cursor, arrange for it to
25803 be displayed again. */
25804 if (FRAME_WINDOW_P (f
)
25805 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25807 int hpos
= w
->phys_cursor
.hpos
;
25809 /* When the window is hscrolled, cursor hpos can legitimately be
25810 out of bounds, but we draw the cursor at the corresponding
25811 window margin in that case. */
25812 if (!row
->reversed_p
&& hpos
< 0)
25814 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25815 hpos
= row
->used
[TEXT_AREA
] - 1;
25818 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
25819 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25822 #endif /* HAVE_WINDOW_SYSTEM */
25825 #ifdef HAVE_WINDOW_SYSTEM
25826 /* Change the mouse cursor. */
25827 if (FRAME_WINDOW_P (f
))
25829 if (draw
== DRAW_NORMAL_TEXT
25830 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25831 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25832 else if (draw
== DRAW_MOUSE_FACE
)
25833 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25835 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25837 #endif /* HAVE_WINDOW_SYSTEM */
25841 Clear out the mouse-highlighted active region.
25842 Redraw it un-highlighted first. Value is non-zero if mouse
25843 face was actually drawn unhighlighted. */
25846 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25850 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25852 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25856 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25857 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25858 hlinfo
->mouse_face_window
= Qnil
;
25859 hlinfo
->mouse_face_overlay
= Qnil
;
25863 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25864 within the mouse face on that window. */
25866 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25868 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25870 /* Quickly resolve the easy cases. */
25871 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25872 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25874 if (vpos
< hlinfo
->mouse_face_beg_row
25875 || vpos
> hlinfo
->mouse_face_end_row
)
25877 if (vpos
> hlinfo
->mouse_face_beg_row
25878 && vpos
< hlinfo
->mouse_face_end_row
)
25881 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25883 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25885 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25888 else if ((vpos
== hlinfo
->mouse_face_beg_row
25889 && hpos
>= hlinfo
->mouse_face_beg_col
)
25890 || (vpos
== hlinfo
->mouse_face_end_row
25891 && hpos
< hlinfo
->mouse_face_end_col
))
25896 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25898 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25901 else if ((vpos
== hlinfo
->mouse_face_beg_row
25902 && hpos
<= hlinfo
->mouse_face_beg_col
)
25903 || (vpos
== hlinfo
->mouse_face_end_row
25904 && hpos
> hlinfo
->mouse_face_end_col
))
25912 Non-zero if physical cursor of window W is within mouse face. */
25915 cursor_in_mouse_face_p (struct window
*w
)
25917 int hpos
= w
->phys_cursor
.hpos
;
25918 int vpos
= w
->phys_cursor
.vpos
;
25919 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25921 /* When the window is hscrolled, cursor hpos can legitimately be out
25922 of bounds, but we draw the cursor at the corresponding window
25923 margin in that case. */
25924 if (!row
->reversed_p
&& hpos
< 0)
25926 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25927 hpos
= row
->used
[TEXT_AREA
] - 1;
25929 return coords_in_mouse_face_p (w
, hpos
, vpos
);
25934 /* Find the glyph rows START_ROW and END_ROW of window W that display
25935 characters between buffer positions START_CHARPOS and END_CHARPOS
25936 (excluding END_CHARPOS). DISP_STRING is a display string that
25937 covers these buffer positions. This is similar to
25938 row_containing_pos, but is more accurate when bidi reordering makes
25939 buffer positions change non-linearly with glyph rows. */
25941 rows_from_pos_range (struct window
*w
,
25942 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25943 Lisp_Object disp_string
,
25944 struct glyph_row
**start
, struct glyph_row
**end
)
25946 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25947 int last_y
= window_text_bottom_y (w
);
25948 struct glyph_row
*row
;
25953 while (!first
->enabled_p
25954 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25957 /* Find the START row. */
25959 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25962 /* A row can potentially be the START row if the range of the
25963 characters it displays intersects the range
25964 [START_CHARPOS..END_CHARPOS). */
25965 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25966 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25967 /* See the commentary in row_containing_pos, for the
25968 explanation of the complicated way to check whether
25969 some position is beyond the end of the characters
25970 displayed by a row. */
25971 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25972 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25973 && !row
->ends_at_zv_p
25974 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25975 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25976 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25977 && !row
->ends_at_zv_p
25978 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25980 /* Found a candidate row. Now make sure at least one of the
25981 glyphs it displays has a charpos from the range
25982 [START_CHARPOS..END_CHARPOS).
25984 This is not obvious because bidi reordering could make
25985 buffer positions of a row be 1,2,3,102,101,100, and if we
25986 want to highlight characters in [50..60), we don't want
25987 this row, even though [50..60) does intersect [1..103),
25988 the range of character positions given by the row's start
25989 and end positions. */
25990 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25991 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25995 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25996 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25997 /* A glyph that comes from DISP_STRING is by
25998 definition to be highlighted. */
25999 || EQ (g
->object
, disp_string
))
26008 /* Find the END row. */
26010 /* If the last row is partially visible, start looking for END
26011 from that row, instead of starting from FIRST. */
26012 && !(row
->enabled_p
26013 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
26015 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
26017 struct glyph_row
*next
= row
+ 1;
26018 EMACS_INT next_start
= MATRIX_ROW_START_CHARPOS (next
);
26020 if (!next
->enabled_p
26021 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
26022 /* The first row >= START whose range of displayed characters
26023 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
26024 is the row END + 1. */
26025 || (start_charpos
< next_start
26026 && end_charpos
< next_start
)
26027 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26028 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26029 && !next
->ends_at_zv_p
26030 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
26031 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
26032 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26033 && !next
->ends_at_zv_p
26034 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26041 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26042 but none of the characters it displays are in the range, it is
26044 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26045 struct glyph
*s
= g
;
26046 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26050 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26051 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26052 /* If the buffer position of the first glyph in
26053 the row is equal to END_CHARPOS, it means
26054 the last character to be highlighted is the
26055 newline of ROW, and we must consider NEXT as
26057 || (((!next
->reversed_p
&& g
== s
)
26058 || (next
->reversed_p
&& g
== e
- 1))
26059 && (g
->charpos
== end_charpos
26060 /* Special case for when NEXT is an
26061 empty line at ZV. */
26062 || (g
->charpos
== -1
26063 && !row
->ends_at_zv_p
26064 && next_start
== end_charpos
)))))
26065 /* A glyph that comes from DISP_STRING is by
26066 definition to be highlighted. */
26067 || EQ (g
->object
, disp_string
))
26076 /* The first row that ends at ZV must be the last to be
26078 else if (next
->ends_at_zv_p
)
26087 /* This function sets the mouse_face_* elements of HLINFO, assuming
26088 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26089 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26090 for the overlay or run of text properties specifying the mouse
26091 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26092 before-string and after-string that must also be highlighted.
26093 DISP_STRING, if non-nil, is a display string that may cover some
26094 or all of the highlighted text. */
26097 mouse_face_from_buffer_pos (Lisp_Object window
,
26098 Mouse_HLInfo
*hlinfo
,
26099 EMACS_INT mouse_charpos
,
26100 EMACS_INT start_charpos
,
26101 EMACS_INT end_charpos
,
26102 Lisp_Object before_string
,
26103 Lisp_Object after_string
,
26104 Lisp_Object disp_string
)
26106 struct window
*w
= XWINDOW (window
);
26107 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26108 struct glyph_row
*r1
, *r2
;
26109 struct glyph
*glyph
, *end
;
26110 EMACS_INT ignore
, pos
;
26113 xassert (NILP (disp_string
) || STRINGP (disp_string
));
26114 xassert (NILP (before_string
) || STRINGP (before_string
));
26115 xassert (NILP (after_string
) || STRINGP (after_string
));
26117 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26118 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26120 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26121 /* If the before-string or display-string contains newlines,
26122 rows_from_pos_range skips to its last row. Move back. */
26123 if (!NILP (before_string
) || !NILP (disp_string
))
26125 struct glyph_row
*prev
;
26126 while ((prev
= r1
- 1, prev
>= first
)
26127 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26128 && prev
->used
[TEXT_AREA
] > 0)
26130 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26131 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26132 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26134 || !(EQ (glyph
->object
, before_string
)
26135 || EQ (glyph
->object
, disp_string
)))
26142 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26143 hlinfo
->mouse_face_past_end
= 1;
26145 else if (!NILP (after_string
))
26147 /* If the after-string has newlines, advance to its last row. */
26148 struct glyph_row
*next
;
26149 struct glyph_row
*last
26150 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26152 for (next
= r2
+ 1;
26154 && next
->used
[TEXT_AREA
] > 0
26155 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26159 /* The rest of the display engine assumes that mouse_face_beg_row is
26160 either above mouse_face_end_row or identical to it. But with
26161 bidi-reordered continued lines, the row for START_CHARPOS could
26162 be below the row for END_CHARPOS. If so, swap the rows and store
26163 them in correct order. */
26166 struct glyph_row
*tem
= r2
;
26172 hlinfo
->mouse_face_beg_y
= r1
->y
;
26173 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26174 hlinfo
->mouse_face_end_y
= r2
->y
;
26175 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26177 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26178 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26179 could be anywhere in the row and in any order. The strategy
26180 below is to find the leftmost and the rightmost glyph that
26181 belongs to either of these 3 strings, or whose position is
26182 between START_CHARPOS and END_CHARPOS, and highlight all the
26183 glyphs between those two. This may cover more than just the text
26184 between START_CHARPOS and END_CHARPOS if the range of characters
26185 strides the bidi level boundary, e.g. if the beginning is in R2L
26186 text while the end is in L2R text or vice versa. */
26187 if (!r1
->reversed_p
)
26189 /* This row is in a left to right paragraph. Scan it left to
26191 glyph
= r1
->glyphs
[TEXT_AREA
];
26192 end
= glyph
+ r1
->used
[TEXT_AREA
];
26195 /* Skip truncation glyphs at the start of the glyph row. */
26196 if (r1
->displays_text_p
)
26198 && INTEGERP (glyph
->object
)
26199 && glyph
->charpos
< 0;
26201 x
+= glyph
->pixel_width
;
26203 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26204 or DISP_STRING, and the first glyph from buffer whose
26205 position is between START_CHARPOS and END_CHARPOS. */
26207 && !INTEGERP (glyph
->object
)
26208 && !EQ (glyph
->object
, disp_string
)
26209 && !(BUFFERP (glyph
->object
)
26210 && (glyph
->charpos
>= start_charpos
26211 && glyph
->charpos
< end_charpos
));
26214 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26215 are present at buffer positions between START_CHARPOS and
26216 END_CHARPOS, or if they come from an overlay. */
26217 if (EQ (glyph
->object
, before_string
))
26219 pos
= string_buffer_position (before_string
,
26221 /* If pos == 0, it means before_string came from an
26222 overlay, not from a buffer position. */
26223 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26226 else if (EQ (glyph
->object
, after_string
))
26228 pos
= string_buffer_position (after_string
, end_charpos
);
26229 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26232 x
+= glyph
->pixel_width
;
26234 hlinfo
->mouse_face_beg_x
= x
;
26235 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26239 /* This row is in a right to left paragraph. Scan it right to
26243 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26244 glyph
= end
+ r1
->used
[TEXT_AREA
];
26246 /* Skip truncation glyphs at the start of the glyph row. */
26247 if (r1
->displays_text_p
)
26249 && INTEGERP (glyph
->object
)
26250 && glyph
->charpos
< 0;
26254 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26255 or DISP_STRING, and the first glyph from buffer whose
26256 position is between START_CHARPOS and END_CHARPOS. */
26258 && !INTEGERP (glyph
->object
)
26259 && !EQ (glyph
->object
, disp_string
)
26260 && !(BUFFERP (glyph
->object
)
26261 && (glyph
->charpos
>= start_charpos
26262 && glyph
->charpos
< end_charpos
));
26265 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26266 are present at buffer positions between START_CHARPOS and
26267 END_CHARPOS, or if they come from an overlay. */
26268 if (EQ (glyph
->object
, before_string
))
26270 pos
= string_buffer_position (before_string
, start_charpos
);
26271 /* If pos == 0, it means before_string came from an
26272 overlay, not from a buffer position. */
26273 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26276 else if (EQ (glyph
->object
, after_string
))
26278 pos
= string_buffer_position (after_string
, end_charpos
);
26279 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26284 glyph
++; /* first glyph to the right of the highlighted area */
26285 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26286 x
+= g
->pixel_width
;
26287 hlinfo
->mouse_face_beg_x
= x
;
26288 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26291 /* If the highlight ends in a different row, compute GLYPH and END
26292 for the end row. Otherwise, reuse the values computed above for
26293 the row where the highlight begins. */
26296 if (!r2
->reversed_p
)
26298 glyph
= r2
->glyphs
[TEXT_AREA
];
26299 end
= glyph
+ r2
->used
[TEXT_AREA
];
26304 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26305 glyph
= end
+ r2
->used
[TEXT_AREA
];
26309 if (!r2
->reversed_p
)
26311 /* Skip truncation and continuation glyphs near the end of the
26312 row, and also blanks and stretch glyphs inserted by
26313 extend_face_to_end_of_line. */
26315 && INTEGERP ((end
- 1)->object
))
26317 /* Scan the rest of the glyph row from the end, looking for the
26318 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26319 DISP_STRING, or whose position is between START_CHARPOS
26323 && !INTEGERP (end
->object
)
26324 && !EQ (end
->object
, disp_string
)
26325 && !(BUFFERP (end
->object
)
26326 && (end
->charpos
>= start_charpos
26327 && end
->charpos
< end_charpos
));
26330 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26331 are present at buffer positions between START_CHARPOS and
26332 END_CHARPOS, or if they come from an overlay. */
26333 if (EQ (end
->object
, before_string
))
26335 pos
= string_buffer_position (before_string
, start_charpos
);
26336 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26339 else if (EQ (end
->object
, after_string
))
26341 pos
= string_buffer_position (after_string
, end_charpos
);
26342 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26346 /* Find the X coordinate of the last glyph to be highlighted. */
26347 for (; glyph
<= end
; ++glyph
)
26348 x
+= glyph
->pixel_width
;
26350 hlinfo
->mouse_face_end_x
= x
;
26351 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26355 /* Skip truncation and continuation glyphs near the end of the
26356 row, and also blanks and stretch glyphs inserted by
26357 extend_face_to_end_of_line. */
26361 && INTEGERP (end
->object
))
26363 x
+= end
->pixel_width
;
26366 /* Scan the rest of the glyph row from the end, looking for the
26367 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26368 DISP_STRING, or whose position is between START_CHARPOS
26372 && !INTEGERP (end
->object
)
26373 && !EQ (end
->object
, disp_string
)
26374 && !(BUFFERP (end
->object
)
26375 && (end
->charpos
>= start_charpos
26376 && end
->charpos
< end_charpos
));
26379 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26380 are present at buffer positions between START_CHARPOS and
26381 END_CHARPOS, or if they come from an overlay. */
26382 if (EQ (end
->object
, before_string
))
26384 pos
= string_buffer_position (before_string
, start_charpos
);
26385 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26388 else if (EQ (end
->object
, after_string
))
26390 pos
= string_buffer_position (after_string
, end_charpos
);
26391 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26394 x
+= end
->pixel_width
;
26396 /* If we exited the above loop because we arrived at the last
26397 glyph of the row, and its buffer position is still not in
26398 range, it means the last character in range is the preceding
26399 newline. Bump the end column and x values to get past the
26402 && BUFFERP (end
->object
)
26403 && (end
->charpos
< start_charpos
26404 || end
->charpos
>= end_charpos
))
26406 x
+= end
->pixel_width
;
26409 hlinfo
->mouse_face_end_x
= x
;
26410 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26413 hlinfo
->mouse_face_window
= window
;
26414 hlinfo
->mouse_face_face_id
26415 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26417 !hlinfo
->mouse_face_hidden
, -1);
26418 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26421 /* The following function is not used anymore (replaced with
26422 mouse_face_from_string_pos), but I leave it here for the time
26423 being, in case someone would. */
26425 #if 0 /* not used */
26427 /* Find the position of the glyph for position POS in OBJECT in
26428 window W's current matrix, and return in *X, *Y the pixel
26429 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26431 RIGHT_P non-zero means return the position of the right edge of the
26432 glyph, RIGHT_P zero means return the left edge position.
26434 If no glyph for POS exists in the matrix, return the position of
26435 the glyph with the next smaller position that is in the matrix, if
26436 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26437 exists in the matrix, return the position of the glyph with the
26438 next larger position in OBJECT.
26440 Value is non-zero if a glyph was found. */
26443 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26444 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26446 int yb
= window_text_bottom_y (w
);
26447 struct glyph_row
*r
;
26448 struct glyph
*best_glyph
= NULL
;
26449 struct glyph_row
*best_row
= NULL
;
26452 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26453 r
->enabled_p
&& r
->y
< yb
;
26456 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26457 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26460 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26461 if (EQ (g
->object
, object
))
26463 if (g
->charpos
== pos
)
26470 else if (best_glyph
== NULL
26471 || ((eabs (g
->charpos
- pos
)
26472 < eabs (best_glyph
->charpos
- pos
))
26475 : g
->charpos
> pos
)))
26489 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26493 *x
+= best_glyph
->pixel_width
;
26498 *vpos
= best_row
- w
->current_matrix
->rows
;
26501 return best_glyph
!= NULL
;
26503 #endif /* not used */
26505 /* Find the positions of the first and the last glyphs in window W's
26506 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26507 (assumed to be a string), and return in HLINFO's mouse_face_*
26508 members the pixel and column/row coordinates of those glyphs. */
26511 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26512 Lisp_Object object
,
26513 EMACS_INT startpos
, EMACS_INT endpos
)
26515 int yb
= window_text_bottom_y (w
);
26516 struct glyph_row
*r
;
26517 struct glyph
*g
, *e
;
26521 /* Find the glyph row with at least one position in the range
26522 [STARTPOS..ENDPOS], and the first glyph in that row whose
26523 position belongs to that range. */
26524 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26525 r
->enabled_p
&& r
->y
< yb
;
26528 if (!r
->reversed_p
)
26530 g
= r
->glyphs
[TEXT_AREA
];
26531 e
= g
+ r
->used
[TEXT_AREA
];
26532 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26533 if (EQ (g
->object
, object
)
26534 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26536 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26537 hlinfo
->mouse_face_beg_y
= r
->y
;
26538 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26539 hlinfo
->mouse_face_beg_x
= gx
;
26548 e
= r
->glyphs
[TEXT_AREA
];
26549 g
= e
+ r
->used
[TEXT_AREA
];
26550 for ( ; g
> e
; --g
)
26551 if (EQ ((g
-1)->object
, object
)
26552 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26554 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26555 hlinfo
->mouse_face_beg_y
= r
->y
;
26556 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26557 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26558 gx
+= g1
->pixel_width
;
26559 hlinfo
->mouse_face_beg_x
= gx
;
26571 /* Starting with the next row, look for the first row which does NOT
26572 include any glyphs whose positions are in the range. */
26573 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26575 g
= r
->glyphs
[TEXT_AREA
];
26576 e
= g
+ r
->used
[TEXT_AREA
];
26578 for ( ; g
< e
; ++g
)
26579 if (EQ (g
->object
, object
)
26580 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26589 /* The highlighted region ends on the previous row. */
26592 /* Set the end row and its vertical pixel coordinate. */
26593 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26594 hlinfo
->mouse_face_end_y
= r
->y
;
26596 /* Compute and set the end column and the end column's horizontal
26597 pixel coordinate. */
26598 if (!r
->reversed_p
)
26600 g
= r
->glyphs
[TEXT_AREA
];
26601 e
= g
+ r
->used
[TEXT_AREA
];
26602 for ( ; e
> g
; --e
)
26603 if (EQ ((e
-1)->object
, object
)
26604 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26606 hlinfo
->mouse_face_end_col
= e
- g
;
26608 for (gx
= r
->x
; g
< e
; ++g
)
26609 gx
+= g
->pixel_width
;
26610 hlinfo
->mouse_face_end_x
= gx
;
26614 e
= r
->glyphs
[TEXT_AREA
];
26615 g
= e
+ r
->used
[TEXT_AREA
];
26616 for (gx
= r
->x
; e
< g
; ++e
)
26618 if (EQ (e
->object
, object
)
26619 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26621 gx
+= e
->pixel_width
;
26623 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26624 hlinfo
->mouse_face_end_x
= gx
;
26628 #ifdef HAVE_WINDOW_SYSTEM
26630 /* See if position X, Y is within a hot-spot of an image. */
26633 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26635 if (!CONSP (hot_spot
))
26638 if (EQ (XCAR (hot_spot
), Qrect
))
26640 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26641 Lisp_Object rect
= XCDR (hot_spot
);
26645 if (!CONSP (XCAR (rect
)))
26647 if (!CONSP (XCDR (rect
)))
26649 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26651 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26653 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26655 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26659 else if (EQ (XCAR (hot_spot
), Qcircle
))
26661 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26662 Lisp_Object circ
= XCDR (hot_spot
);
26663 Lisp_Object lr
, lx0
, ly0
;
26665 && CONSP (XCAR (circ
))
26666 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26667 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26668 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26670 double r
= XFLOATINT (lr
);
26671 double dx
= XINT (lx0
) - x
;
26672 double dy
= XINT (ly0
) - y
;
26673 return (dx
* dx
+ dy
* dy
<= r
* r
);
26676 else if (EQ (XCAR (hot_spot
), Qpoly
))
26678 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26679 if (VECTORP (XCDR (hot_spot
)))
26681 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26682 Lisp_Object
*poly
= v
->contents
;
26683 int n
= v
->header
.size
;
26686 Lisp_Object lx
, ly
;
26689 /* Need an even number of coordinates, and at least 3 edges. */
26690 if (n
< 6 || n
& 1)
26693 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26694 If count is odd, we are inside polygon. Pixels on edges
26695 may or may not be included depending on actual geometry of the
26697 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26698 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26700 x0
= XINT (lx
), y0
= XINT (ly
);
26701 for (i
= 0; i
< n
; i
+= 2)
26703 int x1
= x0
, y1
= y0
;
26704 if ((lx
= poly
[i
], !INTEGERP (lx
))
26705 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26707 x0
= XINT (lx
), y0
= XINT (ly
);
26709 /* Does this segment cross the X line? */
26717 if (y
> y0
&& y
> y1
)
26719 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26729 find_hot_spot (Lisp_Object map
, int x
, int y
)
26731 while (CONSP (map
))
26733 if (CONSP (XCAR (map
))
26734 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26742 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26744 doc
: /* Lookup in image map MAP coordinates X and Y.
26745 An image map is an alist where each element has the format (AREA ID PLIST).
26746 An AREA is specified as either a rectangle, a circle, or a polygon:
26747 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26748 pixel coordinates of the upper left and bottom right corners.
26749 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26750 and the radius of the circle; r may be a float or integer.
26751 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26752 vector describes one corner in the polygon.
26753 Returns the alist element for the first matching AREA in MAP. */)
26754 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26762 return find_hot_spot (map
, XINT (x
), XINT (y
));
26766 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26768 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26770 /* Do not change cursor shape while dragging mouse. */
26771 if (!NILP (do_mouse_tracking
))
26774 if (!NILP (pointer
))
26776 if (EQ (pointer
, Qarrow
))
26777 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26778 else if (EQ (pointer
, Qhand
))
26779 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26780 else if (EQ (pointer
, Qtext
))
26781 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26782 else if (EQ (pointer
, intern ("hdrag")))
26783 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26784 #ifdef HAVE_X_WINDOWS
26785 else if (EQ (pointer
, intern ("vdrag")))
26786 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26788 else if (EQ (pointer
, intern ("hourglass")))
26789 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26790 else if (EQ (pointer
, Qmodeline
))
26791 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26793 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26796 if (cursor
!= No_Cursor
)
26797 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26800 #endif /* HAVE_WINDOW_SYSTEM */
26802 /* Take proper action when mouse has moved to the mode or header line
26803 or marginal area AREA of window W, x-position X and y-position Y.
26804 X is relative to the start of the text display area of W, so the
26805 width of bitmap areas and scroll bars must be subtracted to get a
26806 position relative to the start of the mode line. */
26809 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26810 enum window_part area
)
26812 struct window
*w
= XWINDOW (window
);
26813 struct frame
*f
= XFRAME (w
->frame
);
26814 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26815 #ifdef HAVE_WINDOW_SYSTEM
26816 Display_Info
*dpyinfo
;
26818 Cursor cursor
= No_Cursor
;
26819 Lisp_Object pointer
= Qnil
;
26820 int dx
, dy
, width
, height
;
26822 Lisp_Object string
, object
= Qnil
;
26823 Lisp_Object pos
, help
;
26825 Lisp_Object mouse_face
;
26826 int original_x_pixel
= x
;
26827 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26828 struct glyph_row
*row
;
26830 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26835 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26836 returns them in row/column units! */
26837 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26838 &object
, &dx
, &dy
, &width
, &height
);
26840 row
= (area
== ON_MODE_LINE
26841 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26842 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26844 /* Find the glyph under the mouse pointer. */
26845 if (row
->mode_line_p
&& row
->enabled_p
)
26847 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26848 end
= glyph
+ row
->used
[TEXT_AREA
];
26850 for (x0
= original_x_pixel
;
26851 glyph
< end
&& x0
>= glyph
->pixel_width
;
26853 x0
-= glyph
->pixel_width
;
26861 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26862 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26863 returns them in row/column units! */
26864 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26865 &object
, &dx
, &dy
, &width
, &height
);
26870 #ifdef HAVE_WINDOW_SYSTEM
26871 if (IMAGEP (object
))
26873 Lisp_Object image_map
, hotspot
;
26874 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26876 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26878 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26882 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26883 If so, we could look for mouse-enter, mouse-leave
26884 properties in PLIST (and do something...). */
26885 hotspot
= XCDR (hotspot
);
26886 if (CONSP (hotspot
)
26887 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26889 pointer
= Fplist_get (plist
, Qpointer
);
26890 if (NILP (pointer
))
26892 help
= Fplist_get (plist
, Qhelp_echo
);
26895 help_echo_string
= help
;
26896 /* Is this correct? ++kfs */
26897 XSETWINDOW (help_echo_window
, w
);
26898 help_echo_object
= w
->buffer
;
26899 help_echo_pos
= charpos
;
26903 if (NILP (pointer
))
26904 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26906 #endif /* HAVE_WINDOW_SYSTEM */
26908 if (STRINGP (string
))
26910 pos
= make_number (charpos
);
26911 /* If we're on a string with `help-echo' text property, arrange
26912 for the help to be displayed. This is done by setting the
26913 global variable help_echo_string to the help string. */
26916 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26919 help_echo_string
= help
;
26920 XSETWINDOW (help_echo_window
, w
);
26921 help_echo_object
= string
;
26922 help_echo_pos
= charpos
;
26926 #ifdef HAVE_WINDOW_SYSTEM
26927 if (FRAME_WINDOW_P (f
))
26929 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26930 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26931 if (NILP (pointer
))
26932 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26934 /* Change the mouse pointer according to what is under X/Y. */
26936 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26939 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26940 if (!KEYMAPP (map
))
26941 map
= Fget_text_property (pos
, Qkeymap
, string
);
26942 if (!KEYMAPP (map
))
26943 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26948 /* Change the mouse face according to what is under X/Y. */
26949 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26950 if (!NILP (mouse_face
)
26951 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26956 struct glyph
* tmp_glyph
;
26960 int total_pixel_width
;
26961 EMACS_INT begpos
, endpos
, ignore
;
26965 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26966 Qmouse_face
, string
, Qnil
);
26972 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26974 endpos
= SCHARS (string
);
26978 /* Calculate the glyph position GPOS of GLYPH in the
26979 displayed string, relative to the beginning of the
26980 highlighted part of the string.
26982 Note: GPOS is different from CHARPOS. CHARPOS is the
26983 position of GLYPH in the internal string object. A mode
26984 line string format has structures which are converted to
26985 a flattened string by the Emacs Lisp interpreter. The
26986 internal string is an element of those structures. The
26987 displayed string is the flattened string. */
26988 tmp_glyph
= row_start_glyph
;
26989 while (tmp_glyph
< glyph
26990 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26991 && begpos
<= tmp_glyph
->charpos
26992 && tmp_glyph
->charpos
< endpos
)))
26994 gpos
= glyph
- tmp_glyph
;
26996 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26997 the highlighted part of the displayed string to which
26998 GLYPH belongs. Note: GSEQ_LENGTH is different from
26999 SCHARS (STRING), because the latter returns the length of
27000 the internal string. */
27001 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
27003 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
27004 && begpos
<= tmp_glyph
->charpos
27005 && tmp_glyph
->charpos
< endpos
));
27008 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
27010 /* Calculate the total pixel width of all the glyphs between
27011 the beginning of the highlighted area and GLYPH. */
27012 total_pixel_width
= 0;
27013 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
27014 total_pixel_width
+= tmp_glyph
->pixel_width
;
27016 /* Pre calculation of re-rendering position. Note: X is in
27017 column units here, after the call to mode_line_string or
27018 marginal_area_string. */
27020 vpos
= (area
== ON_MODE_LINE
27021 ? (w
->current_matrix
)->nrows
- 1
27024 /* If GLYPH's position is included in the region that is
27025 already drawn in mouse face, we have nothing to do. */
27026 if ( EQ (window
, hlinfo
->mouse_face_window
)
27027 && (!row
->reversed_p
27028 ? (hlinfo
->mouse_face_beg_col
<= hpos
27029 && hpos
< hlinfo
->mouse_face_end_col
)
27030 /* In R2L rows we swap BEG and END, see below. */
27031 : (hlinfo
->mouse_face_end_col
<= hpos
27032 && hpos
< hlinfo
->mouse_face_beg_col
))
27033 && hlinfo
->mouse_face_beg_row
== vpos
)
27036 if (clear_mouse_face (hlinfo
))
27037 cursor
= No_Cursor
;
27039 if (!row
->reversed_p
)
27041 hlinfo
->mouse_face_beg_col
= hpos
;
27042 hlinfo
->mouse_face_beg_x
= original_x_pixel
27043 - (total_pixel_width
+ dx
);
27044 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27045 hlinfo
->mouse_face_end_x
= 0;
27049 /* In R2L rows, show_mouse_face expects BEG and END
27050 coordinates to be swapped. */
27051 hlinfo
->mouse_face_end_col
= hpos
;
27052 hlinfo
->mouse_face_end_x
= original_x_pixel
27053 - (total_pixel_width
+ dx
);
27054 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27055 hlinfo
->mouse_face_beg_x
= 0;
27058 hlinfo
->mouse_face_beg_row
= vpos
;
27059 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27060 hlinfo
->mouse_face_beg_y
= 0;
27061 hlinfo
->mouse_face_end_y
= 0;
27062 hlinfo
->mouse_face_past_end
= 0;
27063 hlinfo
->mouse_face_window
= window
;
27065 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27071 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27073 if (NILP (pointer
))
27076 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27077 clear_mouse_face (hlinfo
);
27079 #ifdef HAVE_WINDOW_SYSTEM
27080 if (FRAME_WINDOW_P (f
))
27081 define_frame_cursor1 (f
, cursor
, pointer
);
27087 Take proper action when the mouse has moved to position X, Y on
27088 frame F as regards highlighting characters that have mouse-face
27089 properties. Also de-highlighting chars where the mouse was before.
27090 X and Y can be negative or out of range. */
27093 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27095 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27096 enum window_part part
= ON_NOTHING
;
27097 Lisp_Object window
;
27099 Cursor cursor
= No_Cursor
;
27100 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27103 /* When a menu is active, don't highlight because this looks odd. */
27104 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27105 if (popup_activated ())
27109 if (NILP (Vmouse_highlight
)
27110 || !f
->glyphs_initialized_p
27111 || f
->pointer_invisible
)
27114 hlinfo
->mouse_face_mouse_x
= x
;
27115 hlinfo
->mouse_face_mouse_y
= y
;
27116 hlinfo
->mouse_face_mouse_frame
= f
;
27118 if (hlinfo
->mouse_face_defer
)
27121 if (gc_in_progress
)
27123 hlinfo
->mouse_face_deferred_gc
= 1;
27127 /* Which window is that in? */
27128 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27130 /* If displaying active text in another window, clear that. */
27131 if (! EQ (window
, hlinfo
->mouse_face_window
)
27132 /* Also clear if we move out of text area in same window. */
27133 || (!NILP (hlinfo
->mouse_face_window
)
27136 && part
!= ON_MODE_LINE
27137 && part
!= ON_HEADER_LINE
))
27138 clear_mouse_face (hlinfo
);
27140 /* Not on a window -> return. */
27141 if (!WINDOWP (window
))
27144 /* Reset help_echo_string. It will get recomputed below. */
27145 help_echo_string
= Qnil
;
27147 /* Convert to window-relative pixel coordinates. */
27148 w
= XWINDOW (window
);
27149 frame_to_window_pixel_xy (w
, &x
, &y
);
27151 #ifdef HAVE_WINDOW_SYSTEM
27152 /* Handle tool-bar window differently since it doesn't display a
27154 if (EQ (window
, f
->tool_bar_window
))
27156 note_tool_bar_highlight (f
, x
, y
);
27161 /* Mouse is on the mode, header line or margin? */
27162 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27163 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27165 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27169 #ifdef HAVE_WINDOW_SYSTEM
27170 if (part
== ON_VERTICAL_BORDER
)
27172 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27173 help_echo_string
= build_string ("drag-mouse-1: resize");
27175 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27176 || part
== ON_SCROLL_BAR
)
27177 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27179 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27182 /* Are we in a window whose display is up to date?
27183 And verify the buffer's text has not changed. */
27184 b
= XBUFFER (w
->buffer
);
27185 if (part
== ON_TEXT
27186 && EQ (w
->window_end_valid
, w
->buffer
)
27187 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27188 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27190 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27192 struct glyph
*glyph
;
27193 Lisp_Object object
;
27194 Lisp_Object mouse_face
= Qnil
, position
;
27195 Lisp_Object
*overlay_vec
= NULL
;
27196 ptrdiff_t i
, noverlays
;
27197 struct buffer
*obuf
;
27198 EMACS_INT obegv
, ozv
;
27201 /* Find the glyph under X/Y. */
27202 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27204 #ifdef HAVE_WINDOW_SYSTEM
27205 /* Look for :pointer property on image. */
27206 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27208 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27209 if (img
!= NULL
&& IMAGEP (img
->spec
))
27211 Lisp_Object image_map
, hotspot
;
27212 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27214 && (hotspot
= find_hot_spot (image_map
,
27215 glyph
->slice
.img
.x
+ dx
,
27216 glyph
->slice
.img
.y
+ dy
),
27218 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27222 /* Could check XCAR (hotspot) to see if we enter/leave
27224 If so, we could look for mouse-enter, mouse-leave
27225 properties in PLIST (and do something...). */
27226 hotspot
= XCDR (hotspot
);
27227 if (CONSP (hotspot
)
27228 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27230 pointer
= Fplist_get (plist
, Qpointer
);
27231 if (NILP (pointer
))
27233 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27234 if (!NILP (help_echo_string
))
27236 help_echo_window
= window
;
27237 help_echo_object
= glyph
->object
;
27238 help_echo_pos
= glyph
->charpos
;
27242 if (NILP (pointer
))
27243 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27246 #endif /* HAVE_WINDOW_SYSTEM */
27248 /* Clear mouse face if X/Y not over text. */
27250 || area
!= TEXT_AREA
27251 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27252 /* Glyph's OBJECT is an integer for glyphs inserted by the
27253 display engine for its internal purposes, like truncation
27254 and continuation glyphs and blanks beyond the end of
27255 line's text on text terminals. If we are over such a
27256 glyph, we are not over any text. */
27257 || INTEGERP (glyph
->object
)
27258 /* R2L rows have a stretch glyph at their front, which
27259 stands for no text, whereas L2R rows have no glyphs at
27260 all beyond the end of text. Treat such stretch glyphs
27261 like we do with NULL glyphs in L2R rows. */
27262 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27263 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27264 && glyph
->type
== STRETCH_GLYPH
27265 && glyph
->avoid_cursor_p
))
27267 if (clear_mouse_face (hlinfo
))
27268 cursor
= No_Cursor
;
27269 #ifdef HAVE_WINDOW_SYSTEM
27270 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27272 if (area
!= TEXT_AREA
)
27273 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27275 pointer
= Vvoid_text_area_pointer
;
27281 pos
= glyph
->charpos
;
27282 object
= glyph
->object
;
27283 if (!STRINGP (object
) && !BUFFERP (object
))
27286 /* If we get an out-of-range value, return now; avoid an error. */
27287 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27290 /* Make the window's buffer temporarily current for
27291 overlays_at and compute_char_face. */
27292 obuf
= current_buffer
;
27293 current_buffer
= b
;
27299 /* Is this char mouse-active or does it have help-echo? */
27300 position
= make_number (pos
);
27302 if (BUFFERP (object
))
27304 /* Put all the overlays we want in a vector in overlay_vec. */
27305 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27306 /* Sort overlays into increasing priority order. */
27307 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27312 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27315 cursor
= No_Cursor
;
27317 /* Check mouse-face highlighting. */
27319 /* If there exists an overlay with mouse-face overlapping
27320 the one we are currently highlighting, we have to
27321 check if we enter the overlapping overlay, and then
27322 highlight only that. */
27323 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27324 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27326 /* Find the highest priority overlay with a mouse-face. */
27327 Lisp_Object overlay
= Qnil
;
27328 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27330 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27331 if (!NILP (mouse_face
))
27332 overlay
= overlay_vec
[i
];
27335 /* If we're highlighting the same overlay as before, there's
27336 no need to do that again. */
27337 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27338 goto check_help_echo
;
27339 hlinfo
->mouse_face_overlay
= overlay
;
27341 /* Clear the display of the old active region, if any. */
27342 if (clear_mouse_face (hlinfo
))
27343 cursor
= No_Cursor
;
27345 /* If no overlay applies, get a text property. */
27346 if (NILP (overlay
))
27347 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27349 /* Next, compute the bounds of the mouse highlighting and
27351 if (!NILP (mouse_face
) && STRINGP (object
))
27353 /* The mouse-highlighting comes from a display string
27354 with a mouse-face. */
27358 s
= Fprevious_single_property_change
27359 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27360 e
= Fnext_single_property_change
27361 (position
, Qmouse_face
, object
, Qnil
);
27363 s
= make_number (0);
27365 e
= make_number (SCHARS (object
) - 1);
27366 mouse_face_from_string_pos (w
, hlinfo
, object
,
27367 XINT (s
), XINT (e
));
27368 hlinfo
->mouse_face_past_end
= 0;
27369 hlinfo
->mouse_face_window
= window
;
27370 hlinfo
->mouse_face_face_id
27371 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27372 glyph
->face_id
, 1);
27373 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27374 cursor
= No_Cursor
;
27378 /* The mouse-highlighting, if any, comes from an overlay
27379 or text property in the buffer. */
27380 Lisp_Object buffer
IF_LINT (= Qnil
);
27381 Lisp_Object disp_string
IF_LINT (= Qnil
);
27383 if (STRINGP (object
))
27385 /* If we are on a display string with no mouse-face,
27386 check if the text under it has one. */
27387 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27388 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27389 pos
= string_buffer_position (object
, start
);
27392 mouse_face
= get_char_property_and_overlay
27393 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27394 buffer
= w
->buffer
;
27395 disp_string
= object
;
27401 disp_string
= Qnil
;
27404 if (!NILP (mouse_face
))
27406 Lisp_Object before
, after
;
27407 Lisp_Object before_string
, after_string
;
27408 /* To correctly find the limits of mouse highlight
27409 in a bidi-reordered buffer, we must not use the
27410 optimization of limiting the search in
27411 previous-single-property-change and
27412 next-single-property-change, because
27413 rows_from_pos_range needs the real start and end
27414 positions to DTRT in this case. That's because
27415 the first row visible in a window does not
27416 necessarily display the character whose position
27417 is the smallest. */
27419 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27420 ? Fmarker_position (w
->start
)
27423 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27424 ? make_number (BUF_Z (XBUFFER (buffer
))
27425 - XFASTINT (w
->window_end_pos
))
27428 if (NILP (overlay
))
27430 /* Handle the text property case. */
27431 before
= Fprevious_single_property_change
27432 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27433 after
= Fnext_single_property_change
27434 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27435 before_string
= after_string
= Qnil
;
27439 /* Handle the overlay case. */
27440 before
= Foverlay_start (overlay
);
27441 after
= Foverlay_end (overlay
);
27442 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27443 after_string
= Foverlay_get (overlay
, Qafter_string
);
27445 if (!STRINGP (before_string
)) before_string
= Qnil
;
27446 if (!STRINGP (after_string
)) after_string
= Qnil
;
27449 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27452 : XFASTINT (before
),
27454 ? BUF_Z (XBUFFER (buffer
))
27455 : XFASTINT (after
),
27456 before_string
, after_string
,
27458 cursor
= No_Cursor
;
27465 /* Look for a `help-echo' property. */
27466 if (NILP (help_echo_string
)) {
27467 Lisp_Object help
, overlay
;
27469 /* Check overlays first. */
27470 help
= overlay
= Qnil
;
27471 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27473 overlay
= overlay_vec
[i
];
27474 help
= Foverlay_get (overlay
, Qhelp_echo
);
27479 help_echo_string
= help
;
27480 help_echo_window
= window
;
27481 help_echo_object
= overlay
;
27482 help_echo_pos
= pos
;
27486 Lisp_Object obj
= glyph
->object
;
27487 EMACS_INT charpos
= glyph
->charpos
;
27489 /* Try text properties. */
27492 && charpos
< SCHARS (obj
))
27494 help
= Fget_text_property (make_number (charpos
),
27498 /* If the string itself doesn't specify a help-echo,
27499 see if the buffer text ``under'' it does. */
27500 struct glyph_row
*r
27501 = MATRIX_ROW (w
->current_matrix
, vpos
);
27502 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27503 EMACS_INT p
= string_buffer_position (obj
, start
);
27506 help
= Fget_char_property (make_number (p
),
27507 Qhelp_echo
, w
->buffer
);
27516 else if (BUFFERP (obj
)
27519 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27524 help_echo_string
= help
;
27525 help_echo_window
= window
;
27526 help_echo_object
= obj
;
27527 help_echo_pos
= charpos
;
27532 #ifdef HAVE_WINDOW_SYSTEM
27533 /* Look for a `pointer' property. */
27534 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27536 /* Check overlays first. */
27537 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27538 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27540 if (NILP (pointer
))
27542 Lisp_Object obj
= glyph
->object
;
27543 EMACS_INT charpos
= glyph
->charpos
;
27545 /* Try text properties. */
27548 && charpos
< SCHARS (obj
))
27550 pointer
= Fget_text_property (make_number (charpos
),
27552 if (NILP (pointer
))
27554 /* If the string itself doesn't specify a pointer,
27555 see if the buffer text ``under'' it does. */
27556 struct glyph_row
*r
27557 = MATRIX_ROW (w
->current_matrix
, vpos
);
27558 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27559 EMACS_INT p
= string_buffer_position (obj
, start
);
27561 pointer
= Fget_char_property (make_number (p
),
27562 Qpointer
, w
->buffer
);
27565 else if (BUFFERP (obj
)
27568 pointer
= Fget_text_property (make_number (charpos
),
27572 #endif /* HAVE_WINDOW_SYSTEM */
27576 current_buffer
= obuf
;
27581 #ifdef HAVE_WINDOW_SYSTEM
27582 if (FRAME_WINDOW_P (f
))
27583 define_frame_cursor1 (f
, cursor
, pointer
);
27585 /* This is here to prevent a compiler error, about "label at end of
27586 compound statement". */
27593 Clear any mouse-face on window W. This function is part of the
27594 redisplay interface, and is called from try_window_id and similar
27595 functions to ensure the mouse-highlight is off. */
27598 x_clear_window_mouse_face (struct window
*w
)
27600 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27601 Lisp_Object window
;
27604 XSETWINDOW (window
, w
);
27605 if (EQ (window
, hlinfo
->mouse_face_window
))
27606 clear_mouse_face (hlinfo
);
27612 Just discard the mouse face information for frame F, if any.
27613 This is used when the size of F is changed. */
27616 cancel_mouse_face (struct frame
*f
)
27618 Lisp_Object window
;
27619 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27621 window
= hlinfo
->mouse_face_window
;
27622 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27624 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27625 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27626 hlinfo
->mouse_face_window
= Qnil
;
27632 /***********************************************************************
27634 ***********************************************************************/
27636 #ifdef HAVE_WINDOW_SYSTEM
27638 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27639 which intersects rectangle R. R is in window-relative coordinates. */
27642 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27643 enum glyph_row_area area
)
27645 struct glyph
*first
= row
->glyphs
[area
];
27646 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27647 struct glyph
*last
;
27648 int first_x
, start_x
, x
;
27650 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27651 /* If row extends face to end of line write the whole line. */
27652 draw_glyphs (w
, 0, row
, area
,
27653 0, row
->used
[area
],
27654 DRAW_NORMAL_TEXT
, 0);
27657 /* Set START_X to the window-relative start position for drawing glyphs of
27658 AREA. The first glyph of the text area can be partially visible.
27659 The first glyphs of other areas cannot. */
27660 start_x
= window_box_left_offset (w
, area
);
27662 if (area
== TEXT_AREA
)
27665 /* Find the first glyph that must be redrawn. */
27667 && x
+ first
->pixel_width
< r
->x
)
27669 x
+= first
->pixel_width
;
27673 /* Find the last one. */
27677 && x
< r
->x
+ r
->width
)
27679 x
+= last
->pixel_width
;
27685 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27686 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27687 DRAW_NORMAL_TEXT
, 0);
27692 /* Redraw the parts of the glyph row ROW on window W intersecting
27693 rectangle R. R is in window-relative coordinates. Value is
27694 non-zero if mouse-face was overwritten. */
27697 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27699 xassert (row
->enabled_p
);
27701 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27702 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27703 0, row
->used
[TEXT_AREA
],
27704 DRAW_NORMAL_TEXT
, 0);
27707 if (row
->used
[LEFT_MARGIN_AREA
])
27708 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27709 if (row
->used
[TEXT_AREA
])
27710 expose_area (w
, row
, r
, TEXT_AREA
);
27711 if (row
->used
[RIGHT_MARGIN_AREA
])
27712 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27713 draw_row_fringe_bitmaps (w
, row
);
27716 return row
->mouse_face_p
;
27720 /* Redraw those parts of glyphs rows during expose event handling that
27721 overlap other rows. Redrawing of an exposed line writes over parts
27722 of lines overlapping that exposed line; this function fixes that.
27724 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27725 row in W's current matrix that is exposed and overlaps other rows.
27726 LAST_OVERLAPPING_ROW is the last such row. */
27729 expose_overlaps (struct window
*w
,
27730 struct glyph_row
*first_overlapping_row
,
27731 struct glyph_row
*last_overlapping_row
,
27734 struct glyph_row
*row
;
27736 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27737 if (row
->overlapping_p
)
27739 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27742 if (row
->used
[LEFT_MARGIN_AREA
])
27743 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27745 if (row
->used
[TEXT_AREA
])
27746 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27748 if (row
->used
[RIGHT_MARGIN_AREA
])
27749 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27755 /* Return non-zero if W's cursor intersects rectangle R. */
27758 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27760 XRectangle cr
, result
;
27761 struct glyph
*cursor_glyph
;
27762 struct glyph_row
*row
;
27764 if (w
->phys_cursor
.vpos
>= 0
27765 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27766 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27768 && row
->cursor_in_fringe_p
)
27770 /* Cursor is in the fringe. */
27771 cr
.x
= window_box_right_offset (w
,
27772 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27773 ? RIGHT_MARGIN_AREA
27776 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27777 cr
.height
= row
->height
;
27778 return x_intersect_rectangles (&cr
, r
, &result
);
27781 cursor_glyph
= get_phys_cursor_glyph (w
);
27784 /* r is relative to W's box, but w->phys_cursor.x is relative
27785 to left edge of W's TEXT area. Adjust it. */
27786 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27787 cr
.y
= w
->phys_cursor
.y
;
27788 cr
.width
= cursor_glyph
->pixel_width
;
27789 cr
.height
= w
->phys_cursor_height
;
27790 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27791 I assume the effect is the same -- and this is portable. */
27792 return x_intersect_rectangles (&cr
, r
, &result
);
27794 /* If we don't understand the format, pretend we're not in the hot-spot. */
27800 Draw a vertical window border to the right of window W if W doesn't
27801 have vertical scroll bars. */
27804 x_draw_vertical_border (struct window
*w
)
27806 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27808 /* We could do better, if we knew what type of scroll-bar the adjacent
27809 windows (on either side) have... But we don't :-(
27810 However, I think this works ok. ++KFS 2003-04-25 */
27812 /* Redraw borders between horizontally adjacent windows. Don't
27813 do it for frames with vertical scroll bars because either the
27814 right scroll bar of a window, or the left scroll bar of its
27815 neighbor will suffice as a border. */
27816 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27819 if (!WINDOW_RIGHTMOST_P (w
)
27820 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27822 int x0
, x1
, y0
, y1
;
27824 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27827 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27830 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27832 else if (!WINDOW_LEFTMOST_P (w
)
27833 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27835 int x0
, x1
, y0
, y1
;
27837 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27840 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27843 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27848 /* Redraw the part of window W intersection rectangle FR. Pixel
27849 coordinates in FR are frame-relative. Call this function with
27850 input blocked. Value is non-zero if the exposure overwrites
27854 expose_window (struct window
*w
, XRectangle
*fr
)
27856 struct frame
*f
= XFRAME (w
->frame
);
27858 int mouse_face_overwritten_p
= 0;
27860 /* If window is not yet fully initialized, do nothing. This can
27861 happen when toolkit scroll bars are used and a window is split.
27862 Reconfiguring the scroll bar will generate an expose for a newly
27864 if (w
->current_matrix
== NULL
)
27867 /* When we're currently updating the window, display and current
27868 matrix usually don't agree. Arrange for a thorough display
27870 if (w
== updated_window
)
27872 SET_FRAME_GARBAGED (f
);
27876 /* Frame-relative pixel rectangle of W. */
27877 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27878 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27879 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27880 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27882 if (x_intersect_rectangles (fr
, &wr
, &r
))
27884 int yb
= window_text_bottom_y (w
);
27885 struct glyph_row
*row
;
27886 int cursor_cleared_p
, phys_cursor_on_p
;
27887 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27889 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27890 r
.x
, r
.y
, r
.width
, r
.height
));
27892 /* Convert to window coordinates. */
27893 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27894 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27896 /* Turn off the cursor. */
27897 if (!w
->pseudo_window_p
27898 && phys_cursor_in_rect_p (w
, &r
))
27900 x_clear_cursor (w
);
27901 cursor_cleared_p
= 1;
27904 cursor_cleared_p
= 0;
27906 /* If the row containing the cursor extends face to end of line,
27907 then expose_area might overwrite the cursor outside the
27908 rectangle and thus notice_overwritten_cursor might clear
27909 w->phys_cursor_on_p. We remember the original value and
27910 check later if it is changed. */
27911 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27913 /* Update lines intersecting rectangle R. */
27914 first_overlapping_row
= last_overlapping_row
= NULL
;
27915 for (row
= w
->current_matrix
->rows
;
27920 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27922 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27923 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27924 || (r
.y
>= y0
&& r
.y
< y1
)
27925 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27927 /* A header line may be overlapping, but there is no need
27928 to fix overlapping areas for them. KFS 2005-02-12 */
27929 if (row
->overlapping_p
&& !row
->mode_line_p
)
27931 if (first_overlapping_row
== NULL
)
27932 first_overlapping_row
= row
;
27933 last_overlapping_row
= row
;
27937 if (expose_line (w
, row
, &r
))
27938 mouse_face_overwritten_p
= 1;
27941 else if (row
->overlapping_p
)
27943 /* We must redraw a row overlapping the exposed area. */
27945 ? y0
+ row
->phys_height
> r
.y
27946 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27948 if (first_overlapping_row
== NULL
)
27949 first_overlapping_row
= row
;
27950 last_overlapping_row
= row
;
27958 /* Display the mode line if there is one. */
27959 if (WINDOW_WANTS_MODELINE_P (w
)
27960 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27962 && row
->y
< r
.y
+ r
.height
)
27964 if (expose_line (w
, row
, &r
))
27965 mouse_face_overwritten_p
= 1;
27968 if (!w
->pseudo_window_p
)
27970 /* Fix the display of overlapping rows. */
27971 if (first_overlapping_row
)
27972 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27975 /* Draw border between windows. */
27976 x_draw_vertical_border (w
);
27978 /* Turn the cursor on again. */
27979 if (cursor_cleared_p
27980 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27981 update_window_cursor (w
, 1);
27985 return mouse_face_overwritten_p
;
27990 /* Redraw (parts) of all windows in the window tree rooted at W that
27991 intersect R. R contains frame pixel coordinates. Value is
27992 non-zero if the exposure overwrites mouse-face. */
27995 expose_window_tree (struct window
*w
, XRectangle
*r
)
27997 struct frame
*f
= XFRAME (w
->frame
);
27998 int mouse_face_overwritten_p
= 0;
28000 while (w
&& !FRAME_GARBAGED_P (f
))
28002 if (!NILP (w
->hchild
))
28003 mouse_face_overwritten_p
28004 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
28005 else if (!NILP (w
->vchild
))
28006 mouse_face_overwritten_p
28007 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
28009 mouse_face_overwritten_p
|= expose_window (w
, r
);
28011 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
28014 return mouse_face_overwritten_p
;
28019 Redisplay an exposed area of frame F. X and Y are the upper-left
28020 corner of the exposed rectangle. W and H are width and height of
28021 the exposed area. All are pixel values. W or H zero means redraw
28022 the entire frame. */
28025 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
28028 int mouse_face_overwritten_p
= 0;
28030 TRACE ((stderr
, "expose_frame "));
28032 /* No need to redraw if frame will be redrawn soon. */
28033 if (FRAME_GARBAGED_P (f
))
28035 TRACE ((stderr
, " garbaged\n"));
28039 /* If basic faces haven't been realized yet, there is no point in
28040 trying to redraw anything. This can happen when we get an expose
28041 event while Emacs is starting, e.g. by moving another window. */
28042 if (FRAME_FACE_CACHE (f
) == NULL
28043 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28045 TRACE ((stderr
, " no faces\n"));
28049 if (w
== 0 || h
== 0)
28052 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28053 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28063 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28064 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28066 if (WINDOWP (f
->tool_bar_window
))
28067 mouse_face_overwritten_p
28068 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28070 #ifdef HAVE_X_WINDOWS
28072 #ifndef USE_X_TOOLKIT
28073 if (WINDOWP (f
->menu_bar_window
))
28074 mouse_face_overwritten_p
28075 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28076 #endif /* not USE_X_TOOLKIT */
28080 /* Some window managers support a focus-follows-mouse style with
28081 delayed raising of frames. Imagine a partially obscured frame,
28082 and moving the mouse into partially obscured mouse-face on that
28083 frame. The visible part of the mouse-face will be highlighted,
28084 then the WM raises the obscured frame. With at least one WM, KDE
28085 2.1, Emacs is not getting any event for the raising of the frame
28086 (even tried with SubstructureRedirectMask), only Expose events.
28087 These expose events will draw text normally, i.e. not
28088 highlighted. Which means we must redo the highlight here.
28089 Subsume it under ``we love X''. --gerd 2001-08-15 */
28090 /* Included in Windows version because Windows most likely does not
28091 do the right thing if any third party tool offers
28092 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28093 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28095 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28096 if (f
== hlinfo
->mouse_face_mouse_frame
)
28098 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28099 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28100 clear_mouse_face (hlinfo
);
28101 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28108 Determine the intersection of two rectangles R1 and R2. Return
28109 the intersection in *RESULT. Value is non-zero if RESULT is not
28113 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28115 XRectangle
*left
, *right
;
28116 XRectangle
*upper
, *lower
;
28117 int intersection_p
= 0;
28119 /* Rearrange so that R1 is the left-most rectangle. */
28121 left
= r1
, right
= r2
;
28123 left
= r2
, right
= r1
;
28125 /* X0 of the intersection is right.x0, if this is inside R1,
28126 otherwise there is no intersection. */
28127 if (right
->x
<= left
->x
+ left
->width
)
28129 result
->x
= right
->x
;
28131 /* The right end of the intersection is the minimum of
28132 the right ends of left and right. */
28133 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28136 /* Same game for Y. */
28138 upper
= r1
, lower
= r2
;
28140 upper
= r2
, lower
= r1
;
28142 /* The upper end of the intersection is lower.y0, if this is inside
28143 of upper. Otherwise, there is no intersection. */
28144 if (lower
->y
<= upper
->y
+ upper
->height
)
28146 result
->y
= lower
->y
;
28148 /* The lower end of the intersection is the minimum of the lower
28149 ends of upper and lower. */
28150 result
->height
= (min (lower
->y
+ lower
->height
,
28151 upper
->y
+ upper
->height
)
28153 intersection_p
= 1;
28157 return intersection_p
;
28160 #endif /* HAVE_WINDOW_SYSTEM */
28163 /***********************************************************************
28165 ***********************************************************************/
28168 syms_of_xdisp (void)
28170 Vwith_echo_area_save_vector
= Qnil
;
28171 staticpro (&Vwith_echo_area_save_vector
);
28173 Vmessage_stack
= Qnil
;
28174 staticpro (&Vmessage_stack
);
28176 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28178 message_dolog_marker1
= Fmake_marker ();
28179 staticpro (&message_dolog_marker1
);
28180 message_dolog_marker2
= Fmake_marker ();
28181 staticpro (&message_dolog_marker2
);
28182 message_dolog_marker3
= Fmake_marker ();
28183 staticpro (&message_dolog_marker3
);
28186 defsubr (&Sdump_frame_glyph_matrix
);
28187 defsubr (&Sdump_glyph_matrix
);
28188 defsubr (&Sdump_glyph_row
);
28189 defsubr (&Sdump_tool_bar_row
);
28190 defsubr (&Strace_redisplay
);
28191 defsubr (&Strace_to_stderr
);
28193 #ifdef HAVE_WINDOW_SYSTEM
28194 defsubr (&Stool_bar_lines_needed
);
28195 defsubr (&Slookup_image_map
);
28197 defsubr (&Sformat_mode_line
);
28198 defsubr (&Sinvisible_p
);
28199 defsubr (&Scurrent_bidi_paragraph_direction
);
28201 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28202 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28203 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28204 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28205 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28206 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28207 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28208 DEFSYM (Qeval
, "eval");
28209 DEFSYM (QCdata
, ":data");
28210 DEFSYM (Qdisplay
, "display");
28211 DEFSYM (Qspace_width
, "space-width");
28212 DEFSYM (Qraise
, "raise");
28213 DEFSYM (Qslice
, "slice");
28214 DEFSYM (Qspace
, "space");
28215 DEFSYM (Qmargin
, "margin");
28216 DEFSYM (Qpointer
, "pointer");
28217 DEFSYM (Qleft_margin
, "left-margin");
28218 DEFSYM (Qright_margin
, "right-margin");
28219 DEFSYM (Qcenter
, "center");
28220 DEFSYM (Qline_height
, "line-height");
28221 DEFSYM (QCalign_to
, ":align-to");
28222 DEFSYM (QCrelative_width
, ":relative-width");
28223 DEFSYM (QCrelative_height
, ":relative-height");
28224 DEFSYM (QCeval
, ":eval");
28225 DEFSYM (QCpropertize
, ":propertize");
28226 DEFSYM (QCfile
, ":file");
28227 DEFSYM (Qfontified
, "fontified");
28228 DEFSYM (Qfontification_functions
, "fontification-functions");
28229 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28230 DEFSYM (Qescape_glyph
, "escape-glyph");
28231 DEFSYM (Qnobreak_space
, "nobreak-space");
28232 DEFSYM (Qimage
, "image");
28233 DEFSYM (Qtext
, "text");
28234 DEFSYM (Qboth
, "both");
28235 DEFSYM (Qboth_horiz
, "both-horiz");
28236 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28237 DEFSYM (QCmap
, ":map");
28238 DEFSYM (QCpointer
, ":pointer");
28239 DEFSYM (Qrect
, "rect");
28240 DEFSYM (Qcircle
, "circle");
28241 DEFSYM (Qpoly
, "poly");
28242 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28243 DEFSYM (Qgrow_only
, "grow-only");
28244 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28245 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28246 DEFSYM (Qposition
, "position");
28247 DEFSYM (Qbuffer_position
, "buffer-position");
28248 DEFSYM (Qobject
, "object");
28249 DEFSYM (Qbar
, "bar");
28250 DEFSYM (Qhbar
, "hbar");
28251 DEFSYM (Qbox
, "box");
28252 DEFSYM (Qhollow
, "hollow");
28253 DEFSYM (Qhand
, "hand");
28254 DEFSYM (Qarrow
, "arrow");
28255 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28257 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28258 Fcons (intern_c_string ("void-variable"), Qnil
)),
28260 staticpro (&list_of_error
);
28262 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28263 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28264 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28265 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28267 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28268 staticpro (&echo_buffer
[0]);
28269 staticpro (&echo_buffer
[1]);
28271 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28272 staticpro (&echo_area_buffer
[0]);
28273 staticpro (&echo_area_buffer
[1]);
28275 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28276 staticpro (&Vmessages_buffer_name
);
28278 mode_line_proptrans_alist
= Qnil
;
28279 staticpro (&mode_line_proptrans_alist
);
28280 mode_line_string_list
= Qnil
;
28281 staticpro (&mode_line_string_list
);
28282 mode_line_string_face
= Qnil
;
28283 staticpro (&mode_line_string_face
);
28284 mode_line_string_face_prop
= Qnil
;
28285 staticpro (&mode_line_string_face_prop
);
28286 Vmode_line_unwind_vector
= Qnil
;
28287 staticpro (&Vmode_line_unwind_vector
);
28289 help_echo_string
= Qnil
;
28290 staticpro (&help_echo_string
);
28291 help_echo_object
= Qnil
;
28292 staticpro (&help_echo_object
);
28293 help_echo_window
= Qnil
;
28294 staticpro (&help_echo_window
);
28295 previous_help_echo_string
= Qnil
;
28296 staticpro (&previous_help_echo_string
);
28297 help_echo_pos
= -1;
28299 DEFSYM (Qright_to_left
, "right-to-left");
28300 DEFSYM (Qleft_to_right
, "left-to-right");
28302 #ifdef HAVE_WINDOW_SYSTEM
28303 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28304 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
28305 For example, if a block cursor is over a tab, it will be drawn as
28306 wide as that tab on the display. */);
28307 x_stretch_cursor_p
= 0;
28310 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28311 doc
: /* *Non-nil means highlight trailing whitespace.
28312 The face used for trailing whitespace is `trailing-whitespace'. */);
28313 Vshow_trailing_whitespace
= Qnil
;
28315 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28316 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28317 If the value is t, Emacs highlights non-ASCII chars which have the
28318 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28319 or `escape-glyph' face respectively.
28321 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28322 U+2011 (non-breaking hyphen) are affected.
28324 Any other non-nil value means to display these characters as a escape
28325 glyph followed by an ordinary space or hyphen.
28327 A value of nil means no special handling of these characters. */);
28328 Vnobreak_char_display
= Qt
;
28330 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28331 doc
: /* *The pointer shape to show in void text areas.
28332 A value of nil means to show the text pointer. Other options are `arrow',
28333 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28334 Vvoid_text_area_pointer
= Qarrow
;
28336 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28337 doc
: /* Non-nil means don't actually do any redisplay.
28338 This is used for internal purposes. */);
28339 Vinhibit_redisplay
= Qnil
;
28341 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28342 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28343 Vglobal_mode_string
= Qnil
;
28345 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28346 doc
: /* Marker for where to display an arrow on top of the buffer text.
28347 This must be the beginning of a line in order to work.
28348 See also `overlay-arrow-string'. */);
28349 Voverlay_arrow_position
= Qnil
;
28351 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28352 doc
: /* String to display as an arrow in non-window frames.
28353 See also `overlay-arrow-position'. */);
28354 Voverlay_arrow_string
= make_pure_c_string ("=>");
28356 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28357 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28358 The symbols on this list are examined during redisplay to determine
28359 where to display overlay arrows. */);
28360 Voverlay_arrow_variable_list
28361 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28363 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28364 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28365 If that fails to bring point back on frame, point is centered instead.
28366 If this is zero, point is always centered after it moves off frame.
28367 If you want scrolling to always be a line at a time, you should set
28368 `scroll-conservatively' to a large value rather than set this to 1. */);
28370 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28371 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28372 If point moves off-screen, redisplay will scroll by up to
28373 `scroll-conservatively' lines in order to bring point just barely
28374 onto the screen again. If that cannot be done, then redisplay
28375 recenters point as usual.
28377 If the value is greater than 100, redisplay will never recenter point,
28378 but will always scroll just enough text to bring point into view, even
28379 if you move far away.
28381 A value of zero means always recenter point if it moves off screen. */);
28382 scroll_conservatively
= 0;
28384 DEFVAR_INT ("scroll-margin", scroll_margin
,
28385 doc
: /* *Number of lines of margin at the top and bottom of a window.
28386 Recenter the window whenever point gets within this many lines
28387 of the top or bottom of the window. */);
28390 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28391 doc
: /* Pixels per inch value for non-window system displays.
28392 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28393 Vdisplay_pixels_per_inch
= make_float (72.0);
28396 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28399 DEFVAR_LISP ("truncate-partial-width-windows",
28400 Vtruncate_partial_width_windows
,
28401 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28402 For an integer value, truncate lines in each window narrower than the
28403 full frame width, provided the window width is less than that integer;
28404 otherwise, respect the value of `truncate-lines'.
28406 For any other non-nil value, truncate lines in all windows that do
28407 not span the full frame width.
28409 A value of nil means to respect the value of `truncate-lines'.
28411 If `word-wrap' is enabled, you might want to reduce this. */);
28412 Vtruncate_partial_width_windows
= make_number (50);
28414 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28415 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28416 Any other value means to use the appropriate face, `mode-line',
28417 `header-line', or `menu' respectively. */);
28418 mode_line_inverse_video
= 1;
28420 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28421 doc
: /* *Maximum buffer size for which line number should be displayed.
28422 If the buffer is bigger than this, the line number does not appear
28423 in the mode line. A value of nil means no limit. */);
28424 Vline_number_display_limit
= Qnil
;
28426 DEFVAR_INT ("line-number-display-limit-width",
28427 line_number_display_limit_width
,
28428 doc
: /* *Maximum line width (in characters) for line number display.
28429 If the average length of the lines near point is bigger than this, then the
28430 line number may be omitted from the mode line. */);
28431 line_number_display_limit_width
= 200;
28433 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28434 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28435 highlight_nonselected_windows
= 0;
28437 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28438 doc
: /* Non-nil if more than one frame is visible on this display.
28439 Minibuffer-only frames don't count, but iconified frames do.
28440 This variable is not guaranteed to be accurate except while processing
28441 `frame-title-format' and `icon-title-format'. */);
28443 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28444 doc
: /* Template for displaying the title bar of visible frames.
28445 \(Assuming the window manager supports this feature.)
28447 This variable has the same structure as `mode-line-format', except that
28448 the %c and %l constructs are ignored. It is used only on frames for
28449 which no explicit name has been set \(see `modify-frame-parameters'). */);
28451 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28452 doc
: /* Template for displaying the title bar of an iconified frame.
28453 \(Assuming the window manager supports this feature.)
28454 This variable has the same structure as `mode-line-format' (which see),
28455 and is used only on frames for which no explicit name has been set
28456 \(see `modify-frame-parameters'). */);
28458 = Vframe_title_format
28459 = pure_cons (intern_c_string ("multiple-frames"),
28460 pure_cons (make_pure_c_string ("%b"),
28461 pure_cons (pure_cons (empty_unibyte_string
,
28462 pure_cons (intern_c_string ("invocation-name"),
28463 pure_cons (make_pure_c_string ("@"),
28464 pure_cons (intern_c_string ("system-name"),
28468 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28469 doc
: /* Maximum number of lines to keep in the message log buffer.
28470 If nil, disable message logging. If t, log messages but don't truncate
28471 the buffer when it becomes large. */);
28472 Vmessage_log_max
= make_number (100);
28474 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28475 doc
: /* Functions called before redisplay, if window sizes have changed.
28476 The value should be a list of functions that take one argument.
28477 Just before redisplay, for each frame, if any of its windows have changed
28478 size since the last redisplay, or have been split or deleted,
28479 all the functions in the list are called, with the frame as argument. */);
28480 Vwindow_size_change_functions
= Qnil
;
28482 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28483 doc
: /* List of functions to call before redisplaying a window with scrolling.
28484 Each function is called with two arguments, the window and its new
28485 display-start position. Note that these functions are also called by
28486 `set-window-buffer'. Also note that the value of `window-end' is not
28487 valid when these functions are called.
28489 Warning: Do not use this feature to alter the way the window
28490 is scrolled. It is not designed for that, and such use probably won't
28492 Vwindow_scroll_functions
= Qnil
;
28494 DEFVAR_LISP ("window-text-change-functions",
28495 Vwindow_text_change_functions
,
28496 doc
: /* Functions to call in redisplay when text in the window might change. */);
28497 Vwindow_text_change_functions
= Qnil
;
28499 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28500 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28501 Each function is called with two arguments, the window and the end trigger value.
28502 See `set-window-redisplay-end-trigger'. */);
28503 Vredisplay_end_trigger_functions
= Qnil
;
28505 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28506 doc
: /* *Non-nil means autoselect window with mouse pointer.
28507 If nil, do not autoselect windows.
28508 A positive number means delay autoselection by that many seconds: a
28509 window is autoselected only after the mouse has remained in that
28510 window for the duration of the delay.
28511 A negative number has a similar effect, but causes windows to be
28512 autoselected only after the mouse has stopped moving. \(Because of
28513 the way Emacs compares mouse events, you will occasionally wait twice
28514 that time before the window gets selected.\)
28515 Any other value means to autoselect window instantaneously when the
28516 mouse pointer enters it.
28518 Autoselection selects the minibuffer only if it is active, and never
28519 unselects the minibuffer if it is active.
28521 When customizing this variable make sure that the actual value of
28522 `focus-follows-mouse' matches the behavior of your window manager. */);
28523 Vmouse_autoselect_window
= Qnil
;
28525 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28526 doc
: /* *Non-nil means automatically resize tool-bars.
28527 This dynamically changes the tool-bar's height to the minimum height
28528 that is needed to make all tool-bar items visible.
28529 If value is `grow-only', the tool-bar's height is only increased
28530 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28531 Vauto_resize_tool_bars
= Qt
;
28533 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28534 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28535 auto_raise_tool_bar_buttons_p
= 1;
28537 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28538 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28539 make_cursor_line_fully_visible_p
= 1;
28541 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28542 doc
: /* *Border below tool-bar in pixels.
28543 If an integer, use it as the height of the border.
28544 If it is one of `internal-border-width' or `border-width', use the
28545 value of the corresponding frame parameter.
28546 Otherwise, no border is added below the tool-bar. */);
28547 Vtool_bar_border
= Qinternal_border_width
;
28549 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28550 doc
: /* *Margin around tool-bar buttons in pixels.
28551 If an integer, use that for both horizontal and vertical margins.
28552 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28553 HORZ specifying the horizontal margin, and VERT specifying the
28554 vertical margin. */);
28555 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28557 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28558 doc
: /* *Relief thickness of tool-bar buttons. */);
28559 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28561 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28562 doc
: /* Tool bar style to use.
28564 image - show images only
28565 text - show text only
28566 both - show both, text below image
28567 both-horiz - show text to the right of the image
28568 text-image-horiz - show text to the left of the image
28569 any other - use system default or image if no system default. */);
28570 Vtool_bar_style
= Qnil
;
28572 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28573 doc
: /* *Maximum number of characters a label can have to be shown.
28574 The tool bar style must also show labels for this to have any effect, see
28575 `tool-bar-style'. */);
28576 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28578 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28579 doc
: /* List of functions to call to fontify regions of text.
28580 Each function is called with one argument POS. Functions must
28581 fontify a region starting at POS in the current buffer, and give
28582 fontified regions the property `fontified'. */);
28583 Vfontification_functions
= Qnil
;
28584 Fmake_variable_buffer_local (Qfontification_functions
);
28586 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28587 unibyte_display_via_language_environment
,
28588 doc
: /* *Non-nil means display unibyte text according to language environment.
28589 Specifically, this means that raw bytes in the range 160-255 decimal
28590 are displayed by converting them to the equivalent multibyte characters
28591 according to the current language environment. As a result, they are
28592 displayed according to the current fontset.
28594 Note that this variable affects only how these bytes are displayed,
28595 but does not change the fact they are interpreted as raw bytes. */);
28596 unibyte_display_via_language_environment
= 0;
28598 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28599 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28600 If a float, it specifies a fraction of the mini-window frame's height.
28601 If an integer, it specifies a number of lines. */);
28602 Vmax_mini_window_height
= make_float (0.25);
28604 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28605 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28606 A value of nil means don't automatically resize mini-windows.
28607 A value of t means resize them to fit the text displayed in them.
28608 A value of `grow-only', the default, means let mini-windows grow only;
28609 they return to their normal size when the minibuffer is closed, or the
28610 echo area becomes empty. */);
28611 Vresize_mini_windows
= Qgrow_only
;
28613 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28614 doc
: /* Alist specifying how to blink the cursor off.
28615 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28616 `cursor-type' frame-parameter or variable equals ON-STATE,
28617 comparing using `equal', Emacs uses OFF-STATE to specify
28618 how to blink it off. ON-STATE and OFF-STATE are values for
28619 the `cursor-type' frame parameter.
28621 If a frame's ON-STATE has no entry in this list,
28622 the frame's other specifications determine how to blink the cursor off. */);
28623 Vblink_cursor_alist
= Qnil
;
28625 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28626 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28627 If non-nil, windows are automatically scrolled horizontally to make
28628 point visible. */);
28629 automatic_hscrolling_p
= 1;
28630 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28632 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28633 doc
: /* *How many columns away from the window edge point is allowed to get
28634 before automatic hscrolling will horizontally scroll the window. */);
28635 hscroll_margin
= 5;
28637 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28638 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28639 When point is less than `hscroll-margin' columns from the window
28640 edge, automatic hscrolling will scroll the window by the amount of columns
28641 determined by this variable. If its value is a positive integer, scroll that
28642 many columns. If it's a positive floating-point number, it specifies the
28643 fraction of the window's width to scroll. If it's nil or zero, point will be
28644 centered horizontally after the scroll. Any other value, including negative
28645 numbers, are treated as if the value were zero.
28647 Automatic hscrolling always moves point outside the scroll margin, so if
28648 point was more than scroll step columns inside the margin, the window will
28649 scroll more than the value given by the scroll step.
28651 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28652 and `scroll-right' overrides this variable's effect. */);
28653 Vhscroll_step
= make_number (0);
28655 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28656 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28657 Bind this around calls to `message' to let it take effect. */);
28658 message_truncate_lines
= 0;
28660 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28661 doc
: /* Normal hook run to update the menu bar definitions.
28662 Redisplay runs this hook before it redisplays the menu bar.
28663 This is used to update submenus such as Buffers,
28664 whose contents depend on various data. */);
28665 Vmenu_bar_update_hook
= Qnil
;
28667 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28668 doc
: /* Frame for which we are updating a menu.
28669 The enable predicate for a menu binding should check this variable. */);
28670 Vmenu_updating_frame
= Qnil
;
28672 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28673 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28674 inhibit_menubar_update
= 0;
28676 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28677 doc
: /* Prefix prepended to all continuation lines at display time.
28678 The value may be a string, an image, or a stretch-glyph; it is
28679 interpreted in the same way as the value of a `display' text property.
28681 This variable is overridden by any `wrap-prefix' text or overlay
28684 To add a prefix to non-continuation lines, use `line-prefix'. */);
28685 Vwrap_prefix
= Qnil
;
28686 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28687 Fmake_variable_buffer_local (Qwrap_prefix
);
28689 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28690 doc
: /* Prefix prepended to all non-continuation lines at display time.
28691 The value may be a string, an image, or a stretch-glyph; it is
28692 interpreted in the same way as the value of a `display' text property.
28694 This variable is overridden by any `line-prefix' text or overlay
28697 To add a prefix to continuation lines, use `wrap-prefix'. */);
28698 Vline_prefix
= Qnil
;
28699 DEFSYM (Qline_prefix
, "line-prefix");
28700 Fmake_variable_buffer_local (Qline_prefix
);
28702 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28703 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28704 inhibit_eval_during_redisplay
= 0;
28706 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28707 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28708 inhibit_free_realized_faces
= 0;
28711 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28712 doc
: /* Inhibit try_window_id display optimization. */);
28713 inhibit_try_window_id
= 0;
28715 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28716 doc
: /* Inhibit try_window_reusing display optimization. */);
28717 inhibit_try_window_reusing
= 0;
28719 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28720 doc
: /* Inhibit try_cursor_movement display optimization. */);
28721 inhibit_try_cursor_movement
= 0;
28722 #endif /* GLYPH_DEBUG */
28724 DEFVAR_INT ("overline-margin", overline_margin
,
28725 doc
: /* *Space between overline and text, in pixels.
28726 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28727 margin to the character height. */);
28728 overline_margin
= 2;
28730 DEFVAR_INT ("underline-minimum-offset",
28731 underline_minimum_offset
,
28732 doc
: /* Minimum distance between baseline and underline.
28733 This can improve legibility of underlined text at small font sizes,
28734 particularly when using variable `x-use-underline-position-properties'
28735 with fonts that specify an UNDERLINE_POSITION relatively close to the
28736 baseline. The default value is 1. */);
28737 underline_minimum_offset
= 1;
28739 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28740 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28741 This feature only works when on a window system that can change
28742 cursor shapes. */);
28743 display_hourglass_p
= 1;
28745 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28746 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28747 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28749 hourglass_atimer
= NULL
;
28750 hourglass_shown_p
= 0;
28752 DEFSYM (Qglyphless_char
, "glyphless-char");
28753 DEFSYM (Qhex_code
, "hex-code");
28754 DEFSYM (Qempty_box
, "empty-box");
28755 DEFSYM (Qthin_space
, "thin-space");
28756 DEFSYM (Qzero_width
, "zero-width");
28758 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28759 /* Intern this now in case it isn't already done.
28760 Setting this variable twice is harmless.
28761 But don't staticpro it here--that is done in alloc.c. */
28762 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28763 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28765 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28766 doc
: /* Char-table defining glyphless characters.
28767 Each element, if non-nil, should be one of the following:
28768 an ASCII acronym string: display this string in a box
28769 `hex-code': display the hexadecimal code of a character in a box
28770 `empty-box': display as an empty box
28771 `thin-space': display as 1-pixel width space
28772 `zero-width': don't display
28773 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28774 display method for graphical terminals and text terminals respectively.
28775 GRAPHICAL and TEXT should each have one of the values listed above.
28777 The char-table has one extra slot to control the display of a character for
28778 which no font is found. This slot only takes effect on graphical terminals.
28779 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28780 `thin-space'. The default is `empty-box'. */);
28781 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28782 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28787 /* Initialize this module when Emacs starts. */
28792 current_header_line_height
= current_mode_line_height
= -1;
28794 CHARPOS (this_line_start_pos
) = 0;
28796 if (!noninteractive
)
28798 struct window
*m
= XWINDOW (minibuf_window
);
28799 Lisp_Object frame
= m
->frame
;
28800 struct frame
*f
= XFRAME (frame
);
28801 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28802 struct window
*r
= XWINDOW (root
);
28805 echo_area_window
= minibuf_window
;
28807 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28808 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28809 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28810 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28811 XSETFASTINT (m
->total_lines
, 1);
28812 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28814 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28815 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28816 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28818 /* The default ellipsis glyphs `...'. */
28819 for (i
= 0; i
< 3; ++i
)
28820 default_invis_vector
[i
] = make_number ('.');
28824 /* Allocate the buffer for frame titles.
28825 Also used for `format-mode-line'. */
28827 mode_line_noprop_buf
= (char *) xmalloc (size
);
28828 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28829 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28830 mode_line_target
= MODE_LINE_DISPLAY
;
28833 help_echo_showing_p
= 0;
28836 /* Since w32 does not support atimers, it defines its own implementation of
28837 the following three functions in w32fns.c. */
28840 /* Platform-independent portion of hourglass implementation. */
28842 /* Return non-zero if hourglass timer has been started or hourglass is
28845 hourglass_started (void)
28847 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28850 /* Cancel a currently active hourglass timer, and start a new one. */
28852 start_hourglass (void)
28854 #if defined (HAVE_WINDOW_SYSTEM)
28856 int secs
, usecs
= 0;
28858 cancel_hourglass ();
28860 if (INTEGERP (Vhourglass_delay
)
28861 && XINT (Vhourglass_delay
) > 0)
28862 secs
= XFASTINT (Vhourglass_delay
);
28863 else if (FLOATP (Vhourglass_delay
)
28864 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28867 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28868 secs
= XFASTINT (tem
);
28869 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28872 secs
= DEFAULT_HOURGLASS_DELAY
;
28874 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28875 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28876 show_hourglass
, NULL
);
28881 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28884 cancel_hourglass (void)
28886 #if defined (HAVE_WINDOW_SYSTEM)
28887 if (hourglass_atimer
)
28889 cancel_atimer (hourglass_atimer
);
28890 hourglass_atimer
= NULL
;
28893 if (hourglass_shown_p
)
28897 #endif /* ! WINDOWSNT */