1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1213 /* Subroutine of pos_visible_p below. Extracts a display string, if
1214 any, from the display spec given as its argument. */
1216 string_from_display_spec (Lisp_Object spec
)
1220 while (CONSP (spec
))
1222 if (STRINGP (XCAR (spec
)))
1227 else if (VECTORP (spec
))
1231 for (i
= 0; i
< ASIZE (spec
); i
++)
1233 if (STRINGP (AREF (spec
, i
)))
1234 return AREF (spec
, i
);
1242 /* Return 1 if position CHARPOS is visible in window W.
1243 CHARPOS < 0 means return info about WINDOW_END position.
1244 If visible, set *X and *Y to pixel coordinates of top left corner.
1245 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1246 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1249 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1250 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1253 void *itdata
= bidi_shelve_cache ();
1254 struct text_pos top
;
1256 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->buffer
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1269 /* Compute exact mode line heights. */
1270 if (WINDOW_WANTS_MODELINE_P (w
))
1271 current_mode_line_height
1272 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1273 BVAR (current_buffer
, mode_line_format
));
1275 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1276 current_header_line_height
1277 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1278 BVAR (current_buffer
, header_line_format
));
1280 start_display (&it
, w
, top
);
1281 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1282 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1285 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1286 && IT_CHARPOS (it
) >= charpos
)
1287 /* When scanning backwards under bidi iteration, move_it_to
1288 stops at or _before_ CHARPOS, because it stops at or to
1289 the _right_ of the character at CHARPOS. */
1290 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1291 && IT_CHARPOS (it
) <= charpos
)))
1293 /* We have reached CHARPOS, or passed it. How the call to
1294 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1295 or covered by a display property, move_it_to stops at the end
1296 of the invisible text, to the right of CHARPOS. (ii) If
1297 CHARPOS is in a display vector, move_it_to stops on its last
1299 int top_x
= it
.current_x
;
1300 int top_y
= it
.current_y
;
1301 enum it_method it_method
= it
.method
;
1302 /* Calling line_bottom_y may change it.method, it.position, etc. */
1303 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1304 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1306 if (top_y
< window_top_y
)
1307 visible_p
= bottom_y
> window_top_y
;
1308 else if (top_y
< it
.last_visible_y
)
1312 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1314 /* We stopped on the last glyph of a display vector.
1315 Try and recompute. Hack alert! */
1316 if (charpos
< 2 || top
.charpos
>= charpos
)
1317 top_x
= it
.glyph_row
->x
;
1321 start_display (&it2
, w
, top
);
1322 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1323 get_next_display_element (&it2
);
1324 PRODUCE_GLYPHS (&it2
);
1325 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1326 || it2
.current_x
> it2
.last_visible_x
)
1327 top_x
= it
.glyph_row
->x
;
1330 top_x
= it2
.current_x
;
1331 top_y
= it2
.current_y
;
1335 else if (IT_CHARPOS (it
) != charpos
)
1337 Lisp_Object cpos
= make_number (charpos
);
1338 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1339 Lisp_Object string
= string_from_display_spec (spec
);
1340 int newline_in_string
= 0;
1342 if (STRINGP (string
))
1344 const char *s
= SSDATA (string
);
1345 const char *e
= s
+ SBYTES (string
);
1350 newline_in_string
= 1;
1355 /* The tricky code below is needed because there's a
1356 discrepancy between move_it_to and how we set cursor
1357 when the display line ends in a newline from a
1358 display string. move_it_to will stop _after_ such
1359 display strings, whereas set_cursor_from_row
1360 conspires with cursor_row_p to place the cursor on
1361 the first glyph produced from the display string. */
1363 /* We have overshoot PT because it is covered by a
1364 display property whose value is a string. If the
1365 string includes embedded newlines, we are also in the
1366 wrong display line. Backtrack to the correct line,
1367 where the display string begins. */
1368 if (newline_in_string
)
1370 Lisp_Object startpos
, endpos
;
1371 EMACS_INT start
, end
;
1374 /* Find the first and the last buffer positions
1375 covered by the display string. */
1377 Fnext_single_char_property_change (cpos
, Qdisplay
,
1380 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1382 start
= XFASTINT (startpos
);
1383 end
= XFASTINT (endpos
);
1384 /* Move to the last buffer position before the
1385 display property. */
1386 start_display (&it3
, w
, top
);
1387 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1388 /* Move forward one more line if the position before
1389 the display string is a newline or if it is the
1390 rightmost character on a line that is
1391 continued or word-wrapped. */
1392 if (it3
.method
== GET_FROM_BUFFER
1394 move_it_by_lines (&it3
, 1);
1395 else if (move_it_in_display_line_to (&it3
, -1,
1399 == MOVE_LINE_CONTINUED
)
1401 move_it_by_lines (&it3
, 1);
1402 /* When we are under word-wrap, the #$@%!
1403 move_it_by_lines moves 2 lines, so we need to
1405 if (it3
.line_wrap
== WORD_WRAP
)
1406 move_it_by_lines (&it3
, -1);
1409 /* Record the vertical coordinate of the display
1410 line where we wound up. */
1411 top_y
= it3
.current_y
;
1414 /* When characters are reordered for display,
1415 the character displayed to the left of the
1416 display string could be _after_ the display
1417 property in the logical order. Use the
1418 smallest vertical position of these two. */
1419 start_display (&it3
, w
, top
);
1420 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1421 if (it3
.current_y
< top_y
)
1422 top_y
= it3
.current_y
;
1424 /* Move from the top of the window to the beginning
1425 of the display line where the display string
1427 start_display (&it3
, w
, top
);
1428 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1429 /* Finally, advance the iterator until we hit the
1430 first display element whose character position is
1431 CHARPOS, or until the first newline from the
1432 display string, which signals the end of the
1434 while (get_next_display_element (&it3
))
1436 PRODUCE_GLYPHS (&it3
);
1437 if (IT_CHARPOS (it3
) == charpos
1438 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1440 set_iterator_to_next (&it3
, 0);
1442 top_x
= it3
.current_x
- it3
.pixel_width
;
1443 /* Normally, we would exit the above loop because we
1444 found the display element whose character
1445 position is CHARPOS. For the contingency that we
1446 didn't, and stopped at the first newline from the
1447 display string, move back over the glyphs
1448 produced from the string, until we find the
1449 rightmost glyph not from the string. */
1450 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1452 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1453 + it3
.glyph_row
->used
[TEXT_AREA
];
1455 while (EQ ((g
- 1)->object
, string
))
1458 top_x
-= g
->pixel_width
;
1460 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1461 + it3
.glyph_row
->used
[TEXT_AREA
]);
1467 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1468 *rtop
= max (0, window_top_y
- top_y
);
1469 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1470 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1471 - max (top_y
, window_top_y
)));
1477 /* We were asked to provide info about WINDOW_END. */
1479 void *it2data
= NULL
;
1481 SAVE_IT (it2
, it
, it2data
);
1482 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1483 move_it_by_lines (&it
, 1);
1484 if (charpos
< IT_CHARPOS (it
)
1485 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1488 RESTORE_IT (&it2
, &it2
, it2data
);
1489 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1491 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1492 *rtop
= max (0, -it2
.current_y
);
1493 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1494 - it
.last_visible_y
));
1495 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1497 - max (it2
.current_y
,
1498 WINDOW_HEADER_LINE_HEIGHT (w
))));
1502 bidi_unshelve_cache (it2data
, 1);
1504 bidi_unshelve_cache (itdata
, 0);
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR. Return in *LEN the length of
1528 the character. This is like STRING_CHAR_AND_LENGTH but never
1529 returns an invalid character. If we find one, we return a `?', but
1530 with the length of the invalid character. */
1533 string_char_and_length (const unsigned char *str
, int *len
)
1537 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1538 if (!CHAR_VALID_P (c
))
1539 /* We may not change the length here because other places in Emacs
1540 don't use this function, i.e. they silently accept invalid
1549 /* Given a position POS containing a valid character and byte position
1550 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1552 static struct text_pos
1553 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1555 xassert (STRINGP (string
) && nchars
>= 0);
1557 if (STRING_MULTIBYTE (string
))
1559 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1564 string_char_and_length (p
, &len
);
1567 BYTEPOS (pos
) += len
;
1571 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1577 /* Value is the text position, i.e. character and byte position,
1578 for character position CHARPOS in STRING. */
1580 static inline struct text_pos
1581 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1583 struct text_pos pos
;
1584 xassert (STRINGP (string
));
1585 xassert (charpos
>= 0);
1586 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1591 /* Value is a text position, i.e. character and byte position, for
1592 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1593 means recognize multibyte characters. */
1595 static struct text_pos
1596 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1598 struct text_pos pos
;
1600 xassert (s
!= NULL
);
1601 xassert (charpos
>= 0);
1607 SET_TEXT_POS (pos
, 0, 0);
1610 string_char_and_length ((const unsigned char *) s
, &len
);
1613 BYTEPOS (pos
) += len
;
1617 SET_TEXT_POS (pos
, charpos
, charpos
);
1623 /* Value is the number of characters in C string S. MULTIBYTE_P
1624 non-zero means recognize multibyte characters. */
1627 number_of_chars (const char *s
, int multibyte_p
)
1633 EMACS_INT rest
= strlen (s
);
1635 const unsigned char *p
= (const unsigned char *) s
;
1637 for (nchars
= 0; rest
> 0; ++nchars
)
1639 string_char_and_length (p
, &len
);
1640 rest
-= len
, p
+= len
;
1644 nchars
= strlen (s
);
1650 /* Compute byte position NEWPOS->bytepos corresponding to
1651 NEWPOS->charpos. POS is a known position in string STRING.
1652 NEWPOS->charpos must be >= POS.charpos. */
1655 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1657 xassert (STRINGP (string
));
1658 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1660 if (STRING_MULTIBYTE (string
))
1661 *newpos
= string_pos_nchars_ahead (pos
, string
,
1662 CHARPOS (*newpos
) - CHARPOS (pos
));
1664 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1668 Return an estimation of the pixel height of mode or header lines on
1669 frame F. FACE_ID specifies what line's height to estimate. */
1672 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1674 #ifdef HAVE_WINDOW_SYSTEM
1675 if (FRAME_WINDOW_P (f
))
1677 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1679 /* This function is called so early when Emacs starts that the face
1680 cache and mode line face are not yet initialized. */
1681 if (FRAME_FACE_CACHE (f
))
1683 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1687 height
= FONT_HEIGHT (face
->font
);
1688 if (face
->box_line_width
> 0)
1689 height
+= 2 * face
->box_line_width
;
1700 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1701 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1702 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1703 not force the value into range. */
1706 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1707 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1710 #ifdef HAVE_WINDOW_SYSTEM
1711 if (FRAME_WINDOW_P (f
))
1713 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1714 even for negative values. */
1716 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1718 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1720 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1721 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1724 STORE_NATIVE_RECT (*bounds
,
1725 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1726 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1727 FRAME_COLUMN_WIDTH (f
) - 1,
1728 FRAME_LINE_HEIGHT (f
) - 1);
1734 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1735 pix_x
= FRAME_TOTAL_COLS (f
);
1739 else if (pix_y
> FRAME_LINES (f
))
1740 pix_y
= FRAME_LINES (f
);
1750 /* Find the glyph under window-relative coordinates X/Y in window W.
1751 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1752 strings. Return in *HPOS and *VPOS the row and column number of
1753 the glyph found. Return in *AREA the glyph area containing X.
1754 Value is a pointer to the glyph found or null if X/Y is not on
1755 text, or we can't tell because W's current matrix is not up to
1760 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1761 int *dx
, int *dy
, int *area
)
1763 struct glyph
*glyph
, *end
;
1764 struct glyph_row
*row
= NULL
;
1767 /* Find row containing Y. Give up if some row is not enabled. */
1768 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1770 row
= MATRIX_ROW (w
->current_matrix
, i
);
1771 if (!row
->enabled_p
)
1773 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1780 /* Give up if Y is not in the window. */
1781 if (i
== w
->current_matrix
->nrows
)
1784 /* Get the glyph area containing X. */
1785 if (w
->pseudo_window_p
)
1792 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1794 *area
= LEFT_MARGIN_AREA
;
1795 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1797 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1800 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1804 *area
= RIGHT_MARGIN_AREA
;
1805 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1809 /* Find glyph containing X. */
1810 glyph
= row
->glyphs
[*area
];
1811 end
= glyph
+ row
->used
[*area
];
1813 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1815 x
-= glyph
->pixel_width
;
1825 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1828 *hpos
= glyph
- row
->glyphs
[*area
];
1832 /* Convert frame-relative x/y to coordinates relative to window W.
1833 Takes pseudo-windows into account. */
1836 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1838 if (w
->pseudo_window_p
)
1840 /* A pseudo-window is always full-width, and starts at the
1841 left edge of the frame, plus a frame border. */
1842 struct frame
*f
= XFRAME (w
->frame
);
1843 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1844 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1848 *x
-= WINDOW_LEFT_EDGE_X (w
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 #ifdef HAVE_WINDOW_SYSTEM
1856 Return in RECTS[] at most N clipping rectangles for glyph string S.
1857 Return the number of stored rectangles. */
1860 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1867 if (s
->row
->full_width_p
)
1869 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1870 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1871 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1873 /* Unless displaying a mode or menu bar line, which are always
1874 fully visible, clip to the visible part of the row. */
1875 if (s
->w
->pseudo_window_p
)
1876 r
.height
= s
->row
->visible_height
;
1878 r
.height
= s
->height
;
1882 /* This is a text line that may be partially visible. */
1883 r
.x
= window_box_left (s
->w
, s
->area
);
1884 r
.width
= window_box_width (s
->w
, s
->area
);
1885 r
.height
= s
->row
->visible_height
;
1889 if (r
.x
< s
->clip_head
->x
)
1891 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1892 r
.width
-= s
->clip_head
->x
- r
.x
;
1895 r
.x
= s
->clip_head
->x
;
1898 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1900 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1901 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1906 /* If S draws overlapping rows, it's sufficient to use the top and
1907 bottom of the window for clipping because this glyph string
1908 intentionally draws over other lines. */
1909 if (s
->for_overlaps
)
1911 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1912 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1914 /* Alas, the above simple strategy does not work for the
1915 environments with anti-aliased text: if the same text is
1916 drawn onto the same place multiple times, it gets thicker.
1917 If the overlap we are processing is for the erased cursor, we
1918 take the intersection with the rectangle of the cursor. */
1919 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1921 XRectangle rc
, r_save
= r
;
1923 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1924 rc
.y
= s
->w
->phys_cursor
.y
;
1925 rc
.width
= s
->w
->phys_cursor_width
;
1926 rc
.height
= s
->w
->phys_cursor_height
;
1928 x_intersect_rectangles (&r_save
, &rc
, &r
);
1933 /* Don't use S->y for clipping because it doesn't take partially
1934 visible lines into account. For example, it can be negative for
1935 partially visible lines at the top of a window. */
1936 if (!s
->row
->full_width_p
1937 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1938 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1940 r
.y
= max (0, s
->row
->y
);
1943 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1945 /* If drawing the cursor, don't let glyph draw outside its
1946 advertised boundaries. Cleartype does this under some circumstances. */
1947 if (s
->hl
== DRAW_CURSOR
)
1949 struct glyph
*glyph
= s
->first_glyph
;
1954 r
.width
-= s
->x
- r
.x
;
1957 r
.width
= min (r
.width
, glyph
->pixel_width
);
1959 /* If r.y is below window bottom, ensure that we still see a cursor. */
1960 height
= min (glyph
->ascent
+ glyph
->descent
,
1961 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1962 max_y
= window_text_bottom_y (s
->w
) - height
;
1963 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1964 if (s
->ybase
- glyph
->ascent
> max_y
)
1971 /* Don't draw cursor glyph taller than our actual glyph. */
1972 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1973 if (height
< r
.height
)
1975 max_y
= r
.y
+ r
.height
;
1976 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1977 r
.height
= min (max_y
- r
.y
, height
);
1984 XRectangle r_save
= r
;
1986 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1990 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1991 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1993 #ifdef CONVERT_FROM_XRECT
1994 CONVERT_FROM_XRECT (r
, *rects
);
2002 /* If we are processing overlapping and allowed to return
2003 multiple clipping rectangles, we exclude the row of the glyph
2004 string from the clipping rectangle. This is to avoid drawing
2005 the same text on the environment with anti-aliasing. */
2006 #ifdef CONVERT_FROM_XRECT
2009 XRectangle
*rs
= rects
;
2011 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2013 if (s
->for_overlaps
& OVERLAPS_PRED
)
2016 if (r
.y
+ r
.height
> row_y
)
2019 rs
[i
].height
= row_y
- r
.y
;
2025 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2028 if (r
.y
< row_y
+ s
->row
->visible_height
)
2030 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2032 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2033 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2042 #ifdef CONVERT_FROM_XRECT
2043 for (i
= 0; i
< n
; i
++)
2044 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2051 Return in *NR the clipping rectangle for glyph string S. */
2054 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2056 get_glyph_string_clip_rects (s
, nr
, 1);
2061 Return the position and height of the phys cursor in window W.
2062 Set w->phys_cursor_width to width of phys cursor.
2066 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2067 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2070 int x
, y
, wd
, h
, h0
, y0
;
2072 /* Compute the width of the rectangle to draw. If on a stretch
2073 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2074 rectangle as wide as the glyph, but use a canonical character
2076 wd
= glyph
->pixel_width
- 1;
2077 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2081 x
= w
->phys_cursor
.x
;
2088 if (glyph
->type
== STRETCH_GLYPH
2089 && !x_stretch_cursor_p
)
2090 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2091 w
->phys_cursor_width
= wd
;
2093 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2095 /* If y is below window bottom, ensure that we still see a cursor. */
2096 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2098 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2099 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2101 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2104 h
= max (h
- (y0
- y
) + 1, h0
);
2109 y0
= window_text_bottom_y (w
) - h0
;
2117 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2118 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2123 * Remember which glyph the mouse is over.
2127 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2131 struct glyph_row
*r
, *gr
, *end_row
;
2132 enum window_part part
;
2133 enum glyph_row_area area
;
2134 int x
, y
, width
, height
;
2136 /* Try to determine frame pixel position and size of the glyph under
2137 frame pixel coordinates X/Y on frame F. */
2139 if (!f
->glyphs_initialized_p
2140 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2143 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2144 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2148 w
= XWINDOW (window
);
2149 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2150 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2152 x
= window_relative_x_coord (w
, part
, gx
);
2153 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2155 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2156 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2158 if (w
->pseudo_window_p
)
2161 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2167 case ON_LEFT_MARGIN
:
2168 area
= LEFT_MARGIN_AREA
;
2171 case ON_RIGHT_MARGIN
:
2172 area
= RIGHT_MARGIN_AREA
;
2175 case ON_HEADER_LINE
:
2177 gr
= (part
== ON_HEADER_LINE
2178 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2179 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2182 goto text_glyph_row_found
;
2189 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2190 if (r
->y
+ r
->height
> y
)
2196 text_glyph_row_found
:
2199 struct glyph
*g
= gr
->glyphs
[area
];
2200 struct glyph
*end
= g
+ gr
->used
[area
];
2202 height
= gr
->height
;
2203 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2204 if (gx
+ g
->pixel_width
> x
)
2209 if (g
->type
== IMAGE_GLYPH
)
2211 /* Don't remember when mouse is over image, as
2212 image may have hot-spots. */
2213 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2216 width
= g
->pixel_width
;
2220 /* Use nominal char spacing at end of line. */
2222 gx
+= (x
/ width
) * width
;
2225 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2226 gx
+= window_box_left_offset (w
, area
);
2230 /* Use nominal line height at end of window. */
2231 gx
= (x
/ width
) * width
;
2233 gy
+= (y
/ height
) * height
;
2237 case ON_LEFT_FRINGE
:
2238 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2239 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2240 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2241 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2244 case ON_RIGHT_FRINGE
:
2245 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2246 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2247 : window_box_right_offset (w
, TEXT_AREA
));
2248 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2252 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2254 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2255 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2256 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2258 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2262 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2263 if (r
->y
+ r
->height
> y
)
2270 height
= gr
->height
;
2273 /* Use nominal line height at end of window. */
2275 gy
+= (y
/ height
) * height
;
2282 /* If there is no glyph under the mouse, then we divide the screen
2283 into a grid of the smallest glyph in the frame, and use that
2286 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2287 round down even for negative values. */
2293 gx
= (gx
/ width
) * width
;
2294 gy
= (gy
/ height
) * height
;
2299 gx
+= WINDOW_LEFT_EDGE_X (w
);
2300 gy
+= WINDOW_TOP_EDGE_Y (w
);
2303 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2305 /* Visible feedback for debugging. */
2308 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2309 f
->output_data
.x
->normal_gc
,
2310 gx
, gy
, width
, height
);
2316 #endif /* HAVE_WINDOW_SYSTEM */
2319 /***********************************************************************
2320 Lisp form evaluation
2321 ***********************************************************************/
2323 /* Error handler for safe_eval and safe_call. */
2326 safe_eval_handler (Lisp_Object arg
)
2328 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2333 /* Evaluate SEXPR and return the result, or nil if something went
2334 wrong. Prevent redisplay during the evaluation. */
2336 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2337 Return the result, or nil if something went wrong. Prevent
2338 redisplay during the evaluation. */
2341 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2345 if (inhibit_eval_during_redisplay
)
2349 int count
= SPECPDL_INDEX ();
2350 struct gcpro gcpro1
;
2353 gcpro1
.nvars
= nargs
;
2354 specbind (Qinhibit_redisplay
, Qt
);
2355 /* Use Qt to ensure debugger does not run,
2356 so there is no possibility of wanting to redisplay. */
2357 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2360 val
= unbind_to (count
, val
);
2367 /* Call function FN with one argument ARG.
2368 Return the result, or nil if something went wrong. */
2371 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2373 Lisp_Object args
[2];
2376 return safe_call (2, args
);
2379 static Lisp_Object Qeval
;
2382 safe_eval (Lisp_Object sexpr
)
2384 return safe_call1 (Qeval
, sexpr
);
2387 /* Call function FN with one argument ARG.
2388 Return the result, or nil if something went wrong. */
2391 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2393 Lisp_Object args
[3];
2397 return safe_call (3, args
);
2402 /***********************************************************************
2404 ***********************************************************************/
2408 /* Define CHECK_IT to perform sanity checks on iterators.
2409 This is for debugging. It is too slow to do unconditionally. */
2412 check_it (struct it
*it
)
2414 if (it
->method
== GET_FROM_STRING
)
2416 xassert (STRINGP (it
->string
));
2417 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2421 xassert (IT_STRING_CHARPOS (*it
) < 0);
2422 if (it
->method
== GET_FROM_BUFFER
)
2424 /* Check that character and byte positions agree. */
2425 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2430 xassert (it
->current
.dpvec_index
>= 0);
2432 xassert (it
->current
.dpvec_index
< 0);
2435 #define CHECK_IT(IT) check_it ((IT))
2439 #define CHECK_IT(IT) (void) 0
2444 #if GLYPH_DEBUG && XASSERTS
2446 /* Check that the window end of window W is what we expect it
2447 to be---the last row in the current matrix displaying text. */
2450 check_window_end (struct window
*w
)
2452 if (!MINI_WINDOW_P (w
)
2453 && !NILP (w
->window_end_valid
))
2455 struct glyph_row
*row
;
2456 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2457 XFASTINT (w
->window_end_vpos
)),
2459 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2460 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2464 #define CHECK_WINDOW_END(W) check_window_end ((W))
2468 #define CHECK_WINDOW_END(W) (void) 0
2474 /***********************************************************************
2475 Iterator initialization
2476 ***********************************************************************/
2478 /* Initialize IT for displaying current_buffer in window W, starting
2479 at character position CHARPOS. CHARPOS < 0 means that no buffer
2480 position is specified which is useful when the iterator is assigned
2481 a position later. BYTEPOS is the byte position corresponding to
2482 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2484 If ROW is not null, calls to produce_glyphs with IT as parameter
2485 will produce glyphs in that row.
2487 BASE_FACE_ID is the id of a base face to use. It must be one of
2488 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2489 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2490 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2492 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2493 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2494 will be initialized to use the corresponding mode line glyph row of
2495 the desired matrix of W. */
2498 init_iterator (struct it
*it
, struct window
*w
,
2499 EMACS_INT charpos
, EMACS_INT bytepos
,
2500 struct glyph_row
*row
, enum face_id base_face_id
)
2502 int highlight_region_p
;
2503 enum face_id remapped_base_face_id
= base_face_id
;
2505 /* Some precondition checks. */
2506 xassert (w
!= NULL
&& it
!= NULL
);
2507 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2510 /* If face attributes have been changed since the last redisplay,
2511 free realized faces now because they depend on face definitions
2512 that might have changed. Don't free faces while there might be
2513 desired matrices pending which reference these faces. */
2514 if (face_change_count
&& !inhibit_free_realized_faces
)
2516 face_change_count
= 0;
2517 free_all_realized_faces (Qnil
);
2520 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2521 if (! NILP (Vface_remapping_alist
))
2522 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2524 /* Use one of the mode line rows of W's desired matrix if
2528 if (base_face_id
== MODE_LINE_FACE_ID
2529 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2530 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2531 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2532 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2536 memset (it
, 0, sizeof *it
);
2537 it
->current
.overlay_string_index
= -1;
2538 it
->current
.dpvec_index
= -1;
2539 it
->base_face_id
= remapped_base_face_id
;
2541 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2542 it
->paragraph_embedding
= L2R
;
2543 it
->bidi_it
.string
.lstring
= Qnil
;
2544 it
->bidi_it
.string
.s
= NULL
;
2545 it
->bidi_it
.string
.bufpos
= 0;
2547 /* The window in which we iterate over current_buffer: */
2548 XSETWINDOW (it
->window
, w
);
2550 it
->f
= XFRAME (w
->frame
);
2554 /* Extra space between lines (on window systems only). */
2555 if (base_face_id
== DEFAULT_FACE_ID
2556 && FRAME_WINDOW_P (it
->f
))
2558 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2559 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2560 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2561 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2562 * FRAME_LINE_HEIGHT (it
->f
));
2563 else if (it
->f
->extra_line_spacing
> 0)
2564 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2565 it
->max_extra_line_spacing
= 0;
2568 /* If realized faces have been removed, e.g. because of face
2569 attribute changes of named faces, recompute them. When running
2570 in batch mode, the face cache of the initial frame is null. If
2571 we happen to get called, make a dummy face cache. */
2572 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2573 init_frame_faces (it
->f
);
2574 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2575 recompute_basic_faces (it
->f
);
2577 /* Current value of the `slice', `space-width', and 'height' properties. */
2578 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2579 it
->space_width
= Qnil
;
2580 it
->font_height
= Qnil
;
2581 it
->override_ascent
= -1;
2583 /* Are control characters displayed as `^C'? */
2584 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2586 /* -1 means everything between a CR and the following line end
2587 is invisible. >0 means lines indented more than this value are
2589 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2590 ? XINT (BVAR (current_buffer
, selective_display
))
2591 : (!NILP (BVAR (current_buffer
, selective_display
))
2593 it
->selective_display_ellipsis_p
2594 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2596 /* Display table to use. */
2597 it
->dp
= window_display_table (w
);
2599 /* Are multibyte characters enabled in current_buffer? */
2600 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2602 /* Non-zero if we should highlight the region. */
2604 = (!NILP (Vtransient_mark_mode
)
2605 && !NILP (BVAR (current_buffer
, mark_active
))
2606 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2608 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2609 start and end of a visible region in window IT->w. Set both to
2610 -1 to indicate no region. */
2611 if (highlight_region_p
2612 /* Maybe highlight only in selected window. */
2613 && (/* Either show region everywhere. */
2614 highlight_nonselected_windows
2615 /* Or show region in the selected window. */
2616 || w
== XWINDOW (selected_window
)
2617 /* Or show the region if we are in the mini-buffer and W is
2618 the window the mini-buffer refers to. */
2619 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2620 && WINDOWP (minibuf_selected_window
)
2621 && w
== XWINDOW (minibuf_selected_window
))))
2623 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2624 it
->region_beg_charpos
= min (PT
, markpos
);
2625 it
->region_end_charpos
= max (PT
, markpos
);
2628 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2630 /* Get the position at which the redisplay_end_trigger hook should
2631 be run, if it is to be run at all. */
2632 if (MARKERP (w
->redisplay_end_trigger
)
2633 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2634 it
->redisplay_end_trigger_charpos
2635 = marker_position (w
->redisplay_end_trigger
);
2636 else if (INTEGERP (w
->redisplay_end_trigger
))
2637 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2639 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2641 /* Are lines in the display truncated? */
2642 if (base_face_id
!= DEFAULT_FACE_ID
2643 || XINT (it
->w
->hscroll
)
2644 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2645 && ((!NILP (Vtruncate_partial_width_windows
)
2646 && !INTEGERP (Vtruncate_partial_width_windows
))
2647 || (INTEGERP (Vtruncate_partial_width_windows
)
2648 && (WINDOW_TOTAL_COLS (it
->w
)
2649 < XINT (Vtruncate_partial_width_windows
))))))
2650 it
->line_wrap
= TRUNCATE
;
2651 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2652 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2653 ? WINDOW_WRAP
: WORD_WRAP
;
2655 it
->line_wrap
= TRUNCATE
;
2657 /* Get dimensions of truncation and continuation glyphs. These are
2658 displayed as fringe bitmaps under X, so we don't need them for such
2660 if (!FRAME_WINDOW_P (it
->f
))
2662 if (it
->line_wrap
== TRUNCATE
)
2664 /* We will need the truncation glyph. */
2665 xassert (it
->glyph_row
== NULL
);
2666 produce_special_glyphs (it
, IT_TRUNCATION
);
2667 it
->truncation_pixel_width
= it
->pixel_width
;
2671 /* We will need the continuation glyph. */
2672 xassert (it
->glyph_row
== NULL
);
2673 produce_special_glyphs (it
, IT_CONTINUATION
);
2674 it
->continuation_pixel_width
= it
->pixel_width
;
2677 /* Reset these values to zero because the produce_special_glyphs
2678 above has changed them. */
2679 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2680 it
->phys_ascent
= it
->phys_descent
= 0;
2683 /* Set this after getting the dimensions of truncation and
2684 continuation glyphs, so that we don't produce glyphs when calling
2685 produce_special_glyphs, above. */
2686 it
->glyph_row
= row
;
2687 it
->area
= TEXT_AREA
;
2689 /* Forget any previous info about this row being reversed. */
2691 it
->glyph_row
->reversed_p
= 0;
2693 /* Get the dimensions of the display area. The display area
2694 consists of the visible window area plus a horizontally scrolled
2695 part to the left of the window. All x-values are relative to the
2696 start of this total display area. */
2697 if (base_face_id
!= DEFAULT_FACE_ID
)
2699 /* Mode lines, menu bar in terminal frames. */
2700 it
->first_visible_x
= 0;
2701 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2706 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2707 it
->last_visible_x
= (it
->first_visible_x
2708 + window_box_width (w
, TEXT_AREA
));
2710 /* If we truncate lines, leave room for the truncator glyph(s) at
2711 the right margin. Otherwise, leave room for the continuation
2712 glyph(s). Truncation and continuation glyphs are not inserted
2713 for window-based redisplay. */
2714 if (!FRAME_WINDOW_P (it
->f
))
2716 if (it
->line_wrap
== TRUNCATE
)
2717 it
->last_visible_x
-= it
->truncation_pixel_width
;
2719 it
->last_visible_x
-= it
->continuation_pixel_width
;
2722 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2723 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2726 /* Leave room for a border glyph. */
2727 if (!FRAME_WINDOW_P (it
->f
)
2728 && !WINDOW_RIGHTMOST_P (it
->w
))
2729 it
->last_visible_x
-= 1;
2731 it
->last_visible_y
= window_text_bottom_y (w
);
2733 /* For mode lines and alike, arrange for the first glyph having a
2734 left box line if the face specifies a box. */
2735 if (base_face_id
!= DEFAULT_FACE_ID
)
2739 it
->face_id
= remapped_base_face_id
;
2741 /* If we have a boxed mode line, make the first character appear
2742 with a left box line. */
2743 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2744 if (face
->box
!= FACE_NO_BOX
)
2745 it
->start_of_box_run_p
= 1;
2748 /* If a buffer position was specified, set the iterator there,
2749 getting overlays and face properties from that position. */
2750 if (charpos
>= BUF_BEG (current_buffer
))
2752 it
->end_charpos
= ZV
;
2753 IT_CHARPOS (*it
) = charpos
;
2755 /* We will rely on `reseat' to set this up properly, via
2756 handle_face_prop. */
2757 it
->face_id
= it
->base_face_id
;
2759 /* Compute byte position if not specified. */
2760 if (bytepos
< charpos
)
2761 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2763 IT_BYTEPOS (*it
) = bytepos
;
2765 it
->start
= it
->current
;
2766 /* Do we need to reorder bidirectional text? Not if this is a
2767 unibyte buffer: by definition, none of the single-byte
2768 characters are strong R2L, so no reordering is needed. And
2769 bidi.c doesn't support unibyte buffers anyway. Also, don't
2770 reorder while we are loading loadup.el, since the tables of
2771 character properties needed for reordering are not yet
2775 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2778 /* If we are to reorder bidirectional text, init the bidi
2782 /* Note the paragraph direction that this buffer wants to
2784 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2786 it
->paragraph_embedding
= L2R
;
2787 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2789 it
->paragraph_embedding
= R2L
;
2791 it
->paragraph_embedding
= NEUTRAL_DIR
;
2792 bidi_unshelve_cache (NULL
, 0);
2793 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2797 /* Compute faces etc. */
2798 reseat (it
, it
->current
.pos
, 1);
2805 /* Initialize IT for the display of window W with window start POS. */
2808 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2810 struct glyph_row
*row
;
2811 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2813 row
= w
->desired_matrix
->rows
+ first_vpos
;
2814 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2815 it
->first_vpos
= first_vpos
;
2817 /* Don't reseat to previous visible line start if current start
2818 position is in a string or image. */
2819 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2821 int start_at_line_beg_p
;
2822 int first_y
= it
->current_y
;
2824 /* If window start is not at a line start, skip forward to POS to
2825 get the correct continuation lines width. */
2826 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2827 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2828 if (!start_at_line_beg_p
)
2832 reseat_at_previous_visible_line_start (it
);
2833 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2835 new_x
= it
->current_x
+ it
->pixel_width
;
2837 /* If lines are continued, this line may end in the middle
2838 of a multi-glyph character (e.g. a control character
2839 displayed as \003, or in the middle of an overlay
2840 string). In this case move_it_to above will not have
2841 taken us to the start of the continuation line but to the
2842 end of the continued line. */
2843 if (it
->current_x
> 0
2844 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2845 && (/* And glyph doesn't fit on the line. */
2846 new_x
> it
->last_visible_x
2847 /* Or it fits exactly and we're on a window
2849 || (new_x
== it
->last_visible_x
2850 && FRAME_WINDOW_P (it
->f
))))
2852 if ((it
->current
.dpvec_index
>= 0
2853 || it
->current
.overlay_string_index
>= 0)
2854 /* If we are on a newline from a display vector or
2855 overlay string, then we are already at the end of
2856 a screen line; no need to go to the next line in
2857 that case, as this line is not really continued.
2858 (If we do go to the next line, C-e will not DTRT.) */
2861 set_iterator_to_next (it
, 1);
2862 move_it_in_display_line_to (it
, -1, -1, 0);
2865 it
->continuation_lines_width
+= it
->current_x
;
2867 /* If the character at POS is displayed via a display
2868 vector, move_it_to above stops at the final glyph of
2869 IT->dpvec. To make the caller redisplay that character
2870 again (a.k.a. start at POS), we need to reset the
2871 dpvec_index to the beginning of IT->dpvec. */
2872 else if (it
->current
.dpvec_index
>= 0)
2873 it
->current
.dpvec_index
= 0;
2875 /* We're starting a new display line, not affected by the
2876 height of the continued line, so clear the appropriate
2877 fields in the iterator structure. */
2878 it
->max_ascent
= it
->max_descent
= 0;
2879 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2881 it
->current_y
= first_y
;
2883 it
->current_x
= it
->hpos
= 0;
2889 /* Return 1 if POS is a position in ellipses displayed for invisible
2890 text. W is the window we display, for text property lookup. */
2893 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2895 Lisp_Object prop
, window
;
2897 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2899 /* If POS specifies a position in a display vector, this might
2900 be for an ellipsis displayed for invisible text. We won't
2901 get the iterator set up for delivering that ellipsis unless
2902 we make sure that it gets aware of the invisible text. */
2903 if (pos
->dpvec_index
>= 0
2904 && pos
->overlay_string_index
< 0
2905 && CHARPOS (pos
->string_pos
) < 0
2907 && (XSETWINDOW (window
, w
),
2908 prop
= Fget_char_property (make_number (charpos
),
2909 Qinvisible
, window
),
2910 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2912 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2914 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2921 /* Initialize IT for stepping through current_buffer in window W,
2922 starting at position POS that includes overlay string and display
2923 vector/ control character translation position information. Value
2924 is zero if there are overlay strings with newlines at POS. */
2927 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2929 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2930 int i
, overlay_strings_with_newlines
= 0;
2932 /* If POS specifies a position in a display vector, this might
2933 be for an ellipsis displayed for invisible text. We won't
2934 get the iterator set up for delivering that ellipsis unless
2935 we make sure that it gets aware of the invisible text. */
2936 if (in_ellipses_for_invisible_text_p (pos
, w
))
2942 /* Keep in mind: the call to reseat in init_iterator skips invisible
2943 text, so we might end up at a position different from POS. This
2944 is only a problem when POS is a row start after a newline and an
2945 overlay starts there with an after-string, and the overlay has an
2946 invisible property. Since we don't skip invisible text in
2947 display_line and elsewhere immediately after consuming the
2948 newline before the row start, such a POS will not be in a string,
2949 but the call to init_iterator below will move us to the
2951 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2953 /* This only scans the current chunk -- it should scan all chunks.
2954 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2955 to 16 in 22.1 to make this a lesser problem. */
2956 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2958 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2959 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2961 while (s
< e
&& *s
!= '\n')
2966 overlay_strings_with_newlines
= 1;
2971 /* If position is within an overlay string, set up IT to the right
2973 if (pos
->overlay_string_index
>= 0)
2977 /* If the first overlay string happens to have a `display'
2978 property for an image, the iterator will be set up for that
2979 image, and we have to undo that setup first before we can
2980 correct the overlay string index. */
2981 if (it
->method
== GET_FROM_IMAGE
)
2984 /* We already have the first chunk of overlay strings in
2985 IT->overlay_strings. Load more until the one for
2986 pos->overlay_string_index is in IT->overlay_strings. */
2987 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2989 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2990 it
->current
.overlay_string_index
= 0;
2993 load_overlay_strings (it
, 0);
2994 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2998 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2999 relative_index
= (it
->current
.overlay_string_index
3000 % OVERLAY_STRING_CHUNK_SIZE
);
3001 it
->string
= it
->overlay_strings
[relative_index
];
3002 xassert (STRINGP (it
->string
));
3003 it
->current
.string_pos
= pos
->string_pos
;
3004 it
->method
= GET_FROM_STRING
;
3007 if (CHARPOS (pos
->string_pos
) >= 0)
3009 /* Recorded position is not in an overlay string, but in another
3010 string. This can only be a string from a `display' property.
3011 IT should already be filled with that string. */
3012 it
->current
.string_pos
= pos
->string_pos
;
3013 xassert (STRINGP (it
->string
));
3016 /* Restore position in display vector translations, control
3017 character translations or ellipses. */
3018 if (pos
->dpvec_index
>= 0)
3020 if (it
->dpvec
== NULL
)
3021 get_next_display_element (it
);
3022 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3023 it
->current
.dpvec_index
= pos
->dpvec_index
;
3027 return !overlay_strings_with_newlines
;
3031 /* Initialize IT for stepping through current_buffer in window W
3032 starting at ROW->start. */
3035 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3037 init_from_display_pos (it
, w
, &row
->start
);
3038 it
->start
= row
->start
;
3039 it
->continuation_lines_width
= row
->continuation_lines_width
;
3044 /* Initialize IT for stepping through current_buffer in window W
3045 starting in the line following ROW, i.e. starting at ROW->end.
3046 Value is zero if there are overlay strings with newlines at ROW's
3050 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3054 if (init_from_display_pos (it
, w
, &row
->end
))
3056 if (row
->continued_p
)
3057 it
->continuation_lines_width
3058 = row
->continuation_lines_width
+ row
->pixel_width
;
3069 /***********************************************************************
3071 ***********************************************************************/
3073 /* Called when IT reaches IT->stop_charpos. Handle text property and
3074 overlay changes. Set IT->stop_charpos to the next position where
3078 handle_stop (struct it
*it
)
3080 enum prop_handled handled
;
3081 int handle_overlay_change_p
;
3085 it
->current
.dpvec_index
= -1;
3086 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3087 it
->ignore_overlay_strings_at_pos_p
= 0;
3090 /* Use face of preceding text for ellipsis (if invisible) */
3091 if (it
->selective_display_ellipsis_p
)
3092 it
->saved_face_id
= it
->face_id
;
3096 handled
= HANDLED_NORMALLY
;
3098 /* Call text property handlers. */
3099 for (p
= it_props
; p
->handler
; ++p
)
3101 handled
= p
->handler (it
);
3103 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3105 else if (handled
== HANDLED_RETURN
)
3107 /* We still want to show before and after strings from
3108 overlays even if the actual buffer text is replaced. */
3109 if (!handle_overlay_change_p
3111 || !get_overlay_strings_1 (it
, 0, 0))
3114 setup_for_ellipsis (it
, 0);
3115 /* When handling a display spec, we might load an
3116 empty string. In that case, discard it here. We
3117 used to discard it in handle_single_display_spec,
3118 but that causes get_overlay_strings_1, above, to
3119 ignore overlay strings that we must check. */
3120 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3124 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3128 it
->ignore_overlay_strings_at_pos_p
= 1;
3129 it
->string_from_display_prop_p
= 0;
3130 it
->from_disp_prop_p
= 0;
3131 handle_overlay_change_p
= 0;
3133 handled
= HANDLED_RECOMPUTE_PROPS
;
3136 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3137 handle_overlay_change_p
= 0;
3140 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3142 /* Don't check for overlay strings below when set to deliver
3143 characters from a display vector. */
3144 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3145 handle_overlay_change_p
= 0;
3147 /* Handle overlay changes.
3148 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3149 if it finds overlays. */
3150 if (handle_overlay_change_p
)
3151 handled
= handle_overlay_change (it
);
3156 setup_for_ellipsis (it
, 0);
3160 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3162 /* Determine where to stop next. */
3163 if (handled
== HANDLED_NORMALLY
)
3164 compute_stop_pos (it
);
3168 /* Compute IT->stop_charpos from text property and overlay change
3169 information for IT's current position. */
3172 compute_stop_pos (struct it
*it
)
3174 register INTERVAL iv
, next_iv
;
3175 Lisp_Object object
, limit
, position
;
3176 EMACS_INT charpos
, bytepos
;
3178 if (STRINGP (it
->string
))
3180 /* Strings are usually short, so don't limit the search for
3182 it
->stop_charpos
= it
->end_charpos
;
3183 object
= it
->string
;
3185 charpos
= IT_STRING_CHARPOS (*it
);
3186 bytepos
= IT_STRING_BYTEPOS (*it
);
3192 /* If end_charpos is out of range for some reason, such as a
3193 misbehaving display function, rationalize it (Bug#5984). */
3194 if (it
->end_charpos
> ZV
)
3195 it
->end_charpos
= ZV
;
3196 it
->stop_charpos
= it
->end_charpos
;
3198 /* If next overlay change is in front of the current stop pos
3199 (which is IT->end_charpos), stop there. Note: value of
3200 next_overlay_change is point-max if no overlay change
3202 charpos
= IT_CHARPOS (*it
);
3203 bytepos
= IT_BYTEPOS (*it
);
3204 pos
= next_overlay_change (charpos
);
3205 if (pos
< it
->stop_charpos
)
3206 it
->stop_charpos
= pos
;
3208 /* If showing the region, we have to stop at the region
3209 start or end because the face might change there. */
3210 if (it
->region_beg_charpos
> 0)
3212 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3213 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3214 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3215 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3218 /* Set up variables for computing the stop position from text
3219 property changes. */
3220 XSETBUFFER (object
, current_buffer
);
3221 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3224 /* Get the interval containing IT's position. Value is a null
3225 interval if there isn't such an interval. */
3226 position
= make_number (charpos
);
3227 iv
= validate_interval_range (object
, &position
, &position
, 0);
3228 if (!NULL_INTERVAL_P (iv
))
3230 Lisp_Object values_here
[LAST_PROP_IDX
];
3233 /* Get properties here. */
3234 for (p
= it_props
; p
->handler
; ++p
)
3235 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3237 /* Look for an interval following iv that has different
3239 for (next_iv
= next_interval (iv
);
3240 (!NULL_INTERVAL_P (next_iv
)
3242 || XFASTINT (limit
) > next_iv
->position
));
3243 next_iv
= next_interval (next_iv
))
3245 for (p
= it_props
; p
->handler
; ++p
)
3247 Lisp_Object new_value
;
3249 new_value
= textget (next_iv
->plist
, *p
->name
);
3250 if (!EQ (values_here
[p
->idx
], new_value
))
3258 if (!NULL_INTERVAL_P (next_iv
))
3260 if (INTEGERP (limit
)
3261 && next_iv
->position
>= XFASTINT (limit
))
3262 /* No text property change up to limit. */
3263 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3265 /* Text properties change in next_iv. */
3266 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3270 if (it
->cmp_it
.id
< 0)
3272 EMACS_INT stoppos
= it
->end_charpos
;
3274 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3276 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3277 stoppos
, it
->string
);
3280 xassert (STRINGP (it
->string
)
3281 || (it
->stop_charpos
>= BEGV
3282 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3286 /* Return the position of the next overlay change after POS in
3287 current_buffer. Value is point-max if no overlay change
3288 follows. This is like `next-overlay-change' but doesn't use
3292 next_overlay_change (EMACS_INT pos
)
3294 ptrdiff_t i
, noverlays
;
3296 Lisp_Object
*overlays
;
3298 /* Get all overlays at the given position. */
3299 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3301 /* If any of these overlays ends before endpos,
3302 use its ending point instead. */
3303 for (i
= 0; i
< noverlays
; ++i
)
3308 oend
= OVERLAY_END (overlays
[i
]);
3309 oendpos
= OVERLAY_POSITION (oend
);
3310 endpos
= min (endpos
, oendpos
);
3316 /* How many characters forward to search for a display property or
3317 display string. Searching too far forward makes the bidi display
3318 sluggish, especially in small windows. */
3319 #define MAX_DISP_SCAN 250
3321 /* Return the character position of a display string at or after
3322 position specified by POSITION. If no display string exists at or
3323 after POSITION, return ZV. A display string is either an overlay
3324 with `display' property whose value is a string, or a `display'
3325 text property whose value is a string. STRING is data about the
3326 string to iterate; if STRING->lstring is nil, we are iterating a
3327 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3328 on a GUI frame. DISP_PROP is set to zero if we searched
3329 MAX_DISP_SCAN characters forward without finding any display
3330 strings, non-zero otherwise. It is set to 2 if the display string
3331 uses any kind of `(space ...)' spec that will produce a stretch of
3332 white space in the text area. */
3334 compute_display_string_pos (struct text_pos
*position
,
3335 struct bidi_string_data
*string
,
3336 int frame_window_p
, int *disp_prop
)
3338 /* OBJECT = nil means current buffer. */
3339 Lisp_Object object
=
3340 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3341 Lisp_Object pos
, spec
, limpos
;
3342 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3343 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3344 EMACS_INT begb
= string_p
? 0 : BEGV
;
3345 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3347 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3348 struct text_pos tpos
;
3354 /* We don't support display properties whose values are strings
3355 that have display string properties. */
3356 || string
->from_disp_str
3357 /* C strings cannot have display properties. */
3358 || (string
->s
&& !STRINGP (object
)))
3364 /* If the character at CHARPOS is where the display string begins,
3366 pos
= make_number (charpos
);
3367 if (STRINGP (object
))
3368 bufpos
= string
->bufpos
;
3372 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3374 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3377 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3385 /* Look forward for the first character with a `display' property
3386 that will replace the underlying text when displayed. */
3387 limpos
= make_number (lim
);
3389 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3390 CHARPOS (tpos
) = XFASTINT (pos
);
3391 if (CHARPOS (tpos
) >= lim
)
3396 if (STRINGP (object
))
3397 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3399 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3400 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3401 if (!STRINGP (object
))
3402 bufpos
= CHARPOS (tpos
);
3403 } while (NILP (spec
)
3404 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3405 bufpos
, frame_window_p
)));
3409 return CHARPOS (tpos
);
3412 /* Return the character position of the end of the display string that
3413 started at CHARPOS. If there's no display string at CHARPOS,
3414 return -1. A display string is either an overlay with `display'
3415 property whose value is a string or a `display' text property whose
3416 value is a string. */
3418 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3420 /* OBJECT = nil means current buffer. */
3421 Lisp_Object object
=
3422 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3423 Lisp_Object pos
= make_number (charpos
);
3425 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3427 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3430 /* It could happen that the display property or overlay was removed
3431 since we found it in compute_display_string_pos above. One way
3432 this can happen is if JIT font-lock was called (through
3433 handle_fontified_prop), and jit-lock-functions remove text
3434 properties or overlays from the portion of buffer that includes
3435 CHARPOS. Muse mode is known to do that, for example. In this
3436 case, we return -1 to the caller, to signal that no display
3437 string is actually present at CHARPOS. See bidi_fetch_char for
3438 how this is handled.
3440 An alternative would be to never look for display properties past
3441 it->stop_charpos. But neither compute_display_string_pos nor
3442 bidi_fetch_char that calls it know or care where the next
3444 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3447 /* Look forward for the first character where the `display' property
3449 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3451 return XFASTINT (pos
);
3456 /***********************************************************************
3458 ***********************************************************************/
3460 /* Handle changes in the `fontified' property of the current buffer by
3461 calling hook functions from Qfontification_functions to fontify
3464 static enum prop_handled
3465 handle_fontified_prop (struct it
*it
)
3467 Lisp_Object prop
, pos
;
3468 enum prop_handled handled
= HANDLED_NORMALLY
;
3470 if (!NILP (Vmemory_full
))
3473 /* Get the value of the `fontified' property at IT's current buffer
3474 position. (The `fontified' property doesn't have a special
3475 meaning in strings.) If the value is nil, call functions from
3476 Qfontification_functions. */
3477 if (!STRINGP (it
->string
)
3479 && !NILP (Vfontification_functions
)
3480 && !NILP (Vrun_hooks
)
3481 && (pos
= make_number (IT_CHARPOS (*it
)),
3482 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3483 /* Ignore the special cased nil value always present at EOB since
3484 no amount of fontifying will be able to change it. */
3485 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3487 int count
= SPECPDL_INDEX ();
3489 struct buffer
*obuf
= current_buffer
;
3490 int begv
= BEGV
, zv
= ZV
;
3491 int old_clip_changed
= current_buffer
->clip_changed
;
3493 val
= Vfontification_functions
;
3494 specbind (Qfontification_functions
, Qnil
);
3496 xassert (it
->end_charpos
== ZV
);
3498 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3499 safe_call1 (val
, pos
);
3502 Lisp_Object fns
, fn
;
3503 struct gcpro gcpro1
, gcpro2
;
3508 for (; CONSP (val
); val
= XCDR (val
))
3514 /* A value of t indicates this hook has a local
3515 binding; it means to run the global binding too.
3516 In a global value, t should not occur. If it
3517 does, we must ignore it to avoid an endless
3519 for (fns
= Fdefault_value (Qfontification_functions
);
3525 safe_call1 (fn
, pos
);
3529 safe_call1 (fn
, pos
);
3535 unbind_to (count
, Qnil
);
3537 /* Fontification functions routinely call `save-restriction'.
3538 Normally, this tags clip_changed, which can confuse redisplay
3539 (see discussion in Bug#6671). Since we don't perform any
3540 special handling of fontification changes in the case where
3541 `save-restriction' isn't called, there's no point doing so in
3542 this case either. So, if the buffer's restrictions are
3543 actually left unchanged, reset clip_changed. */
3544 if (obuf
== current_buffer
)
3546 if (begv
== BEGV
&& zv
== ZV
)
3547 current_buffer
->clip_changed
= old_clip_changed
;
3549 /* There isn't much we can reasonably do to protect against
3550 misbehaving fontification, but here's a fig leaf. */
3551 else if (!NILP (BVAR (obuf
, name
)))
3552 set_buffer_internal_1 (obuf
);
3554 /* The fontification code may have added/removed text.
3555 It could do even a lot worse, but let's at least protect against
3556 the most obvious case where only the text past `pos' gets changed',
3557 as is/was done in grep.el where some escapes sequences are turned
3558 into face properties (bug#7876). */
3559 it
->end_charpos
= ZV
;
3561 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3562 something. This avoids an endless loop if they failed to
3563 fontify the text for which reason ever. */
3564 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3565 handled
= HANDLED_RECOMPUTE_PROPS
;
3573 /***********************************************************************
3575 ***********************************************************************/
3577 /* Set up iterator IT from face properties at its current position.
3578 Called from handle_stop. */
3580 static enum prop_handled
3581 handle_face_prop (struct it
*it
)
3584 EMACS_INT next_stop
;
3586 if (!STRINGP (it
->string
))
3589 = face_at_buffer_position (it
->w
,
3591 it
->region_beg_charpos
,
3592 it
->region_end_charpos
,
3595 + TEXT_PROP_DISTANCE_LIMIT
),
3596 0, it
->base_face_id
);
3598 /* Is this a start of a run of characters with box face?
3599 Caveat: this can be called for a freshly initialized
3600 iterator; face_id is -1 in this case. We know that the new
3601 face will not change until limit, i.e. if the new face has a
3602 box, all characters up to limit will have one. But, as
3603 usual, we don't know whether limit is really the end. */
3604 if (new_face_id
!= it
->face_id
)
3606 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3608 /* If new face has a box but old face has not, this is
3609 the start of a run of characters with box, i.e. it has
3610 a shadow on the left side. The value of face_id of the
3611 iterator will be -1 if this is the initial call that gets
3612 the face. In this case, we have to look in front of IT's
3613 position and see whether there is a face != new_face_id. */
3614 it
->start_of_box_run_p
3615 = (new_face
->box
!= FACE_NO_BOX
3616 && (it
->face_id
>= 0
3617 || IT_CHARPOS (*it
) == BEG
3618 || new_face_id
!= face_before_it_pos (it
)));
3619 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3627 Lisp_Object from_overlay
3628 = (it
->current
.overlay_string_index
>= 0
3629 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3632 /* See if we got to this string directly or indirectly from
3633 an overlay property. That includes the before-string or
3634 after-string of an overlay, strings in display properties
3635 provided by an overlay, their text properties, etc.
3637 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3638 if (! NILP (from_overlay
))
3639 for (i
= it
->sp
- 1; i
>= 0; i
--)
3641 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3643 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3644 else if (! NILP (it
->stack
[i
].from_overlay
))
3645 from_overlay
= it
->stack
[i
].from_overlay
;
3647 if (!NILP (from_overlay
))
3651 if (! NILP (from_overlay
))
3653 bufpos
= IT_CHARPOS (*it
);
3654 /* For a string from an overlay, the base face depends
3655 only on text properties and ignores overlays. */
3657 = face_for_overlay_string (it
->w
,
3659 it
->region_beg_charpos
,
3660 it
->region_end_charpos
,
3663 + TEXT_PROP_DISTANCE_LIMIT
),
3671 /* For strings from a `display' property, use the face at
3672 IT's current buffer position as the base face to merge
3673 with, so that overlay strings appear in the same face as
3674 surrounding text, unless they specify their own
3676 base_face_id
= it
->string_from_prefix_prop_p
3678 : underlying_face_id (it
);
3681 new_face_id
= face_at_string_position (it
->w
,
3683 IT_STRING_CHARPOS (*it
),
3685 it
->region_beg_charpos
,
3686 it
->region_end_charpos
,
3690 /* Is this a start of a run of characters with box? Caveat:
3691 this can be called for a freshly allocated iterator; face_id
3692 is -1 is this case. We know that the new face will not
3693 change until the next check pos, i.e. if the new face has a
3694 box, all characters up to that position will have a
3695 box. But, as usual, we don't know whether that position
3696 is really the end. */
3697 if (new_face_id
!= it
->face_id
)
3699 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3700 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3702 /* If new face has a box but old face hasn't, this is the
3703 start of a run of characters with box, i.e. it has a
3704 shadow on the left side. */
3705 it
->start_of_box_run_p
3706 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3707 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3711 it
->face_id
= new_face_id
;
3712 return HANDLED_NORMALLY
;
3716 /* Return the ID of the face ``underlying'' IT's current position,
3717 which is in a string. If the iterator is associated with a
3718 buffer, return the face at IT's current buffer position.
3719 Otherwise, use the iterator's base_face_id. */
3722 underlying_face_id (struct it
*it
)
3724 int face_id
= it
->base_face_id
, i
;
3726 xassert (STRINGP (it
->string
));
3728 for (i
= it
->sp
- 1; i
>= 0; --i
)
3729 if (NILP (it
->stack
[i
].string
))
3730 face_id
= it
->stack
[i
].face_id
;
3736 /* Compute the face one character before or after the current position
3737 of IT, in the visual order. BEFORE_P non-zero means get the face
3738 in front (to the left in L2R paragraphs, to the right in R2L
3739 paragraphs) of IT's screen position. Value is the ID of the face. */
3742 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3745 EMACS_INT next_check_charpos
;
3747 void *it_copy_data
= NULL
;
3749 xassert (it
->s
== NULL
);
3751 if (STRINGP (it
->string
))
3753 EMACS_INT bufpos
, charpos
;
3756 /* No face change past the end of the string (for the case
3757 we are padding with spaces). No face change before the
3759 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3760 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3765 /* Set charpos to the position before or after IT's current
3766 position, in the logical order, which in the non-bidi
3767 case is the same as the visual order. */
3769 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3770 else if (it
->what
== IT_COMPOSITION
)
3771 /* For composition, we must check the character after the
3773 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3775 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3781 /* With bidi iteration, the character before the current
3782 in the visual order cannot be found by simple
3783 iteration, because "reverse" reordering is not
3784 supported. Instead, we need to use the move_it_*
3785 family of functions. */
3786 /* Ignore face changes before the first visible
3787 character on this display line. */
3788 if (it
->current_x
<= it
->first_visible_x
)
3790 SAVE_IT (it_copy
, *it
, it_copy_data
);
3791 /* Implementation note: Since move_it_in_display_line
3792 works in the iterator geometry, and thinks the first
3793 character is always the leftmost, even in R2L lines,
3794 we don't need to distinguish between the R2L and L2R
3796 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3797 it_copy
.current_x
- 1, MOVE_TO_X
);
3798 charpos
= IT_STRING_CHARPOS (it_copy
);
3799 RESTORE_IT (it
, it
, it_copy_data
);
3803 /* Set charpos to the string position of the character
3804 that comes after IT's current position in the visual
3806 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3810 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3812 charpos
= it_copy
.bidi_it
.charpos
;
3815 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3817 if (it
->current
.overlay_string_index
>= 0)
3818 bufpos
= IT_CHARPOS (*it
);
3822 base_face_id
= underlying_face_id (it
);
3824 /* Get the face for ASCII, or unibyte. */
3825 face_id
= face_at_string_position (it
->w
,
3829 it
->region_beg_charpos
,
3830 it
->region_end_charpos
,
3831 &next_check_charpos
,
3834 /* Correct the face for charsets different from ASCII. Do it
3835 for the multibyte case only. The face returned above is
3836 suitable for unibyte text if IT->string is unibyte. */
3837 if (STRING_MULTIBYTE (it
->string
))
3839 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3840 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3842 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3844 c
= string_char_and_length (p
, &len
);
3845 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3850 struct text_pos pos
;
3852 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3853 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3856 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3857 pos
= it
->current
.pos
;
3862 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3865 if (it
->what
== IT_COMPOSITION
)
3867 /* For composition, we must check the position after
3869 pos
.charpos
+= it
->cmp_it
.nchars
;
3870 pos
.bytepos
+= it
->len
;
3873 INC_TEXT_POS (pos
, it
->multibyte_p
);
3880 /* With bidi iteration, the character before the current
3881 in the visual order cannot be found by simple
3882 iteration, because "reverse" reordering is not
3883 supported. Instead, we need to use the move_it_*
3884 family of functions. */
3885 /* Ignore face changes before the first visible
3886 character on this display line. */
3887 if (it
->current_x
<= it
->first_visible_x
)
3889 SAVE_IT (it_copy
, *it
, it_copy_data
);
3890 /* Implementation note: Since move_it_in_display_line
3891 works in the iterator geometry, and thinks the first
3892 character is always the leftmost, even in R2L lines,
3893 we don't need to distinguish between the R2L and L2R
3895 move_it_in_display_line (&it_copy
, ZV
,
3896 it_copy
.current_x
- 1, MOVE_TO_X
);
3897 pos
= it_copy
.current
.pos
;
3898 RESTORE_IT (it
, it
, it_copy_data
);
3902 /* Set charpos to the buffer position of the character
3903 that comes after IT's current position in the visual
3905 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3909 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3912 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3915 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3917 /* Determine face for CHARSET_ASCII, or unibyte. */
3918 face_id
= face_at_buffer_position (it
->w
,
3920 it
->region_beg_charpos
,
3921 it
->region_end_charpos
,
3922 &next_check_charpos
,
3925 /* Correct the face for charsets different from ASCII. Do it
3926 for the multibyte case only. The face returned above is
3927 suitable for unibyte text if current_buffer is unibyte. */
3928 if (it
->multibyte_p
)
3930 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3931 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3932 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3941 /***********************************************************************
3943 ***********************************************************************/
3945 /* Set up iterator IT from invisible properties at its current
3946 position. Called from handle_stop. */
3948 static enum prop_handled
3949 handle_invisible_prop (struct it
*it
)
3951 enum prop_handled handled
= HANDLED_NORMALLY
;
3953 if (STRINGP (it
->string
))
3955 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3957 /* Get the value of the invisible text property at the
3958 current position. Value will be nil if there is no such
3960 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3961 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3964 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3968 handled
= HANDLED_RECOMPUTE_PROPS
;
3970 /* Get the position at which the next change of the
3971 invisible text property can be found in IT->string.
3972 Value will be nil if the property value is the same for
3973 all the rest of IT->string. */
3974 XSETINT (limit
, SCHARS (it
->string
));
3975 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3978 /* Text at current position is invisible. The next
3979 change in the property is at position end_charpos.
3980 Move IT's current position to that position. */
3981 if (INTEGERP (end_charpos
)
3982 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3984 struct text_pos old
;
3987 old
= it
->current
.string_pos
;
3988 oldpos
= CHARPOS (old
);
3991 if (it
->bidi_it
.first_elt
3992 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3993 bidi_paragraph_init (it
->paragraph_embedding
,
3995 /* Bidi-iterate out of the invisible text. */
3998 bidi_move_to_visually_next (&it
->bidi_it
);
4000 while (oldpos
<= it
->bidi_it
.charpos
4001 && it
->bidi_it
.charpos
< endpos
);
4003 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4004 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4005 if (IT_CHARPOS (*it
) >= endpos
)
4006 it
->prev_stop
= endpos
;
4010 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4011 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4016 /* The rest of the string is invisible. If this is an
4017 overlay string, proceed with the next overlay string
4018 or whatever comes and return a character from there. */
4019 if (it
->current
.overlay_string_index
>= 0)
4021 next_overlay_string (it
);
4022 /* Don't check for overlay strings when we just
4023 finished processing them. */
4024 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4028 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4029 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4037 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4038 Lisp_Object pos
, prop
, overlay
;
4040 /* First of all, is there invisible text at this position? */
4041 tem
= start_charpos
= IT_CHARPOS (*it
);
4042 pos
= make_number (tem
);
4043 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4045 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4047 /* If we are on invisible text, skip over it. */
4048 if (invis_p
&& start_charpos
< it
->end_charpos
)
4050 /* Record whether we have to display an ellipsis for the
4052 int display_ellipsis_p
= invis_p
== 2;
4054 handled
= HANDLED_RECOMPUTE_PROPS
;
4056 /* Loop skipping over invisible text. The loop is left at
4057 ZV or with IT on the first char being visible again. */
4060 /* Try to skip some invisible text. Return value is the
4061 position reached which can be equal to where we start
4062 if there is nothing invisible there. This skips both
4063 over invisible text properties and overlays with
4064 invisible property. */
4065 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4067 /* If we skipped nothing at all we weren't at invisible
4068 text in the first place. If everything to the end of
4069 the buffer was skipped, end the loop. */
4070 if (newpos
== tem
|| newpos
>= ZV
)
4074 /* We skipped some characters but not necessarily
4075 all there are. Check if we ended up on visible
4076 text. Fget_char_property returns the property of
4077 the char before the given position, i.e. if we
4078 get invis_p = 0, this means that the char at
4079 newpos is visible. */
4080 pos
= make_number (newpos
);
4081 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4082 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4085 /* If we ended up on invisible text, proceed to
4086 skip starting with next_stop. */
4090 /* If there are adjacent invisible texts, don't lose the
4091 second one's ellipsis. */
4093 display_ellipsis_p
= 1;
4097 /* The position newpos is now either ZV or on visible text. */
4100 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4102 bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4104 newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4106 /* If the invisible text ends on a newline or on a
4107 character after a newline, we can avoid the costly,
4108 character by character, bidi iteration to NEWPOS, and
4109 instead simply reseat the iterator there. That's
4110 because all bidi reordering information is tossed at
4111 the newline. This is a big win for modes that hide
4112 complete lines, like Outline, Org, etc. */
4113 if (on_newline
|| after_newline
)
4115 struct text_pos tpos
;
4116 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4118 SET_TEXT_POS (tpos
, newpos
, bpos
);
4119 reseat_1 (it
, tpos
, 0);
4120 /* If we reseat on a newline/ZV, we need to prep the
4121 bidi iterator for advancing to the next character
4122 after the newline/EOB, keeping the current paragraph
4123 direction (so that PRODUCE_GLYPHS does TRT wrt
4124 prepending/appending glyphs to a glyph row). */
4127 it
->bidi_it
.first_elt
= 0;
4128 it
->bidi_it
.paragraph_dir
= pdir
;
4129 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4130 it
->bidi_it
.nchars
= 1;
4131 it
->bidi_it
.ch_len
= 1;
4134 else /* Must use the slow method. */
4136 /* With bidi iteration, the region of invisible text
4137 could start and/or end in the middle of a
4138 non-base embedding level. Therefore, we need to
4139 skip invisible text using the bidi iterator,
4140 starting at IT's current position, until we find
4141 ourselves outside of the invisible text.
4142 Skipping invisible text _after_ bidi iteration
4143 avoids affecting the visual order of the
4144 displayed text when invisible properties are
4145 added or removed. */
4146 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4148 /* If we were `reseat'ed to a new paragraph,
4149 determine the paragraph base direction. We
4150 need to do it now because
4151 next_element_from_buffer may not have a
4152 chance to do it, if we are going to skip any
4153 text at the beginning, which resets the
4155 bidi_paragraph_init (it
->paragraph_embedding
,
4160 bidi_move_to_visually_next (&it
->bidi_it
);
4162 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4163 && it
->bidi_it
.charpos
< newpos
);
4164 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4165 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4166 /* If we overstepped NEWPOS, record its position in
4167 the iterator, so that we skip invisible text if
4168 later the bidi iteration lands us in the
4169 invisible region again. */
4170 if (IT_CHARPOS (*it
) >= newpos
)
4171 it
->prev_stop
= newpos
;
4176 IT_CHARPOS (*it
) = newpos
;
4177 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4180 /* If there are before-strings at the start of invisible
4181 text, and the text is invisible because of a text
4182 property, arrange to show before-strings because 20.x did
4183 it that way. (If the text is invisible because of an
4184 overlay property instead of a text property, this is
4185 already handled in the overlay code.) */
4187 && get_overlay_strings (it
, it
->stop_charpos
))
4189 handled
= HANDLED_RECOMPUTE_PROPS
;
4190 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4192 else if (display_ellipsis_p
)
4194 /* Make sure that the glyphs of the ellipsis will get
4195 correct `charpos' values. If we would not update
4196 it->position here, the glyphs would belong to the
4197 last visible character _before_ the invisible
4198 text, which confuses `set_cursor_from_row'.
4200 We use the last invisible position instead of the
4201 first because this way the cursor is always drawn on
4202 the first "." of the ellipsis, whenever PT is inside
4203 the invisible text. Otherwise the cursor would be
4204 placed _after_ the ellipsis when the point is after the
4205 first invisible character. */
4206 if (!STRINGP (it
->object
))
4208 it
->position
.charpos
= newpos
- 1;
4209 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4212 /* Let the ellipsis display before
4213 considering any properties of the following char.
4214 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4215 handled
= HANDLED_RETURN
;
4224 /* Make iterator IT return `...' next.
4225 Replaces LEN characters from buffer. */
4228 setup_for_ellipsis (struct it
*it
, int len
)
4230 /* Use the display table definition for `...'. Invalid glyphs
4231 will be handled by the method returning elements from dpvec. */
4232 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4234 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4235 it
->dpvec
= v
->contents
;
4236 it
->dpend
= v
->contents
+ v
->header
.size
;
4240 /* Default `...'. */
4241 it
->dpvec
= default_invis_vector
;
4242 it
->dpend
= default_invis_vector
+ 3;
4245 it
->dpvec_char_len
= len
;
4246 it
->current
.dpvec_index
= 0;
4247 it
->dpvec_face_id
= -1;
4249 /* Remember the current face id in case glyphs specify faces.
4250 IT's face is restored in set_iterator_to_next.
4251 saved_face_id was set to preceding char's face in handle_stop. */
4252 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4253 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4255 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4261 /***********************************************************************
4263 ***********************************************************************/
4265 /* Set up iterator IT from `display' property at its current position.
4266 Called from handle_stop.
4267 We return HANDLED_RETURN if some part of the display property
4268 overrides the display of the buffer text itself.
4269 Otherwise we return HANDLED_NORMALLY. */
4271 static enum prop_handled
4272 handle_display_prop (struct it
*it
)
4274 Lisp_Object propval
, object
, overlay
;
4275 struct text_pos
*position
;
4277 /* Nonzero if some property replaces the display of the text itself. */
4278 int display_replaced_p
= 0;
4280 if (STRINGP (it
->string
))
4282 object
= it
->string
;
4283 position
= &it
->current
.string_pos
;
4284 bufpos
= CHARPOS (it
->current
.pos
);
4288 XSETWINDOW (object
, it
->w
);
4289 position
= &it
->current
.pos
;
4290 bufpos
= CHARPOS (*position
);
4293 /* Reset those iterator values set from display property values. */
4294 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4295 it
->space_width
= Qnil
;
4296 it
->font_height
= Qnil
;
4299 /* We don't support recursive `display' properties, i.e. string
4300 values that have a string `display' property, that have a string
4301 `display' property etc. */
4302 if (!it
->string_from_display_prop_p
)
4303 it
->area
= TEXT_AREA
;
4305 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4306 Qdisplay
, object
, &overlay
);
4308 return HANDLED_NORMALLY
;
4309 /* Now OVERLAY is the overlay that gave us this property, or nil
4310 if it was a text property. */
4312 if (!STRINGP (it
->string
))
4313 object
= it
->w
->buffer
;
4315 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4317 FRAME_WINDOW_P (it
->f
));
4319 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4322 /* Subroutine of handle_display_prop. Returns non-zero if the display
4323 specification in SPEC is a replacing specification, i.e. it would
4324 replace the text covered by `display' property with something else,
4325 such as an image or a display string. If SPEC includes any kind or
4326 `(space ...) specification, the value is 2; this is used by
4327 compute_display_string_pos, which see.
4329 See handle_single_display_spec for documentation of arguments.
4330 frame_window_p is non-zero if the window being redisplayed is on a
4331 GUI frame; this argument is used only if IT is NULL, see below.
4333 IT can be NULL, if this is called by the bidi reordering code
4334 through compute_display_string_pos, which see. In that case, this
4335 function only examines SPEC, but does not otherwise "handle" it, in
4336 the sense that it doesn't set up members of IT from the display
4339 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4340 Lisp_Object overlay
, struct text_pos
*position
,
4341 EMACS_INT bufpos
, int frame_window_p
)
4343 int replacing_p
= 0;
4347 /* Simple specifications. */
4348 && !EQ (XCAR (spec
), Qimage
)
4349 && !EQ (XCAR (spec
), Qspace
)
4350 && !EQ (XCAR (spec
), Qwhen
)
4351 && !EQ (XCAR (spec
), Qslice
)
4352 && !EQ (XCAR (spec
), Qspace_width
)
4353 && !EQ (XCAR (spec
), Qheight
)
4354 && !EQ (XCAR (spec
), Qraise
)
4355 /* Marginal area specifications. */
4356 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4357 && !EQ (XCAR (spec
), Qleft_fringe
)
4358 && !EQ (XCAR (spec
), Qright_fringe
)
4359 && !NILP (XCAR (spec
)))
4361 for (; CONSP (spec
); spec
= XCDR (spec
))
4363 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4364 overlay
, position
, bufpos
,
4365 replacing_p
, frame_window_p
)))
4368 /* If some text in a string is replaced, `position' no
4369 longer points to the position of `object'. */
4370 if (!it
|| STRINGP (object
))
4375 else if (VECTORP (spec
))
4378 for (i
= 0; i
< ASIZE (spec
); ++i
)
4379 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4380 overlay
, position
, bufpos
,
4381 replacing_p
, frame_window_p
)))
4384 /* If some text in a string is replaced, `position' no
4385 longer points to the position of `object'. */
4386 if (!it
|| STRINGP (object
))
4392 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4393 position
, bufpos
, 0,
4401 /* Value is the position of the end of the `display' property starting
4402 at START_POS in OBJECT. */
4404 static struct text_pos
4405 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4408 struct text_pos end_pos
;
4410 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4411 Qdisplay
, object
, Qnil
);
4412 CHARPOS (end_pos
) = XFASTINT (end
);
4413 if (STRINGP (object
))
4414 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4416 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4422 /* Set up IT from a single `display' property specification SPEC. OBJECT
4423 is the object in which the `display' property was found. *POSITION
4424 is the position in OBJECT at which the `display' property was found.
4425 BUFPOS is the buffer position of OBJECT (different from POSITION if
4426 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4427 previously saw a display specification which already replaced text
4428 display with something else, for example an image; we ignore such
4429 properties after the first one has been processed.
4431 OVERLAY is the overlay this `display' property came from,
4432 or nil if it was a text property.
4434 If SPEC is a `space' or `image' specification, and in some other
4435 cases too, set *POSITION to the position where the `display'
4438 If IT is NULL, only examine the property specification in SPEC, but
4439 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4440 is intended to be displayed in a window on a GUI frame.
4442 Value is non-zero if something was found which replaces the display
4443 of buffer or string text. */
4446 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4447 Lisp_Object overlay
, struct text_pos
*position
,
4448 EMACS_INT bufpos
, int display_replaced_p
,
4452 Lisp_Object location
, value
;
4453 struct text_pos start_pos
= *position
;
4456 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4457 If the result is non-nil, use VALUE instead of SPEC. */
4459 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4468 if (!NILP (form
) && !EQ (form
, Qt
))
4470 int count
= SPECPDL_INDEX ();
4471 struct gcpro gcpro1
;
4473 /* Bind `object' to the object having the `display' property, a
4474 buffer or string. Bind `position' to the position in the
4475 object where the property was found, and `buffer-position'
4476 to the current position in the buffer. */
4479 XSETBUFFER (object
, current_buffer
);
4480 specbind (Qobject
, object
);
4481 specbind (Qposition
, make_number (CHARPOS (*position
)));
4482 specbind (Qbuffer_position
, make_number (bufpos
));
4484 form
= safe_eval (form
);
4486 unbind_to (count
, Qnil
);
4492 /* Handle `(height HEIGHT)' specifications. */
4494 && EQ (XCAR (spec
), Qheight
)
4495 && CONSP (XCDR (spec
)))
4499 if (!FRAME_WINDOW_P (it
->f
))
4502 it
->font_height
= XCAR (XCDR (spec
));
4503 if (!NILP (it
->font_height
))
4505 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4506 int new_height
= -1;
4508 if (CONSP (it
->font_height
)
4509 && (EQ (XCAR (it
->font_height
), Qplus
)
4510 || EQ (XCAR (it
->font_height
), Qminus
))
4511 && CONSP (XCDR (it
->font_height
))
4512 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4514 /* `(+ N)' or `(- N)' where N is an integer. */
4515 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4516 if (EQ (XCAR (it
->font_height
), Qplus
))
4518 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4520 else if (FUNCTIONP (it
->font_height
))
4522 /* Call function with current height as argument.
4523 Value is the new height. */
4525 height
= safe_call1 (it
->font_height
,
4526 face
->lface
[LFACE_HEIGHT_INDEX
]);
4527 if (NUMBERP (height
))
4528 new_height
= XFLOATINT (height
);
4530 else if (NUMBERP (it
->font_height
))
4532 /* Value is a multiple of the canonical char height. */
4535 f
= FACE_FROM_ID (it
->f
,
4536 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4537 new_height
= (XFLOATINT (it
->font_height
)
4538 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4542 /* Evaluate IT->font_height with `height' bound to the
4543 current specified height to get the new height. */
4544 int count
= SPECPDL_INDEX ();
4546 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4547 value
= safe_eval (it
->font_height
);
4548 unbind_to (count
, Qnil
);
4550 if (NUMBERP (value
))
4551 new_height
= XFLOATINT (value
);
4555 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4562 /* Handle `(space-width WIDTH)'. */
4564 && EQ (XCAR (spec
), Qspace_width
)
4565 && CONSP (XCDR (spec
)))
4569 if (!FRAME_WINDOW_P (it
->f
))
4572 value
= XCAR (XCDR (spec
));
4573 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4574 it
->space_width
= value
;
4580 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4582 && EQ (XCAR (spec
), Qslice
))
4588 if (!FRAME_WINDOW_P (it
->f
))
4591 if (tem
= XCDR (spec
), CONSP (tem
))
4593 it
->slice
.x
= XCAR (tem
);
4594 if (tem
= XCDR (tem
), CONSP (tem
))
4596 it
->slice
.y
= XCAR (tem
);
4597 if (tem
= XCDR (tem
), CONSP (tem
))
4599 it
->slice
.width
= XCAR (tem
);
4600 if (tem
= XCDR (tem
), CONSP (tem
))
4601 it
->slice
.height
= XCAR (tem
);
4610 /* Handle `(raise FACTOR)'. */
4612 && EQ (XCAR (spec
), Qraise
)
4613 && CONSP (XCDR (spec
)))
4617 if (!FRAME_WINDOW_P (it
->f
))
4620 #ifdef HAVE_WINDOW_SYSTEM
4621 value
= XCAR (XCDR (spec
));
4622 if (NUMBERP (value
))
4624 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4625 it
->voffset
= - (XFLOATINT (value
)
4626 * (FONT_HEIGHT (face
->font
)));
4628 #endif /* HAVE_WINDOW_SYSTEM */
4634 /* Don't handle the other kinds of display specifications
4635 inside a string that we got from a `display' property. */
4636 if (it
&& it
->string_from_display_prop_p
)
4639 /* Characters having this form of property are not displayed, so
4640 we have to find the end of the property. */
4643 start_pos
= *position
;
4644 *position
= display_prop_end (it
, object
, start_pos
);
4648 /* Stop the scan at that end position--we assume that all
4649 text properties change there. */
4651 it
->stop_charpos
= position
->charpos
;
4653 /* Handle `(left-fringe BITMAP [FACE])'
4654 and `(right-fringe BITMAP [FACE])'. */
4656 && (EQ (XCAR (spec
), Qleft_fringe
)
4657 || EQ (XCAR (spec
), Qright_fringe
))
4658 && CONSP (XCDR (spec
)))
4664 if (!FRAME_WINDOW_P (it
->f
))
4665 /* If we return here, POSITION has been advanced
4666 across the text with this property. */
4669 else if (!frame_window_p
)
4672 #ifdef HAVE_WINDOW_SYSTEM
4673 value
= XCAR (XCDR (spec
));
4674 if (!SYMBOLP (value
)
4675 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4676 /* If we return here, POSITION has been advanced
4677 across the text with this property. */
4682 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4684 if (CONSP (XCDR (XCDR (spec
))))
4686 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4687 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4693 /* Save current settings of IT so that we can restore them
4694 when we are finished with the glyph property value. */
4695 push_it (it
, position
);
4697 it
->area
= TEXT_AREA
;
4698 it
->what
= IT_IMAGE
;
4699 it
->image_id
= -1; /* no image */
4700 it
->position
= start_pos
;
4701 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4702 it
->method
= GET_FROM_IMAGE
;
4703 it
->from_overlay
= Qnil
;
4704 it
->face_id
= face_id
;
4705 it
->from_disp_prop_p
= 1;
4707 /* Say that we haven't consumed the characters with
4708 `display' property yet. The call to pop_it in
4709 set_iterator_to_next will clean this up. */
4710 *position
= start_pos
;
4712 if (EQ (XCAR (spec
), Qleft_fringe
))
4714 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4715 it
->left_user_fringe_face_id
= face_id
;
4719 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4720 it
->right_user_fringe_face_id
= face_id
;
4723 #endif /* HAVE_WINDOW_SYSTEM */
4727 /* Prepare to handle `((margin left-margin) ...)',
4728 `((margin right-margin) ...)' and `((margin nil) ...)'
4729 prefixes for display specifications. */
4730 location
= Qunbound
;
4731 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4735 value
= XCDR (spec
);
4737 value
= XCAR (value
);
4740 if (EQ (XCAR (tem
), Qmargin
)
4741 && (tem
= XCDR (tem
),
4742 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4744 || EQ (tem
, Qleft_margin
)
4745 || EQ (tem
, Qright_margin
))))
4749 if (EQ (location
, Qunbound
))
4755 /* After this point, VALUE is the property after any
4756 margin prefix has been stripped. It must be a string,
4757 an image specification, or `(space ...)'.
4759 LOCATION specifies where to display: `left-margin',
4760 `right-margin' or nil. */
4762 valid_p
= (STRINGP (value
)
4763 #ifdef HAVE_WINDOW_SYSTEM
4764 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4765 && valid_image_p (value
))
4766 #endif /* not HAVE_WINDOW_SYSTEM */
4767 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4769 if (valid_p
&& !display_replaced_p
)
4775 /* Callers need to know whether the display spec is any kind
4776 of `(space ...)' spec that is about to affect text-area
4778 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4783 /* Save current settings of IT so that we can restore them
4784 when we are finished with the glyph property value. */
4785 push_it (it
, position
);
4786 it
->from_overlay
= overlay
;
4787 it
->from_disp_prop_p
= 1;
4789 if (NILP (location
))
4790 it
->area
= TEXT_AREA
;
4791 else if (EQ (location
, Qleft_margin
))
4792 it
->area
= LEFT_MARGIN_AREA
;
4794 it
->area
= RIGHT_MARGIN_AREA
;
4796 if (STRINGP (value
))
4799 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4800 it
->current
.overlay_string_index
= -1;
4801 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4802 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4803 it
->method
= GET_FROM_STRING
;
4804 it
->stop_charpos
= 0;
4806 it
->base_level_stop
= 0;
4807 it
->string_from_display_prop_p
= 1;
4808 /* Say that we haven't consumed the characters with
4809 `display' property yet. The call to pop_it in
4810 set_iterator_to_next will clean this up. */
4811 if (BUFFERP (object
))
4812 *position
= start_pos
;
4814 /* Force paragraph direction to be that of the parent
4815 object. If the parent object's paragraph direction is
4816 not yet determined, default to L2R. */
4817 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4818 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4820 it
->paragraph_embedding
= L2R
;
4822 /* Set up the bidi iterator for this display string. */
4825 it
->bidi_it
.string
.lstring
= it
->string
;
4826 it
->bidi_it
.string
.s
= NULL
;
4827 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4828 it
->bidi_it
.string
.bufpos
= bufpos
;
4829 it
->bidi_it
.string
.from_disp_str
= 1;
4830 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4831 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4834 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4836 it
->method
= GET_FROM_STRETCH
;
4838 *position
= it
->position
= start_pos
;
4839 retval
= 1 + (it
->area
== TEXT_AREA
);
4841 #ifdef HAVE_WINDOW_SYSTEM
4844 it
->what
= IT_IMAGE
;
4845 it
->image_id
= lookup_image (it
->f
, value
);
4846 it
->position
= start_pos
;
4847 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4848 it
->method
= GET_FROM_IMAGE
;
4850 /* Say that we haven't consumed the characters with
4851 `display' property yet. The call to pop_it in
4852 set_iterator_to_next will clean this up. */
4853 *position
= start_pos
;
4855 #endif /* HAVE_WINDOW_SYSTEM */
4860 /* Invalid property or property not supported. Restore
4861 POSITION to what it was before. */
4862 *position
= start_pos
;
4866 /* Check if PROP is a display property value whose text should be
4867 treated as intangible. OVERLAY is the overlay from which PROP
4868 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4869 specify the buffer position covered by PROP. */
4872 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4873 EMACS_INT charpos
, EMACS_INT bytepos
)
4875 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4876 struct text_pos position
;
4878 SET_TEXT_POS (position
, charpos
, bytepos
);
4879 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4880 &position
, charpos
, frame_window_p
);
4884 /* Return 1 if PROP is a display sub-property value containing STRING.
4886 Implementation note: this and the following function are really
4887 special cases of handle_display_spec and
4888 handle_single_display_spec, and should ideally use the same code.
4889 Until they do, these two pairs must be consistent and must be
4890 modified in sync. */
4893 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4895 if (EQ (string
, prop
))
4898 /* Skip over `when FORM'. */
4899 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4904 /* Actually, the condition following `when' should be eval'ed,
4905 like handle_single_display_spec does, and we should return
4906 zero if it evaluates to nil. However, this function is
4907 called only when the buffer was already displayed and some
4908 glyph in the glyph matrix was found to come from a display
4909 string. Therefore, the condition was already evaluated, and
4910 the result was non-nil, otherwise the display string wouldn't
4911 have been displayed and we would have never been called for
4912 this property. Thus, we can skip the evaluation and assume
4913 its result is non-nil. */
4918 /* Skip over `margin LOCATION'. */
4919 if (EQ (XCAR (prop
), Qmargin
))
4930 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4934 /* Return 1 if STRING appears in the `display' property PROP. */
4937 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4940 && !EQ (XCAR (prop
), Qwhen
)
4941 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4943 /* A list of sub-properties. */
4944 while (CONSP (prop
))
4946 if (single_display_spec_string_p (XCAR (prop
), string
))
4951 else if (VECTORP (prop
))
4953 /* A vector of sub-properties. */
4955 for (i
= 0; i
< ASIZE (prop
); ++i
)
4956 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4960 return single_display_spec_string_p (prop
, string
);
4965 /* Look for STRING in overlays and text properties in the current
4966 buffer, between character positions FROM and TO (excluding TO).
4967 BACK_P non-zero means look back (in this case, TO is supposed to be
4969 Value is the first character position where STRING was found, or
4970 zero if it wasn't found before hitting TO.
4972 This function may only use code that doesn't eval because it is
4973 called asynchronously from note_mouse_highlight. */
4976 string_buffer_position_lim (Lisp_Object string
,
4977 EMACS_INT from
, EMACS_INT to
, int back_p
)
4979 Lisp_Object limit
, prop
, pos
;
4982 pos
= make_number (from
);
4984 if (!back_p
) /* looking forward */
4986 limit
= make_number (min (to
, ZV
));
4987 while (!found
&& !EQ (pos
, limit
))
4989 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4990 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4993 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4997 else /* looking back */
4999 limit
= make_number (max (to
, BEGV
));
5000 while (!found
&& !EQ (pos
, limit
))
5002 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5003 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5006 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5011 return found
? XINT (pos
) : 0;
5014 /* Determine which buffer position in current buffer STRING comes from.
5015 AROUND_CHARPOS is an approximate position where it could come from.
5016 Value is the buffer position or 0 if it couldn't be determined.
5018 This function is necessary because we don't record buffer positions
5019 in glyphs generated from strings (to keep struct glyph small).
5020 This function may only use code that doesn't eval because it is
5021 called asynchronously from note_mouse_highlight. */
5024 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
5026 const int MAX_DISTANCE
= 1000;
5027 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
5028 around_charpos
+ MAX_DISTANCE
,
5032 found
= string_buffer_position_lim (string
, around_charpos
,
5033 around_charpos
- MAX_DISTANCE
, 1);
5039 /***********************************************************************
5040 `composition' property
5041 ***********************************************************************/
5043 /* Set up iterator IT from `composition' property at its current
5044 position. Called from handle_stop. */
5046 static enum prop_handled
5047 handle_composition_prop (struct it
*it
)
5049 Lisp_Object prop
, string
;
5050 EMACS_INT pos
, pos_byte
, start
, end
;
5052 if (STRINGP (it
->string
))
5056 pos
= IT_STRING_CHARPOS (*it
);
5057 pos_byte
= IT_STRING_BYTEPOS (*it
);
5058 string
= it
->string
;
5059 s
= SDATA (string
) + pos_byte
;
5060 it
->c
= STRING_CHAR (s
);
5064 pos
= IT_CHARPOS (*it
);
5065 pos_byte
= IT_BYTEPOS (*it
);
5067 it
->c
= FETCH_CHAR (pos_byte
);
5070 /* If there's a valid composition and point is not inside of the
5071 composition (in the case that the composition is from the current
5072 buffer), draw a glyph composed from the composition components. */
5073 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5074 && COMPOSITION_VALID_P (start
, end
, prop
)
5075 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5078 /* As we can't handle this situation (perhaps font-lock added
5079 a new composition), we just return here hoping that next
5080 redisplay will detect this composition much earlier. */
5081 return HANDLED_NORMALLY
;
5084 if (STRINGP (it
->string
))
5085 pos_byte
= string_char_to_byte (it
->string
, start
);
5087 pos_byte
= CHAR_TO_BYTE (start
);
5089 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5092 if (it
->cmp_it
.id
>= 0)
5095 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5096 it
->cmp_it
.nglyphs
= -1;
5100 return HANDLED_NORMALLY
;
5105 /***********************************************************************
5107 ***********************************************************************/
5109 /* The following structure is used to record overlay strings for
5110 later sorting in load_overlay_strings. */
5112 struct overlay_entry
5114 Lisp_Object overlay
;
5121 /* Set up iterator IT from overlay strings at its current position.
5122 Called from handle_stop. */
5124 static enum prop_handled
5125 handle_overlay_change (struct it
*it
)
5127 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5128 return HANDLED_RECOMPUTE_PROPS
;
5130 return HANDLED_NORMALLY
;
5134 /* Set up the next overlay string for delivery by IT, if there is an
5135 overlay string to deliver. Called by set_iterator_to_next when the
5136 end of the current overlay string is reached. If there are more
5137 overlay strings to display, IT->string and
5138 IT->current.overlay_string_index are set appropriately here.
5139 Otherwise IT->string is set to nil. */
5142 next_overlay_string (struct it
*it
)
5144 ++it
->current
.overlay_string_index
;
5145 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5147 /* No more overlay strings. Restore IT's settings to what
5148 they were before overlay strings were processed, and
5149 continue to deliver from current_buffer. */
5151 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5154 || (NILP (it
->string
)
5155 && it
->method
== GET_FROM_BUFFER
5156 && it
->stop_charpos
>= BEGV
5157 && it
->stop_charpos
<= it
->end_charpos
));
5158 it
->current
.overlay_string_index
= -1;
5159 it
->n_overlay_strings
= 0;
5160 it
->overlay_strings_charpos
= -1;
5161 /* If there's an empty display string on the stack, pop the
5162 stack, to resync the bidi iterator with IT's position. Such
5163 empty strings are pushed onto the stack in
5164 get_overlay_strings_1. */
5165 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5168 /* If we're at the end of the buffer, record that we have
5169 processed the overlay strings there already, so that
5170 next_element_from_buffer doesn't try it again. */
5171 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5172 it
->overlay_strings_at_end_processed_p
= 1;
5176 /* There are more overlay strings to process. If
5177 IT->current.overlay_string_index has advanced to a position
5178 where we must load IT->overlay_strings with more strings, do
5179 it. We must load at the IT->overlay_strings_charpos where
5180 IT->n_overlay_strings was originally computed; when invisible
5181 text is present, this might not be IT_CHARPOS (Bug#7016). */
5182 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5184 if (it
->current
.overlay_string_index
&& i
== 0)
5185 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5187 /* Initialize IT to deliver display elements from the overlay
5189 it
->string
= it
->overlay_strings
[i
];
5190 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5191 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5192 it
->method
= GET_FROM_STRING
;
5193 it
->stop_charpos
= 0;
5194 if (it
->cmp_it
.stop_pos
>= 0)
5195 it
->cmp_it
.stop_pos
= 0;
5197 it
->base_level_stop
= 0;
5199 /* Set up the bidi iterator for this overlay string. */
5202 it
->bidi_it
.string
.lstring
= it
->string
;
5203 it
->bidi_it
.string
.s
= NULL
;
5204 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5205 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5206 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5207 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5208 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5216 /* Compare two overlay_entry structures E1 and E2. Used as a
5217 comparison function for qsort in load_overlay_strings. Overlay
5218 strings for the same position are sorted so that
5220 1. All after-strings come in front of before-strings, except
5221 when they come from the same overlay.
5223 2. Within after-strings, strings are sorted so that overlay strings
5224 from overlays with higher priorities come first.
5226 2. Within before-strings, strings are sorted so that overlay
5227 strings from overlays with higher priorities come last.
5229 Value is analogous to strcmp. */
5233 compare_overlay_entries (const void *e1
, const void *e2
)
5235 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5236 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5239 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5241 /* Let after-strings appear in front of before-strings if
5242 they come from different overlays. */
5243 if (EQ (entry1
->overlay
, entry2
->overlay
))
5244 result
= entry1
->after_string_p
? 1 : -1;
5246 result
= entry1
->after_string_p
? -1 : 1;
5248 else if (entry1
->after_string_p
)
5249 /* After-strings sorted in order of decreasing priority. */
5250 result
= entry2
->priority
- entry1
->priority
;
5252 /* Before-strings sorted in order of increasing priority. */
5253 result
= entry1
->priority
- entry2
->priority
;
5259 /* Load the vector IT->overlay_strings with overlay strings from IT's
5260 current buffer position, or from CHARPOS if that is > 0. Set
5261 IT->n_overlays to the total number of overlay strings found.
5263 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5264 a time. On entry into load_overlay_strings,
5265 IT->current.overlay_string_index gives the number of overlay
5266 strings that have already been loaded by previous calls to this
5269 IT->add_overlay_start contains an additional overlay start
5270 position to consider for taking overlay strings from, if non-zero.
5271 This position comes into play when the overlay has an `invisible'
5272 property, and both before and after-strings. When we've skipped to
5273 the end of the overlay, because of its `invisible' property, we
5274 nevertheless want its before-string to appear.
5275 IT->add_overlay_start will contain the overlay start position
5278 Overlay strings are sorted so that after-string strings come in
5279 front of before-string strings. Within before and after-strings,
5280 strings are sorted by overlay priority. See also function
5281 compare_overlay_entries. */
5284 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5286 Lisp_Object overlay
, window
, str
, invisible
;
5287 struct Lisp_Overlay
*ov
;
5288 EMACS_INT start
, end
;
5290 int n
= 0, i
, j
, invis_p
;
5291 struct overlay_entry
*entries
5292 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5295 charpos
= IT_CHARPOS (*it
);
5297 /* Append the overlay string STRING of overlay OVERLAY to vector
5298 `entries' which has size `size' and currently contains `n'
5299 elements. AFTER_P non-zero means STRING is an after-string of
5301 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5304 Lisp_Object priority; \
5308 int new_size = 2 * size; \
5309 struct overlay_entry *old = entries; \
5311 (struct overlay_entry *) alloca (new_size \
5312 * sizeof *entries); \
5313 memcpy (entries, old, size * sizeof *entries); \
5317 entries[n].string = (STRING); \
5318 entries[n].overlay = (OVERLAY); \
5319 priority = Foverlay_get ((OVERLAY), Qpriority); \
5320 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5321 entries[n].after_string_p = (AFTER_P); \
5326 /* Process overlay before the overlay center. */
5327 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5329 XSETMISC (overlay
, ov
);
5330 xassert (OVERLAYP (overlay
));
5331 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5332 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5337 /* Skip this overlay if it doesn't start or end at IT's current
5339 if (end
!= charpos
&& start
!= charpos
)
5342 /* Skip this overlay if it doesn't apply to IT->w. */
5343 window
= Foverlay_get (overlay
, Qwindow
);
5344 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5347 /* If the text ``under'' the overlay is invisible, both before-
5348 and after-strings from this overlay are visible; start and
5349 end position are indistinguishable. */
5350 invisible
= Foverlay_get (overlay
, Qinvisible
);
5351 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5353 /* If overlay has a non-empty before-string, record it. */
5354 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5355 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5357 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5359 /* If overlay has a non-empty after-string, record it. */
5360 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5361 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5363 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5366 /* Process overlays after the overlay center. */
5367 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5369 XSETMISC (overlay
, ov
);
5370 xassert (OVERLAYP (overlay
));
5371 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5372 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5374 if (start
> charpos
)
5377 /* Skip this overlay if it doesn't start or end at IT's current
5379 if (end
!= charpos
&& start
!= charpos
)
5382 /* Skip this overlay if it doesn't apply to IT->w. */
5383 window
= Foverlay_get (overlay
, Qwindow
);
5384 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5387 /* If the text ``under'' the overlay is invisible, it has a zero
5388 dimension, and both before- and after-strings apply. */
5389 invisible
= Foverlay_get (overlay
, Qinvisible
);
5390 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5392 /* If overlay has a non-empty before-string, record it. */
5393 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5394 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5396 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5398 /* If overlay has a non-empty after-string, record it. */
5399 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5400 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5402 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5405 #undef RECORD_OVERLAY_STRING
5409 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5411 /* Record number of overlay strings, and where we computed it. */
5412 it
->n_overlay_strings
= n
;
5413 it
->overlay_strings_charpos
= charpos
;
5415 /* IT->current.overlay_string_index is the number of overlay strings
5416 that have already been consumed by IT. Copy some of the
5417 remaining overlay strings to IT->overlay_strings. */
5419 j
= it
->current
.overlay_string_index
;
5420 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5422 it
->overlay_strings
[i
] = entries
[j
].string
;
5423 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5430 /* Get the first chunk of overlay strings at IT's current buffer
5431 position, or at CHARPOS if that is > 0. Value is non-zero if at
5432 least one overlay string was found. */
5435 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5437 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5438 process. This fills IT->overlay_strings with strings, and sets
5439 IT->n_overlay_strings to the total number of strings to process.
5440 IT->pos.overlay_string_index has to be set temporarily to zero
5441 because load_overlay_strings needs this; it must be set to -1
5442 when no overlay strings are found because a zero value would
5443 indicate a position in the first overlay string. */
5444 it
->current
.overlay_string_index
= 0;
5445 load_overlay_strings (it
, charpos
);
5447 /* If we found overlay strings, set up IT to deliver display
5448 elements from the first one. Otherwise set up IT to deliver
5449 from current_buffer. */
5450 if (it
->n_overlay_strings
)
5452 /* Make sure we know settings in current_buffer, so that we can
5453 restore meaningful values when we're done with the overlay
5456 compute_stop_pos (it
);
5457 xassert (it
->face_id
>= 0);
5459 /* Save IT's settings. They are restored after all overlay
5460 strings have been processed. */
5461 xassert (!compute_stop_p
|| it
->sp
== 0);
5463 /* When called from handle_stop, there might be an empty display
5464 string loaded. In that case, don't bother saving it. But
5465 don't use this optimization with the bidi iterator, since we
5466 need the corresponding pop_it call to resync the bidi
5467 iterator's position with IT's position, after we are done
5468 with the overlay strings. (The corresponding call to pop_it
5469 in case of an empty display string is in
5470 next_overlay_string.) */
5472 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5475 /* Set up IT to deliver display elements from the first overlay
5477 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5478 it
->string
= it
->overlay_strings
[0];
5479 it
->from_overlay
= Qnil
;
5480 it
->stop_charpos
= 0;
5481 xassert (STRINGP (it
->string
));
5482 it
->end_charpos
= SCHARS (it
->string
);
5484 it
->base_level_stop
= 0;
5485 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5486 it
->method
= GET_FROM_STRING
;
5487 it
->from_disp_prop_p
= 0;
5489 /* Force paragraph direction to be that of the parent
5491 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5492 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5494 it
->paragraph_embedding
= L2R
;
5496 /* Set up the bidi iterator for this overlay string. */
5499 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5501 it
->bidi_it
.string
.lstring
= it
->string
;
5502 it
->bidi_it
.string
.s
= NULL
;
5503 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5504 it
->bidi_it
.string
.bufpos
= pos
;
5505 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5506 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5507 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5512 it
->current
.overlay_string_index
= -1;
5517 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5520 it
->method
= GET_FROM_BUFFER
;
5522 (void) get_overlay_strings_1 (it
, charpos
, 1);
5526 /* Value is non-zero if we found at least one overlay string. */
5527 return STRINGP (it
->string
);
5532 /***********************************************************************
5533 Saving and restoring state
5534 ***********************************************************************/
5536 /* Save current settings of IT on IT->stack. Called, for example,
5537 before setting up IT for an overlay string, to be able to restore
5538 IT's settings to what they were after the overlay string has been
5539 processed. If POSITION is non-NULL, it is the position to save on
5540 the stack instead of IT->position. */
5543 push_it (struct it
*it
, struct text_pos
*position
)
5545 struct iterator_stack_entry
*p
;
5547 xassert (it
->sp
< IT_STACK_SIZE
);
5548 p
= it
->stack
+ it
->sp
;
5550 p
->stop_charpos
= it
->stop_charpos
;
5551 p
->prev_stop
= it
->prev_stop
;
5552 p
->base_level_stop
= it
->base_level_stop
;
5553 p
->cmp_it
= it
->cmp_it
;
5554 xassert (it
->face_id
>= 0);
5555 p
->face_id
= it
->face_id
;
5556 p
->string
= it
->string
;
5557 p
->method
= it
->method
;
5558 p
->from_overlay
= it
->from_overlay
;
5561 case GET_FROM_IMAGE
:
5562 p
->u
.image
.object
= it
->object
;
5563 p
->u
.image
.image_id
= it
->image_id
;
5564 p
->u
.image
.slice
= it
->slice
;
5566 case GET_FROM_STRETCH
:
5567 p
->u
.stretch
.object
= it
->object
;
5570 p
->position
= position
? *position
: it
->position
;
5571 p
->current
= it
->current
;
5572 p
->end_charpos
= it
->end_charpos
;
5573 p
->string_nchars
= it
->string_nchars
;
5575 p
->multibyte_p
= it
->multibyte_p
;
5576 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5577 p
->space_width
= it
->space_width
;
5578 p
->font_height
= it
->font_height
;
5579 p
->voffset
= it
->voffset
;
5580 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5581 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5582 p
->display_ellipsis_p
= 0;
5583 p
->line_wrap
= it
->line_wrap
;
5584 p
->bidi_p
= it
->bidi_p
;
5585 p
->paragraph_embedding
= it
->paragraph_embedding
;
5586 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5589 /* Save the state of the bidi iterator as well. */
5591 bidi_push_it (&it
->bidi_it
);
5595 iterate_out_of_display_property (struct it
*it
)
5597 int buffer_p
= BUFFERP (it
->object
);
5598 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5599 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5601 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5603 /* Maybe initialize paragraph direction. If we are at the beginning
5604 of a new paragraph, next_element_from_buffer may not have a
5605 chance to do that. */
5606 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5607 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5608 /* prev_stop can be zero, so check against BEGV as well. */
5609 while (it
->bidi_it
.charpos
>= bob
5610 && it
->prev_stop
<= it
->bidi_it
.charpos
5611 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5612 && it
->bidi_it
.charpos
< eob
)
5613 bidi_move_to_visually_next (&it
->bidi_it
);
5614 /* Record the stop_pos we just crossed, for when we cross it
5616 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5617 it
->prev_stop
= CHARPOS (it
->position
);
5618 /* If we ended up not where pop_it put us, resync IT's
5619 positional members with the bidi iterator. */
5620 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5621 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5623 it
->current
.pos
= it
->position
;
5625 it
->current
.string_pos
= it
->position
;
5628 /* Restore IT's settings from IT->stack. Called, for example, when no
5629 more overlay strings must be processed, and we return to delivering
5630 display elements from a buffer, or when the end of a string from a
5631 `display' property is reached and we return to delivering display
5632 elements from an overlay string, or from a buffer. */
5635 pop_it (struct it
*it
)
5637 struct iterator_stack_entry
*p
;
5638 int from_display_prop
= it
->from_disp_prop_p
;
5640 xassert (it
->sp
> 0);
5642 p
= it
->stack
+ it
->sp
;
5643 it
->stop_charpos
= p
->stop_charpos
;
5644 it
->prev_stop
= p
->prev_stop
;
5645 it
->base_level_stop
= p
->base_level_stop
;
5646 it
->cmp_it
= p
->cmp_it
;
5647 it
->face_id
= p
->face_id
;
5648 it
->current
= p
->current
;
5649 it
->position
= p
->position
;
5650 it
->string
= p
->string
;
5651 it
->from_overlay
= p
->from_overlay
;
5652 if (NILP (it
->string
))
5653 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5654 it
->method
= p
->method
;
5657 case GET_FROM_IMAGE
:
5658 it
->image_id
= p
->u
.image
.image_id
;
5659 it
->object
= p
->u
.image
.object
;
5660 it
->slice
= p
->u
.image
.slice
;
5662 case GET_FROM_STRETCH
:
5663 it
->object
= p
->u
.stretch
.object
;
5665 case GET_FROM_BUFFER
:
5666 it
->object
= it
->w
->buffer
;
5668 case GET_FROM_STRING
:
5669 it
->object
= it
->string
;
5671 case GET_FROM_DISPLAY_VECTOR
:
5673 it
->method
= GET_FROM_C_STRING
;
5674 else if (STRINGP (it
->string
))
5675 it
->method
= GET_FROM_STRING
;
5678 it
->method
= GET_FROM_BUFFER
;
5679 it
->object
= it
->w
->buffer
;
5682 it
->end_charpos
= p
->end_charpos
;
5683 it
->string_nchars
= p
->string_nchars
;
5685 it
->multibyte_p
= p
->multibyte_p
;
5686 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5687 it
->space_width
= p
->space_width
;
5688 it
->font_height
= p
->font_height
;
5689 it
->voffset
= p
->voffset
;
5690 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5691 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
5692 it
->line_wrap
= p
->line_wrap
;
5693 it
->bidi_p
= p
->bidi_p
;
5694 it
->paragraph_embedding
= p
->paragraph_embedding
;
5695 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5698 bidi_pop_it (&it
->bidi_it
);
5699 /* Bidi-iterate until we get out of the portion of text, if any,
5700 covered by a `display' text property or by an overlay with
5701 `display' property. (We cannot just jump there, because the
5702 internal coherency of the bidi iterator state can not be
5703 preserved across such jumps.) We also must determine the
5704 paragraph base direction if the overlay we just processed is
5705 at the beginning of a new paragraph. */
5706 if (from_display_prop
5707 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5708 iterate_out_of_display_property (it
);
5710 xassert ((BUFFERP (it
->object
)
5711 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5712 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5713 || (STRINGP (it
->object
)
5714 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5715 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5716 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5722 /***********************************************************************
5724 ***********************************************************************/
5726 /* Set IT's current position to the previous line start. */
5729 back_to_previous_line_start (struct it
*it
)
5731 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5732 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5736 /* Move IT to the next line start.
5738 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5739 we skipped over part of the text (as opposed to moving the iterator
5740 continuously over the text). Otherwise, don't change the value
5743 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5744 iterator on the newline, if it was found.
5746 Newlines may come from buffer text, overlay strings, or strings
5747 displayed via the `display' property. That's the reason we can't
5748 simply use find_next_newline_no_quit.
5750 Note that this function may not skip over invisible text that is so
5751 because of text properties and immediately follows a newline. If
5752 it would, function reseat_at_next_visible_line_start, when called
5753 from set_iterator_to_next, would effectively make invisible
5754 characters following a newline part of the wrong glyph row, which
5755 leads to wrong cursor motion. */
5758 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5759 struct bidi_it
*bidi_it_prev
)
5761 EMACS_INT old_selective
;
5762 int newline_found_p
, n
;
5763 const int MAX_NEWLINE_DISTANCE
= 500;
5765 /* If already on a newline, just consume it to avoid unintended
5766 skipping over invisible text below. */
5767 if (it
->what
== IT_CHARACTER
5769 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5771 if (it
->bidi_p
&& bidi_it_prev
)
5772 *bidi_it_prev
= it
->bidi_it
;
5773 set_iterator_to_next (it
, 0);
5778 /* Don't handle selective display in the following. It's (a)
5779 unnecessary because it's done by the caller, and (b) leads to an
5780 infinite recursion because next_element_from_ellipsis indirectly
5781 calls this function. */
5782 old_selective
= it
->selective
;
5785 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5786 from buffer text. */
5787 for (n
= newline_found_p
= 0;
5788 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5789 n
+= STRINGP (it
->string
) ? 0 : 1)
5791 if (!get_next_display_element (it
))
5793 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5794 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5795 *bidi_it_prev
= it
->bidi_it
;
5796 set_iterator_to_next (it
, 0);
5799 /* If we didn't find a newline near enough, see if we can use a
5801 if (!newline_found_p
)
5803 EMACS_INT start
= IT_CHARPOS (*it
);
5804 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5807 xassert (!STRINGP (it
->string
));
5809 /* If there isn't any `display' property in sight, and no
5810 overlays, we can just use the position of the newline in
5812 if (it
->stop_charpos
>= limit
5813 || ((pos
= Fnext_single_property_change (make_number (start
),
5815 make_number (limit
)),
5817 && next_overlay_change (start
) == ZV
))
5821 IT_CHARPOS (*it
) = limit
;
5822 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5826 struct bidi_it bprev
;
5828 /* Help bidi.c avoid expensive searches for display
5829 properties and overlays, by telling it that there are
5830 none up to `limit'. */
5831 if (it
->bidi_it
.disp_pos
< limit
)
5833 it
->bidi_it
.disp_pos
= limit
;
5834 it
->bidi_it
.disp_prop
= 0;
5837 bprev
= it
->bidi_it
;
5838 bidi_move_to_visually_next (&it
->bidi_it
);
5839 } while (it
->bidi_it
.charpos
!= limit
);
5840 IT_CHARPOS (*it
) = limit
;
5841 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5843 *bidi_it_prev
= bprev
;
5845 *skipped_p
= newline_found_p
= 1;
5849 while (get_next_display_element (it
)
5850 && !newline_found_p
)
5852 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5853 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5854 *bidi_it_prev
= it
->bidi_it
;
5855 set_iterator_to_next (it
, 0);
5860 it
->selective
= old_selective
;
5861 return newline_found_p
;
5865 /* Set IT's current position to the previous visible line start. Skip
5866 invisible text that is so either due to text properties or due to
5867 selective display. Caution: this does not change IT->current_x and
5871 back_to_previous_visible_line_start (struct it
*it
)
5873 while (IT_CHARPOS (*it
) > BEGV
)
5875 back_to_previous_line_start (it
);
5877 if (IT_CHARPOS (*it
) <= BEGV
)
5880 /* If selective > 0, then lines indented more than its value are
5882 if (it
->selective
> 0
5883 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5887 /* Check the newline before point for invisibility. */
5890 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5891 Qinvisible
, it
->window
);
5892 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5896 if (IT_CHARPOS (*it
) <= BEGV
)
5901 void *it2data
= NULL
;
5904 Lisp_Object val
, overlay
;
5906 SAVE_IT (it2
, *it
, it2data
);
5908 /* If newline is part of a composition, continue from start of composition */
5909 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5910 && beg
< IT_CHARPOS (*it
))
5913 /* If newline is replaced by a display property, find start of overlay
5914 or interval and continue search from that point. */
5915 pos
= --IT_CHARPOS (it2
);
5918 bidi_unshelve_cache (NULL
, 0);
5919 it2
.string_from_display_prop_p
= 0;
5920 it2
.from_disp_prop_p
= 0;
5921 if (handle_display_prop (&it2
) == HANDLED_RETURN
5922 && !NILP (val
= get_char_property_and_overlay
5923 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5924 && (OVERLAYP (overlay
)
5925 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5926 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5928 RESTORE_IT (it
, it
, it2data
);
5932 /* Newline is not replaced by anything -- so we are done. */
5933 RESTORE_IT (it
, it
, it2data
);
5939 IT_CHARPOS (*it
) = beg
;
5940 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5944 it
->continuation_lines_width
= 0;
5946 xassert (IT_CHARPOS (*it
) >= BEGV
);
5947 xassert (IT_CHARPOS (*it
) == BEGV
5948 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5953 /* Reseat iterator IT at the previous visible line start. Skip
5954 invisible text that is so either due to text properties or due to
5955 selective display. At the end, update IT's overlay information,
5956 face information etc. */
5959 reseat_at_previous_visible_line_start (struct it
*it
)
5961 back_to_previous_visible_line_start (it
);
5962 reseat (it
, it
->current
.pos
, 1);
5967 /* Reseat iterator IT on the next visible line start in the current
5968 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5969 preceding the line start. Skip over invisible text that is so
5970 because of selective display. Compute faces, overlays etc at the
5971 new position. Note that this function does not skip over text that
5972 is invisible because of text properties. */
5975 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5977 int newline_found_p
, skipped_p
= 0;
5978 struct bidi_it bidi_it_prev
;
5980 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5982 /* Skip over lines that are invisible because they are indented
5983 more than the value of IT->selective. */
5984 if (it
->selective
> 0)
5985 while (IT_CHARPOS (*it
) < ZV
5986 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5989 xassert (IT_BYTEPOS (*it
) == BEGV
5990 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5992 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5995 /* Position on the newline if that's what's requested. */
5996 if (on_newline_p
&& newline_found_p
)
5998 if (STRINGP (it
->string
))
6000 if (IT_STRING_CHARPOS (*it
) > 0)
6004 --IT_STRING_CHARPOS (*it
);
6005 --IT_STRING_BYTEPOS (*it
);
6009 /* We need to restore the bidi iterator to the state
6010 it had on the newline, and resync the IT's
6011 position with that. */
6012 it
->bidi_it
= bidi_it_prev
;
6013 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6014 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6018 else if (IT_CHARPOS (*it
) > BEGV
)
6027 /* We need to restore the bidi iterator to the state it
6028 had on the newline and resync IT with that. */
6029 it
->bidi_it
= bidi_it_prev
;
6030 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6031 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6033 reseat (it
, it
->current
.pos
, 0);
6037 reseat (it
, it
->current
.pos
, 0);
6044 /***********************************************************************
6045 Changing an iterator's position
6046 ***********************************************************************/
6048 /* Change IT's current position to POS in current_buffer. If FORCE_P
6049 is non-zero, always check for text properties at the new position.
6050 Otherwise, text properties are only looked up if POS >=
6051 IT->check_charpos of a property. */
6054 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6056 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6058 reseat_1 (it
, pos
, 0);
6060 /* Determine where to check text properties. Avoid doing it
6061 where possible because text property lookup is very expensive. */
6063 || CHARPOS (pos
) > it
->stop_charpos
6064 || CHARPOS (pos
) < original_pos
)
6068 /* For bidi iteration, we need to prime prev_stop and
6069 base_level_stop with our best estimations. */
6070 /* Implementation note: Of course, POS is not necessarily a
6071 stop position, so assigning prev_pos to it is a lie; we
6072 should have called compute_stop_backwards. However, if
6073 the current buffer does not include any R2L characters,
6074 that call would be a waste of cycles, because the
6075 iterator will never move back, and thus never cross this
6076 "fake" stop position. So we delay that backward search
6077 until the time we really need it, in next_element_from_buffer. */
6078 if (CHARPOS (pos
) != it
->prev_stop
)
6079 it
->prev_stop
= CHARPOS (pos
);
6080 if (CHARPOS (pos
) < it
->base_level_stop
)
6081 it
->base_level_stop
= 0; /* meaning it's unknown */
6087 it
->prev_stop
= it
->base_level_stop
= 0;
6096 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6097 IT->stop_pos to POS, also. */
6100 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6102 /* Don't call this function when scanning a C string. */
6103 xassert (it
->s
== NULL
);
6105 /* POS must be a reasonable value. */
6106 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6108 it
->current
.pos
= it
->position
= pos
;
6109 it
->end_charpos
= ZV
;
6111 it
->current
.dpvec_index
= -1;
6112 it
->current
.overlay_string_index
= -1;
6113 IT_STRING_CHARPOS (*it
) = -1;
6114 IT_STRING_BYTEPOS (*it
) = -1;
6116 it
->method
= GET_FROM_BUFFER
;
6117 it
->object
= it
->w
->buffer
;
6118 it
->area
= TEXT_AREA
;
6119 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6121 it
->string_from_display_prop_p
= 0;
6122 it
->string_from_prefix_prop_p
= 0;
6124 it
->from_disp_prop_p
= 0;
6125 it
->face_before_selective_p
= 0;
6128 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6130 bidi_unshelve_cache (NULL
, 0);
6131 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6132 it
->bidi_it
.string
.s
= NULL
;
6133 it
->bidi_it
.string
.lstring
= Qnil
;
6134 it
->bidi_it
.string
.bufpos
= 0;
6135 it
->bidi_it
.string
.unibyte
= 0;
6140 it
->stop_charpos
= CHARPOS (pos
);
6141 it
->base_level_stop
= CHARPOS (pos
);
6146 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6147 If S is non-null, it is a C string to iterate over. Otherwise,
6148 STRING gives a Lisp string to iterate over.
6150 If PRECISION > 0, don't return more then PRECISION number of
6151 characters from the string.
6153 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6154 characters have been returned. FIELD_WIDTH < 0 means an infinite
6157 MULTIBYTE = 0 means disable processing of multibyte characters,
6158 MULTIBYTE > 0 means enable it,
6159 MULTIBYTE < 0 means use IT->multibyte_p.
6161 IT must be initialized via a prior call to init_iterator before
6162 calling this function. */
6165 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6166 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6169 /* No region in strings. */
6170 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6172 /* No text property checks performed by default, but see below. */
6173 it
->stop_charpos
= -1;
6175 /* Set iterator position and end position. */
6176 memset (&it
->current
, 0, sizeof it
->current
);
6177 it
->current
.overlay_string_index
= -1;
6178 it
->current
.dpvec_index
= -1;
6179 xassert (charpos
>= 0);
6181 /* If STRING is specified, use its multibyteness, otherwise use the
6182 setting of MULTIBYTE, if specified. */
6184 it
->multibyte_p
= multibyte
> 0;
6186 /* Bidirectional reordering of strings is controlled by the default
6187 value of bidi-display-reordering. Don't try to reorder while
6188 loading loadup.el, as the necessary character property tables are
6189 not yet available. */
6192 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6196 xassert (STRINGP (string
));
6197 it
->string
= string
;
6199 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6200 it
->method
= GET_FROM_STRING
;
6201 it
->current
.string_pos
= string_pos (charpos
, string
);
6205 it
->bidi_it
.string
.lstring
= string
;
6206 it
->bidi_it
.string
.s
= NULL
;
6207 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6208 it
->bidi_it
.string
.bufpos
= 0;
6209 it
->bidi_it
.string
.from_disp_str
= 0;
6210 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6211 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6212 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6217 it
->s
= (const unsigned char *) s
;
6220 /* Note that we use IT->current.pos, not it->current.string_pos,
6221 for displaying C strings. */
6222 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6223 if (it
->multibyte_p
)
6225 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6226 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6230 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6231 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6236 it
->bidi_it
.string
.lstring
= Qnil
;
6237 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6238 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6239 it
->bidi_it
.string
.bufpos
= 0;
6240 it
->bidi_it
.string
.from_disp_str
= 0;
6241 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6242 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6245 it
->method
= GET_FROM_C_STRING
;
6248 /* PRECISION > 0 means don't return more than PRECISION characters
6250 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6252 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6254 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6257 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6258 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6259 FIELD_WIDTH < 0 means infinite field width. This is useful for
6260 padding with `-' at the end of a mode line. */
6261 if (field_width
< 0)
6262 field_width
= INFINITY
;
6263 /* Implementation note: We deliberately don't enlarge
6264 it->bidi_it.string.schars here to fit it->end_charpos, because
6265 the bidi iterator cannot produce characters out of thin air. */
6266 if (field_width
> it
->end_charpos
- charpos
)
6267 it
->end_charpos
= charpos
+ field_width
;
6269 /* Use the standard display table for displaying strings. */
6270 if (DISP_TABLE_P (Vstandard_display_table
))
6271 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6273 it
->stop_charpos
= charpos
;
6274 it
->prev_stop
= charpos
;
6275 it
->base_level_stop
= 0;
6278 it
->bidi_it
.first_elt
= 1;
6279 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6280 it
->bidi_it
.disp_pos
= -1;
6282 if (s
== NULL
&& it
->multibyte_p
)
6284 EMACS_INT endpos
= SCHARS (it
->string
);
6285 if (endpos
> it
->end_charpos
)
6286 endpos
= it
->end_charpos
;
6287 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6295 /***********************************************************************
6297 ***********************************************************************/
6299 /* Map enum it_method value to corresponding next_element_from_* function. */
6301 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6303 next_element_from_buffer
,
6304 next_element_from_display_vector
,
6305 next_element_from_string
,
6306 next_element_from_c_string
,
6307 next_element_from_image
,
6308 next_element_from_stretch
6311 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6314 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6315 (possibly with the following characters). */
6317 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6318 ((IT)->cmp_it.id >= 0 \
6319 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6320 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6321 END_CHARPOS, (IT)->w, \
6322 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6326 /* Lookup the char-table Vglyphless_char_display for character C (-1
6327 if we want information for no-font case), and return the display
6328 method symbol. By side-effect, update it->what and
6329 it->glyphless_method. This function is called from
6330 get_next_display_element for each character element, and from
6331 x_produce_glyphs when no suitable font was found. */
6334 lookup_glyphless_char_display (int c
, struct it
*it
)
6336 Lisp_Object glyphless_method
= Qnil
;
6338 if (CHAR_TABLE_P (Vglyphless_char_display
)
6339 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6343 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6344 if (CONSP (glyphless_method
))
6345 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6346 ? XCAR (glyphless_method
)
6347 : XCDR (glyphless_method
);
6350 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6354 if (NILP (glyphless_method
))
6357 /* The default is to display the character by a proper font. */
6359 /* The default for the no-font case is to display an empty box. */
6360 glyphless_method
= Qempty_box
;
6362 if (EQ (glyphless_method
, Qzero_width
))
6365 return glyphless_method
;
6366 /* This method can't be used for the no-font case. */
6367 glyphless_method
= Qempty_box
;
6369 if (EQ (glyphless_method
, Qthin_space
))
6370 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6371 else if (EQ (glyphless_method
, Qempty_box
))
6372 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6373 else if (EQ (glyphless_method
, Qhex_code
))
6374 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6375 else if (STRINGP (glyphless_method
))
6376 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6379 /* Invalid value. We use the default method. */
6380 glyphless_method
= Qnil
;
6383 it
->what
= IT_GLYPHLESS
;
6384 return glyphless_method
;
6387 /* Load IT's display element fields with information about the next
6388 display element from the current position of IT. Value is zero if
6389 end of buffer (or C string) is reached. */
6391 static struct frame
*last_escape_glyph_frame
= NULL
;
6392 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6393 static int last_escape_glyph_merged_face_id
= 0;
6395 struct frame
*last_glyphless_glyph_frame
= NULL
;
6396 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6397 int last_glyphless_glyph_merged_face_id
= 0;
6400 get_next_display_element (struct it
*it
)
6402 /* Non-zero means that we found a display element. Zero means that
6403 we hit the end of what we iterate over. Performance note: the
6404 function pointer `method' used here turns out to be faster than
6405 using a sequence of if-statements. */
6409 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6411 if (it
->what
== IT_CHARACTER
)
6413 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6414 and only if (a) the resolved directionality of that character
6416 /* FIXME: Do we need an exception for characters from display
6418 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6419 it
->c
= bidi_mirror_char (it
->c
);
6420 /* Map via display table or translate control characters.
6421 IT->c, IT->len etc. have been set to the next character by
6422 the function call above. If we have a display table, and it
6423 contains an entry for IT->c, translate it. Don't do this if
6424 IT->c itself comes from a display table, otherwise we could
6425 end up in an infinite recursion. (An alternative could be to
6426 count the recursion depth of this function and signal an
6427 error when a certain maximum depth is reached.) Is it worth
6429 if (success_p
&& it
->dpvec
== NULL
)
6432 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6433 int nonascii_space_p
= 0;
6434 int nonascii_hyphen_p
= 0;
6435 int c
= it
->c
; /* This is the character to display. */
6437 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6439 xassert (SINGLE_BYTE_CHAR_P (c
));
6440 if (unibyte_display_via_language_environment
)
6442 c
= DECODE_CHAR (unibyte
, c
);
6444 c
= BYTE8_TO_CHAR (it
->c
);
6447 c
= BYTE8_TO_CHAR (it
->c
);
6451 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6454 struct Lisp_Vector
*v
= XVECTOR (dv
);
6456 /* Return the first character from the display table
6457 entry, if not empty. If empty, don't display the
6458 current character. */
6461 it
->dpvec_char_len
= it
->len
;
6462 it
->dpvec
= v
->contents
;
6463 it
->dpend
= v
->contents
+ v
->header
.size
;
6464 it
->current
.dpvec_index
= 0;
6465 it
->dpvec_face_id
= -1;
6466 it
->saved_face_id
= it
->face_id
;
6467 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6472 set_iterator_to_next (it
, 0);
6477 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6479 if (it
->what
== IT_GLYPHLESS
)
6481 /* Don't display this character. */
6482 set_iterator_to_next (it
, 0);
6486 /* If `nobreak-char-display' is non-nil, we display
6487 non-ASCII spaces and hyphens specially. */
6488 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6491 nonascii_space_p
= 1;
6492 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6493 nonascii_hyphen_p
= 1;
6496 /* Translate control characters into `\003' or `^C' form.
6497 Control characters coming from a display table entry are
6498 currently not translated because we use IT->dpvec to hold
6499 the translation. This could easily be changed but I
6500 don't believe that it is worth doing.
6502 The characters handled by `nobreak-char-display' must be
6505 Non-printable characters and raw-byte characters are also
6506 translated to octal form. */
6507 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6508 ? (it
->area
!= TEXT_AREA
6509 /* In mode line, treat \n, \t like other crl chars. */
6512 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6513 || (c
!= '\n' && c
!= '\t'))
6515 || nonascii_hyphen_p
6517 || ! CHAR_PRINTABLE_P (c
))))
6519 /* C is a control character, non-ASCII space/hyphen,
6520 raw-byte, or a non-printable character which must be
6521 displayed either as '\003' or as `^C' where the '\\'
6522 and '^' can be defined in the display table. Fill
6523 IT->ctl_chars with glyphs for what we have to
6524 display. Then, set IT->dpvec to these glyphs. */
6528 EMACS_INT lface_id
= 0;
6531 /* Handle control characters with ^. */
6533 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6537 g
= '^'; /* default glyph for Control */
6538 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6540 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6541 && GLYPH_CODE_CHAR_VALID_P (gc
))
6543 g
= GLYPH_CODE_CHAR (gc
);
6544 lface_id
= GLYPH_CODE_FACE (gc
);
6548 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6550 else if (it
->f
== last_escape_glyph_frame
6551 && it
->face_id
== last_escape_glyph_face_id
)
6553 face_id
= last_escape_glyph_merged_face_id
;
6557 /* Merge the escape-glyph face into the current face. */
6558 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6560 last_escape_glyph_frame
= it
->f
;
6561 last_escape_glyph_face_id
= it
->face_id
;
6562 last_escape_glyph_merged_face_id
= face_id
;
6565 XSETINT (it
->ctl_chars
[0], g
);
6566 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6568 goto display_control
;
6571 /* Handle non-ascii space in the mode where it only gets
6574 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6576 /* Merge `nobreak-space' into the current face. */
6577 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6579 XSETINT (it
->ctl_chars
[0], ' ');
6581 goto display_control
;
6584 /* Handle sequences that start with the "escape glyph". */
6586 /* the default escape glyph is \. */
6587 escape_glyph
= '\\';
6590 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6591 && GLYPH_CODE_CHAR_VALID_P (gc
))
6593 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6594 lface_id
= GLYPH_CODE_FACE (gc
);
6598 /* The display table specified a face.
6599 Merge it into face_id and also into escape_glyph. */
6600 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6603 else if (it
->f
== last_escape_glyph_frame
6604 && it
->face_id
== last_escape_glyph_face_id
)
6606 face_id
= last_escape_glyph_merged_face_id
;
6610 /* Merge the escape-glyph face into the current face. */
6611 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6613 last_escape_glyph_frame
= it
->f
;
6614 last_escape_glyph_face_id
= it
->face_id
;
6615 last_escape_glyph_merged_face_id
= face_id
;
6618 /* Draw non-ASCII hyphen with just highlighting: */
6620 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6622 XSETINT (it
->ctl_chars
[0], '-');
6624 goto display_control
;
6627 /* Draw non-ASCII space/hyphen with escape glyph: */
6629 if (nonascii_space_p
|| nonascii_hyphen_p
)
6631 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6632 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6634 goto display_control
;
6641 if (CHAR_BYTE8_P (c
))
6642 /* Display \200 instead of \17777600. */
6643 c
= CHAR_TO_BYTE8 (c
);
6644 len
= sprintf (str
, "%03o", c
);
6646 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6647 for (i
= 0; i
< len
; i
++)
6648 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6653 /* Set up IT->dpvec and return first character from it. */
6654 it
->dpvec_char_len
= it
->len
;
6655 it
->dpvec
= it
->ctl_chars
;
6656 it
->dpend
= it
->dpvec
+ ctl_len
;
6657 it
->current
.dpvec_index
= 0;
6658 it
->dpvec_face_id
= face_id
;
6659 it
->saved_face_id
= it
->face_id
;
6660 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6664 it
->char_to_display
= c
;
6668 it
->char_to_display
= it
->c
;
6672 /* Adjust face id for a multibyte character. There are no multibyte
6673 character in unibyte text. */
6674 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6677 && FRAME_WINDOW_P (it
->f
))
6679 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6681 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6683 /* Automatic composition with glyph-string. */
6684 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6686 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6690 EMACS_INT pos
= (it
->s
? -1
6691 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6692 : IT_CHARPOS (*it
));
6695 if (it
->what
== IT_CHARACTER
)
6696 c
= it
->char_to_display
;
6699 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6703 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6704 /* TAB in a composition means display glyphs with
6705 padding space on the left or right. */
6706 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6709 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6714 /* Is this character the last one of a run of characters with
6715 box? If yes, set IT->end_of_box_run_p to 1. */
6719 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6721 int face_id
= underlying_face_id (it
);
6722 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6726 if (face
->box
== FACE_NO_BOX
)
6728 /* If the box comes from face properties in a
6729 display string, check faces in that string. */
6730 int string_face_id
= face_after_it_pos (it
);
6731 it
->end_of_box_run_p
6732 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6735 /* Otherwise, the box comes from the underlying face.
6736 If this is the last string character displayed, check
6737 the next buffer location. */
6738 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6739 && (it
->current
.overlay_string_index
6740 == it
->n_overlay_strings
- 1))
6744 struct text_pos pos
= it
->current
.pos
;
6745 INC_TEXT_POS (pos
, it
->multibyte_p
);
6747 next_face_id
= face_at_buffer_position
6748 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6749 it
->region_end_charpos
, &ignore
,
6750 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6752 it
->end_of_box_run_p
6753 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6760 int face_id
= face_after_it_pos (it
);
6761 it
->end_of_box_run_p
6762 = (face_id
!= it
->face_id
6763 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6767 /* Value is 0 if end of buffer or string reached. */
6772 /* Move IT to the next display element.
6774 RESEAT_P non-zero means if called on a newline in buffer text,
6775 skip to the next visible line start.
6777 Functions get_next_display_element and set_iterator_to_next are
6778 separate because I find this arrangement easier to handle than a
6779 get_next_display_element function that also increments IT's
6780 position. The way it is we can first look at an iterator's current
6781 display element, decide whether it fits on a line, and if it does,
6782 increment the iterator position. The other way around we probably
6783 would either need a flag indicating whether the iterator has to be
6784 incremented the next time, or we would have to implement a
6785 decrement position function which would not be easy to write. */
6788 set_iterator_to_next (struct it
*it
, int reseat_p
)
6790 /* Reset flags indicating start and end of a sequence of characters
6791 with box. Reset them at the start of this function because
6792 moving the iterator to a new position might set them. */
6793 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6797 case GET_FROM_BUFFER
:
6798 /* The current display element of IT is a character from
6799 current_buffer. Advance in the buffer, and maybe skip over
6800 invisible lines that are so because of selective display. */
6801 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6802 reseat_at_next_visible_line_start (it
, 0);
6803 else if (it
->cmp_it
.id
>= 0)
6805 /* We are currently getting glyphs from a composition. */
6810 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6811 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6812 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6814 it
->cmp_it
.from
= it
->cmp_it
.to
;
6819 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6821 it
->end_charpos
, Qnil
);
6824 else if (! it
->cmp_it
.reversed_p
)
6826 /* Composition created while scanning forward. */
6827 /* Update IT's char/byte positions to point to the first
6828 character of the next grapheme cluster, or to the
6829 character visually after the current composition. */
6830 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6831 bidi_move_to_visually_next (&it
->bidi_it
);
6832 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6833 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6835 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6837 /* Proceed to the next grapheme cluster. */
6838 it
->cmp_it
.from
= it
->cmp_it
.to
;
6842 /* No more grapheme clusters in this composition.
6843 Find the next stop position. */
6844 EMACS_INT stop
= it
->end_charpos
;
6845 if (it
->bidi_it
.scan_dir
< 0)
6846 /* Now we are scanning backward and don't know
6849 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6850 IT_BYTEPOS (*it
), stop
, Qnil
);
6855 /* Composition created while scanning backward. */
6856 /* Update IT's char/byte positions to point to the last
6857 character of the previous grapheme cluster, or the
6858 character visually after the current composition. */
6859 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6860 bidi_move_to_visually_next (&it
->bidi_it
);
6861 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6862 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6863 if (it
->cmp_it
.from
> 0)
6865 /* Proceed to the previous grapheme cluster. */
6866 it
->cmp_it
.to
= it
->cmp_it
.from
;
6870 /* No more grapheme clusters in this composition.
6871 Find the next stop position. */
6872 EMACS_INT stop
= it
->end_charpos
;
6873 if (it
->bidi_it
.scan_dir
< 0)
6874 /* Now we are scanning backward and don't know
6877 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6878 IT_BYTEPOS (*it
), stop
, Qnil
);
6884 xassert (it
->len
!= 0);
6888 IT_BYTEPOS (*it
) += it
->len
;
6889 IT_CHARPOS (*it
) += 1;
6893 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6894 /* If this is a new paragraph, determine its base
6895 direction (a.k.a. its base embedding level). */
6896 if (it
->bidi_it
.new_paragraph
)
6897 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6898 bidi_move_to_visually_next (&it
->bidi_it
);
6899 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6900 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6901 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6903 /* As the scan direction was changed, we must
6904 re-compute the stop position for composition. */
6905 EMACS_INT stop
= it
->end_charpos
;
6906 if (it
->bidi_it
.scan_dir
< 0)
6908 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6909 IT_BYTEPOS (*it
), stop
, Qnil
);
6912 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6916 case GET_FROM_C_STRING
:
6917 /* Current display element of IT is from a C string. */
6919 /* If the string position is beyond string's end, it means
6920 next_element_from_c_string is padding the string with
6921 blanks, in which case we bypass the bidi iterator,
6922 because it cannot deal with such virtual characters. */
6923 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6925 IT_BYTEPOS (*it
) += it
->len
;
6926 IT_CHARPOS (*it
) += 1;
6930 bidi_move_to_visually_next (&it
->bidi_it
);
6931 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6932 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6936 case GET_FROM_DISPLAY_VECTOR
:
6937 /* Current display element of IT is from a display table entry.
6938 Advance in the display table definition. Reset it to null if
6939 end reached, and continue with characters from buffers/
6941 ++it
->current
.dpvec_index
;
6943 /* Restore face of the iterator to what they were before the
6944 display vector entry (these entries may contain faces). */
6945 it
->face_id
= it
->saved_face_id
;
6947 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6949 int recheck_faces
= it
->ellipsis_p
;
6952 it
->method
= GET_FROM_C_STRING
;
6953 else if (STRINGP (it
->string
))
6954 it
->method
= GET_FROM_STRING
;
6957 it
->method
= GET_FROM_BUFFER
;
6958 it
->object
= it
->w
->buffer
;
6962 it
->current
.dpvec_index
= -1;
6964 /* Skip over characters which were displayed via IT->dpvec. */
6965 if (it
->dpvec_char_len
< 0)
6966 reseat_at_next_visible_line_start (it
, 1);
6967 else if (it
->dpvec_char_len
> 0)
6969 if (it
->method
== GET_FROM_STRING
6970 && it
->n_overlay_strings
> 0)
6971 it
->ignore_overlay_strings_at_pos_p
= 1;
6972 it
->len
= it
->dpvec_char_len
;
6973 set_iterator_to_next (it
, reseat_p
);
6976 /* Maybe recheck faces after display vector */
6978 it
->stop_charpos
= IT_CHARPOS (*it
);
6982 case GET_FROM_STRING
:
6983 /* Current display element is a character from a Lisp string. */
6984 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6985 if (it
->cmp_it
.id
>= 0)
6991 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6992 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6993 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6994 it
->cmp_it
.from
= it
->cmp_it
.to
;
6998 composition_compute_stop_pos (&it
->cmp_it
,
6999 IT_STRING_CHARPOS (*it
),
7000 IT_STRING_BYTEPOS (*it
),
7001 it
->end_charpos
, it
->string
);
7004 else if (! it
->cmp_it
.reversed_p
)
7006 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7007 bidi_move_to_visually_next (&it
->bidi_it
);
7008 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7009 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7011 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7012 it
->cmp_it
.from
= it
->cmp_it
.to
;
7015 EMACS_INT stop
= it
->end_charpos
;
7016 if (it
->bidi_it
.scan_dir
< 0)
7018 composition_compute_stop_pos (&it
->cmp_it
,
7019 IT_STRING_CHARPOS (*it
),
7020 IT_STRING_BYTEPOS (*it
), stop
,
7026 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7027 bidi_move_to_visually_next (&it
->bidi_it
);
7028 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7029 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7030 if (it
->cmp_it
.from
> 0)
7031 it
->cmp_it
.to
= it
->cmp_it
.from
;
7034 EMACS_INT stop
= it
->end_charpos
;
7035 if (it
->bidi_it
.scan_dir
< 0)
7037 composition_compute_stop_pos (&it
->cmp_it
,
7038 IT_STRING_CHARPOS (*it
),
7039 IT_STRING_BYTEPOS (*it
), stop
,
7047 /* If the string position is beyond string's end, it
7048 means next_element_from_string is padding the string
7049 with blanks, in which case we bypass the bidi
7050 iterator, because it cannot deal with such virtual
7052 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7054 IT_STRING_BYTEPOS (*it
) += it
->len
;
7055 IT_STRING_CHARPOS (*it
) += 1;
7059 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7061 bidi_move_to_visually_next (&it
->bidi_it
);
7062 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7063 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7064 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7066 EMACS_INT stop
= it
->end_charpos
;
7068 if (it
->bidi_it
.scan_dir
< 0)
7070 composition_compute_stop_pos (&it
->cmp_it
,
7071 IT_STRING_CHARPOS (*it
),
7072 IT_STRING_BYTEPOS (*it
), stop
,
7078 consider_string_end
:
7080 if (it
->current
.overlay_string_index
>= 0)
7082 /* IT->string is an overlay string. Advance to the
7083 next, if there is one. */
7084 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7087 next_overlay_string (it
);
7089 setup_for_ellipsis (it
, 0);
7094 /* IT->string is not an overlay string. If we reached
7095 its end, and there is something on IT->stack, proceed
7096 with what is on the stack. This can be either another
7097 string, this time an overlay string, or a buffer. */
7098 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7102 if (it
->method
== GET_FROM_STRING
)
7103 goto consider_string_end
;
7108 case GET_FROM_IMAGE
:
7109 case GET_FROM_STRETCH
:
7110 /* The position etc with which we have to proceed are on
7111 the stack. The position may be at the end of a string,
7112 if the `display' property takes up the whole string. */
7113 xassert (it
->sp
> 0);
7115 if (it
->method
== GET_FROM_STRING
)
7116 goto consider_string_end
;
7120 /* There are no other methods defined, so this should be a bug. */
7124 xassert (it
->method
!= GET_FROM_STRING
7125 || (STRINGP (it
->string
)
7126 && IT_STRING_CHARPOS (*it
) >= 0));
7129 /* Load IT's display element fields with information about the next
7130 display element which comes from a display table entry or from the
7131 result of translating a control character to one of the forms `^C'
7134 IT->dpvec holds the glyphs to return as characters.
7135 IT->saved_face_id holds the face id before the display vector--it
7136 is restored into IT->face_id in set_iterator_to_next. */
7139 next_element_from_display_vector (struct it
*it
)
7144 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7146 it
->face_id
= it
->saved_face_id
;
7148 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7149 That seemed totally bogus - so I changed it... */
7150 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7152 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7154 it
->c
= GLYPH_CODE_CHAR (gc
);
7155 it
->len
= CHAR_BYTES (it
->c
);
7157 /* The entry may contain a face id to use. Such a face id is
7158 the id of a Lisp face, not a realized face. A face id of
7159 zero means no face is specified. */
7160 if (it
->dpvec_face_id
>= 0)
7161 it
->face_id
= it
->dpvec_face_id
;
7164 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7166 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7171 /* Display table entry is invalid. Return a space. */
7172 it
->c
= ' ', it
->len
= 1;
7174 /* Don't change position and object of the iterator here. They are
7175 still the values of the character that had this display table
7176 entry or was translated, and that's what we want. */
7177 it
->what
= IT_CHARACTER
;
7181 /* Get the first element of string/buffer in the visual order, after
7182 being reseated to a new position in a string or a buffer. */
7184 get_visually_first_element (struct it
*it
)
7186 int string_p
= STRINGP (it
->string
) || it
->s
;
7187 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7188 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7190 if (STRINGP (it
->string
))
7192 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7193 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7197 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7198 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7201 if (it
->bidi_it
.charpos
== eob
)
7203 /* Nothing to do, but reset the FIRST_ELT flag, like
7204 bidi_paragraph_init does, because we are not going to
7206 it
->bidi_it
.first_elt
= 0;
7208 else if (it
->bidi_it
.charpos
== bob
7210 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7211 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7213 /* If we are at the beginning of a line/string, we can produce
7214 the next element right away. */
7215 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7216 bidi_move_to_visually_next (&it
->bidi_it
);
7220 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7222 /* We need to prime the bidi iterator starting at the line's or
7223 string's beginning, before we will be able to produce the
7226 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7229 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7231 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7233 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7236 /* Now return to buffer/string position where we were asked
7237 to get the next display element, and produce that. */
7238 bidi_move_to_visually_next (&it
->bidi_it
);
7240 while (it
->bidi_it
.bytepos
!= orig_bytepos
7241 && it
->bidi_it
.charpos
< eob
);
7244 /* Adjust IT's position information to where we ended up. */
7245 if (STRINGP (it
->string
))
7247 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7248 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7252 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7253 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7256 if (STRINGP (it
->string
) || !it
->s
)
7258 EMACS_INT stop
, charpos
, bytepos
;
7260 if (STRINGP (it
->string
))
7263 stop
= SCHARS (it
->string
);
7264 if (stop
> it
->end_charpos
)
7265 stop
= it
->end_charpos
;
7266 charpos
= IT_STRING_CHARPOS (*it
);
7267 bytepos
= IT_STRING_BYTEPOS (*it
);
7271 stop
= it
->end_charpos
;
7272 charpos
= IT_CHARPOS (*it
);
7273 bytepos
= IT_BYTEPOS (*it
);
7275 if (it
->bidi_it
.scan_dir
< 0)
7277 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7282 /* Load IT with the next display element from Lisp string IT->string.
7283 IT->current.string_pos is the current position within the string.
7284 If IT->current.overlay_string_index >= 0, the Lisp string is an
7288 next_element_from_string (struct it
*it
)
7290 struct text_pos position
;
7292 xassert (STRINGP (it
->string
));
7293 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7294 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7295 position
= it
->current
.string_pos
;
7297 /* With bidi reordering, the character to display might not be the
7298 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7299 that we were reseat()ed to a new string, whose paragraph
7300 direction is not known. */
7301 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7303 get_visually_first_element (it
);
7304 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7307 /* Time to check for invisible text? */
7308 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7310 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7313 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7314 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7316 /* With bidi non-linear iteration, we could find
7317 ourselves far beyond the last computed stop_charpos,
7318 with several other stop positions in between that we
7319 missed. Scan them all now, in buffer's logical
7320 order, until we find and handle the last stop_charpos
7321 that precedes our current position. */
7322 handle_stop_backwards (it
, it
->stop_charpos
);
7323 return GET_NEXT_DISPLAY_ELEMENT (it
);
7329 /* Take note of the stop position we just moved
7330 across, for when we will move back across it. */
7331 it
->prev_stop
= it
->stop_charpos
;
7332 /* If we are at base paragraph embedding level, take
7333 note of the last stop position seen at this
7335 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7336 it
->base_level_stop
= it
->stop_charpos
;
7340 /* Since a handler may have changed IT->method, we must
7342 return GET_NEXT_DISPLAY_ELEMENT (it
);
7346 /* If we are before prev_stop, we may have overstepped
7347 on our way backwards a stop_pos, and if so, we need
7348 to handle that stop_pos. */
7349 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7350 /* We can sometimes back up for reasons that have nothing
7351 to do with bidi reordering. E.g., compositions. The
7352 code below is only needed when we are above the base
7353 embedding level, so test for that explicitly. */
7354 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7356 /* If we lost track of base_level_stop, we have no better
7357 place for handle_stop_backwards to start from than string
7358 beginning. This happens, e.g., when we were reseated to
7359 the previous screenful of text by vertical-motion. */
7360 if (it
->base_level_stop
<= 0
7361 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7362 it
->base_level_stop
= 0;
7363 handle_stop_backwards (it
, it
->base_level_stop
);
7364 return GET_NEXT_DISPLAY_ELEMENT (it
);
7368 if (it
->current
.overlay_string_index
>= 0)
7370 /* Get the next character from an overlay string. In overlay
7371 strings, there is no field width or padding with spaces to
7373 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7378 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7379 IT_STRING_BYTEPOS (*it
),
7380 it
->bidi_it
.scan_dir
< 0
7382 : SCHARS (it
->string
))
7383 && next_element_from_composition (it
))
7387 else if (STRING_MULTIBYTE (it
->string
))
7389 const unsigned char *s
= (SDATA (it
->string
)
7390 + IT_STRING_BYTEPOS (*it
));
7391 it
->c
= string_char_and_length (s
, &it
->len
);
7395 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7401 /* Get the next character from a Lisp string that is not an
7402 overlay string. Such strings come from the mode line, for
7403 example. We may have to pad with spaces, or truncate the
7404 string. See also next_element_from_c_string. */
7405 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7410 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7412 /* Pad with spaces. */
7413 it
->c
= ' ', it
->len
= 1;
7414 CHARPOS (position
) = BYTEPOS (position
) = -1;
7416 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7417 IT_STRING_BYTEPOS (*it
),
7418 it
->bidi_it
.scan_dir
< 0
7420 : it
->string_nchars
)
7421 && next_element_from_composition (it
))
7425 else if (STRING_MULTIBYTE (it
->string
))
7427 const unsigned char *s
= (SDATA (it
->string
)
7428 + IT_STRING_BYTEPOS (*it
));
7429 it
->c
= string_char_and_length (s
, &it
->len
);
7433 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7438 /* Record what we have and where it came from. */
7439 it
->what
= IT_CHARACTER
;
7440 it
->object
= it
->string
;
7441 it
->position
= position
;
7446 /* Load IT with next display element from C string IT->s.
7447 IT->string_nchars is the maximum number of characters to return
7448 from the string. IT->end_charpos may be greater than
7449 IT->string_nchars when this function is called, in which case we
7450 may have to return padding spaces. Value is zero if end of string
7451 reached, including padding spaces. */
7454 next_element_from_c_string (struct it
*it
)
7459 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7460 it
->what
= IT_CHARACTER
;
7461 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7464 /* With bidi reordering, the character to display might not be the
7465 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7466 we were reseated to a new string, whose paragraph direction is
7468 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7469 get_visually_first_element (it
);
7471 /* IT's position can be greater than IT->string_nchars in case a
7472 field width or precision has been specified when the iterator was
7474 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7476 /* End of the game. */
7480 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7482 /* Pad with spaces. */
7483 it
->c
= ' ', it
->len
= 1;
7484 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7486 else if (it
->multibyte_p
)
7487 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7489 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7495 /* Set up IT to return characters from an ellipsis, if appropriate.
7496 The definition of the ellipsis glyphs may come from a display table
7497 entry. This function fills IT with the first glyph from the
7498 ellipsis if an ellipsis is to be displayed. */
7501 next_element_from_ellipsis (struct it
*it
)
7503 if (it
->selective_display_ellipsis_p
)
7504 setup_for_ellipsis (it
, it
->len
);
7507 /* The face at the current position may be different from the
7508 face we find after the invisible text. Remember what it
7509 was in IT->saved_face_id, and signal that it's there by
7510 setting face_before_selective_p. */
7511 it
->saved_face_id
= it
->face_id
;
7512 it
->method
= GET_FROM_BUFFER
;
7513 it
->object
= it
->w
->buffer
;
7514 reseat_at_next_visible_line_start (it
, 1);
7515 it
->face_before_selective_p
= 1;
7518 return GET_NEXT_DISPLAY_ELEMENT (it
);
7522 /* Deliver an image display element. The iterator IT is already
7523 filled with image information (done in handle_display_prop). Value
7528 next_element_from_image (struct it
*it
)
7530 it
->what
= IT_IMAGE
;
7531 it
->ignore_overlay_strings_at_pos_p
= 0;
7536 /* Fill iterator IT with next display element from a stretch glyph
7537 property. IT->object is the value of the text property. Value is
7541 next_element_from_stretch (struct it
*it
)
7543 it
->what
= IT_STRETCH
;
7547 /* Scan backwards from IT's current position until we find a stop
7548 position, or until BEGV. This is called when we find ourself
7549 before both the last known prev_stop and base_level_stop while
7550 reordering bidirectional text. */
7553 compute_stop_pos_backwards (struct it
*it
)
7555 const int SCAN_BACK_LIMIT
= 1000;
7556 struct text_pos pos
;
7557 struct display_pos save_current
= it
->current
;
7558 struct text_pos save_position
= it
->position
;
7559 EMACS_INT charpos
= IT_CHARPOS (*it
);
7560 EMACS_INT where_we_are
= charpos
;
7561 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7562 EMACS_INT save_end_pos
= it
->end_charpos
;
7564 xassert (NILP (it
->string
) && !it
->s
);
7565 xassert (it
->bidi_p
);
7569 it
->end_charpos
= min (charpos
+ 1, ZV
);
7570 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7571 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7572 reseat_1 (it
, pos
, 0);
7573 compute_stop_pos (it
);
7574 /* We must advance forward, right? */
7575 if (it
->stop_charpos
<= charpos
)
7578 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7580 if (it
->stop_charpos
<= where_we_are
)
7581 it
->prev_stop
= it
->stop_charpos
;
7583 it
->prev_stop
= BEGV
;
7585 it
->current
= save_current
;
7586 it
->position
= save_position
;
7587 it
->stop_charpos
= save_stop_pos
;
7588 it
->end_charpos
= save_end_pos
;
7591 /* Scan forward from CHARPOS in the current buffer/string, until we
7592 find a stop position > current IT's position. Then handle the stop
7593 position before that. This is called when we bump into a stop
7594 position while reordering bidirectional text. CHARPOS should be
7595 the last previously processed stop_pos (or BEGV/0, if none were
7596 processed yet) whose position is less that IT's current
7600 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7602 int bufp
= !STRINGP (it
->string
);
7603 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7604 struct display_pos save_current
= it
->current
;
7605 struct text_pos save_position
= it
->position
;
7606 struct text_pos pos1
;
7607 EMACS_INT next_stop
;
7609 /* Scan in strict logical order. */
7610 xassert (it
->bidi_p
);
7614 it
->prev_stop
= charpos
;
7617 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7618 reseat_1 (it
, pos1
, 0);
7621 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7622 compute_stop_pos (it
);
7623 /* We must advance forward, right? */
7624 if (it
->stop_charpos
<= it
->prev_stop
)
7626 charpos
= it
->stop_charpos
;
7628 while (charpos
<= where_we_are
);
7631 it
->current
= save_current
;
7632 it
->position
= save_position
;
7633 next_stop
= it
->stop_charpos
;
7634 it
->stop_charpos
= it
->prev_stop
;
7636 it
->stop_charpos
= next_stop
;
7639 /* Load IT with the next display element from current_buffer. Value
7640 is zero if end of buffer reached. IT->stop_charpos is the next
7641 position at which to stop and check for text properties or buffer
7645 next_element_from_buffer (struct it
*it
)
7649 xassert (IT_CHARPOS (*it
) >= BEGV
);
7650 xassert (NILP (it
->string
) && !it
->s
);
7651 xassert (!it
->bidi_p
7652 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7653 && it
->bidi_it
.string
.s
== NULL
));
7655 /* With bidi reordering, the character to display might not be the
7656 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7657 we were reseat()ed to a new buffer position, which is potentially
7658 a different paragraph. */
7659 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7661 get_visually_first_element (it
);
7662 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7665 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7667 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7669 int overlay_strings_follow_p
;
7671 /* End of the game, except when overlay strings follow that
7672 haven't been returned yet. */
7673 if (it
->overlay_strings_at_end_processed_p
)
7674 overlay_strings_follow_p
= 0;
7677 it
->overlay_strings_at_end_processed_p
= 1;
7678 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7681 if (overlay_strings_follow_p
)
7682 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7686 it
->position
= it
->current
.pos
;
7690 else if (!(!it
->bidi_p
7691 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7692 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7694 /* With bidi non-linear iteration, we could find ourselves
7695 far beyond the last computed stop_charpos, with several
7696 other stop positions in between that we missed. Scan
7697 them all now, in buffer's logical order, until we find
7698 and handle the last stop_charpos that precedes our
7699 current position. */
7700 handle_stop_backwards (it
, it
->stop_charpos
);
7701 return GET_NEXT_DISPLAY_ELEMENT (it
);
7707 /* Take note of the stop position we just moved across,
7708 for when we will move back across it. */
7709 it
->prev_stop
= it
->stop_charpos
;
7710 /* If we are at base paragraph embedding level, take
7711 note of the last stop position seen at this
7713 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7714 it
->base_level_stop
= it
->stop_charpos
;
7717 return GET_NEXT_DISPLAY_ELEMENT (it
);
7721 /* If we are before prev_stop, we may have overstepped on
7722 our way backwards a stop_pos, and if so, we need to
7723 handle that stop_pos. */
7724 && IT_CHARPOS (*it
) < it
->prev_stop
7725 /* We can sometimes back up for reasons that have nothing
7726 to do with bidi reordering. E.g., compositions. The
7727 code below is only needed when we are above the base
7728 embedding level, so test for that explicitly. */
7729 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7731 if (it
->base_level_stop
<= 0
7732 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7734 /* If we lost track of base_level_stop, we need to find
7735 prev_stop by looking backwards. This happens, e.g., when
7736 we were reseated to the previous screenful of text by
7738 it
->base_level_stop
= BEGV
;
7739 compute_stop_pos_backwards (it
);
7740 handle_stop_backwards (it
, it
->prev_stop
);
7743 handle_stop_backwards (it
, it
->base_level_stop
);
7744 return GET_NEXT_DISPLAY_ELEMENT (it
);
7748 /* No face changes, overlays etc. in sight, so just return a
7749 character from current_buffer. */
7753 /* Maybe run the redisplay end trigger hook. Performance note:
7754 This doesn't seem to cost measurable time. */
7755 if (it
->redisplay_end_trigger_charpos
7757 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7758 run_redisplay_end_trigger_hook (it
);
7760 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7761 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7763 && next_element_from_composition (it
))
7768 /* Get the next character, maybe multibyte. */
7769 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7770 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7771 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7773 it
->c
= *p
, it
->len
= 1;
7775 /* Record what we have and where it came from. */
7776 it
->what
= IT_CHARACTER
;
7777 it
->object
= it
->w
->buffer
;
7778 it
->position
= it
->current
.pos
;
7780 /* Normally we return the character found above, except when we
7781 really want to return an ellipsis for selective display. */
7786 /* A value of selective > 0 means hide lines indented more
7787 than that number of columns. */
7788 if (it
->selective
> 0
7789 && IT_CHARPOS (*it
) + 1 < ZV
7790 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7791 IT_BYTEPOS (*it
) + 1,
7794 success_p
= next_element_from_ellipsis (it
);
7795 it
->dpvec_char_len
= -1;
7798 else if (it
->c
== '\r' && it
->selective
== -1)
7800 /* A value of selective == -1 means that everything from the
7801 CR to the end of the line is invisible, with maybe an
7802 ellipsis displayed for it. */
7803 success_p
= next_element_from_ellipsis (it
);
7804 it
->dpvec_char_len
= -1;
7809 /* Value is zero if end of buffer reached. */
7810 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7815 /* Run the redisplay end trigger hook for IT. */
7818 run_redisplay_end_trigger_hook (struct it
*it
)
7820 Lisp_Object args
[3];
7822 /* IT->glyph_row should be non-null, i.e. we should be actually
7823 displaying something, or otherwise we should not run the hook. */
7824 xassert (it
->glyph_row
);
7826 /* Set up hook arguments. */
7827 args
[0] = Qredisplay_end_trigger_functions
;
7828 args
[1] = it
->window
;
7829 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7830 it
->redisplay_end_trigger_charpos
= 0;
7832 /* Since we are *trying* to run these functions, don't try to run
7833 them again, even if they get an error. */
7834 it
->w
->redisplay_end_trigger
= Qnil
;
7835 Frun_hook_with_args (3, args
);
7837 /* Notice if it changed the face of the character we are on. */
7838 handle_face_prop (it
);
7842 /* Deliver a composition display element. Unlike the other
7843 next_element_from_XXX, this function is not registered in the array
7844 get_next_element[]. It is called from next_element_from_buffer and
7845 next_element_from_string when necessary. */
7848 next_element_from_composition (struct it
*it
)
7850 it
->what
= IT_COMPOSITION
;
7851 it
->len
= it
->cmp_it
.nbytes
;
7852 if (STRINGP (it
->string
))
7856 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7857 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7860 it
->position
= it
->current
.string_pos
;
7861 it
->object
= it
->string
;
7862 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7863 IT_STRING_BYTEPOS (*it
), it
->string
);
7869 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7870 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7873 if (it
->bidi_it
.new_paragraph
)
7874 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7875 /* Resync the bidi iterator with IT's new position.
7876 FIXME: this doesn't support bidirectional text. */
7877 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7878 bidi_move_to_visually_next (&it
->bidi_it
);
7882 it
->position
= it
->current
.pos
;
7883 it
->object
= it
->w
->buffer
;
7884 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7885 IT_BYTEPOS (*it
), Qnil
);
7892 /***********************************************************************
7893 Moving an iterator without producing glyphs
7894 ***********************************************************************/
7896 /* Check if iterator is at a position corresponding to a valid buffer
7897 position after some move_it_ call. */
7899 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7900 ((it)->method == GET_FROM_STRING \
7901 ? IT_STRING_CHARPOS (*it) == 0 \
7905 /* Move iterator IT to a specified buffer or X position within one
7906 line on the display without producing glyphs.
7908 OP should be a bit mask including some or all of these bits:
7909 MOVE_TO_X: Stop upon reaching x-position TO_X.
7910 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7911 Regardless of OP's value, stop upon reaching the end of the display line.
7913 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7914 This means, in particular, that TO_X includes window's horizontal
7917 The return value has several possible values that
7918 say what condition caused the scan to stop:
7920 MOVE_POS_MATCH_OR_ZV
7921 - when TO_POS or ZV was reached.
7924 -when TO_X was reached before TO_POS or ZV were reached.
7927 - when we reached the end of the display area and the line must
7931 - when we reached the end of the display area and the line is
7935 - when we stopped at a line end, i.e. a newline or a CR and selective
7938 static enum move_it_result
7939 move_it_in_display_line_to (struct it
*it
,
7940 EMACS_INT to_charpos
, int to_x
,
7941 enum move_operation_enum op
)
7943 enum move_it_result result
= MOVE_UNDEFINED
;
7944 struct glyph_row
*saved_glyph_row
;
7945 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7946 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7947 void *ppos_data
= NULL
;
7949 enum it_method prev_method
= it
->method
;
7950 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7951 int saw_smaller_pos
= prev_pos
< to_charpos
;
7953 /* Don't produce glyphs in produce_glyphs. */
7954 saved_glyph_row
= it
->glyph_row
;
7955 it
->glyph_row
= NULL
;
7957 /* Use wrap_it to save a copy of IT wherever a word wrap could
7958 occur. Use atpos_it to save a copy of IT at the desired buffer
7959 position, if found, so that we can scan ahead and check if the
7960 word later overshoots the window edge. Use atx_it similarly, for
7966 /* Use ppos_it under bidi reordering to save a copy of IT for the
7967 position > CHARPOS that is the closest to CHARPOS. We restore
7968 that position in IT when we have scanned the entire display line
7969 without finding a match for CHARPOS and all the character
7970 positions are greater than CHARPOS. */
7973 SAVE_IT (ppos_it
, *it
, ppos_data
);
7974 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7975 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7976 SAVE_IT (ppos_it
, *it
, ppos_data
);
7979 #define BUFFER_POS_REACHED_P() \
7980 ((op & MOVE_TO_POS) != 0 \
7981 && BUFFERP (it->object) \
7982 && (IT_CHARPOS (*it) == to_charpos \
7984 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7985 && IT_CHARPOS (*it) > to_charpos) \
7986 || (it->what == IT_COMPOSITION \
7987 && ((IT_CHARPOS (*it) > to_charpos \
7988 && to_charpos >= it->cmp_it.charpos) \
7989 || (IT_CHARPOS (*it) < to_charpos \
7990 && to_charpos <= it->cmp_it.charpos)))) \
7991 && (it->method == GET_FROM_BUFFER \
7992 || (it->method == GET_FROM_DISPLAY_VECTOR \
7993 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7995 /* If there's a line-/wrap-prefix, handle it. */
7996 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7997 && it
->current_y
< it
->last_visible_y
)
7998 handle_line_prefix (it
);
8000 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8001 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8005 int x
, i
, ascent
= 0, descent
= 0;
8007 /* Utility macro to reset an iterator with x, ascent, and descent. */
8008 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8009 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8010 (IT)->max_descent = descent)
8012 /* Stop if we move beyond TO_CHARPOS (after an image or a
8013 display string or stretch glyph). */
8014 if ((op
& MOVE_TO_POS
) != 0
8015 && BUFFERP (it
->object
)
8016 && it
->method
== GET_FROM_BUFFER
8018 /* When the iterator is at base embedding level, we
8019 are guaranteed that characters are delivered for
8020 display in strictly increasing order of their
8021 buffer positions. */
8022 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8023 && IT_CHARPOS (*it
) > to_charpos
)
8025 && (prev_method
== GET_FROM_IMAGE
8026 || prev_method
== GET_FROM_STRETCH
8027 || prev_method
== GET_FROM_STRING
)
8028 /* Passed TO_CHARPOS from left to right. */
8029 && ((prev_pos
< to_charpos
8030 && IT_CHARPOS (*it
) > to_charpos
)
8031 /* Passed TO_CHARPOS from right to left. */
8032 || (prev_pos
> to_charpos
8033 && IT_CHARPOS (*it
) < to_charpos
)))))
8035 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8037 result
= MOVE_POS_MATCH_OR_ZV
;
8040 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8041 /* If wrap_it is valid, the current position might be in a
8042 word that is wrapped. So, save the iterator in
8043 atpos_it and continue to see if wrapping happens. */
8044 SAVE_IT (atpos_it
, *it
, atpos_data
);
8047 /* Stop when ZV reached.
8048 We used to stop here when TO_CHARPOS reached as well, but that is
8049 too soon if this glyph does not fit on this line. So we handle it
8050 explicitly below. */
8051 if (!get_next_display_element (it
))
8053 result
= MOVE_POS_MATCH_OR_ZV
;
8057 if (it
->line_wrap
== TRUNCATE
)
8059 if (BUFFER_POS_REACHED_P ())
8061 result
= MOVE_POS_MATCH_OR_ZV
;
8067 if (it
->line_wrap
== WORD_WRAP
)
8069 if (IT_DISPLAYING_WHITESPACE (it
))
8073 /* We have reached a glyph that follows one or more
8074 whitespace characters. If the position is
8075 already found, we are done. */
8076 if (atpos_it
.sp
>= 0)
8078 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8079 result
= MOVE_POS_MATCH_OR_ZV
;
8084 RESTORE_IT (it
, &atx_it
, atx_data
);
8085 result
= MOVE_X_REACHED
;
8088 /* Otherwise, we can wrap here. */
8089 SAVE_IT (wrap_it
, *it
, wrap_data
);
8095 /* Remember the line height for the current line, in case
8096 the next element doesn't fit on the line. */
8097 ascent
= it
->max_ascent
;
8098 descent
= it
->max_descent
;
8100 /* The call to produce_glyphs will get the metrics of the
8101 display element IT is loaded with. Record the x-position
8102 before this display element, in case it doesn't fit on the
8106 PRODUCE_GLYPHS (it
);
8108 if (it
->area
!= TEXT_AREA
)
8110 prev_method
= it
->method
;
8111 if (it
->method
== GET_FROM_BUFFER
)
8112 prev_pos
= IT_CHARPOS (*it
);
8113 set_iterator_to_next (it
, 1);
8114 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8115 SET_TEXT_POS (this_line_min_pos
,
8116 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8118 && (op
& MOVE_TO_POS
)
8119 && IT_CHARPOS (*it
) > to_charpos
8120 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8121 SAVE_IT (ppos_it
, *it
, ppos_data
);
8125 /* The number of glyphs we get back in IT->nglyphs will normally
8126 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8127 character on a terminal frame, or (iii) a line end. For the
8128 second case, IT->nglyphs - 1 padding glyphs will be present.
8129 (On X frames, there is only one glyph produced for a
8130 composite character.)
8132 The behavior implemented below means, for continuation lines,
8133 that as many spaces of a TAB as fit on the current line are
8134 displayed there. For terminal frames, as many glyphs of a
8135 multi-glyph character are displayed in the current line, too.
8136 This is what the old redisplay code did, and we keep it that
8137 way. Under X, the whole shape of a complex character must
8138 fit on the line or it will be completely displayed in the
8141 Note that both for tabs and padding glyphs, all glyphs have
8145 /* More than one glyph or glyph doesn't fit on line. All
8146 glyphs have the same width. */
8147 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8149 int x_before_this_char
= x
;
8150 int hpos_before_this_char
= it
->hpos
;
8152 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8154 new_x
= x
+ single_glyph_width
;
8156 /* We want to leave anything reaching TO_X to the caller. */
8157 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8159 if (BUFFER_POS_REACHED_P ())
8161 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8162 goto buffer_pos_reached
;
8163 if (atpos_it
.sp
< 0)
8165 SAVE_IT (atpos_it
, *it
, atpos_data
);
8166 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8171 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8174 result
= MOVE_X_REACHED
;
8179 SAVE_IT (atx_it
, *it
, atx_data
);
8180 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8185 if (/* Lines are continued. */
8186 it
->line_wrap
!= TRUNCATE
8187 && (/* And glyph doesn't fit on the line. */
8188 new_x
> it
->last_visible_x
8189 /* Or it fits exactly and we're on a window
8191 || (new_x
== it
->last_visible_x
8192 && FRAME_WINDOW_P (it
->f
))))
8194 if (/* IT->hpos == 0 means the very first glyph
8195 doesn't fit on the line, e.g. a wide image. */
8197 || (new_x
== it
->last_visible_x
8198 && FRAME_WINDOW_P (it
->f
)))
8201 it
->current_x
= new_x
;
8203 /* The character's last glyph just barely fits
8205 if (i
== it
->nglyphs
- 1)
8207 /* If this is the destination position,
8208 return a position *before* it in this row,
8209 now that we know it fits in this row. */
8210 if (BUFFER_POS_REACHED_P ())
8212 if (it
->line_wrap
!= WORD_WRAP
8215 it
->hpos
= hpos_before_this_char
;
8216 it
->current_x
= x_before_this_char
;
8217 result
= MOVE_POS_MATCH_OR_ZV
;
8220 if (it
->line_wrap
== WORD_WRAP
8223 SAVE_IT (atpos_it
, *it
, atpos_data
);
8224 atpos_it
.current_x
= x_before_this_char
;
8225 atpos_it
.hpos
= hpos_before_this_char
;
8229 prev_method
= it
->method
;
8230 if (it
->method
== GET_FROM_BUFFER
)
8231 prev_pos
= IT_CHARPOS (*it
);
8232 set_iterator_to_next (it
, 1);
8233 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8234 SET_TEXT_POS (this_line_min_pos
,
8235 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8236 /* On graphical terminals, newlines may
8237 "overflow" into the fringe if
8238 overflow-newline-into-fringe is non-nil.
8239 On text-only terminals, newlines may
8240 overflow into the last glyph on the
8242 if (!FRAME_WINDOW_P (it
->f
)
8243 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8245 if (!get_next_display_element (it
))
8247 result
= MOVE_POS_MATCH_OR_ZV
;
8250 if (BUFFER_POS_REACHED_P ())
8252 if (ITERATOR_AT_END_OF_LINE_P (it
))
8253 result
= MOVE_POS_MATCH_OR_ZV
;
8255 result
= MOVE_LINE_CONTINUED
;
8258 if (ITERATOR_AT_END_OF_LINE_P (it
))
8260 result
= MOVE_NEWLINE_OR_CR
;
8267 IT_RESET_X_ASCENT_DESCENT (it
);
8269 if (wrap_it
.sp
>= 0)
8271 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8276 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8278 result
= MOVE_LINE_CONTINUED
;
8282 if (BUFFER_POS_REACHED_P ())
8284 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8285 goto buffer_pos_reached
;
8286 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8288 SAVE_IT (atpos_it
, *it
, atpos_data
);
8289 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8293 if (new_x
> it
->first_visible_x
)
8295 /* Glyph is visible. Increment number of glyphs that
8296 would be displayed. */
8301 if (result
!= MOVE_UNDEFINED
)
8304 else if (BUFFER_POS_REACHED_P ())
8307 IT_RESET_X_ASCENT_DESCENT (it
);
8308 result
= MOVE_POS_MATCH_OR_ZV
;
8311 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8313 /* Stop when TO_X specified and reached. This check is
8314 necessary here because of lines consisting of a line end,
8315 only. The line end will not produce any glyphs and we
8316 would never get MOVE_X_REACHED. */
8317 xassert (it
->nglyphs
== 0);
8318 result
= MOVE_X_REACHED
;
8322 /* Is this a line end? If yes, we're done. */
8323 if (ITERATOR_AT_END_OF_LINE_P (it
))
8325 /* If we are past TO_CHARPOS, but never saw any character
8326 positions smaller than TO_CHARPOS, return
8327 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8329 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8331 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8333 if (IT_CHARPOS (ppos_it
) < ZV
)
8335 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8336 result
= MOVE_POS_MATCH_OR_ZV
;
8339 goto buffer_pos_reached
;
8341 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8342 && IT_CHARPOS (*it
) > to_charpos
)
8343 goto buffer_pos_reached
;
8345 result
= MOVE_NEWLINE_OR_CR
;
8348 result
= MOVE_NEWLINE_OR_CR
;
8352 prev_method
= it
->method
;
8353 if (it
->method
== GET_FROM_BUFFER
)
8354 prev_pos
= IT_CHARPOS (*it
);
8355 /* The current display element has been consumed. Advance
8357 set_iterator_to_next (it
, 1);
8358 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8359 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8360 if (IT_CHARPOS (*it
) < to_charpos
)
8361 saw_smaller_pos
= 1;
8363 && (op
& MOVE_TO_POS
)
8364 && IT_CHARPOS (*it
) >= to_charpos
8365 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8366 SAVE_IT (ppos_it
, *it
, ppos_data
);
8368 /* Stop if lines are truncated and IT's current x-position is
8369 past the right edge of the window now. */
8370 if (it
->line_wrap
== TRUNCATE
8371 && it
->current_x
>= it
->last_visible_x
)
8373 if (!FRAME_WINDOW_P (it
->f
)
8374 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8378 if ((at_eob_p
= !get_next_display_element (it
))
8379 || BUFFER_POS_REACHED_P ()
8380 /* If we are past TO_CHARPOS, but never saw any
8381 character positions smaller than TO_CHARPOS,
8382 return MOVE_POS_MATCH_OR_ZV, like the
8383 unidirectional display did. */
8384 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8386 && IT_CHARPOS (*it
) > to_charpos
))
8389 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8390 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8391 result
= MOVE_POS_MATCH_OR_ZV
;
8394 if (ITERATOR_AT_END_OF_LINE_P (it
))
8396 result
= MOVE_NEWLINE_OR_CR
;
8400 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8402 && IT_CHARPOS (*it
) > to_charpos
)
8404 if (IT_CHARPOS (ppos_it
) < ZV
)
8405 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8406 result
= MOVE_POS_MATCH_OR_ZV
;
8409 result
= MOVE_LINE_TRUNCATED
;
8412 #undef IT_RESET_X_ASCENT_DESCENT
8415 #undef BUFFER_POS_REACHED_P
8417 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8418 restore the saved iterator. */
8419 if (atpos_it
.sp
>= 0)
8420 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8421 else if (atx_it
.sp
>= 0)
8422 RESTORE_IT (it
, &atx_it
, atx_data
);
8427 bidi_unshelve_cache (atpos_data
, 1);
8429 bidi_unshelve_cache (atx_data
, 1);
8431 bidi_unshelve_cache (wrap_data
, 1);
8433 bidi_unshelve_cache (ppos_data
, 1);
8435 /* Restore the iterator settings altered at the beginning of this
8437 it
->glyph_row
= saved_glyph_row
;
8441 /* For external use. */
8443 move_it_in_display_line (struct it
*it
,
8444 EMACS_INT to_charpos
, int to_x
,
8445 enum move_operation_enum op
)
8447 if (it
->line_wrap
== WORD_WRAP
8448 && (op
& MOVE_TO_X
))
8451 void *save_data
= NULL
;
8454 SAVE_IT (save_it
, *it
, save_data
);
8455 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8456 /* When word-wrap is on, TO_X may lie past the end
8457 of a wrapped line. Then it->current is the
8458 character on the next line, so backtrack to the
8459 space before the wrap point. */
8460 if (skip
== MOVE_LINE_CONTINUED
)
8462 int prev_x
= max (it
->current_x
- 1, 0);
8463 RESTORE_IT (it
, &save_it
, save_data
);
8464 move_it_in_display_line_to
8465 (it
, -1, prev_x
, MOVE_TO_X
);
8468 bidi_unshelve_cache (save_data
, 1);
8471 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8475 /* Move IT forward until it satisfies one or more of the criteria in
8476 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8478 OP is a bit-mask that specifies where to stop, and in particular,
8479 which of those four position arguments makes a difference. See the
8480 description of enum move_operation_enum.
8482 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8483 screen line, this function will set IT to the next position that is
8484 displayed to the right of TO_CHARPOS on the screen. */
8487 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8489 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8490 int line_height
, line_start_x
= 0, reached
= 0;
8491 void *backup_data
= NULL
;
8495 if (op
& MOVE_TO_VPOS
)
8497 /* If no TO_CHARPOS and no TO_X specified, stop at the
8498 start of the line TO_VPOS. */
8499 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8501 if (it
->vpos
== to_vpos
)
8507 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8511 /* TO_VPOS >= 0 means stop at TO_X in the line at
8512 TO_VPOS, or at TO_POS, whichever comes first. */
8513 if (it
->vpos
== to_vpos
)
8519 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8521 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8526 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8528 /* We have reached TO_X but not in the line we want. */
8529 skip
= move_it_in_display_line_to (it
, to_charpos
,
8531 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8539 else if (op
& MOVE_TO_Y
)
8541 struct it it_backup
;
8543 if (it
->line_wrap
== WORD_WRAP
)
8544 SAVE_IT (it_backup
, *it
, backup_data
);
8546 /* TO_Y specified means stop at TO_X in the line containing
8547 TO_Y---or at TO_CHARPOS if this is reached first. The
8548 problem is that we can't really tell whether the line
8549 contains TO_Y before we have completely scanned it, and
8550 this may skip past TO_X. What we do is to first scan to
8553 If TO_X is not specified, use a TO_X of zero. The reason
8554 is to make the outcome of this function more predictable.
8555 If we didn't use TO_X == 0, we would stop at the end of
8556 the line which is probably not what a caller would expect
8558 skip
= move_it_in_display_line_to
8559 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8560 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8562 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8563 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8565 else if (skip
== MOVE_X_REACHED
)
8567 /* If TO_X was reached, we want to know whether TO_Y is
8568 in the line. We know this is the case if the already
8569 scanned glyphs make the line tall enough. Otherwise,
8570 we must check by scanning the rest of the line. */
8571 line_height
= it
->max_ascent
+ it
->max_descent
;
8572 if (to_y
>= it
->current_y
8573 && to_y
< it
->current_y
+ line_height
)
8578 SAVE_IT (it_backup
, *it
, backup_data
);
8579 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8580 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8582 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8583 line_height
= it
->max_ascent
+ it
->max_descent
;
8584 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8586 if (to_y
>= it
->current_y
8587 && to_y
< it
->current_y
+ line_height
)
8589 /* If TO_Y is in this line and TO_X was reached
8590 above, we scanned too far. We have to restore
8591 IT's settings to the ones before skipping. */
8592 RESTORE_IT (it
, &it_backup
, backup_data
);
8598 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8604 /* Check whether TO_Y is in this line. */
8605 line_height
= it
->max_ascent
+ it
->max_descent
;
8606 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8608 if (to_y
>= it
->current_y
8609 && to_y
< it
->current_y
+ line_height
)
8611 /* When word-wrap is on, TO_X may lie past the end
8612 of a wrapped line. Then it->current is the
8613 character on the next line, so backtrack to the
8614 space before the wrap point. */
8615 if (skip
== MOVE_LINE_CONTINUED
8616 && it
->line_wrap
== WORD_WRAP
)
8618 int prev_x
= max (it
->current_x
- 1, 0);
8619 RESTORE_IT (it
, &it_backup
, backup_data
);
8620 skip
= move_it_in_display_line_to
8621 (it
, -1, prev_x
, MOVE_TO_X
);
8630 else if (BUFFERP (it
->object
)
8631 && (it
->method
== GET_FROM_BUFFER
8632 || it
->method
== GET_FROM_STRETCH
)
8633 && IT_CHARPOS (*it
) >= to_charpos
8634 /* Under bidi iteration, a call to set_iterator_to_next
8635 can scan far beyond to_charpos if the initial
8636 portion of the next line needs to be reordered. In
8637 that case, give move_it_in_display_line_to another
8640 && it
->bidi_it
.scan_dir
== -1))
8641 skip
= MOVE_POS_MATCH_OR_ZV
;
8643 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8647 case MOVE_POS_MATCH_OR_ZV
:
8651 case MOVE_NEWLINE_OR_CR
:
8652 set_iterator_to_next (it
, 1);
8653 it
->continuation_lines_width
= 0;
8656 case MOVE_LINE_TRUNCATED
:
8657 it
->continuation_lines_width
= 0;
8658 reseat_at_next_visible_line_start (it
, 0);
8659 if ((op
& MOVE_TO_POS
) != 0
8660 && IT_CHARPOS (*it
) > to_charpos
)
8667 case MOVE_LINE_CONTINUED
:
8668 /* For continued lines ending in a tab, some of the glyphs
8669 associated with the tab are displayed on the current
8670 line. Since it->current_x does not include these glyphs,
8671 we use it->last_visible_x instead. */
8674 it
->continuation_lines_width
+= it
->last_visible_x
;
8675 /* When moving by vpos, ensure that the iterator really
8676 advances to the next line (bug#847, bug#969). Fixme:
8677 do we need to do this in other circumstances? */
8678 if (it
->current_x
!= it
->last_visible_x
8679 && (op
& MOVE_TO_VPOS
)
8680 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8682 line_start_x
= it
->current_x
+ it
->pixel_width
8683 - it
->last_visible_x
;
8684 set_iterator_to_next (it
, 0);
8688 it
->continuation_lines_width
+= it
->current_x
;
8695 /* Reset/increment for the next run. */
8696 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8697 it
->current_x
= line_start_x
;
8700 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8702 last_height
= it
->max_ascent
+ it
->max_descent
;
8703 last_max_ascent
= it
->max_ascent
;
8704 it
->max_ascent
= it
->max_descent
= 0;
8709 /* On text terminals, we may stop at the end of a line in the middle
8710 of a multi-character glyph. If the glyph itself is continued,
8711 i.e. it is actually displayed on the next line, don't treat this
8712 stopping point as valid; move to the next line instead (unless
8713 that brings us offscreen). */
8714 if (!FRAME_WINDOW_P (it
->f
)
8716 && IT_CHARPOS (*it
) == to_charpos
8717 && it
->what
== IT_CHARACTER
8719 && it
->line_wrap
== WINDOW_WRAP
8720 && it
->current_x
== it
->last_visible_x
- 1
8723 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8725 it
->continuation_lines_width
+= it
->current_x
;
8726 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8727 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8729 last_height
= it
->max_ascent
+ it
->max_descent
;
8730 last_max_ascent
= it
->max_ascent
;
8734 bidi_unshelve_cache (backup_data
, 1);
8736 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8740 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8742 If DY > 0, move IT backward at least that many pixels. DY = 0
8743 means move IT backward to the preceding line start or BEGV. This
8744 function may move over more than DY pixels if IT->current_y - DY
8745 ends up in the middle of a line; in this case IT->current_y will be
8746 set to the top of the line moved to. */
8749 move_it_vertically_backward (struct it
*it
, int dy
)
8753 void *it2data
= NULL
, *it3data
= NULL
;
8754 EMACS_INT start_pos
;
8759 start_pos
= IT_CHARPOS (*it
);
8761 /* Estimate how many newlines we must move back. */
8762 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8764 /* Set the iterator's position that many lines back. */
8765 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8766 back_to_previous_visible_line_start (it
);
8768 /* Reseat the iterator here. When moving backward, we don't want
8769 reseat to skip forward over invisible text, set up the iterator
8770 to deliver from overlay strings at the new position etc. So,
8771 use reseat_1 here. */
8772 reseat_1 (it
, it
->current
.pos
, 1);
8774 /* We are now surely at a line start. */
8775 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8776 reordering is in effect. */
8777 it
->continuation_lines_width
= 0;
8779 /* Move forward and see what y-distance we moved. First move to the
8780 start of the next line so that we get its height. We need this
8781 height to be able to tell whether we reached the specified
8783 SAVE_IT (it2
, *it
, it2data
);
8784 it2
.max_ascent
= it2
.max_descent
= 0;
8787 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8788 MOVE_TO_POS
| MOVE_TO_VPOS
);
8790 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8791 /* If we are in a display string which starts at START_POS,
8792 and that display string includes a newline, and we are
8793 right after that newline (i.e. at the beginning of a
8794 display line), exit the loop, because otherwise we will
8795 infloop, since move_it_to will see that it is already at
8796 START_POS and will not move. */
8797 || (it2
.method
== GET_FROM_STRING
8798 && IT_CHARPOS (it2
) == start_pos
8799 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8800 xassert (IT_CHARPOS (*it
) >= BEGV
);
8801 SAVE_IT (it3
, it2
, it3data
);
8803 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8804 xassert (IT_CHARPOS (*it
) >= BEGV
);
8805 /* H is the actual vertical distance from the position in *IT
8806 and the starting position. */
8807 h
= it2
.current_y
- it
->current_y
;
8808 /* NLINES is the distance in number of lines. */
8809 nlines
= it2
.vpos
- it
->vpos
;
8811 /* Correct IT's y and vpos position
8812 so that they are relative to the starting point. */
8818 /* DY == 0 means move to the start of the screen line. The
8819 value of nlines is > 0 if continuation lines were involved,
8820 or if the original IT position was at start of a line. */
8821 RESTORE_IT (it
, it
, it2data
);
8823 move_it_by_lines (it
, nlines
);
8824 /* The above code moves us to some position NLINES down,
8825 usually to its first glyph (leftmost in an L2R line), but
8826 that's not necessarily the start of the line, under bidi
8827 reordering. We want to get to the character position
8828 that is immediately after the newline of the previous
8831 && !it
->continuation_lines_width
8832 && !STRINGP (it
->string
)
8833 && IT_CHARPOS (*it
) > BEGV
8834 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8837 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8839 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8841 bidi_unshelve_cache (it3data
, 1);
8845 /* The y-position we try to reach, relative to *IT.
8846 Note that H has been subtracted in front of the if-statement. */
8847 int target_y
= it
->current_y
+ h
- dy
;
8848 int y0
= it3
.current_y
;
8852 RESTORE_IT (&it3
, &it3
, it3data
);
8853 y1
= line_bottom_y (&it3
);
8854 line_height
= y1
- y0
;
8855 RESTORE_IT (it
, it
, it2data
);
8856 /* If we did not reach target_y, try to move further backward if
8857 we can. If we moved too far backward, try to move forward. */
8858 if (target_y
< it
->current_y
8859 /* This is heuristic. In a window that's 3 lines high, with
8860 a line height of 13 pixels each, recentering with point
8861 on the bottom line will try to move -39/2 = 19 pixels
8862 backward. Try to avoid moving into the first line. */
8863 && (it
->current_y
- target_y
8864 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8865 && IT_CHARPOS (*it
) > BEGV
)
8867 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8868 target_y
- it
->current_y
));
8869 dy
= it
->current_y
- target_y
;
8870 goto move_further_back
;
8872 else if (target_y
>= it
->current_y
+ line_height
8873 && IT_CHARPOS (*it
) < ZV
)
8875 /* Should move forward by at least one line, maybe more.
8877 Note: Calling move_it_by_lines can be expensive on
8878 terminal frames, where compute_motion is used (via
8879 vmotion) to do the job, when there are very long lines
8880 and truncate-lines is nil. That's the reason for
8881 treating terminal frames specially here. */
8883 if (!FRAME_WINDOW_P (it
->f
))
8884 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8889 move_it_by_lines (it
, 1);
8891 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8898 /* Move IT by a specified amount of pixel lines DY. DY negative means
8899 move backwards. DY = 0 means move to start of screen line. At the
8900 end, IT will be on the start of a screen line. */
8903 move_it_vertically (struct it
*it
, int dy
)
8906 move_it_vertically_backward (it
, -dy
);
8909 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8910 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8911 MOVE_TO_POS
| MOVE_TO_Y
);
8912 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8914 /* If buffer ends in ZV without a newline, move to the start of
8915 the line to satisfy the post-condition. */
8916 if (IT_CHARPOS (*it
) == ZV
8918 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8919 move_it_by_lines (it
, 0);
8924 /* Move iterator IT past the end of the text line it is in. */
8927 move_it_past_eol (struct it
*it
)
8929 enum move_it_result rc
;
8931 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8932 if (rc
== MOVE_NEWLINE_OR_CR
)
8933 set_iterator_to_next (it
, 0);
8937 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8938 negative means move up. DVPOS == 0 means move to the start of the
8941 Optimization idea: If we would know that IT->f doesn't use
8942 a face with proportional font, we could be faster for
8943 truncate-lines nil. */
8946 move_it_by_lines (struct it
*it
, int dvpos
)
8949 /* The commented-out optimization uses vmotion on terminals. This
8950 gives bad results, because elements like it->what, on which
8951 callers such as pos_visible_p rely, aren't updated. */
8952 /* struct position pos;
8953 if (!FRAME_WINDOW_P (it->f))
8955 struct text_pos textpos;
8957 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8958 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8959 reseat (it, textpos, 1);
8960 it->vpos += pos.vpos;
8961 it->current_y += pos.vpos;
8967 /* DVPOS == 0 means move to the start of the screen line. */
8968 move_it_vertically_backward (it
, 0);
8969 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8970 /* Let next call to line_bottom_y calculate real line height */
8975 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8976 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8977 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8982 void *it2data
= NULL
;
8983 EMACS_INT start_charpos
, i
;
8985 /* Start at the beginning of the screen line containing IT's
8986 position. This may actually move vertically backwards,
8987 in case of overlays, so adjust dvpos accordingly. */
8989 move_it_vertically_backward (it
, 0);
8992 /* Go back -DVPOS visible lines and reseat the iterator there. */
8993 start_charpos
= IT_CHARPOS (*it
);
8994 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8995 back_to_previous_visible_line_start (it
);
8996 reseat (it
, it
->current
.pos
, 1);
8998 /* Move further back if we end up in a string or an image. */
8999 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9001 /* First try to move to start of display line. */
9003 move_it_vertically_backward (it
, 0);
9005 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9007 /* If start of line is still in string or image,
9008 move further back. */
9009 back_to_previous_visible_line_start (it
);
9010 reseat (it
, it
->current
.pos
, 1);
9014 it
->current_x
= it
->hpos
= 0;
9016 /* Above call may have moved too far if continuation lines
9017 are involved. Scan forward and see if it did. */
9018 SAVE_IT (it2
, *it
, it2data
);
9019 it2
.vpos
= it2
.current_y
= 0;
9020 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9021 it
->vpos
-= it2
.vpos
;
9022 it
->current_y
-= it2
.current_y
;
9023 it
->current_x
= it
->hpos
= 0;
9025 /* If we moved too far back, move IT some lines forward. */
9026 if (it2
.vpos
> -dvpos
)
9028 int delta
= it2
.vpos
+ dvpos
;
9030 RESTORE_IT (&it2
, &it2
, it2data
);
9031 SAVE_IT (it2
, *it
, it2data
);
9032 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9033 /* Move back again if we got too far ahead. */
9034 if (IT_CHARPOS (*it
) >= start_charpos
)
9035 RESTORE_IT (it
, &it2
, it2data
);
9037 bidi_unshelve_cache (it2data
, 1);
9040 RESTORE_IT (it
, it
, it2data
);
9044 /* Return 1 if IT points into the middle of a display vector. */
9047 in_display_vector_p (struct it
*it
)
9049 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9050 && it
->current
.dpvec_index
> 0
9051 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9055 /***********************************************************************
9057 ***********************************************************************/
9060 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9064 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9066 Lisp_Object args
[3];
9067 Lisp_Object msg
, fmt
;
9070 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9073 /* Do nothing if called asynchronously. Inserting text into
9074 a buffer may call after-change-functions and alike and
9075 that would means running Lisp asynchronously. */
9076 if (handling_signal
)
9080 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9082 args
[0] = fmt
= build_string (format
);
9085 msg
= Fformat (3, args
);
9087 len
= SBYTES (msg
) + 1;
9088 SAFE_ALLOCA (buffer
, char *, len
);
9089 memcpy (buffer
, SDATA (msg
), len
);
9091 message_dolog (buffer
, len
- 1, 1, 0);
9098 /* Output a newline in the *Messages* buffer if "needs" one. */
9101 message_log_maybe_newline (void)
9103 if (message_log_need_newline
)
9104 message_dolog ("", 0, 1, 0);
9108 /* Add a string M of length NBYTES to the message log, optionally
9109 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9110 nonzero, means interpret the contents of M as multibyte. This
9111 function calls low-level routines in order to bypass text property
9112 hooks, etc. which might not be safe to run.
9114 This may GC (insert may run before/after change hooks),
9115 so the buffer M must NOT point to a Lisp string. */
9118 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9120 const unsigned char *msg
= (const unsigned char *) m
;
9122 if (!NILP (Vmemory_full
))
9125 if (!NILP (Vmessage_log_max
))
9127 struct buffer
*oldbuf
;
9128 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9129 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9130 EMACS_INT point_at_end
= 0;
9131 EMACS_INT zv_at_end
= 0;
9132 Lisp_Object old_deactivate_mark
, tem
;
9133 struct gcpro gcpro1
;
9135 old_deactivate_mark
= Vdeactivate_mark
;
9136 oldbuf
= current_buffer
;
9137 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9138 BVAR (current_buffer
, undo_list
) = Qt
;
9140 oldpoint
= message_dolog_marker1
;
9141 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9142 oldbegv
= message_dolog_marker2
;
9143 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9144 oldzv
= message_dolog_marker3
;
9145 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9146 GCPRO1 (old_deactivate_mark
);
9154 BEGV_BYTE
= BEG_BYTE
;
9157 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9159 /* Insert the string--maybe converting multibyte to single byte
9160 or vice versa, so that all the text fits the buffer. */
9162 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9168 /* Convert a multibyte string to single-byte
9169 for the *Message* buffer. */
9170 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9172 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9173 work
[0] = (ASCII_CHAR_P (c
)
9175 : multibyte_char_to_unibyte (c
));
9176 insert_1_both (work
, 1, 1, 1, 0, 0);
9179 else if (! multibyte
9180 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9184 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9185 /* Convert a single-byte string to multibyte
9186 for the *Message* buffer. */
9187 for (i
= 0; i
< nbytes
; i
++)
9190 MAKE_CHAR_MULTIBYTE (c
);
9191 char_bytes
= CHAR_STRING (c
, str
);
9192 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9196 insert_1 (m
, nbytes
, 1, 0, 0);
9200 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9202 insert_1 ("\n", 1, 1, 0, 0);
9204 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9206 this_bol_byte
= PT_BYTE
;
9208 /* See if this line duplicates the previous one.
9209 If so, combine duplicates. */
9212 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9214 prev_bol_byte
= PT_BYTE
;
9216 dups
= message_log_check_duplicate (prev_bol_byte
,
9220 del_range_both (prev_bol
, prev_bol_byte
,
9221 this_bol
, this_bol_byte
, 0);
9224 char dupstr
[sizeof " [ times]"
9225 + INT_STRLEN_BOUND (printmax_t
)];
9228 /* If you change this format, don't forget to also
9229 change message_log_check_duplicate. */
9230 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9231 duplen
= strlen (dupstr
);
9232 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9233 insert_1 (dupstr
, duplen
, 1, 0, 1);
9238 /* If we have more than the desired maximum number of lines
9239 in the *Messages* buffer now, delete the oldest ones.
9240 This is safe because we don't have undo in this buffer. */
9242 if (NATNUMP (Vmessage_log_max
))
9244 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9245 -XFASTINT (Vmessage_log_max
) - 1, 0);
9246 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9249 BEGV
= XMARKER (oldbegv
)->charpos
;
9250 BEGV_BYTE
= marker_byte_position (oldbegv
);
9259 ZV
= XMARKER (oldzv
)->charpos
;
9260 ZV_BYTE
= marker_byte_position (oldzv
);
9264 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9266 /* We can't do Fgoto_char (oldpoint) because it will run some
9268 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9269 XMARKER (oldpoint
)->bytepos
);
9272 unchain_marker (XMARKER (oldpoint
));
9273 unchain_marker (XMARKER (oldbegv
));
9274 unchain_marker (XMARKER (oldzv
));
9276 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9277 set_buffer_internal (oldbuf
);
9279 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9280 message_log_need_newline
= !nlflag
;
9281 Vdeactivate_mark
= old_deactivate_mark
;
9286 /* We are at the end of the buffer after just having inserted a newline.
9287 (Note: We depend on the fact we won't be crossing the gap.)
9288 Check to see if the most recent message looks a lot like the previous one.
9289 Return 0 if different, 1 if the new one should just replace it, or a
9290 value N > 1 if we should also append " [N times]". */
9293 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9296 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9298 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9299 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9301 for (i
= 0; i
< len
; i
++)
9303 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9311 if (*p1
++ == ' ' && *p1
++ == '[')
9314 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9315 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9322 /* Display an echo area message M with a specified length of NBYTES
9323 bytes. The string may include null characters. If M is 0, clear
9324 out any existing message, and let the mini-buffer text show
9327 This may GC, so the buffer M must NOT point to a Lisp string. */
9330 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9332 /* First flush out any partial line written with print. */
9333 message_log_maybe_newline ();
9335 message_dolog (m
, nbytes
, 1, multibyte
);
9336 message2_nolog (m
, nbytes
, multibyte
);
9340 /* The non-logging counterpart of message2. */
9343 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9345 struct frame
*sf
= SELECTED_FRAME ();
9346 message_enable_multibyte
= multibyte
;
9348 if (FRAME_INITIAL_P (sf
))
9350 if (noninteractive_need_newline
)
9351 putc ('\n', stderr
);
9352 noninteractive_need_newline
= 0;
9354 fwrite (m
, nbytes
, 1, stderr
);
9355 if (cursor_in_echo_area
== 0)
9356 fprintf (stderr
, "\n");
9359 /* A null message buffer means that the frame hasn't really been
9360 initialized yet. Error messages get reported properly by
9361 cmd_error, so this must be just an informative message; toss it. */
9362 else if (INTERACTIVE
9363 && sf
->glyphs_initialized_p
9364 && FRAME_MESSAGE_BUF (sf
))
9366 Lisp_Object mini_window
;
9369 /* Get the frame containing the mini-buffer
9370 that the selected frame is using. */
9371 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9372 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9374 FRAME_SAMPLE_VISIBILITY (f
);
9375 if (FRAME_VISIBLE_P (sf
)
9376 && ! FRAME_VISIBLE_P (f
))
9377 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9381 set_message (m
, Qnil
, nbytes
, multibyte
);
9382 if (minibuffer_auto_raise
)
9383 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9386 clear_message (1, 1);
9388 do_pending_window_change (0);
9389 echo_area_display (1);
9390 do_pending_window_change (0);
9391 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9392 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9397 /* Display an echo area message M with a specified length of NBYTES
9398 bytes. The string may include null characters. If M is not a
9399 string, clear out any existing message, and let the mini-buffer
9402 This function cancels echoing. */
9405 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9407 struct gcpro gcpro1
;
9410 clear_message (1,1);
9413 /* First flush out any partial line written with print. */
9414 message_log_maybe_newline ();
9420 SAFE_ALLOCA (buffer
, char *, nbytes
);
9421 memcpy (buffer
, SDATA (m
), nbytes
);
9422 message_dolog (buffer
, nbytes
, 1, multibyte
);
9425 message3_nolog (m
, nbytes
, multibyte
);
9431 /* The non-logging version of message3.
9432 This does not cancel echoing, because it is used for echoing.
9433 Perhaps we need to make a separate function for echoing
9434 and make this cancel echoing. */
9437 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9439 struct frame
*sf
= SELECTED_FRAME ();
9440 message_enable_multibyte
= multibyte
;
9442 if (FRAME_INITIAL_P (sf
))
9444 if (noninteractive_need_newline
)
9445 putc ('\n', stderr
);
9446 noninteractive_need_newline
= 0;
9448 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9449 if (cursor_in_echo_area
== 0)
9450 fprintf (stderr
, "\n");
9453 /* A null message buffer means that the frame hasn't really been
9454 initialized yet. Error messages get reported properly by
9455 cmd_error, so this must be just an informative message; toss it. */
9456 else if (INTERACTIVE
9457 && sf
->glyphs_initialized_p
9458 && FRAME_MESSAGE_BUF (sf
))
9460 Lisp_Object mini_window
;
9464 /* Get the frame containing the mini-buffer
9465 that the selected frame is using. */
9466 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9467 frame
= XWINDOW (mini_window
)->frame
;
9470 FRAME_SAMPLE_VISIBILITY (f
);
9471 if (FRAME_VISIBLE_P (sf
)
9472 && !FRAME_VISIBLE_P (f
))
9473 Fmake_frame_visible (frame
);
9475 if (STRINGP (m
) && SCHARS (m
) > 0)
9477 set_message (NULL
, m
, nbytes
, multibyte
);
9478 if (minibuffer_auto_raise
)
9479 Fraise_frame (frame
);
9480 /* Assume we are not echoing.
9481 (If we are, echo_now will override this.) */
9482 echo_message_buffer
= Qnil
;
9485 clear_message (1, 1);
9487 do_pending_window_change (0);
9488 echo_area_display (1);
9489 do_pending_window_change (0);
9490 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9491 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9496 /* Display a null-terminated echo area message M. If M is 0, clear
9497 out any existing message, and let the mini-buffer text show through.
9499 The buffer M must continue to exist until after the echo area gets
9500 cleared or some other message gets displayed there. Do not pass
9501 text that is stored in a Lisp string. Do not pass text in a buffer
9502 that was alloca'd. */
9505 message1 (const char *m
)
9507 message2 (m
, (m
? strlen (m
) : 0), 0);
9511 /* The non-logging counterpart of message1. */
9514 message1_nolog (const char *m
)
9516 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9519 /* Display a message M which contains a single %s
9520 which gets replaced with STRING. */
9523 message_with_string (const char *m
, Lisp_Object string
, int log
)
9525 CHECK_STRING (string
);
9531 if (noninteractive_need_newline
)
9532 putc ('\n', stderr
);
9533 noninteractive_need_newline
= 0;
9534 fprintf (stderr
, m
, SDATA (string
));
9535 if (!cursor_in_echo_area
)
9536 fprintf (stderr
, "\n");
9540 else if (INTERACTIVE
)
9542 /* The frame whose minibuffer we're going to display the message on.
9543 It may be larger than the selected frame, so we need
9544 to use its buffer, not the selected frame's buffer. */
9545 Lisp_Object mini_window
;
9546 struct frame
*f
, *sf
= SELECTED_FRAME ();
9548 /* Get the frame containing the minibuffer
9549 that the selected frame is using. */
9550 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9551 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9553 /* A null message buffer means that the frame hasn't really been
9554 initialized yet. Error messages get reported properly by
9555 cmd_error, so this must be just an informative message; toss it. */
9556 if (FRAME_MESSAGE_BUF (f
))
9558 Lisp_Object args
[2], msg
;
9559 struct gcpro gcpro1
, gcpro2
;
9561 args
[0] = build_string (m
);
9562 args
[1] = msg
= string
;
9563 GCPRO2 (args
[0], msg
);
9566 msg
= Fformat (2, args
);
9569 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9571 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9575 /* Print should start at the beginning of the message
9576 buffer next time. */
9577 message_buf_print
= 0;
9583 /* Dump an informative message to the minibuf. If M is 0, clear out
9584 any existing message, and let the mini-buffer text show through. */
9587 vmessage (const char *m
, va_list ap
)
9593 if (noninteractive_need_newline
)
9594 putc ('\n', stderr
);
9595 noninteractive_need_newline
= 0;
9596 vfprintf (stderr
, m
, ap
);
9597 if (cursor_in_echo_area
== 0)
9598 fprintf (stderr
, "\n");
9602 else if (INTERACTIVE
)
9604 /* The frame whose mini-buffer we're going to display the message
9605 on. It may be larger than the selected frame, so we need to
9606 use its buffer, not the selected frame's buffer. */
9607 Lisp_Object mini_window
;
9608 struct frame
*f
, *sf
= SELECTED_FRAME ();
9610 /* Get the frame containing the mini-buffer
9611 that the selected frame is using. */
9612 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9613 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9615 /* A null message buffer means that the frame hasn't really been
9616 initialized yet. Error messages get reported properly by
9617 cmd_error, so this must be just an informative message; toss
9619 if (FRAME_MESSAGE_BUF (f
))
9625 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9626 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9628 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9633 /* Print should start at the beginning of the message
9634 buffer next time. */
9635 message_buf_print
= 0;
9641 message (const char *m
, ...)
9651 /* The non-logging version of message. */
9654 message_nolog (const char *m
, ...)
9656 Lisp_Object old_log_max
;
9659 old_log_max
= Vmessage_log_max
;
9660 Vmessage_log_max
= Qnil
;
9662 Vmessage_log_max
= old_log_max
;
9668 /* Display the current message in the current mini-buffer. This is
9669 only called from error handlers in process.c, and is not time
9673 update_echo_area (void)
9675 if (!NILP (echo_area_buffer
[0]))
9678 string
= Fcurrent_message ();
9679 message3 (string
, SBYTES (string
),
9680 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9685 /* Make sure echo area buffers in `echo_buffers' are live.
9686 If they aren't, make new ones. */
9689 ensure_echo_area_buffers (void)
9693 for (i
= 0; i
< 2; ++i
)
9694 if (!BUFFERP (echo_buffer
[i
])
9695 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9698 Lisp_Object old_buffer
;
9701 old_buffer
= echo_buffer
[i
];
9702 sprintf (name
, " *Echo Area %d*", i
);
9703 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9704 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9705 /* to force word wrap in echo area -
9706 it was decided to postpone this*/
9707 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9709 for (j
= 0; j
< 2; ++j
)
9710 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9711 echo_area_buffer
[j
] = echo_buffer
[i
];
9716 /* Call FN with args A1..A4 with either the current or last displayed
9717 echo_area_buffer as current buffer.
9719 WHICH zero means use the current message buffer
9720 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9721 from echo_buffer[] and clear it.
9723 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9724 suitable buffer from echo_buffer[] and clear it.
9726 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9727 that the current message becomes the last displayed one, make
9728 choose a suitable buffer for echo_area_buffer[0], and clear it.
9730 Value is what FN returns. */
9733 with_echo_area_buffer (struct window
*w
, int which
,
9734 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9735 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9738 int this_one
, the_other
, clear_buffer_p
, rc
;
9739 int count
= SPECPDL_INDEX ();
9741 /* If buffers aren't live, make new ones. */
9742 ensure_echo_area_buffers ();
9747 this_one
= 0, the_other
= 1;
9749 this_one
= 1, the_other
= 0;
9752 this_one
= 0, the_other
= 1;
9755 /* We need a fresh one in case the current echo buffer equals
9756 the one containing the last displayed echo area message. */
9757 if (!NILP (echo_area_buffer
[this_one
])
9758 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9759 echo_area_buffer
[this_one
] = Qnil
;
9762 /* Choose a suitable buffer from echo_buffer[] is we don't
9764 if (NILP (echo_area_buffer
[this_one
]))
9766 echo_area_buffer
[this_one
]
9767 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9768 ? echo_buffer
[the_other
]
9769 : echo_buffer
[this_one
]);
9773 buffer
= echo_area_buffer
[this_one
];
9775 /* Don't get confused by reusing the buffer used for echoing
9776 for a different purpose. */
9777 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9780 record_unwind_protect (unwind_with_echo_area_buffer
,
9781 with_echo_area_buffer_unwind_data (w
));
9783 /* Make the echo area buffer current. Note that for display
9784 purposes, it is not necessary that the displayed window's buffer
9785 == current_buffer, except for text property lookup. So, let's
9786 only set that buffer temporarily here without doing a full
9787 Fset_window_buffer. We must also change w->pointm, though,
9788 because otherwise an assertions in unshow_buffer fails, and Emacs
9790 set_buffer_internal_1 (XBUFFER (buffer
));
9794 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9797 BVAR (current_buffer
, undo_list
) = Qt
;
9798 BVAR (current_buffer
, read_only
) = Qnil
;
9799 specbind (Qinhibit_read_only
, Qt
);
9800 specbind (Qinhibit_modification_hooks
, Qt
);
9802 if (clear_buffer_p
&& Z
> BEG
)
9805 xassert (BEGV
>= BEG
);
9806 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9808 rc
= fn (a1
, a2
, a3
, a4
);
9810 xassert (BEGV
>= BEG
);
9811 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9813 unbind_to (count
, Qnil
);
9818 /* Save state that should be preserved around the call to the function
9819 FN called in with_echo_area_buffer. */
9822 with_echo_area_buffer_unwind_data (struct window
*w
)
9825 Lisp_Object vector
, tmp
;
9827 /* Reduce consing by keeping one vector in
9828 Vwith_echo_area_save_vector. */
9829 vector
= Vwith_echo_area_save_vector
;
9830 Vwith_echo_area_save_vector
= Qnil
;
9833 vector
= Fmake_vector (make_number (7), Qnil
);
9835 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9836 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9837 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9841 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9842 ASET (vector
, i
, w
->buffer
); ++i
;
9843 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9844 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9849 for (; i
< end
; ++i
)
9850 ASET (vector
, i
, Qnil
);
9853 xassert (i
== ASIZE (vector
));
9858 /* Restore global state from VECTOR which was created by
9859 with_echo_area_buffer_unwind_data. */
9862 unwind_with_echo_area_buffer (Lisp_Object vector
)
9864 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9865 Vdeactivate_mark
= AREF (vector
, 1);
9866 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9868 if (WINDOWP (AREF (vector
, 3)))
9871 Lisp_Object buffer
, charpos
, bytepos
;
9873 w
= XWINDOW (AREF (vector
, 3));
9874 buffer
= AREF (vector
, 4);
9875 charpos
= AREF (vector
, 5);
9876 bytepos
= AREF (vector
, 6);
9879 set_marker_both (w
->pointm
, buffer
,
9880 XFASTINT (charpos
), XFASTINT (bytepos
));
9883 Vwith_echo_area_save_vector
= vector
;
9888 /* Set up the echo area for use by print functions. MULTIBYTE_P
9889 non-zero means we will print multibyte. */
9892 setup_echo_area_for_printing (int multibyte_p
)
9894 /* If we can't find an echo area any more, exit. */
9895 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9898 ensure_echo_area_buffers ();
9900 if (!message_buf_print
)
9902 /* A message has been output since the last time we printed.
9903 Choose a fresh echo area buffer. */
9904 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9905 echo_area_buffer
[0] = echo_buffer
[1];
9907 echo_area_buffer
[0] = echo_buffer
[0];
9909 /* Switch to that buffer and clear it. */
9910 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9911 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9915 int count
= SPECPDL_INDEX ();
9916 specbind (Qinhibit_read_only
, Qt
);
9917 /* Note that undo recording is always disabled. */
9919 unbind_to (count
, Qnil
);
9921 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9923 /* Set up the buffer for the multibyteness we need. */
9925 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9926 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9928 /* Raise the frame containing the echo area. */
9929 if (minibuffer_auto_raise
)
9931 struct frame
*sf
= SELECTED_FRAME ();
9932 Lisp_Object mini_window
;
9933 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9934 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9937 message_log_maybe_newline ();
9938 message_buf_print
= 1;
9942 if (NILP (echo_area_buffer
[0]))
9944 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9945 echo_area_buffer
[0] = echo_buffer
[1];
9947 echo_area_buffer
[0] = echo_buffer
[0];
9950 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9952 /* Someone switched buffers between print requests. */
9953 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9954 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9960 /* Display an echo area message in window W. Value is non-zero if W's
9961 height is changed. If display_last_displayed_message_p is
9962 non-zero, display the message that was last displayed, otherwise
9963 display the current message. */
9966 display_echo_area (struct window
*w
)
9968 int i
, no_message_p
, window_height_changed_p
, count
;
9970 /* Temporarily disable garbage collections while displaying the echo
9971 area. This is done because a GC can print a message itself.
9972 That message would modify the echo area buffer's contents while a
9973 redisplay of the buffer is going on, and seriously confuse
9975 count
= inhibit_garbage_collection ();
9977 /* If there is no message, we must call display_echo_area_1
9978 nevertheless because it resizes the window. But we will have to
9979 reset the echo_area_buffer in question to nil at the end because
9980 with_echo_area_buffer will sets it to an empty buffer. */
9981 i
= display_last_displayed_message_p
? 1 : 0;
9982 no_message_p
= NILP (echo_area_buffer
[i
]);
9984 window_height_changed_p
9985 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9986 display_echo_area_1
,
9987 (intptr_t) w
, Qnil
, 0, 0);
9990 echo_area_buffer
[i
] = Qnil
;
9992 unbind_to (count
, Qnil
);
9993 return window_height_changed_p
;
9997 /* Helper for display_echo_area. Display the current buffer which
9998 contains the current echo area message in window W, a mini-window,
9999 a pointer to which is passed in A1. A2..A4 are currently not used.
10000 Change the height of W so that all of the message is displayed.
10001 Value is non-zero if height of W was changed. */
10004 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10007 struct window
*w
= (struct window
*) i1
;
10008 Lisp_Object window
;
10009 struct text_pos start
;
10010 int window_height_changed_p
= 0;
10012 /* Do this before displaying, so that we have a large enough glyph
10013 matrix for the display. If we can't get enough space for the
10014 whole text, display the last N lines. That works by setting w->start. */
10015 window_height_changed_p
= resize_mini_window (w
, 0);
10017 /* Use the starting position chosen by resize_mini_window. */
10018 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10021 clear_glyph_matrix (w
->desired_matrix
);
10022 XSETWINDOW (window
, w
);
10023 try_window (window
, start
, 0);
10025 return window_height_changed_p
;
10029 /* Resize the echo area window to exactly the size needed for the
10030 currently displayed message, if there is one. If a mini-buffer
10031 is active, don't shrink it. */
10034 resize_echo_area_exactly (void)
10036 if (BUFFERP (echo_area_buffer
[0])
10037 && WINDOWP (echo_area_window
))
10039 struct window
*w
= XWINDOW (echo_area_window
);
10041 Lisp_Object resize_exactly
;
10043 if (minibuf_level
== 0)
10044 resize_exactly
= Qt
;
10046 resize_exactly
= Qnil
;
10048 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10049 (intptr_t) w
, resize_exactly
,
10053 ++windows_or_buffers_changed
;
10054 ++update_mode_lines
;
10055 redisplay_internal ();
10061 /* Callback function for with_echo_area_buffer, when used from
10062 resize_echo_area_exactly. A1 contains a pointer to the window to
10063 resize, EXACTLY non-nil means resize the mini-window exactly to the
10064 size of the text displayed. A3 and A4 are not used. Value is what
10065 resize_mini_window returns. */
10068 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10071 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10075 /* Resize mini-window W to fit the size of its contents. EXACT_P
10076 means size the window exactly to the size needed. Otherwise, it's
10077 only enlarged until W's buffer is empty.
10079 Set W->start to the right place to begin display. If the whole
10080 contents fit, start at the beginning. Otherwise, start so as
10081 to make the end of the contents appear. This is particularly
10082 important for y-or-n-p, but seems desirable generally.
10084 Value is non-zero if the window height has been changed. */
10087 resize_mini_window (struct window
*w
, int exact_p
)
10089 struct frame
*f
= XFRAME (w
->frame
);
10090 int window_height_changed_p
= 0;
10092 xassert (MINI_WINDOW_P (w
));
10094 /* By default, start display at the beginning. */
10095 set_marker_both (w
->start
, w
->buffer
,
10096 BUF_BEGV (XBUFFER (w
->buffer
)),
10097 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10099 /* Don't resize windows while redisplaying a window; it would
10100 confuse redisplay functions when the size of the window they are
10101 displaying changes from under them. Such a resizing can happen,
10102 for instance, when which-func prints a long message while
10103 we are running fontification-functions. We're running these
10104 functions with safe_call which binds inhibit-redisplay to t. */
10105 if (!NILP (Vinhibit_redisplay
))
10108 /* Nil means don't try to resize. */
10109 if (NILP (Vresize_mini_windows
)
10110 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10113 if (!FRAME_MINIBUF_ONLY_P (f
))
10116 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10117 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10118 int height
, max_height
;
10119 int unit
= FRAME_LINE_HEIGHT (f
);
10120 struct text_pos start
;
10121 struct buffer
*old_current_buffer
= NULL
;
10123 if (current_buffer
!= XBUFFER (w
->buffer
))
10125 old_current_buffer
= current_buffer
;
10126 set_buffer_internal (XBUFFER (w
->buffer
));
10129 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10131 /* Compute the max. number of lines specified by the user. */
10132 if (FLOATP (Vmax_mini_window_height
))
10133 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10134 else if (INTEGERP (Vmax_mini_window_height
))
10135 max_height
= XINT (Vmax_mini_window_height
);
10137 max_height
= total_height
/ 4;
10139 /* Correct that max. height if it's bogus. */
10140 max_height
= max (1, max_height
);
10141 max_height
= min (total_height
, max_height
);
10143 /* Find out the height of the text in the window. */
10144 if (it
.line_wrap
== TRUNCATE
)
10149 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10150 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10151 height
= it
.current_y
+ last_height
;
10153 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10154 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10155 height
= (height
+ unit
- 1) / unit
;
10158 /* Compute a suitable window start. */
10159 if (height
> max_height
)
10161 height
= max_height
;
10162 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10163 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10164 start
= it
.current
.pos
;
10167 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10168 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10170 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10172 /* Let it grow only, until we display an empty message, in which
10173 case the window shrinks again. */
10174 if (height
> WINDOW_TOTAL_LINES (w
))
10176 int old_height
= WINDOW_TOTAL_LINES (w
);
10177 freeze_window_starts (f
, 1);
10178 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10179 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10181 else if (height
< WINDOW_TOTAL_LINES (w
)
10182 && (exact_p
|| BEGV
== ZV
))
10184 int old_height
= WINDOW_TOTAL_LINES (w
);
10185 freeze_window_starts (f
, 0);
10186 shrink_mini_window (w
);
10187 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10192 /* Always resize to exact size needed. */
10193 if (height
> WINDOW_TOTAL_LINES (w
))
10195 int old_height
= WINDOW_TOTAL_LINES (w
);
10196 freeze_window_starts (f
, 1);
10197 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10198 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10200 else if (height
< WINDOW_TOTAL_LINES (w
))
10202 int old_height
= WINDOW_TOTAL_LINES (w
);
10203 freeze_window_starts (f
, 0);
10204 shrink_mini_window (w
);
10208 freeze_window_starts (f
, 1);
10209 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10212 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10216 if (old_current_buffer
)
10217 set_buffer_internal (old_current_buffer
);
10220 return window_height_changed_p
;
10224 /* Value is the current message, a string, or nil if there is no
10225 current message. */
10228 current_message (void)
10232 if (!BUFFERP (echo_area_buffer
[0]))
10236 with_echo_area_buffer (0, 0, current_message_1
,
10237 (intptr_t) &msg
, Qnil
, 0, 0);
10239 echo_area_buffer
[0] = Qnil
;
10247 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10250 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10253 *msg
= make_buffer_string (BEG
, Z
, 1);
10260 /* Push the current message on Vmessage_stack for later restoration
10261 by restore_message. Value is non-zero if the current message isn't
10262 empty. This is a relatively infrequent operation, so it's not
10263 worth optimizing. */
10266 push_message (void)
10269 msg
= current_message ();
10270 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10271 return STRINGP (msg
);
10275 /* Restore message display from the top of Vmessage_stack. */
10278 restore_message (void)
10282 xassert (CONSP (Vmessage_stack
));
10283 msg
= XCAR (Vmessage_stack
);
10285 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10287 message3_nolog (msg
, 0, 0);
10291 /* Handler for record_unwind_protect calling pop_message. */
10294 pop_message_unwind (Lisp_Object dummy
)
10300 /* Pop the top-most entry off Vmessage_stack. */
10305 xassert (CONSP (Vmessage_stack
));
10306 Vmessage_stack
= XCDR (Vmessage_stack
);
10310 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10311 exits. If the stack is not empty, we have a missing pop_message
10315 check_message_stack (void)
10317 if (!NILP (Vmessage_stack
))
10322 /* Truncate to NCHARS what will be displayed in the echo area the next
10323 time we display it---but don't redisplay it now. */
10326 truncate_echo_area (EMACS_INT nchars
)
10329 echo_area_buffer
[0] = Qnil
;
10330 /* A null message buffer means that the frame hasn't really been
10331 initialized yet. Error messages get reported properly by
10332 cmd_error, so this must be just an informative message; toss it. */
10333 else if (!noninteractive
10335 && !NILP (echo_area_buffer
[0]))
10337 struct frame
*sf
= SELECTED_FRAME ();
10338 if (FRAME_MESSAGE_BUF (sf
))
10339 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10344 /* Helper function for truncate_echo_area. Truncate the current
10345 message to at most NCHARS characters. */
10348 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10350 if (BEG
+ nchars
< Z
)
10351 del_range (BEG
+ nchars
, Z
);
10353 echo_area_buffer
[0] = Qnil
;
10358 /* Set the current message to a substring of S or STRING.
10360 If STRING is a Lisp string, set the message to the first NBYTES
10361 bytes from STRING. NBYTES zero means use the whole string. If
10362 STRING is multibyte, the message will be displayed multibyte.
10364 If S is not null, set the message to the first LEN bytes of S. LEN
10365 zero means use the whole string. MULTIBYTE_P non-zero means S is
10366 multibyte. Display the message multibyte in that case.
10368 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10369 to t before calling set_message_1 (which calls insert).
10373 set_message (const char *s
, Lisp_Object string
,
10374 EMACS_INT nbytes
, int multibyte_p
)
10376 message_enable_multibyte
10377 = ((s
&& multibyte_p
)
10378 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10380 with_echo_area_buffer (0, -1, set_message_1
,
10381 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10382 message_buf_print
= 0;
10383 help_echo_showing_p
= 0;
10387 /* Helper function for set_message. Arguments have the same meaning
10388 as there, with A1 corresponding to S and A2 corresponding to STRING
10389 This function is called with the echo area buffer being
10393 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10396 const char *s
= (const char *) i1
;
10397 const unsigned char *msg
= (const unsigned char *) s
;
10398 Lisp_Object string
= a2
;
10400 /* Change multibyteness of the echo buffer appropriately. */
10401 if (message_enable_multibyte
10402 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10403 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10405 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10406 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10407 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10409 /* Insert new message at BEG. */
10410 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10412 if (STRINGP (string
))
10417 nbytes
= SBYTES (string
);
10418 nchars
= string_byte_to_char (string
, nbytes
);
10420 /* This function takes care of single/multibyte conversion. We
10421 just have to ensure that the echo area buffer has the right
10422 setting of enable_multibyte_characters. */
10423 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10428 nbytes
= strlen (s
);
10430 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10432 /* Convert from multi-byte to single-byte. */
10437 /* Convert a multibyte string to single-byte. */
10438 for (i
= 0; i
< nbytes
; i
+= n
)
10440 c
= string_char_and_length (msg
+ i
, &n
);
10441 work
[0] = (ASCII_CHAR_P (c
)
10443 : multibyte_char_to_unibyte (c
));
10444 insert_1_both (work
, 1, 1, 1, 0, 0);
10447 else if (!multibyte_p
10448 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10450 /* Convert from single-byte to multi-byte. */
10453 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10455 /* Convert a single-byte string to multibyte. */
10456 for (i
= 0; i
< nbytes
; i
++)
10459 MAKE_CHAR_MULTIBYTE (c
);
10460 n
= CHAR_STRING (c
, str
);
10461 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10465 insert_1 (s
, nbytes
, 1, 0, 0);
10472 /* Clear messages. CURRENT_P non-zero means clear the current
10473 message. LAST_DISPLAYED_P non-zero means clear the message
10477 clear_message (int current_p
, int last_displayed_p
)
10481 echo_area_buffer
[0] = Qnil
;
10482 message_cleared_p
= 1;
10485 if (last_displayed_p
)
10486 echo_area_buffer
[1] = Qnil
;
10488 message_buf_print
= 0;
10491 /* Clear garbaged frames.
10493 This function is used where the old redisplay called
10494 redraw_garbaged_frames which in turn called redraw_frame which in
10495 turn called clear_frame. The call to clear_frame was a source of
10496 flickering. I believe a clear_frame is not necessary. It should
10497 suffice in the new redisplay to invalidate all current matrices,
10498 and ensure a complete redisplay of all windows. */
10501 clear_garbaged_frames (void)
10503 if (frame_garbaged
)
10505 Lisp_Object tail
, frame
;
10506 int changed_count
= 0;
10508 FOR_EACH_FRAME (tail
, frame
)
10510 struct frame
*f
= XFRAME (frame
);
10512 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10516 Fredraw_frame (frame
);
10517 f
->force_flush_display_p
= 1;
10519 clear_current_matrices (f
);
10526 frame_garbaged
= 0;
10528 ++windows_or_buffers_changed
;
10533 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10534 is non-zero update selected_frame. Value is non-zero if the
10535 mini-windows height has been changed. */
10538 echo_area_display (int update_frame_p
)
10540 Lisp_Object mini_window
;
10543 int window_height_changed_p
= 0;
10544 struct frame
*sf
= SELECTED_FRAME ();
10546 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10547 w
= XWINDOW (mini_window
);
10548 f
= XFRAME (WINDOW_FRAME (w
));
10550 /* Don't display if frame is invisible or not yet initialized. */
10551 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10554 #ifdef HAVE_WINDOW_SYSTEM
10555 /* When Emacs starts, selected_frame may be the initial terminal
10556 frame. If we let this through, a message would be displayed on
10558 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10560 #endif /* HAVE_WINDOW_SYSTEM */
10562 /* Redraw garbaged frames. */
10563 if (frame_garbaged
)
10564 clear_garbaged_frames ();
10566 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10568 echo_area_window
= mini_window
;
10569 window_height_changed_p
= display_echo_area (w
);
10570 w
->must_be_updated_p
= 1;
10572 /* Update the display, unless called from redisplay_internal.
10573 Also don't update the screen during redisplay itself. The
10574 update will happen at the end of redisplay, and an update
10575 here could cause confusion. */
10576 if (update_frame_p
&& !redisplaying_p
)
10580 /* If the display update has been interrupted by pending
10581 input, update mode lines in the frame. Due to the
10582 pending input, it might have been that redisplay hasn't
10583 been called, so that mode lines above the echo area are
10584 garbaged. This looks odd, so we prevent it here. */
10585 if (!display_completed
)
10586 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10588 if (window_height_changed_p
10589 /* Don't do this if Emacs is shutting down. Redisplay
10590 needs to run hooks. */
10591 && !NILP (Vrun_hooks
))
10593 /* Must update other windows. Likewise as in other
10594 cases, don't let this update be interrupted by
10596 int count
= SPECPDL_INDEX ();
10597 specbind (Qredisplay_dont_pause
, Qt
);
10598 windows_or_buffers_changed
= 1;
10599 redisplay_internal ();
10600 unbind_to (count
, Qnil
);
10602 else if (FRAME_WINDOW_P (f
) && n
== 0)
10604 /* Window configuration is the same as before.
10605 Can do with a display update of the echo area,
10606 unless we displayed some mode lines. */
10607 update_single_window (w
, 1);
10608 FRAME_RIF (f
)->flush_display (f
);
10611 update_frame (f
, 1, 1);
10613 /* If cursor is in the echo area, make sure that the next
10614 redisplay displays the minibuffer, so that the cursor will
10615 be replaced with what the minibuffer wants. */
10616 if (cursor_in_echo_area
)
10617 ++windows_or_buffers_changed
;
10620 else if (!EQ (mini_window
, selected_window
))
10621 windows_or_buffers_changed
++;
10623 /* Last displayed message is now the current message. */
10624 echo_area_buffer
[1] = echo_area_buffer
[0];
10625 /* Inform read_char that we're not echoing. */
10626 echo_message_buffer
= Qnil
;
10628 /* Prevent redisplay optimization in redisplay_internal by resetting
10629 this_line_start_pos. This is done because the mini-buffer now
10630 displays the message instead of its buffer text. */
10631 if (EQ (mini_window
, selected_window
))
10632 CHARPOS (this_line_start_pos
) = 0;
10634 return window_height_changed_p
;
10639 /***********************************************************************
10640 Mode Lines and Frame Titles
10641 ***********************************************************************/
10643 /* A buffer for constructing non-propertized mode-line strings and
10644 frame titles in it; allocated from the heap in init_xdisp and
10645 resized as needed in store_mode_line_noprop_char. */
10647 static char *mode_line_noprop_buf
;
10649 /* The buffer's end, and a current output position in it. */
10651 static char *mode_line_noprop_buf_end
;
10652 static char *mode_line_noprop_ptr
;
10654 #define MODE_LINE_NOPROP_LEN(start) \
10655 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10658 MODE_LINE_DISPLAY
= 0,
10662 } mode_line_target
;
10664 /* Alist that caches the results of :propertize.
10665 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10666 static Lisp_Object mode_line_proptrans_alist
;
10668 /* List of strings making up the mode-line. */
10669 static Lisp_Object mode_line_string_list
;
10671 /* Base face property when building propertized mode line string. */
10672 static Lisp_Object mode_line_string_face
;
10673 static Lisp_Object mode_line_string_face_prop
;
10676 /* Unwind data for mode line strings */
10678 static Lisp_Object Vmode_line_unwind_vector
;
10681 format_mode_line_unwind_data (struct buffer
*obuf
,
10683 int save_proptrans
)
10685 Lisp_Object vector
, tmp
;
10687 /* Reduce consing by keeping one vector in
10688 Vwith_echo_area_save_vector. */
10689 vector
= Vmode_line_unwind_vector
;
10690 Vmode_line_unwind_vector
= Qnil
;
10693 vector
= Fmake_vector (make_number (8), Qnil
);
10695 ASET (vector
, 0, make_number (mode_line_target
));
10696 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10697 ASET (vector
, 2, mode_line_string_list
);
10698 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10699 ASET (vector
, 4, mode_line_string_face
);
10700 ASET (vector
, 5, mode_line_string_face_prop
);
10703 XSETBUFFER (tmp
, obuf
);
10706 ASET (vector
, 6, tmp
);
10707 ASET (vector
, 7, owin
);
10713 unwind_format_mode_line (Lisp_Object vector
)
10715 mode_line_target
= XINT (AREF (vector
, 0));
10716 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10717 mode_line_string_list
= AREF (vector
, 2);
10718 if (! EQ (AREF (vector
, 3), Qt
))
10719 mode_line_proptrans_alist
= AREF (vector
, 3);
10720 mode_line_string_face
= AREF (vector
, 4);
10721 mode_line_string_face_prop
= AREF (vector
, 5);
10723 if (!NILP (AREF (vector
, 7)))
10724 /* Select window before buffer, since it may change the buffer. */
10725 Fselect_window (AREF (vector
, 7), Qt
);
10727 if (!NILP (AREF (vector
, 6)))
10729 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10730 ASET (vector
, 6, Qnil
);
10733 Vmode_line_unwind_vector
= vector
;
10738 /* Store a single character C for the frame title in mode_line_noprop_buf.
10739 Re-allocate mode_line_noprop_buf if necessary. */
10742 store_mode_line_noprop_char (char c
)
10744 /* If output position has reached the end of the allocated buffer,
10745 increase the buffer's size. */
10746 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10748 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10749 ptrdiff_t size
= len
;
10750 mode_line_noprop_buf
=
10751 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10752 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10753 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10756 *mode_line_noprop_ptr
++ = c
;
10760 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10761 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10762 characters that yield more columns than PRECISION; PRECISION <= 0
10763 means copy the whole string. Pad with spaces until FIELD_WIDTH
10764 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10765 pad. Called from display_mode_element when it is used to build a
10769 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10771 const unsigned char *str
= (const unsigned char *) string
;
10773 EMACS_INT dummy
, nbytes
;
10775 /* Copy at most PRECISION chars from STR. */
10776 nbytes
= strlen (string
);
10777 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10779 store_mode_line_noprop_char (*str
++);
10781 /* Fill up with spaces until FIELD_WIDTH reached. */
10782 while (field_width
> 0
10783 && n
< field_width
)
10785 store_mode_line_noprop_char (' ');
10792 /***********************************************************************
10794 ***********************************************************************/
10796 #ifdef HAVE_WINDOW_SYSTEM
10798 /* Set the title of FRAME, if it has changed. The title format is
10799 Vicon_title_format if FRAME is iconified, otherwise it is
10800 frame_title_format. */
10803 x_consider_frame_title (Lisp_Object frame
)
10805 struct frame
*f
= XFRAME (frame
);
10807 if (FRAME_WINDOW_P (f
)
10808 || FRAME_MINIBUF_ONLY_P (f
)
10809 || f
->explicit_name
)
10811 /* Do we have more than one visible frame on this X display? */
10814 ptrdiff_t title_start
;
10818 int count
= SPECPDL_INDEX ();
10820 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10822 Lisp_Object other_frame
= XCAR (tail
);
10823 struct frame
*tf
= XFRAME (other_frame
);
10826 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10827 && !FRAME_MINIBUF_ONLY_P (tf
)
10828 && !EQ (other_frame
, tip_frame
)
10829 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10833 /* Set global variable indicating that multiple frames exist. */
10834 multiple_frames
= CONSP (tail
);
10836 /* Switch to the buffer of selected window of the frame. Set up
10837 mode_line_target so that display_mode_element will output into
10838 mode_line_noprop_buf; then display the title. */
10839 record_unwind_protect (unwind_format_mode_line
,
10840 format_mode_line_unwind_data
10841 (current_buffer
, selected_window
, 0));
10843 Fselect_window (f
->selected_window
, Qt
);
10844 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10845 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10847 mode_line_target
= MODE_LINE_TITLE
;
10848 title_start
= MODE_LINE_NOPROP_LEN (0);
10849 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10850 NULL
, DEFAULT_FACE_ID
);
10851 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10852 len
= MODE_LINE_NOPROP_LEN (title_start
);
10853 title
= mode_line_noprop_buf
+ title_start
;
10854 unbind_to (count
, Qnil
);
10856 /* Set the title only if it's changed. This avoids consing in
10857 the common case where it hasn't. (If it turns out that we've
10858 already wasted too much time by walking through the list with
10859 display_mode_element, then we might need to optimize at a
10860 higher level than this.) */
10861 if (! STRINGP (f
->name
)
10862 || SBYTES (f
->name
) != len
10863 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10864 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10868 #endif /* not HAVE_WINDOW_SYSTEM */
10873 /***********************************************************************
10875 ***********************************************************************/
10878 /* Prepare for redisplay by updating menu-bar item lists when
10879 appropriate. This can call eval. */
10882 prepare_menu_bars (void)
10885 struct gcpro gcpro1
, gcpro2
;
10887 Lisp_Object tooltip_frame
;
10889 #ifdef HAVE_WINDOW_SYSTEM
10890 tooltip_frame
= tip_frame
;
10892 tooltip_frame
= Qnil
;
10895 /* Update all frame titles based on their buffer names, etc. We do
10896 this before the menu bars so that the buffer-menu will show the
10897 up-to-date frame titles. */
10898 #ifdef HAVE_WINDOW_SYSTEM
10899 if (windows_or_buffers_changed
|| update_mode_lines
)
10901 Lisp_Object tail
, frame
;
10903 FOR_EACH_FRAME (tail
, frame
)
10905 f
= XFRAME (frame
);
10906 if (!EQ (frame
, tooltip_frame
)
10907 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10908 x_consider_frame_title (frame
);
10911 #endif /* HAVE_WINDOW_SYSTEM */
10913 /* Update the menu bar item lists, if appropriate. This has to be
10914 done before any actual redisplay or generation of display lines. */
10915 all_windows
= (update_mode_lines
10916 || buffer_shared
> 1
10917 || windows_or_buffers_changed
);
10920 Lisp_Object tail
, frame
;
10921 int count
= SPECPDL_INDEX ();
10922 /* 1 means that update_menu_bar has run its hooks
10923 so any further calls to update_menu_bar shouldn't do so again. */
10924 int menu_bar_hooks_run
= 0;
10926 record_unwind_save_match_data ();
10928 FOR_EACH_FRAME (tail
, frame
)
10930 f
= XFRAME (frame
);
10932 /* Ignore tooltip frame. */
10933 if (EQ (frame
, tooltip_frame
))
10936 /* If a window on this frame changed size, report that to
10937 the user and clear the size-change flag. */
10938 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10940 Lisp_Object functions
;
10942 /* Clear flag first in case we get an error below. */
10943 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10944 functions
= Vwindow_size_change_functions
;
10945 GCPRO2 (tail
, functions
);
10947 while (CONSP (functions
))
10949 if (!EQ (XCAR (functions
), Qt
))
10950 call1 (XCAR (functions
), frame
);
10951 functions
= XCDR (functions
);
10957 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10958 #ifdef HAVE_WINDOW_SYSTEM
10959 update_tool_bar (f
, 0);
10962 if (windows_or_buffers_changed
10964 ns_set_doc_edited (f
, Fbuffer_modified_p
10965 (XWINDOW (f
->selected_window
)->buffer
));
10970 unbind_to (count
, Qnil
);
10974 struct frame
*sf
= SELECTED_FRAME ();
10975 update_menu_bar (sf
, 1, 0);
10976 #ifdef HAVE_WINDOW_SYSTEM
10977 update_tool_bar (sf
, 1);
10983 /* Update the menu bar item list for frame F. This has to be done
10984 before we start to fill in any display lines, because it can call
10987 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10989 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10990 already ran the menu bar hooks for this redisplay, so there
10991 is no need to run them again. The return value is the
10992 updated value of this flag, to pass to the next call. */
10995 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10997 Lisp_Object window
;
10998 register struct window
*w
;
11000 /* If called recursively during a menu update, do nothing. This can
11001 happen when, for instance, an activate-menubar-hook causes a
11003 if (inhibit_menubar_update
)
11006 window
= FRAME_SELECTED_WINDOW (f
);
11007 w
= XWINDOW (window
);
11009 if (FRAME_WINDOW_P (f
)
11011 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11012 || defined (HAVE_NS) || defined (USE_GTK)
11013 FRAME_EXTERNAL_MENU_BAR (f
)
11015 FRAME_MENU_BAR_LINES (f
) > 0
11017 : FRAME_MENU_BAR_LINES (f
) > 0)
11019 /* If the user has switched buffers or windows, we need to
11020 recompute to reflect the new bindings. But we'll
11021 recompute when update_mode_lines is set too; that means
11022 that people can use force-mode-line-update to request
11023 that the menu bar be recomputed. The adverse effect on
11024 the rest of the redisplay algorithm is about the same as
11025 windows_or_buffers_changed anyway. */
11026 if (windows_or_buffers_changed
11027 /* This used to test w->update_mode_line, but we believe
11028 there is no need to recompute the menu in that case. */
11029 || update_mode_lines
11030 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11031 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11032 != !NILP (w
->last_had_star
))
11033 || ((!NILP (Vtransient_mark_mode
)
11034 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11035 != !NILP (w
->region_showing
)))
11037 struct buffer
*prev
= current_buffer
;
11038 int count
= SPECPDL_INDEX ();
11040 specbind (Qinhibit_menubar_update
, Qt
);
11042 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11043 if (save_match_data
)
11044 record_unwind_save_match_data ();
11045 if (NILP (Voverriding_local_map_menu_flag
))
11047 specbind (Qoverriding_terminal_local_map
, Qnil
);
11048 specbind (Qoverriding_local_map
, Qnil
);
11053 /* Run the Lucid hook. */
11054 safe_run_hooks (Qactivate_menubar_hook
);
11056 /* If it has changed current-menubar from previous value,
11057 really recompute the menu-bar from the value. */
11058 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11059 call0 (Qrecompute_lucid_menubar
);
11061 safe_run_hooks (Qmenu_bar_update_hook
);
11066 XSETFRAME (Vmenu_updating_frame
, f
);
11067 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11069 /* Redisplay the menu bar in case we changed it. */
11070 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11071 || defined (HAVE_NS) || defined (USE_GTK)
11072 if (FRAME_WINDOW_P (f
))
11074 #if defined (HAVE_NS)
11075 /* All frames on Mac OS share the same menubar. So only
11076 the selected frame should be allowed to set it. */
11077 if (f
== SELECTED_FRAME ())
11079 set_frame_menubar (f
, 0, 0);
11082 /* On a terminal screen, the menu bar is an ordinary screen
11083 line, and this makes it get updated. */
11084 w
->update_mode_line
= Qt
;
11085 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11086 /* In the non-toolkit version, the menu bar is an ordinary screen
11087 line, and this makes it get updated. */
11088 w
->update_mode_line
= Qt
;
11089 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11091 unbind_to (count
, Qnil
);
11092 set_buffer_internal_1 (prev
);
11101 /***********************************************************************
11103 ***********************************************************************/
11105 #ifdef HAVE_WINDOW_SYSTEM
11108 Nominal cursor position -- where to draw output.
11109 HPOS and VPOS are window relative glyph matrix coordinates.
11110 X and Y are window relative pixel coordinates. */
11112 struct cursor_pos output_cursor
;
11116 Set the global variable output_cursor to CURSOR. All cursor
11117 positions are relative to updated_window. */
11120 set_output_cursor (struct cursor_pos
*cursor
)
11122 output_cursor
.hpos
= cursor
->hpos
;
11123 output_cursor
.vpos
= cursor
->vpos
;
11124 output_cursor
.x
= cursor
->x
;
11125 output_cursor
.y
= cursor
->y
;
11130 Set a nominal cursor position.
11132 HPOS and VPOS are column/row positions in a window glyph matrix. X
11133 and Y are window text area relative pixel positions.
11135 If this is done during an update, updated_window will contain the
11136 window that is being updated and the position is the future output
11137 cursor position for that window. If updated_window is null, use
11138 selected_window and display the cursor at the given position. */
11141 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11145 /* If updated_window is not set, work on selected_window. */
11146 if (updated_window
)
11147 w
= updated_window
;
11149 w
= XWINDOW (selected_window
);
11151 /* Set the output cursor. */
11152 output_cursor
.hpos
= hpos
;
11153 output_cursor
.vpos
= vpos
;
11154 output_cursor
.x
= x
;
11155 output_cursor
.y
= y
;
11157 /* If not called as part of an update, really display the cursor.
11158 This will also set the cursor position of W. */
11159 if (updated_window
== NULL
)
11162 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11163 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11164 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11169 #endif /* HAVE_WINDOW_SYSTEM */
11172 /***********************************************************************
11174 ***********************************************************************/
11176 #ifdef HAVE_WINDOW_SYSTEM
11178 /* Where the mouse was last time we reported a mouse event. */
11180 FRAME_PTR last_mouse_frame
;
11182 /* Tool-bar item index of the item on which a mouse button was pressed
11185 int last_tool_bar_item
;
11189 update_tool_bar_unwind (Lisp_Object frame
)
11191 selected_frame
= frame
;
11195 /* Update the tool-bar item list for frame F. This has to be done
11196 before we start to fill in any display lines. Called from
11197 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11198 and restore it here. */
11201 update_tool_bar (struct frame
*f
, int save_match_data
)
11203 #if defined (USE_GTK) || defined (HAVE_NS)
11204 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11206 int do_update
= WINDOWP (f
->tool_bar_window
)
11207 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11212 Lisp_Object window
;
11215 window
= FRAME_SELECTED_WINDOW (f
);
11216 w
= XWINDOW (window
);
11218 /* If the user has switched buffers or windows, we need to
11219 recompute to reflect the new bindings. But we'll
11220 recompute when update_mode_lines is set too; that means
11221 that people can use force-mode-line-update to request
11222 that the menu bar be recomputed. The adverse effect on
11223 the rest of the redisplay algorithm is about the same as
11224 windows_or_buffers_changed anyway. */
11225 if (windows_or_buffers_changed
11226 || !NILP (w
->update_mode_line
)
11227 || update_mode_lines
11228 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11229 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11230 != !NILP (w
->last_had_star
))
11231 || ((!NILP (Vtransient_mark_mode
)
11232 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11233 != !NILP (w
->region_showing
)))
11235 struct buffer
*prev
= current_buffer
;
11236 int count
= SPECPDL_INDEX ();
11237 Lisp_Object frame
, new_tool_bar
;
11238 int new_n_tool_bar
;
11239 struct gcpro gcpro1
;
11241 /* Set current_buffer to the buffer of the selected
11242 window of the frame, so that we get the right local
11244 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11246 /* Save match data, if we must. */
11247 if (save_match_data
)
11248 record_unwind_save_match_data ();
11250 /* Make sure that we don't accidentally use bogus keymaps. */
11251 if (NILP (Voverriding_local_map_menu_flag
))
11253 specbind (Qoverriding_terminal_local_map
, Qnil
);
11254 specbind (Qoverriding_local_map
, Qnil
);
11257 GCPRO1 (new_tool_bar
);
11259 /* We must temporarily set the selected frame to this frame
11260 before calling tool_bar_items, because the calculation of
11261 the tool-bar keymap uses the selected frame (see
11262 `tool-bar-make-keymap' in tool-bar.el). */
11263 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11264 XSETFRAME (frame
, f
);
11265 selected_frame
= frame
;
11267 /* Build desired tool-bar items from keymaps. */
11268 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11271 /* Redisplay the tool-bar if we changed it. */
11272 if (new_n_tool_bar
!= f
->n_tool_bar_items
11273 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11275 /* Redisplay that happens asynchronously due to an expose event
11276 may access f->tool_bar_items. Make sure we update both
11277 variables within BLOCK_INPUT so no such event interrupts. */
11279 f
->tool_bar_items
= new_tool_bar
;
11280 f
->n_tool_bar_items
= new_n_tool_bar
;
11281 w
->update_mode_line
= Qt
;
11287 unbind_to (count
, Qnil
);
11288 set_buffer_internal_1 (prev
);
11294 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11295 F's desired tool-bar contents. F->tool_bar_items must have
11296 been set up previously by calling prepare_menu_bars. */
11299 build_desired_tool_bar_string (struct frame
*f
)
11301 int i
, size
, size_needed
;
11302 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11303 Lisp_Object image
, plist
, props
;
11305 image
= plist
= props
= Qnil
;
11306 GCPRO3 (image
, plist
, props
);
11308 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11309 Otherwise, make a new string. */
11311 /* The size of the string we might be able to reuse. */
11312 size
= (STRINGP (f
->desired_tool_bar_string
)
11313 ? SCHARS (f
->desired_tool_bar_string
)
11316 /* We need one space in the string for each image. */
11317 size_needed
= f
->n_tool_bar_items
;
11319 /* Reuse f->desired_tool_bar_string, if possible. */
11320 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11321 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11322 make_number (' '));
11325 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11326 Fremove_text_properties (make_number (0), make_number (size
),
11327 props
, f
->desired_tool_bar_string
);
11330 /* Put a `display' property on the string for the images to display,
11331 put a `menu_item' property on tool-bar items with a value that
11332 is the index of the item in F's tool-bar item vector. */
11333 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11335 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11337 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11338 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11339 int hmargin
, vmargin
, relief
, idx
, end
;
11341 /* If image is a vector, choose the image according to the
11343 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11344 if (VECTORP (image
))
11348 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11349 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11352 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11353 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11355 xassert (ASIZE (image
) >= idx
);
11356 image
= AREF (image
, idx
);
11361 /* Ignore invalid image specifications. */
11362 if (!valid_image_p (image
))
11365 /* Display the tool-bar button pressed, or depressed. */
11366 plist
= Fcopy_sequence (XCDR (image
));
11368 /* Compute margin and relief to draw. */
11369 relief
= (tool_bar_button_relief
>= 0
11370 ? tool_bar_button_relief
11371 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11372 hmargin
= vmargin
= relief
;
11374 if (INTEGERP (Vtool_bar_button_margin
)
11375 && XINT (Vtool_bar_button_margin
) > 0)
11377 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11378 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11380 else if (CONSP (Vtool_bar_button_margin
))
11382 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11383 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11384 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11386 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11387 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11388 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11391 if (auto_raise_tool_bar_buttons_p
)
11393 /* Add a `:relief' property to the image spec if the item is
11397 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11404 /* If image is selected, display it pressed, i.e. with a
11405 negative relief. If it's not selected, display it with a
11407 plist
= Fplist_put (plist
, QCrelief
,
11409 ? make_number (-relief
)
11410 : make_number (relief
)));
11415 /* Put a margin around the image. */
11416 if (hmargin
|| vmargin
)
11418 if (hmargin
== vmargin
)
11419 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11421 plist
= Fplist_put (plist
, QCmargin
,
11422 Fcons (make_number (hmargin
),
11423 make_number (vmargin
)));
11426 /* If button is not enabled, and we don't have special images
11427 for the disabled state, make the image appear disabled by
11428 applying an appropriate algorithm to it. */
11429 if (!enabled_p
&& idx
< 0)
11430 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11432 /* Put a `display' text property on the string for the image to
11433 display. Put a `menu-item' property on the string that gives
11434 the start of this item's properties in the tool-bar items
11436 image
= Fcons (Qimage
, plist
);
11437 props
= list4 (Qdisplay
, image
,
11438 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11440 /* Let the last image hide all remaining spaces in the tool bar
11441 string. The string can be longer than needed when we reuse a
11442 previous string. */
11443 if (i
+ 1 == f
->n_tool_bar_items
)
11444 end
= SCHARS (f
->desired_tool_bar_string
);
11447 Fadd_text_properties (make_number (i
), make_number (end
),
11448 props
, f
->desired_tool_bar_string
);
11456 /* Display one line of the tool-bar of frame IT->f.
11458 HEIGHT specifies the desired height of the tool-bar line.
11459 If the actual height of the glyph row is less than HEIGHT, the
11460 row's height is increased to HEIGHT, and the icons are centered
11461 vertically in the new height.
11463 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11464 count a final empty row in case the tool-bar width exactly matches
11469 display_tool_bar_line (struct it
*it
, int height
)
11471 struct glyph_row
*row
= it
->glyph_row
;
11472 int max_x
= it
->last_visible_x
;
11473 struct glyph
*last
;
11475 prepare_desired_row (row
);
11476 row
->y
= it
->current_y
;
11478 /* Note that this isn't made use of if the face hasn't a box,
11479 so there's no need to check the face here. */
11480 it
->start_of_box_run_p
= 1;
11482 while (it
->current_x
< max_x
)
11484 int x
, n_glyphs_before
, i
, nglyphs
;
11485 struct it it_before
;
11487 /* Get the next display element. */
11488 if (!get_next_display_element (it
))
11490 /* Don't count empty row if we are counting needed tool-bar lines. */
11491 if (height
< 0 && !it
->hpos
)
11496 /* Produce glyphs. */
11497 n_glyphs_before
= row
->used
[TEXT_AREA
];
11500 PRODUCE_GLYPHS (it
);
11502 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11504 x
= it_before
.current_x
;
11505 while (i
< nglyphs
)
11507 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11509 if (x
+ glyph
->pixel_width
> max_x
)
11511 /* Glyph doesn't fit on line. Backtrack. */
11512 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11514 /* If this is the only glyph on this line, it will never fit on the
11515 tool-bar, so skip it. But ensure there is at least one glyph,
11516 so we don't accidentally disable the tool-bar. */
11517 if (n_glyphs_before
== 0
11518 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11524 x
+= glyph
->pixel_width
;
11528 /* Stop at line end. */
11529 if (ITERATOR_AT_END_OF_LINE_P (it
))
11532 set_iterator_to_next (it
, 1);
11537 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11539 /* Use default face for the border below the tool bar.
11541 FIXME: When auto-resize-tool-bars is grow-only, there is
11542 no additional border below the possibly empty tool-bar lines.
11543 So to make the extra empty lines look "normal", we have to
11544 use the tool-bar face for the border too. */
11545 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11546 it
->face_id
= DEFAULT_FACE_ID
;
11548 extend_face_to_end_of_line (it
);
11549 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11550 last
->right_box_line_p
= 1;
11551 if (last
== row
->glyphs
[TEXT_AREA
])
11552 last
->left_box_line_p
= 1;
11554 /* Make line the desired height and center it vertically. */
11555 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11557 /* Don't add more than one line height. */
11558 height
%= FRAME_LINE_HEIGHT (it
->f
);
11559 it
->max_ascent
+= height
/ 2;
11560 it
->max_descent
+= (height
+ 1) / 2;
11563 compute_line_metrics (it
);
11565 /* If line is empty, make it occupy the rest of the tool-bar. */
11566 if (!row
->displays_text_p
)
11568 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11569 row
->visible_height
= row
->height
;
11570 row
->ascent
= row
->phys_ascent
= 0;
11571 row
->extra_line_spacing
= 0;
11574 row
->full_width_p
= 1;
11575 row
->continued_p
= 0;
11576 row
->truncated_on_left_p
= 0;
11577 row
->truncated_on_right_p
= 0;
11579 it
->current_x
= it
->hpos
= 0;
11580 it
->current_y
+= row
->height
;
11586 /* Max tool-bar height. */
11588 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11589 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11591 /* Value is the number of screen lines needed to make all tool-bar
11592 items of frame F visible. The number of actual rows needed is
11593 returned in *N_ROWS if non-NULL. */
11596 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11598 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11600 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11601 the desired matrix, so use (unused) mode-line row as temporary row to
11602 avoid destroying the first tool-bar row. */
11603 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11605 /* Initialize an iterator for iteration over
11606 F->desired_tool_bar_string in the tool-bar window of frame F. */
11607 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11608 it
.first_visible_x
= 0;
11609 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11610 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11611 it
.paragraph_embedding
= L2R
;
11613 while (!ITERATOR_AT_END_P (&it
))
11615 clear_glyph_row (temp_row
);
11616 it
.glyph_row
= temp_row
;
11617 display_tool_bar_line (&it
, -1);
11619 clear_glyph_row (temp_row
);
11621 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11623 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11625 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11629 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11631 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11632 (Lisp_Object frame
)
11639 frame
= selected_frame
;
11641 CHECK_FRAME (frame
);
11642 f
= XFRAME (frame
);
11644 if (WINDOWP (f
->tool_bar_window
)
11645 && (w
= XWINDOW (f
->tool_bar_window
),
11646 WINDOW_TOTAL_LINES (w
) > 0))
11648 update_tool_bar (f
, 1);
11649 if (f
->n_tool_bar_items
)
11651 build_desired_tool_bar_string (f
);
11652 nlines
= tool_bar_lines_needed (f
, NULL
);
11656 return make_number (nlines
);
11660 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11661 height should be changed. */
11664 redisplay_tool_bar (struct frame
*f
)
11668 struct glyph_row
*row
;
11670 #if defined (USE_GTK) || defined (HAVE_NS)
11671 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11672 update_frame_tool_bar (f
);
11676 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11677 do anything. This means you must start with tool-bar-lines
11678 non-zero to get the auto-sizing effect. Or in other words, you
11679 can turn off tool-bars by specifying tool-bar-lines zero. */
11680 if (!WINDOWP (f
->tool_bar_window
)
11681 || (w
= XWINDOW (f
->tool_bar_window
),
11682 WINDOW_TOTAL_LINES (w
) == 0))
11685 /* Set up an iterator for the tool-bar window. */
11686 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11687 it
.first_visible_x
= 0;
11688 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11689 row
= it
.glyph_row
;
11691 /* Build a string that represents the contents of the tool-bar. */
11692 build_desired_tool_bar_string (f
);
11693 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11694 /* FIXME: This should be controlled by a user option. But it
11695 doesn't make sense to have an R2L tool bar if the menu bar cannot
11696 be drawn also R2L, and making the menu bar R2L is tricky due
11697 toolkit-specific code that implements it. If an R2L tool bar is
11698 ever supported, display_tool_bar_line should also be augmented to
11699 call unproduce_glyphs like display_line and display_string
11701 it
.paragraph_embedding
= L2R
;
11703 if (f
->n_tool_bar_rows
== 0)
11707 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11708 nlines
!= WINDOW_TOTAL_LINES (w
)))
11711 int old_height
= WINDOW_TOTAL_LINES (w
);
11713 XSETFRAME (frame
, f
);
11714 Fmodify_frame_parameters (frame
,
11715 Fcons (Fcons (Qtool_bar_lines
,
11716 make_number (nlines
)),
11718 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11720 clear_glyph_matrix (w
->desired_matrix
);
11721 fonts_changed_p
= 1;
11727 /* Display as many lines as needed to display all tool-bar items. */
11729 if (f
->n_tool_bar_rows
> 0)
11731 int border
, rows
, height
, extra
;
11733 if (INTEGERP (Vtool_bar_border
))
11734 border
= XINT (Vtool_bar_border
);
11735 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11736 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11737 else if (EQ (Vtool_bar_border
, Qborder_width
))
11738 border
= f
->border_width
;
11744 rows
= f
->n_tool_bar_rows
;
11745 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11746 extra
= it
.last_visible_y
- border
- height
* rows
;
11748 while (it
.current_y
< it
.last_visible_y
)
11751 if (extra
> 0 && rows
-- > 0)
11753 h
= (extra
+ rows
- 1) / rows
;
11756 display_tool_bar_line (&it
, height
+ h
);
11761 while (it
.current_y
< it
.last_visible_y
)
11762 display_tool_bar_line (&it
, 0);
11765 /* It doesn't make much sense to try scrolling in the tool-bar
11766 window, so don't do it. */
11767 w
->desired_matrix
->no_scrolling_p
= 1;
11768 w
->must_be_updated_p
= 1;
11770 if (!NILP (Vauto_resize_tool_bars
))
11772 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11773 int change_height_p
= 0;
11775 /* If we couldn't display everything, change the tool-bar's
11776 height if there is room for more. */
11777 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11778 && it
.current_y
< max_tool_bar_height
)
11779 change_height_p
= 1;
11781 row
= it
.glyph_row
- 1;
11783 /* If there are blank lines at the end, except for a partially
11784 visible blank line at the end that is smaller than
11785 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11786 if (!row
->displays_text_p
11787 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11788 change_height_p
= 1;
11790 /* If row displays tool-bar items, but is partially visible,
11791 change the tool-bar's height. */
11792 if (row
->displays_text_p
11793 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11794 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11795 change_height_p
= 1;
11797 /* Resize windows as needed by changing the `tool-bar-lines'
11798 frame parameter. */
11799 if (change_height_p
)
11802 int old_height
= WINDOW_TOTAL_LINES (w
);
11804 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11806 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11807 && !f
->minimize_tool_bar_window_p
)
11808 ? (nlines
> old_height
)
11809 : (nlines
!= old_height
));
11810 f
->minimize_tool_bar_window_p
= 0;
11812 if (change_height_p
)
11814 XSETFRAME (frame
, f
);
11815 Fmodify_frame_parameters (frame
,
11816 Fcons (Fcons (Qtool_bar_lines
,
11817 make_number (nlines
)),
11819 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11821 clear_glyph_matrix (w
->desired_matrix
);
11822 f
->n_tool_bar_rows
= nrows
;
11823 fonts_changed_p
= 1;
11830 f
->minimize_tool_bar_window_p
= 0;
11835 /* Get information about the tool-bar item which is displayed in GLYPH
11836 on frame F. Return in *PROP_IDX the index where tool-bar item
11837 properties start in F->tool_bar_items. Value is zero if
11838 GLYPH doesn't display a tool-bar item. */
11841 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11847 /* This function can be called asynchronously, which means we must
11848 exclude any possibility that Fget_text_property signals an
11850 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11851 charpos
= max (0, charpos
);
11853 /* Get the text property `menu-item' at pos. The value of that
11854 property is the start index of this item's properties in
11855 F->tool_bar_items. */
11856 prop
= Fget_text_property (make_number (charpos
),
11857 Qmenu_item
, f
->current_tool_bar_string
);
11858 if (INTEGERP (prop
))
11860 *prop_idx
= XINT (prop
);
11870 /* Get information about the tool-bar item at position X/Y on frame F.
11871 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11872 the current matrix of the tool-bar window of F, or NULL if not
11873 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11874 item in F->tool_bar_items. Value is
11876 -1 if X/Y is not on a tool-bar item
11877 0 if X/Y is on the same item that was highlighted before.
11881 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11882 int *hpos
, int *vpos
, int *prop_idx
)
11884 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11885 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11888 /* Find the glyph under X/Y. */
11889 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11890 if (*glyph
== NULL
)
11893 /* Get the start of this tool-bar item's properties in
11894 f->tool_bar_items. */
11895 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11898 /* Is mouse on the highlighted item? */
11899 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11900 && *vpos
>= hlinfo
->mouse_face_beg_row
11901 && *vpos
<= hlinfo
->mouse_face_end_row
11902 && (*vpos
> hlinfo
->mouse_face_beg_row
11903 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11904 && (*vpos
< hlinfo
->mouse_face_end_row
11905 || *hpos
< hlinfo
->mouse_face_end_col
11906 || hlinfo
->mouse_face_past_end
))
11914 Handle mouse button event on the tool-bar of frame F, at
11915 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11916 0 for button release. MODIFIERS is event modifiers for button
11920 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11921 unsigned int modifiers
)
11923 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11924 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11925 int hpos
, vpos
, prop_idx
;
11926 struct glyph
*glyph
;
11927 Lisp_Object enabled_p
;
11929 /* If not on the highlighted tool-bar item, return. */
11930 frame_to_window_pixel_xy (w
, &x
, &y
);
11931 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11934 /* If item is disabled, do nothing. */
11935 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11936 if (NILP (enabled_p
))
11941 /* Show item in pressed state. */
11942 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11943 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11944 last_tool_bar_item
= prop_idx
;
11948 Lisp_Object key
, frame
;
11949 struct input_event event
;
11950 EVENT_INIT (event
);
11952 /* Show item in released state. */
11953 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11954 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11956 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11958 XSETFRAME (frame
, f
);
11959 event
.kind
= TOOL_BAR_EVENT
;
11960 event
.frame_or_window
= frame
;
11962 kbd_buffer_store_event (&event
);
11964 event
.kind
= TOOL_BAR_EVENT
;
11965 event
.frame_or_window
= frame
;
11967 event
.modifiers
= modifiers
;
11968 kbd_buffer_store_event (&event
);
11969 last_tool_bar_item
= -1;
11974 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11975 tool-bar window-relative coordinates X/Y. Called from
11976 note_mouse_highlight. */
11979 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11981 Lisp_Object window
= f
->tool_bar_window
;
11982 struct window
*w
= XWINDOW (window
);
11983 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11984 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11986 struct glyph
*glyph
;
11987 struct glyph_row
*row
;
11989 Lisp_Object enabled_p
;
11991 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11992 int mouse_down_p
, rc
;
11994 /* Function note_mouse_highlight is called with negative X/Y
11995 values when mouse moves outside of the frame. */
11996 if (x
<= 0 || y
<= 0)
11998 clear_mouse_face (hlinfo
);
12002 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12005 /* Not on tool-bar item. */
12006 clear_mouse_face (hlinfo
);
12010 /* On same tool-bar item as before. */
12011 goto set_help_echo
;
12013 clear_mouse_face (hlinfo
);
12015 /* Mouse is down, but on different tool-bar item? */
12016 mouse_down_p
= (dpyinfo
->grabbed
12017 && f
== last_mouse_frame
12018 && FRAME_LIVE_P (f
));
12020 && last_tool_bar_item
!= prop_idx
)
12023 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
12024 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12026 /* If tool-bar item is not enabled, don't highlight it. */
12027 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12028 if (!NILP (enabled_p
))
12030 /* Compute the x-position of the glyph. In front and past the
12031 image is a space. We include this in the highlighted area. */
12032 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12033 for (i
= x
= 0; i
< hpos
; ++i
)
12034 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12036 /* Record this as the current active region. */
12037 hlinfo
->mouse_face_beg_col
= hpos
;
12038 hlinfo
->mouse_face_beg_row
= vpos
;
12039 hlinfo
->mouse_face_beg_x
= x
;
12040 hlinfo
->mouse_face_beg_y
= row
->y
;
12041 hlinfo
->mouse_face_past_end
= 0;
12043 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12044 hlinfo
->mouse_face_end_row
= vpos
;
12045 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12046 hlinfo
->mouse_face_end_y
= row
->y
;
12047 hlinfo
->mouse_face_window
= window
;
12048 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12050 /* Display it as active. */
12051 show_mouse_face (hlinfo
, draw
);
12052 hlinfo
->mouse_face_image_state
= draw
;
12057 /* Set help_echo_string to a help string to display for this tool-bar item.
12058 XTread_socket does the rest. */
12059 help_echo_object
= help_echo_window
= Qnil
;
12060 help_echo_pos
= -1;
12061 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12062 if (NILP (help_echo_string
))
12063 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12066 #endif /* HAVE_WINDOW_SYSTEM */
12070 /************************************************************************
12071 Horizontal scrolling
12072 ************************************************************************/
12074 static int hscroll_window_tree (Lisp_Object
);
12075 static int hscroll_windows (Lisp_Object
);
12077 /* For all leaf windows in the window tree rooted at WINDOW, set their
12078 hscroll value so that PT is (i) visible in the window, and (ii) so
12079 that it is not within a certain margin at the window's left and
12080 right border. Value is non-zero if any window's hscroll has been
12084 hscroll_window_tree (Lisp_Object window
)
12086 int hscrolled_p
= 0;
12087 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12088 int hscroll_step_abs
= 0;
12089 double hscroll_step_rel
= 0;
12091 if (hscroll_relative_p
)
12093 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12094 if (hscroll_step_rel
< 0)
12096 hscroll_relative_p
= 0;
12097 hscroll_step_abs
= 0;
12100 else if (INTEGERP (Vhscroll_step
))
12102 hscroll_step_abs
= XINT (Vhscroll_step
);
12103 if (hscroll_step_abs
< 0)
12104 hscroll_step_abs
= 0;
12107 hscroll_step_abs
= 0;
12109 while (WINDOWP (window
))
12111 struct window
*w
= XWINDOW (window
);
12113 if (WINDOWP (w
->hchild
))
12114 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12115 else if (WINDOWP (w
->vchild
))
12116 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12117 else if (w
->cursor
.vpos
>= 0)
12120 int text_area_width
;
12121 struct glyph_row
*current_cursor_row
12122 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12123 struct glyph_row
*desired_cursor_row
12124 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12125 struct glyph_row
*cursor_row
12126 = (desired_cursor_row
->enabled_p
12127 ? desired_cursor_row
12128 : current_cursor_row
);
12129 int row_r2l_p
= cursor_row
->reversed_p
;
12131 text_area_width
= window_box_width (w
, TEXT_AREA
);
12133 /* Scroll when cursor is inside this scroll margin. */
12134 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12136 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12137 /* For left-to-right rows, hscroll when cursor is either
12138 (i) inside the right hscroll margin, or (ii) if it is
12139 inside the left margin and the window is already
12142 && ((XFASTINT (w
->hscroll
)
12143 && w
->cursor
.x
<= h_margin
)
12144 || (cursor_row
->enabled_p
12145 && cursor_row
->truncated_on_right_p
12146 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12147 /* For right-to-left rows, the logic is similar,
12148 except that rules for scrolling to left and right
12149 are reversed. E.g., if cursor.x <= h_margin, we
12150 need to hscroll "to the right" unconditionally,
12151 and that will scroll the screen to the left so as
12152 to reveal the next portion of the row. */
12154 && ((cursor_row
->enabled_p
12155 /* FIXME: It is confusing to set the
12156 truncated_on_right_p flag when R2L rows
12157 are actually truncated on the left. */
12158 && cursor_row
->truncated_on_right_p
12159 && w
->cursor
.x
<= h_margin
)
12160 || (XFASTINT (w
->hscroll
)
12161 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12165 struct buffer
*saved_current_buffer
;
12169 /* Find point in a display of infinite width. */
12170 saved_current_buffer
= current_buffer
;
12171 current_buffer
= XBUFFER (w
->buffer
);
12173 if (w
== XWINDOW (selected_window
))
12177 pt
= marker_position (w
->pointm
);
12178 pt
= max (BEGV
, pt
);
12182 /* Move iterator to pt starting at cursor_row->start in
12183 a line with infinite width. */
12184 init_to_row_start (&it
, w
, cursor_row
);
12185 it
.last_visible_x
= INFINITY
;
12186 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12187 current_buffer
= saved_current_buffer
;
12189 /* Position cursor in window. */
12190 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12191 hscroll
= max (0, (it
.current_x
12192 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12193 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12194 : (text_area_width
/ 2))))
12195 / FRAME_COLUMN_WIDTH (it
.f
);
12196 else if ((!row_r2l_p
12197 && w
->cursor
.x
>= text_area_width
- h_margin
)
12198 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12200 if (hscroll_relative_p
)
12201 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12204 wanted_x
= text_area_width
12205 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12208 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12212 if (hscroll_relative_p
)
12213 wanted_x
= text_area_width
* hscroll_step_rel
12216 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12219 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12221 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12223 /* Don't prevent redisplay optimizations if hscroll
12224 hasn't changed, as it will unnecessarily slow down
12226 if (XFASTINT (w
->hscroll
) != hscroll
)
12228 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12229 w
->hscroll
= make_number (hscroll
);
12238 /* Value is non-zero if hscroll of any leaf window has been changed. */
12239 return hscrolled_p
;
12243 /* Set hscroll so that cursor is visible and not inside horizontal
12244 scroll margins for all windows in the tree rooted at WINDOW. See
12245 also hscroll_window_tree above. Value is non-zero if any window's
12246 hscroll has been changed. If it has, desired matrices on the frame
12247 of WINDOW are cleared. */
12250 hscroll_windows (Lisp_Object window
)
12252 int hscrolled_p
= hscroll_window_tree (window
);
12254 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12255 return hscrolled_p
;
12260 /************************************************************************
12262 ************************************************************************/
12264 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12265 to a non-zero value. This is sometimes handy to have in a debugger
12270 /* First and last unchanged row for try_window_id. */
12272 static int debug_first_unchanged_at_end_vpos
;
12273 static int debug_last_unchanged_at_beg_vpos
;
12275 /* Delta vpos and y. */
12277 static int debug_dvpos
, debug_dy
;
12279 /* Delta in characters and bytes for try_window_id. */
12281 static EMACS_INT debug_delta
, debug_delta_bytes
;
12283 /* Values of window_end_pos and window_end_vpos at the end of
12286 static EMACS_INT debug_end_vpos
;
12288 /* Append a string to W->desired_matrix->method. FMT is a printf
12289 format string. If trace_redisplay_p is non-zero also printf the
12290 resulting string to stderr. */
12292 static void debug_method_add (struct window
*, char const *, ...)
12293 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12296 debug_method_add (struct window
*w
, char const *fmt
, ...)
12299 char *method
= w
->desired_matrix
->method
;
12300 int len
= strlen (method
);
12301 int size
= sizeof w
->desired_matrix
->method
;
12302 int remaining
= size
- len
- 1;
12305 va_start (ap
, fmt
);
12306 vsprintf (buffer
, fmt
, ap
);
12308 if (len
&& remaining
)
12311 --remaining
, ++len
;
12314 strncpy (method
+ len
, buffer
, remaining
);
12316 if (trace_redisplay_p
)
12317 fprintf (stderr
, "%p (%s): %s\n",
12319 ((BUFFERP (w
->buffer
)
12320 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12321 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12326 #endif /* GLYPH_DEBUG */
12329 /* Value is non-zero if all changes in window W, which displays
12330 current_buffer, are in the text between START and END. START is a
12331 buffer position, END is given as a distance from Z. Used in
12332 redisplay_internal for display optimization. */
12335 text_outside_line_unchanged_p (struct window
*w
,
12336 EMACS_INT start
, EMACS_INT end
)
12338 int unchanged_p
= 1;
12340 /* If text or overlays have changed, see where. */
12341 if (XFASTINT (w
->last_modified
) < MODIFF
12342 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12344 /* Gap in the line? */
12345 if (GPT
< start
|| Z
- GPT
< end
)
12348 /* Changes start in front of the line, or end after it? */
12350 && (BEG_UNCHANGED
< start
- 1
12351 || END_UNCHANGED
< end
))
12354 /* If selective display, can't optimize if changes start at the
12355 beginning of the line. */
12357 && INTEGERP (BVAR (current_buffer
, selective_display
))
12358 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12359 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12362 /* If there are overlays at the start or end of the line, these
12363 may have overlay strings with newlines in them. A change at
12364 START, for instance, may actually concern the display of such
12365 overlay strings as well, and they are displayed on different
12366 lines. So, quickly rule out this case. (For the future, it
12367 might be desirable to implement something more telling than
12368 just BEG/END_UNCHANGED.) */
12371 if (BEG
+ BEG_UNCHANGED
== start
12372 && overlay_touches_p (start
))
12374 if (END_UNCHANGED
== end
12375 && overlay_touches_p (Z
- end
))
12379 /* Under bidi reordering, adding or deleting a character in the
12380 beginning of a paragraph, before the first strong directional
12381 character, can change the base direction of the paragraph (unless
12382 the buffer specifies a fixed paragraph direction), which will
12383 require to redisplay the whole paragraph. It might be worthwhile
12384 to find the paragraph limits and widen the range of redisplayed
12385 lines to that, but for now just give up this optimization. */
12386 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12387 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12391 return unchanged_p
;
12395 /* Do a frame update, taking possible shortcuts into account. This is
12396 the main external entry point for redisplay.
12398 If the last redisplay displayed an echo area message and that message
12399 is no longer requested, we clear the echo area or bring back the
12400 mini-buffer if that is in use. */
12405 redisplay_internal ();
12410 overlay_arrow_string_or_property (Lisp_Object var
)
12414 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12417 return Voverlay_arrow_string
;
12420 /* Return 1 if there are any overlay-arrows in current_buffer. */
12422 overlay_arrow_in_current_buffer_p (void)
12426 for (vlist
= Voverlay_arrow_variable_list
;
12428 vlist
= XCDR (vlist
))
12430 Lisp_Object var
= XCAR (vlist
);
12433 if (!SYMBOLP (var
))
12435 val
= find_symbol_value (var
);
12437 && current_buffer
== XMARKER (val
)->buffer
)
12444 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12448 overlay_arrows_changed_p (void)
12452 for (vlist
= Voverlay_arrow_variable_list
;
12454 vlist
= XCDR (vlist
))
12456 Lisp_Object var
= XCAR (vlist
);
12457 Lisp_Object val
, pstr
;
12459 if (!SYMBOLP (var
))
12461 val
= find_symbol_value (var
);
12462 if (!MARKERP (val
))
12464 if (! EQ (COERCE_MARKER (val
),
12465 Fget (var
, Qlast_arrow_position
))
12466 || ! (pstr
= overlay_arrow_string_or_property (var
),
12467 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12473 /* Mark overlay arrows to be updated on next redisplay. */
12476 update_overlay_arrows (int up_to_date
)
12480 for (vlist
= Voverlay_arrow_variable_list
;
12482 vlist
= XCDR (vlist
))
12484 Lisp_Object var
= XCAR (vlist
);
12486 if (!SYMBOLP (var
))
12489 if (up_to_date
> 0)
12491 Lisp_Object val
= find_symbol_value (var
);
12492 Fput (var
, Qlast_arrow_position
,
12493 COERCE_MARKER (val
));
12494 Fput (var
, Qlast_arrow_string
,
12495 overlay_arrow_string_or_property (var
));
12497 else if (up_to_date
< 0
12498 || !NILP (Fget (var
, Qlast_arrow_position
)))
12500 Fput (var
, Qlast_arrow_position
, Qt
);
12501 Fput (var
, Qlast_arrow_string
, Qt
);
12507 /* Return overlay arrow string to display at row.
12508 Return integer (bitmap number) for arrow bitmap in left fringe.
12509 Return nil if no overlay arrow. */
12512 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12516 for (vlist
= Voverlay_arrow_variable_list
;
12518 vlist
= XCDR (vlist
))
12520 Lisp_Object var
= XCAR (vlist
);
12523 if (!SYMBOLP (var
))
12526 val
= find_symbol_value (var
);
12529 && current_buffer
== XMARKER (val
)->buffer
12530 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12532 if (FRAME_WINDOW_P (it
->f
)
12533 /* FIXME: if ROW->reversed_p is set, this should test
12534 the right fringe, not the left one. */
12535 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12537 #ifdef HAVE_WINDOW_SYSTEM
12538 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12541 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12542 return make_number (fringe_bitmap
);
12545 return make_number (-1); /* Use default arrow bitmap */
12547 return overlay_arrow_string_or_property (var
);
12554 /* Return 1 if point moved out of or into a composition. Otherwise
12555 return 0. PREV_BUF and PREV_PT are the last point buffer and
12556 position. BUF and PT are the current point buffer and position. */
12559 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12560 struct buffer
*buf
, EMACS_INT pt
)
12562 EMACS_INT start
, end
;
12564 Lisp_Object buffer
;
12566 XSETBUFFER (buffer
, buf
);
12567 /* Check a composition at the last point if point moved within the
12569 if (prev_buf
== buf
)
12572 /* Point didn't move. */
12575 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12576 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12577 && COMPOSITION_VALID_P (start
, end
, prop
)
12578 && start
< prev_pt
&& end
> prev_pt
)
12579 /* The last point was within the composition. Return 1 iff
12580 point moved out of the composition. */
12581 return (pt
<= start
|| pt
>= end
);
12584 /* Check a composition at the current point. */
12585 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12586 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12587 && COMPOSITION_VALID_P (start
, end
, prop
)
12588 && start
< pt
&& end
> pt
);
12592 /* Reconsider the setting of B->clip_changed which is displayed
12596 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12598 if (b
->clip_changed
12599 && !NILP (w
->window_end_valid
)
12600 && w
->current_matrix
->buffer
== b
12601 && w
->current_matrix
->zv
== BUF_ZV (b
)
12602 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12603 b
->clip_changed
= 0;
12605 /* If display wasn't paused, and W is not a tool bar window, see if
12606 point has been moved into or out of a composition. In that case,
12607 we set b->clip_changed to 1 to force updating the screen. If
12608 b->clip_changed has already been set to 1, we can skip this
12610 if (!b
->clip_changed
12611 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12615 if (w
== XWINDOW (selected_window
))
12618 pt
= marker_position (w
->pointm
);
12620 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12621 || pt
!= XINT (w
->last_point
))
12622 && check_point_in_composition (w
->current_matrix
->buffer
,
12623 XINT (w
->last_point
),
12624 XBUFFER (w
->buffer
), pt
))
12625 b
->clip_changed
= 1;
12630 /* Select FRAME to forward the values of frame-local variables into C
12631 variables so that the redisplay routines can access those values
12635 select_frame_for_redisplay (Lisp_Object frame
)
12637 Lisp_Object tail
, tem
;
12638 Lisp_Object old
= selected_frame
;
12639 struct Lisp_Symbol
*sym
;
12641 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12643 selected_frame
= frame
;
12646 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12647 if (CONSP (XCAR (tail
))
12648 && (tem
= XCAR (XCAR (tail
)),
12650 && (sym
= indirect_variable (XSYMBOL (tem
)),
12651 sym
->redirect
== SYMBOL_LOCALIZED
)
12652 && sym
->val
.blv
->frame_local
)
12653 /* Use find_symbol_value rather than Fsymbol_value
12654 to avoid an error if it is void. */
12655 find_symbol_value (tem
);
12656 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12660 #define STOP_POLLING \
12661 do { if (! polling_stopped_here) stop_polling (); \
12662 polling_stopped_here = 1; } while (0)
12664 #define RESUME_POLLING \
12665 do { if (polling_stopped_here) start_polling (); \
12666 polling_stopped_here = 0; } while (0)
12669 /* Perhaps in the future avoid recentering windows if it
12670 is not necessary; currently that causes some problems. */
12673 redisplay_internal (void)
12675 struct window
*w
= XWINDOW (selected_window
);
12679 int must_finish
= 0;
12680 struct text_pos tlbufpos
, tlendpos
;
12681 int number_of_visible_frames
;
12684 int polling_stopped_here
= 0;
12685 Lisp_Object old_frame
= selected_frame
;
12687 /* Non-zero means redisplay has to consider all windows on all
12688 frames. Zero means, only selected_window is considered. */
12689 int consider_all_windows_p
;
12691 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12693 /* No redisplay if running in batch mode or frame is not yet fully
12694 initialized, or redisplay is explicitly turned off by setting
12695 Vinhibit_redisplay. */
12696 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12697 || !NILP (Vinhibit_redisplay
))
12700 /* Don't examine these until after testing Vinhibit_redisplay.
12701 When Emacs is shutting down, perhaps because its connection to
12702 X has dropped, we should not look at them at all. */
12703 fr
= XFRAME (w
->frame
);
12704 sf
= SELECTED_FRAME ();
12706 if (!fr
->glyphs_initialized_p
)
12709 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12710 if (popup_activated ())
12714 /* I don't think this happens but let's be paranoid. */
12715 if (redisplaying_p
)
12718 /* Record a function that resets redisplaying_p to its old value
12719 when we leave this function. */
12720 count
= SPECPDL_INDEX ();
12721 record_unwind_protect (unwind_redisplay
,
12722 Fcons (make_number (redisplaying_p
), selected_frame
));
12724 specbind (Qinhibit_free_realized_faces
, Qnil
);
12727 Lisp_Object tail
, frame
;
12729 FOR_EACH_FRAME (tail
, frame
)
12731 struct frame
*f
= XFRAME (frame
);
12732 f
->already_hscrolled_p
= 0;
12737 /* Remember the currently selected window. */
12740 if (!EQ (old_frame
, selected_frame
)
12741 && FRAME_LIVE_P (XFRAME (old_frame
)))
12742 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12743 selected_frame and selected_window to be temporarily out-of-sync so
12744 when we come back here via `goto retry', we need to resync because we
12745 may need to run Elisp code (via prepare_menu_bars). */
12746 select_frame_for_redisplay (old_frame
);
12749 reconsider_clip_changes (w
, current_buffer
);
12750 last_escape_glyph_frame
= NULL
;
12751 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12752 last_glyphless_glyph_frame
= NULL
;
12753 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12755 /* If new fonts have been loaded that make a glyph matrix adjustment
12756 necessary, do it. */
12757 if (fonts_changed_p
)
12759 adjust_glyphs (NULL
);
12760 ++windows_or_buffers_changed
;
12761 fonts_changed_p
= 0;
12764 /* If face_change_count is non-zero, init_iterator will free all
12765 realized faces, which includes the faces referenced from current
12766 matrices. So, we can't reuse current matrices in this case. */
12767 if (face_change_count
)
12768 ++windows_or_buffers_changed
;
12770 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12771 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12773 /* Since frames on a single ASCII terminal share the same
12774 display area, displaying a different frame means redisplay
12775 the whole thing. */
12776 windows_or_buffers_changed
++;
12777 SET_FRAME_GARBAGED (sf
);
12779 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12781 FRAME_TTY (sf
)->previous_frame
= sf
;
12784 /* Set the visible flags for all frames. Do this before checking
12785 for resized or garbaged frames; they want to know if their frames
12786 are visible. See the comment in frame.h for
12787 FRAME_SAMPLE_VISIBILITY. */
12789 Lisp_Object tail
, frame
;
12791 number_of_visible_frames
= 0;
12793 FOR_EACH_FRAME (tail
, frame
)
12795 struct frame
*f
= XFRAME (frame
);
12797 FRAME_SAMPLE_VISIBILITY (f
);
12798 if (FRAME_VISIBLE_P (f
))
12799 ++number_of_visible_frames
;
12800 clear_desired_matrices (f
);
12804 /* Notice any pending interrupt request to change frame size. */
12805 do_pending_window_change (1);
12807 /* do_pending_window_change could change the selected_window due to
12808 frame resizing which makes the selected window too small. */
12809 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12812 reconsider_clip_changes (w
, current_buffer
);
12815 /* Clear frames marked as garbaged. */
12816 if (frame_garbaged
)
12817 clear_garbaged_frames ();
12819 /* Build menubar and tool-bar items. */
12820 if (NILP (Vmemory_full
))
12821 prepare_menu_bars ();
12823 if (windows_or_buffers_changed
)
12824 update_mode_lines
++;
12826 /* Detect case that we need to write or remove a star in the mode line. */
12827 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12829 w
->update_mode_line
= Qt
;
12830 if (buffer_shared
> 1)
12831 update_mode_lines
++;
12834 /* Avoid invocation of point motion hooks by `current_column' below. */
12835 count1
= SPECPDL_INDEX ();
12836 specbind (Qinhibit_point_motion_hooks
, Qt
);
12838 /* If %c is in the mode line, update it if needed. */
12839 if (!NILP (w
->column_number_displayed
)
12840 /* This alternative quickly identifies a common case
12841 where no change is needed. */
12842 && !(PT
== XFASTINT (w
->last_point
)
12843 && XFASTINT (w
->last_modified
) >= MODIFF
12844 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12845 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12846 w
->update_mode_line
= Qt
;
12848 unbind_to (count1
, Qnil
);
12850 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12852 /* The variable buffer_shared is set in redisplay_window and
12853 indicates that we redisplay a buffer in different windows. See
12855 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12856 || cursor_type_changed
);
12858 /* If specs for an arrow have changed, do thorough redisplay
12859 to ensure we remove any arrow that should no longer exist. */
12860 if (overlay_arrows_changed_p ())
12861 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12863 /* Normally the message* functions will have already displayed and
12864 updated the echo area, but the frame may have been trashed, or
12865 the update may have been preempted, so display the echo area
12866 again here. Checking message_cleared_p captures the case that
12867 the echo area should be cleared. */
12868 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12869 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12870 || (message_cleared_p
12871 && minibuf_level
== 0
12872 /* If the mini-window is currently selected, this means the
12873 echo-area doesn't show through. */
12874 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12876 int window_height_changed_p
= echo_area_display (0);
12879 /* If we don't display the current message, don't clear the
12880 message_cleared_p flag, because, if we did, we wouldn't clear
12881 the echo area in the next redisplay which doesn't preserve
12883 if (!display_last_displayed_message_p
)
12884 message_cleared_p
= 0;
12886 if (fonts_changed_p
)
12888 else if (window_height_changed_p
)
12890 consider_all_windows_p
= 1;
12891 ++update_mode_lines
;
12892 ++windows_or_buffers_changed
;
12894 /* If window configuration was changed, frames may have been
12895 marked garbaged. Clear them or we will experience
12896 surprises wrt scrolling. */
12897 if (frame_garbaged
)
12898 clear_garbaged_frames ();
12901 else if (EQ (selected_window
, minibuf_window
)
12902 && (current_buffer
->clip_changed
12903 || XFASTINT (w
->last_modified
) < MODIFF
12904 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12905 && resize_mini_window (w
, 0))
12907 /* Resized active mini-window to fit the size of what it is
12908 showing if its contents might have changed. */
12910 /* FIXME: this causes all frames to be updated, which seems unnecessary
12911 since only the current frame needs to be considered. This function needs
12912 to be rewritten with two variables, consider_all_windows and
12913 consider_all_frames. */
12914 consider_all_windows_p
= 1;
12915 ++windows_or_buffers_changed
;
12916 ++update_mode_lines
;
12918 /* If window configuration was changed, frames may have been
12919 marked garbaged. Clear them or we will experience
12920 surprises wrt scrolling. */
12921 if (frame_garbaged
)
12922 clear_garbaged_frames ();
12926 /* If showing the region, and mark has changed, we must redisplay
12927 the whole window. The assignment to this_line_start_pos prevents
12928 the optimization directly below this if-statement. */
12929 if (((!NILP (Vtransient_mark_mode
)
12930 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12931 != !NILP (w
->region_showing
))
12932 || (!NILP (w
->region_showing
)
12933 && !EQ (w
->region_showing
,
12934 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12935 CHARPOS (this_line_start_pos
) = 0;
12937 /* Optimize the case that only the line containing the cursor in the
12938 selected window has changed. Variables starting with this_ are
12939 set in display_line and record information about the line
12940 containing the cursor. */
12941 tlbufpos
= this_line_start_pos
;
12942 tlendpos
= this_line_end_pos
;
12943 if (!consider_all_windows_p
12944 && CHARPOS (tlbufpos
) > 0
12945 && NILP (w
->update_mode_line
)
12946 && !current_buffer
->clip_changed
12947 && !current_buffer
->prevent_redisplay_optimizations_p
12948 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12949 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12950 /* Make sure recorded data applies to current buffer, etc. */
12951 && this_line_buffer
== current_buffer
12952 && current_buffer
== XBUFFER (w
->buffer
)
12953 && NILP (w
->force_start
)
12954 && NILP (w
->optional_new_start
)
12955 /* Point must be on the line that we have info recorded about. */
12956 && PT
>= CHARPOS (tlbufpos
)
12957 && PT
<= Z
- CHARPOS (tlendpos
)
12958 /* All text outside that line, including its final newline,
12959 must be unchanged. */
12960 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12961 CHARPOS (tlendpos
)))
12963 if (CHARPOS (tlbufpos
) > BEGV
12964 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12965 && (CHARPOS (tlbufpos
) == ZV
12966 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12967 /* Former continuation line has disappeared by becoming empty. */
12969 else if (XFASTINT (w
->last_modified
) < MODIFF
12970 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12971 || MINI_WINDOW_P (w
))
12973 /* We have to handle the case of continuation around a
12974 wide-column character (see the comment in indent.c around
12977 For instance, in the following case:
12979 -------- Insert --------
12980 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12981 J_I_ ==> J_I_ `^^' are cursors.
12985 As we have to redraw the line above, we cannot use this
12989 int line_height_before
= this_line_pixel_height
;
12991 /* Note that start_display will handle the case that the
12992 line starting at tlbufpos is a continuation line. */
12993 start_display (&it
, w
, tlbufpos
);
12995 /* Implementation note: It this still necessary? */
12996 if (it
.current_x
!= this_line_start_x
)
12999 TRACE ((stderr
, "trying display optimization 1\n"));
13000 w
->cursor
.vpos
= -1;
13001 overlay_arrow_seen
= 0;
13002 it
.vpos
= this_line_vpos
;
13003 it
.current_y
= this_line_y
;
13004 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13005 display_line (&it
);
13007 /* If line contains point, is not continued,
13008 and ends at same distance from eob as before, we win. */
13009 if (w
->cursor
.vpos
>= 0
13010 /* Line is not continued, otherwise this_line_start_pos
13011 would have been set to 0 in display_line. */
13012 && CHARPOS (this_line_start_pos
)
13013 /* Line ends as before. */
13014 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13015 /* Line has same height as before. Otherwise other lines
13016 would have to be shifted up or down. */
13017 && this_line_pixel_height
== line_height_before
)
13019 /* If this is not the window's last line, we must adjust
13020 the charstarts of the lines below. */
13021 if (it
.current_y
< it
.last_visible_y
)
13023 struct glyph_row
*row
13024 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13025 EMACS_INT delta
, delta_bytes
;
13027 /* We used to distinguish between two cases here,
13028 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13029 when the line ends in a newline or the end of the
13030 buffer's accessible portion. But both cases did
13031 the same, so they were collapsed. */
13033 - CHARPOS (tlendpos
)
13034 - MATRIX_ROW_START_CHARPOS (row
));
13035 delta_bytes
= (Z_BYTE
13036 - BYTEPOS (tlendpos
)
13037 - MATRIX_ROW_START_BYTEPOS (row
));
13039 increment_matrix_positions (w
->current_matrix
,
13040 this_line_vpos
+ 1,
13041 w
->current_matrix
->nrows
,
13042 delta
, delta_bytes
);
13045 /* If this row displays text now but previously didn't,
13046 or vice versa, w->window_end_vpos may have to be
13048 if ((it
.glyph_row
- 1)->displays_text_p
)
13050 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13051 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13053 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13054 && this_line_vpos
> 0)
13055 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13056 w
->window_end_valid
= Qnil
;
13058 /* Update hint: No need to try to scroll in update_window. */
13059 w
->desired_matrix
->no_scrolling_p
= 1;
13062 *w
->desired_matrix
->method
= 0;
13063 debug_method_add (w
, "optimization 1");
13065 #ifdef HAVE_WINDOW_SYSTEM
13066 update_window_fringes (w
, 0);
13073 else if (/* Cursor position hasn't changed. */
13074 PT
== XFASTINT (w
->last_point
)
13075 /* Make sure the cursor was last displayed
13076 in this window. Otherwise we have to reposition it. */
13077 && 0 <= w
->cursor
.vpos
13078 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13082 do_pending_window_change (1);
13083 /* If selected_window changed, redisplay again. */
13084 if (WINDOWP (selected_window
)
13085 && (w
= XWINDOW (selected_window
)) != sw
)
13088 /* We used to always goto end_of_redisplay here, but this
13089 isn't enough if we have a blinking cursor. */
13090 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13091 goto end_of_redisplay
;
13095 /* If highlighting the region, or if the cursor is in the echo area,
13096 then we can't just move the cursor. */
13097 else if (! (!NILP (Vtransient_mark_mode
)
13098 && !NILP (BVAR (current_buffer
, mark_active
)))
13099 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13100 || highlight_nonselected_windows
)
13101 && NILP (w
->region_showing
)
13102 && NILP (Vshow_trailing_whitespace
)
13103 && !cursor_in_echo_area
)
13106 struct glyph_row
*row
;
13108 /* Skip from tlbufpos to PT and see where it is. Note that
13109 PT may be in invisible text. If so, we will end at the
13110 next visible position. */
13111 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13112 NULL
, DEFAULT_FACE_ID
);
13113 it
.current_x
= this_line_start_x
;
13114 it
.current_y
= this_line_y
;
13115 it
.vpos
= this_line_vpos
;
13117 /* The call to move_it_to stops in front of PT, but
13118 moves over before-strings. */
13119 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13121 if (it
.vpos
== this_line_vpos
13122 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13125 xassert (this_line_vpos
== it
.vpos
);
13126 xassert (this_line_y
== it
.current_y
);
13127 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13129 *w
->desired_matrix
->method
= 0;
13130 debug_method_add (w
, "optimization 3");
13139 /* Text changed drastically or point moved off of line. */
13140 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13143 CHARPOS (this_line_start_pos
) = 0;
13144 consider_all_windows_p
|= buffer_shared
> 1;
13145 ++clear_face_cache_count
;
13146 #ifdef HAVE_WINDOW_SYSTEM
13147 ++clear_image_cache_count
;
13150 /* Build desired matrices, and update the display. If
13151 consider_all_windows_p is non-zero, do it for all windows on all
13152 frames. Otherwise do it for selected_window, only. */
13154 if (consider_all_windows_p
)
13156 Lisp_Object tail
, frame
;
13158 FOR_EACH_FRAME (tail
, frame
)
13159 XFRAME (frame
)->updated_p
= 0;
13161 /* Recompute # windows showing selected buffer. This will be
13162 incremented each time such a window is displayed. */
13165 FOR_EACH_FRAME (tail
, frame
)
13167 struct frame
*f
= XFRAME (frame
);
13169 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13171 if (! EQ (frame
, selected_frame
))
13172 /* Select the frame, for the sake of frame-local
13174 select_frame_for_redisplay (frame
);
13176 /* Mark all the scroll bars to be removed; we'll redeem
13177 the ones we want when we redisplay their windows. */
13178 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13179 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13181 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13182 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13184 /* The X error handler may have deleted that frame. */
13185 if (!FRAME_LIVE_P (f
))
13188 /* Any scroll bars which redisplay_windows should have
13189 nuked should now go away. */
13190 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13191 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13193 /* If fonts changed, display again. */
13194 /* ??? rms: I suspect it is a mistake to jump all the way
13195 back to retry here. It should just retry this frame. */
13196 if (fonts_changed_p
)
13199 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13201 /* See if we have to hscroll. */
13202 if (!f
->already_hscrolled_p
)
13204 f
->already_hscrolled_p
= 1;
13205 if (hscroll_windows (f
->root_window
))
13209 /* Prevent various kinds of signals during display
13210 update. stdio is not robust about handling
13211 signals, which can cause an apparent I/O
13213 if (interrupt_input
)
13214 unrequest_sigio ();
13217 /* Update the display. */
13218 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13219 pending
|= update_frame (f
, 0, 0);
13225 if (!EQ (old_frame
, selected_frame
)
13226 && FRAME_LIVE_P (XFRAME (old_frame
)))
13227 /* We played a bit fast-and-loose above and allowed selected_frame
13228 and selected_window to be temporarily out-of-sync but let's make
13229 sure this stays contained. */
13230 select_frame_for_redisplay (old_frame
);
13231 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13235 /* Do the mark_window_display_accurate after all windows have
13236 been redisplayed because this call resets flags in buffers
13237 which are needed for proper redisplay. */
13238 FOR_EACH_FRAME (tail
, frame
)
13240 struct frame
*f
= XFRAME (frame
);
13243 mark_window_display_accurate (f
->root_window
, 1);
13244 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13245 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13250 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13252 Lisp_Object mini_window
;
13253 struct frame
*mini_frame
;
13255 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13256 /* Use list_of_error, not Qerror, so that
13257 we catch only errors and don't run the debugger. */
13258 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13260 redisplay_window_error
);
13262 /* Compare desired and current matrices, perform output. */
13265 /* If fonts changed, display again. */
13266 if (fonts_changed_p
)
13269 /* Prevent various kinds of signals during display update.
13270 stdio is not robust about handling signals,
13271 which can cause an apparent I/O error. */
13272 if (interrupt_input
)
13273 unrequest_sigio ();
13276 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13278 if (hscroll_windows (selected_window
))
13281 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13282 pending
= update_frame (sf
, 0, 0);
13285 /* We may have called echo_area_display at the top of this
13286 function. If the echo area is on another frame, that may
13287 have put text on a frame other than the selected one, so the
13288 above call to update_frame would not have caught it. Catch
13290 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13291 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13293 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13295 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13296 pending
|= update_frame (mini_frame
, 0, 0);
13297 if (!pending
&& hscroll_windows (mini_window
))
13302 /* If display was paused because of pending input, make sure we do a
13303 thorough update the next time. */
13306 /* Prevent the optimization at the beginning of
13307 redisplay_internal that tries a single-line update of the
13308 line containing the cursor in the selected window. */
13309 CHARPOS (this_line_start_pos
) = 0;
13311 /* Let the overlay arrow be updated the next time. */
13312 update_overlay_arrows (0);
13314 /* If we pause after scrolling, some rows in the current
13315 matrices of some windows are not valid. */
13316 if (!WINDOW_FULL_WIDTH_P (w
)
13317 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13318 update_mode_lines
= 1;
13322 if (!consider_all_windows_p
)
13324 /* This has already been done above if
13325 consider_all_windows_p is set. */
13326 mark_window_display_accurate_1 (w
, 1);
13328 /* Say overlay arrows are up to date. */
13329 update_overlay_arrows (1);
13331 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13332 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13335 update_mode_lines
= 0;
13336 windows_or_buffers_changed
= 0;
13337 cursor_type_changed
= 0;
13340 /* Start SIGIO interrupts coming again. Having them off during the
13341 code above makes it less likely one will discard output, but not
13342 impossible, since there might be stuff in the system buffer here.
13343 But it is much hairier to try to do anything about that. */
13344 if (interrupt_input
)
13348 /* If a frame has become visible which was not before, redisplay
13349 again, so that we display it. Expose events for such a frame
13350 (which it gets when becoming visible) don't call the parts of
13351 redisplay constructing glyphs, so simply exposing a frame won't
13352 display anything in this case. So, we have to display these
13353 frames here explicitly. */
13356 Lisp_Object tail
, frame
;
13359 FOR_EACH_FRAME (tail
, frame
)
13361 int this_is_visible
= 0;
13363 if (XFRAME (frame
)->visible
)
13364 this_is_visible
= 1;
13365 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13366 if (XFRAME (frame
)->visible
)
13367 this_is_visible
= 1;
13369 if (this_is_visible
)
13373 if (new_count
!= number_of_visible_frames
)
13374 windows_or_buffers_changed
++;
13377 /* Change frame size now if a change is pending. */
13378 do_pending_window_change (1);
13380 /* If we just did a pending size change, or have additional
13381 visible frames, or selected_window changed, redisplay again. */
13382 if ((windows_or_buffers_changed
&& !pending
)
13383 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13386 /* Clear the face and image caches.
13388 We used to do this only if consider_all_windows_p. But the cache
13389 needs to be cleared if a timer creates images in the current
13390 buffer (e.g. the test case in Bug#6230). */
13392 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13394 clear_face_cache (0);
13395 clear_face_cache_count
= 0;
13398 #ifdef HAVE_WINDOW_SYSTEM
13399 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13401 clear_image_caches (Qnil
);
13402 clear_image_cache_count
= 0;
13404 #endif /* HAVE_WINDOW_SYSTEM */
13407 unbind_to (count
, Qnil
);
13412 /* Redisplay, but leave alone any recent echo area message unless
13413 another message has been requested in its place.
13415 This is useful in situations where you need to redisplay but no
13416 user action has occurred, making it inappropriate for the message
13417 area to be cleared. See tracking_off and
13418 wait_reading_process_output for examples of these situations.
13420 FROM_WHERE is an integer saying from where this function was
13421 called. This is useful for debugging. */
13424 redisplay_preserve_echo_area (int from_where
)
13426 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13428 if (!NILP (echo_area_buffer
[1]))
13430 /* We have a previously displayed message, but no current
13431 message. Redisplay the previous message. */
13432 display_last_displayed_message_p
= 1;
13433 redisplay_internal ();
13434 display_last_displayed_message_p
= 0;
13437 redisplay_internal ();
13439 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13440 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13441 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13445 /* Function registered with record_unwind_protect in
13446 redisplay_internal. Reset redisplaying_p to the value it had
13447 before redisplay_internal was called, and clear
13448 prevent_freeing_realized_faces_p. It also selects the previously
13449 selected frame, unless it has been deleted (by an X connection
13450 failure during redisplay, for example). */
13453 unwind_redisplay (Lisp_Object val
)
13455 Lisp_Object old_redisplaying_p
, old_frame
;
13457 old_redisplaying_p
= XCAR (val
);
13458 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13459 old_frame
= XCDR (val
);
13460 if (! EQ (old_frame
, selected_frame
)
13461 && FRAME_LIVE_P (XFRAME (old_frame
)))
13462 select_frame_for_redisplay (old_frame
);
13467 /* Mark the display of window W as accurate or inaccurate. If
13468 ACCURATE_P is non-zero mark display of W as accurate. If
13469 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13470 redisplay_internal is called. */
13473 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13475 if (BUFFERP (w
->buffer
))
13477 struct buffer
*b
= XBUFFER (w
->buffer
);
13480 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13481 w
->last_overlay_modified
13482 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13484 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13488 b
->clip_changed
= 0;
13489 b
->prevent_redisplay_optimizations_p
= 0;
13491 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13492 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13493 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13494 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13496 w
->current_matrix
->buffer
= b
;
13497 w
->current_matrix
->begv
= BUF_BEGV (b
);
13498 w
->current_matrix
->zv
= BUF_ZV (b
);
13500 w
->last_cursor
= w
->cursor
;
13501 w
->last_cursor_off_p
= w
->cursor_off_p
;
13503 if (w
== XWINDOW (selected_window
))
13504 w
->last_point
= make_number (BUF_PT (b
));
13506 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13512 w
->window_end_valid
= w
->buffer
;
13513 w
->update_mode_line
= Qnil
;
13518 /* Mark the display of windows in the window tree rooted at WINDOW as
13519 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13520 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13521 be redisplayed the next time redisplay_internal is called. */
13524 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13528 for (; !NILP (window
); window
= w
->next
)
13530 w
= XWINDOW (window
);
13531 mark_window_display_accurate_1 (w
, accurate_p
);
13533 if (!NILP (w
->vchild
))
13534 mark_window_display_accurate (w
->vchild
, accurate_p
);
13535 if (!NILP (w
->hchild
))
13536 mark_window_display_accurate (w
->hchild
, accurate_p
);
13541 update_overlay_arrows (1);
13545 /* Force a thorough redisplay the next time by setting
13546 last_arrow_position and last_arrow_string to t, which is
13547 unequal to any useful value of Voverlay_arrow_... */
13548 update_overlay_arrows (-1);
13553 /* Return value in display table DP (Lisp_Char_Table *) for character
13554 C. Since a display table doesn't have any parent, we don't have to
13555 follow parent. Do not call this function directly but use the
13556 macro DISP_CHAR_VECTOR. */
13559 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13563 if (ASCII_CHAR_P (c
))
13566 if (SUB_CHAR_TABLE_P (val
))
13567 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13573 XSETCHAR_TABLE (table
, dp
);
13574 val
= char_table_ref (table
, c
);
13583 /***********************************************************************
13585 ***********************************************************************/
13587 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13590 redisplay_windows (Lisp_Object window
)
13592 while (!NILP (window
))
13594 struct window
*w
= XWINDOW (window
);
13596 if (!NILP (w
->hchild
))
13597 redisplay_windows (w
->hchild
);
13598 else if (!NILP (w
->vchild
))
13599 redisplay_windows (w
->vchild
);
13600 else if (!NILP (w
->buffer
))
13602 displayed_buffer
= XBUFFER (w
->buffer
);
13603 /* Use list_of_error, not Qerror, so that
13604 we catch only errors and don't run the debugger. */
13605 internal_condition_case_1 (redisplay_window_0
, window
,
13607 redisplay_window_error
);
13615 redisplay_window_error (Lisp_Object ignore
)
13617 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13622 redisplay_window_0 (Lisp_Object window
)
13624 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13625 redisplay_window (window
, 0);
13630 redisplay_window_1 (Lisp_Object window
)
13632 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13633 redisplay_window (window
, 1);
13638 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13639 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13640 which positions recorded in ROW differ from current buffer
13643 Return 0 if cursor is not on this row, 1 otherwise. */
13646 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13647 struct glyph_matrix
*matrix
,
13648 EMACS_INT delta
, EMACS_INT delta_bytes
,
13651 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13652 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13653 struct glyph
*cursor
= NULL
;
13654 /* The last known character position in row. */
13655 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13657 EMACS_INT pt_old
= PT
- delta
;
13658 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13659 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13660 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13661 /* A glyph beyond the edge of TEXT_AREA which we should never
13663 struct glyph
*glyphs_end
= end
;
13664 /* Non-zero means we've found a match for cursor position, but that
13665 glyph has the avoid_cursor_p flag set. */
13666 int match_with_avoid_cursor
= 0;
13667 /* Non-zero means we've seen at least one glyph that came from a
13669 int string_seen
= 0;
13670 /* Largest and smallest buffer positions seen so far during scan of
13672 EMACS_INT bpos_max
= pos_before
;
13673 EMACS_INT bpos_min
= pos_after
;
13674 /* Last buffer position covered by an overlay string with an integer
13675 `cursor' property. */
13676 EMACS_INT bpos_covered
= 0;
13677 /* Non-zero means the display string on which to display the cursor
13678 comes from a text property, not from an overlay. */
13679 int string_from_text_prop
= 0;
13681 /* Skip over glyphs not having an object at the start and the end of
13682 the row. These are special glyphs like truncation marks on
13683 terminal frames. */
13684 if (row
->displays_text_p
)
13686 if (!row
->reversed_p
)
13689 && INTEGERP (glyph
->object
)
13690 && glyph
->charpos
< 0)
13692 x
+= glyph
->pixel_width
;
13696 && INTEGERP ((end
- 1)->object
)
13697 /* CHARPOS is zero for blanks and stretch glyphs
13698 inserted by extend_face_to_end_of_line. */
13699 && (end
- 1)->charpos
<= 0)
13701 glyph_before
= glyph
- 1;
13708 /* If the glyph row is reversed, we need to process it from back
13709 to front, so swap the edge pointers. */
13710 glyphs_end
= end
= glyph
- 1;
13711 glyph
+= row
->used
[TEXT_AREA
] - 1;
13713 while (glyph
> end
+ 1
13714 && INTEGERP (glyph
->object
)
13715 && glyph
->charpos
< 0)
13718 x
-= glyph
->pixel_width
;
13720 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13722 /* By default, in reversed rows we put the cursor on the
13723 rightmost (first in the reading order) glyph. */
13724 for (g
= end
+ 1; g
< glyph
; g
++)
13725 x
+= g
->pixel_width
;
13727 && INTEGERP ((end
+ 1)->object
)
13728 && (end
+ 1)->charpos
<= 0)
13730 glyph_before
= glyph
+ 1;
13734 else if (row
->reversed_p
)
13736 /* In R2L rows that don't display text, put the cursor on the
13737 rightmost glyph. Case in point: an empty last line that is
13738 part of an R2L paragraph. */
13740 /* Avoid placing the cursor on the last glyph of the row, where
13741 on terminal frames we hold the vertical border between
13742 adjacent windows. */
13743 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13744 && !WINDOW_RIGHTMOST_P (w
)
13745 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13747 x
= -1; /* will be computed below, at label compute_x */
13750 /* Step 1: Try to find the glyph whose character position
13751 corresponds to point. If that's not possible, find 2 glyphs
13752 whose character positions are the closest to point, one before
13753 point, the other after it. */
13754 if (!row
->reversed_p
)
13755 while (/* not marched to end of glyph row */
13757 /* glyph was not inserted by redisplay for internal purposes */
13758 && !INTEGERP (glyph
->object
))
13760 if (BUFFERP (glyph
->object
))
13762 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13764 if (glyph
->charpos
> bpos_max
)
13765 bpos_max
= glyph
->charpos
;
13766 if (glyph
->charpos
< bpos_min
)
13767 bpos_min
= glyph
->charpos
;
13768 if (!glyph
->avoid_cursor_p
)
13770 /* If we hit point, we've found the glyph on which to
13771 display the cursor. */
13774 match_with_avoid_cursor
= 0;
13777 /* See if we've found a better approximation to
13778 POS_BEFORE or to POS_AFTER. Note that we want the
13779 first (leftmost) glyph of all those that are the
13780 closest from below, and the last (rightmost) of all
13781 those from above. */
13782 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13784 pos_before
= glyph
->charpos
;
13785 glyph_before
= glyph
;
13787 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13789 pos_after
= glyph
->charpos
;
13790 glyph_after
= glyph
;
13793 else if (dpos
== 0)
13794 match_with_avoid_cursor
= 1;
13796 else if (STRINGP (glyph
->object
))
13798 Lisp_Object chprop
;
13799 EMACS_INT glyph_pos
= glyph
->charpos
;
13801 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13803 if (!NILP (chprop
))
13805 /* If the string came from a `display' text property,
13806 look up the buffer position of that property and
13807 use that position to update bpos_max, as if we
13808 actually saw such a position in one of the row's
13809 glyphs. This helps with supporting integer values
13810 of `cursor' property on the display string in
13811 situations where most or all of the row's buffer
13812 text is completely covered by display properties,
13813 so that no glyph with valid buffer positions is
13814 ever seen in the row. */
13815 EMACS_INT prop_pos
=
13816 string_buffer_position_lim (glyph
->object
, pos_before
,
13819 if (prop_pos
>= pos_before
)
13820 bpos_max
= prop_pos
- 1;
13822 if (INTEGERP (chprop
))
13824 bpos_covered
= bpos_max
+ XINT (chprop
);
13825 /* If the `cursor' property covers buffer positions up
13826 to and including point, we should display cursor on
13827 this glyph. Note that, if a `cursor' property on one
13828 of the string's characters has an integer value, we
13829 will break out of the loop below _before_ we get to
13830 the position match above. IOW, integer values of
13831 the `cursor' property override the "exact match for
13832 point" strategy of positioning the cursor. */
13833 /* Implementation note: bpos_max == pt_old when, e.g.,
13834 we are in an empty line, where bpos_max is set to
13835 MATRIX_ROW_START_CHARPOS, see above. */
13836 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13845 x
+= glyph
->pixel_width
;
13848 else if (glyph
> end
) /* row is reversed */
13849 while (!INTEGERP (glyph
->object
))
13851 if (BUFFERP (glyph
->object
))
13853 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13855 if (glyph
->charpos
> bpos_max
)
13856 bpos_max
= glyph
->charpos
;
13857 if (glyph
->charpos
< bpos_min
)
13858 bpos_min
= glyph
->charpos
;
13859 if (!glyph
->avoid_cursor_p
)
13863 match_with_avoid_cursor
= 0;
13866 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13868 pos_before
= glyph
->charpos
;
13869 glyph_before
= glyph
;
13871 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13873 pos_after
= glyph
->charpos
;
13874 glyph_after
= glyph
;
13877 else if (dpos
== 0)
13878 match_with_avoid_cursor
= 1;
13880 else if (STRINGP (glyph
->object
))
13882 Lisp_Object chprop
;
13883 EMACS_INT glyph_pos
= glyph
->charpos
;
13885 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13887 if (!NILP (chprop
))
13889 EMACS_INT prop_pos
=
13890 string_buffer_position_lim (glyph
->object
, pos_before
,
13893 if (prop_pos
>= pos_before
)
13894 bpos_max
= prop_pos
- 1;
13896 if (INTEGERP (chprop
))
13898 bpos_covered
= bpos_max
+ XINT (chprop
);
13899 /* If the `cursor' property covers buffer positions up
13900 to and including point, we should display cursor on
13902 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13911 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13913 x
--; /* can't use any pixel_width */
13916 x
-= glyph
->pixel_width
;
13919 /* Step 2: If we didn't find an exact match for point, we need to
13920 look for a proper place to put the cursor among glyphs between
13921 GLYPH_BEFORE and GLYPH_AFTER. */
13922 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13923 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13924 && bpos_covered
< pt_old
)
13926 /* An empty line has a single glyph whose OBJECT is zero and
13927 whose CHARPOS is the position of a newline on that line.
13928 Note that on a TTY, there are more glyphs after that, which
13929 were produced by extend_face_to_end_of_line, but their
13930 CHARPOS is zero or negative. */
13932 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13933 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13935 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13937 EMACS_INT ellipsis_pos
;
13939 /* Scan back over the ellipsis glyphs. */
13940 if (!row
->reversed_p
)
13942 ellipsis_pos
= (glyph
- 1)->charpos
;
13943 while (glyph
> row
->glyphs
[TEXT_AREA
]
13944 && (glyph
- 1)->charpos
== ellipsis_pos
)
13945 glyph
--, x
-= glyph
->pixel_width
;
13946 /* That loop always goes one position too far, including
13947 the glyph before the ellipsis. So scan forward over
13949 x
+= glyph
->pixel_width
;
13952 else /* row is reversed */
13954 ellipsis_pos
= (glyph
+ 1)->charpos
;
13955 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13956 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13957 glyph
++, x
+= glyph
->pixel_width
;
13958 x
-= glyph
->pixel_width
;
13962 else if (match_with_avoid_cursor
)
13964 cursor
= glyph_after
;
13967 else if (string_seen
)
13969 int incr
= row
->reversed_p
? -1 : +1;
13971 /* Need to find the glyph that came out of a string which is
13972 present at point. That glyph is somewhere between
13973 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13974 positioned between POS_BEFORE and POS_AFTER in the
13976 struct glyph
*start
, *stop
;
13977 EMACS_INT pos
= pos_before
;
13981 /* If the row ends in a newline from a display string,
13982 reordering could have moved the glyphs belonging to the
13983 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13984 in this case we extend the search to the last glyph in
13985 the row that was not inserted by redisplay. */
13986 if (row
->ends_in_newline_from_string_p
)
13989 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13992 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13993 correspond to POS_BEFORE and POS_AFTER, respectively. We
13994 need START and STOP in the order that corresponds to the
13995 row's direction as given by its reversed_p flag. If the
13996 directionality of characters between POS_BEFORE and
13997 POS_AFTER is the opposite of the row's base direction,
13998 these characters will have been reordered for display,
13999 and we need to reverse START and STOP. */
14000 if (!row
->reversed_p
)
14002 start
= min (glyph_before
, glyph_after
);
14003 stop
= max (glyph_before
, glyph_after
);
14007 start
= max (glyph_before
, glyph_after
);
14008 stop
= min (glyph_before
, glyph_after
);
14010 for (glyph
= start
+ incr
;
14011 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14014 /* Any glyphs that come from the buffer are here because
14015 of bidi reordering. Skip them, and only pay
14016 attention to glyphs that came from some string. */
14017 if (STRINGP (glyph
->object
))
14021 /* If the display property covers the newline, we
14022 need to search for it one position farther. */
14023 EMACS_INT lim
= pos_after
14024 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14026 string_from_text_prop
= 0;
14027 str
= glyph
->object
;
14028 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14029 if (tem
== 0 /* from overlay */
14032 /* If the string from which this glyph came is
14033 found in the buffer at point, then we've
14034 found the glyph we've been looking for. If
14035 it comes from an overlay (tem == 0), and it
14036 has the `cursor' property on one of its
14037 glyphs, record that glyph as a candidate for
14038 displaying the cursor. (As in the
14039 unidirectional version, we will display the
14040 cursor on the last candidate we find.) */
14041 if (tem
== 0 || tem
== pt_old
)
14043 /* The glyphs from this string could have
14044 been reordered. Find the one with the
14045 smallest string position. Or there could
14046 be a character in the string with the
14047 `cursor' property, which means display
14048 cursor on that character's glyph. */
14049 EMACS_INT strpos
= glyph
->charpos
;
14054 string_from_text_prop
= 1;
14057 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14058 && EQ (glyph
->object
, str
);
14062 EMACS_INT gpos
= glyph
->charpos
;
14064 cprop
= Fget_char_property (make_number (gpos
),
14072 if (tem
&& glyph
->charpos
< strpos
)
14074 strpos
= glyph
->charpos
;
14083 pos
= tem
+ 1; /* don't find previous instances */
14085 /* This string is not what we want; skip all of the
14086 glyphs that came from it. */
14087 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14088 && EQ (glyph
->object
, str
))
14095 /* If we reached the end of the line, and END was from a string,
14096 the cursor is not on this line. */
14098 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14099 && STRINGP (end
->object
)
14100 && row
->continued_p
)
14103 /* A truncated row may not include PT among its character positions.
14104 Setting the cursor inside the scroll margin will trigger
14105 recalculation of hscroll in hscroll_window_tree. But if a
14106 display string covers point, defer to the string-handling
14107 code below to figure this out. */
14108 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14110 cursor
= glyph_before
;
14113 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14114 /* Zero-width characters produce no glyphs. */
14116 && (row
->reversed_p
14117 ? glyph_after
> glyphs_end
14118 : glyph_after
< glyphs_end
)))
14120 cursor
= glyph_after
;
14126 if (cursor
!= NULL
)
14132 /* Need to compute x that corresponds to GLYPH. */
14133 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14135 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14137 x
+= g
->pixel_width
;
14141 /* ROW could be part of a continued line, which, under bidi
14142 reordering, might have other rows whose start and end charpos
14143 occlude point. Only set w->cursor if we found a better
14144 approximation to the cursor position than we have from previously
14145 examined candidate rows belonging to the same continued line. */
14146 if (/* we already have a candidate row */
14147 w
->cursor
.vpos
>= 0
14148 /* that candidate is not the row we are processing */
14149 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14150 /* Make sure cursor.vpos specifies a row whose start and end
14151 charpos occlude point, and it is valid candidate for being a
14152 cursor-row. This is because some callers of this function
14153 leave cursor.vpos at the row where the cursor was displayed
14154 during the last redisplay cycle. */
14155 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14156 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14157 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14160 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14162 /* Don't consider glyphs that are outside TEXT_AREA. */
14163 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14165 /* Keep the candidate whose buffer position is the closest to
14166 point or has the `cursor' property. */
14167 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14168 w
->cursor
.hpos
>= 0
14169 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14170 && ((BUFFERP (g1
->object
)
14171 && (g1
->charpos
== pt_old
/* an exact match always wins */
14172 || (BUFFERP (glyph
->object
)
14173 && eabs (g1
->charpos
- pt_old
)
14174 < eabs (glyph
->charpos
- pt_old
))))
14175 /* previous candidate is a glyph from a string that has
14176 a non-nil `cursor' property */
14177 || (STRINGP (g1
->object
)
14178 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14179 Qcursor
, g1
->object
))
14180 /* previous candidate is from the same display
14181 string as this one, and the display string
14182 came from a text property */
14183 || (EQ (g1
->object
, glyph
->object
)
14184 && string_from_text_prop
)
14185 /* this candidate is from newline and its
14186 position is not an exact match */
14187 || (INTEGERP (glyph
->object
)
14188 && glyph
->charpos
!= pt_old
)))))
14190 /* If this candidate gives an exact match, use that. */
14191 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14192 /* If this candidate is a glyph created for the
14193 terminating newline of a line, and point is on that
14194 newline, it wins because it's an exact match. */
14195 || (!row
->continued_p
14196 && INTEGERP (glyph
->object
)
14197 && glyph
->charpos
== 0
14198 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14199 /* Otherwise, keep the candidate that comes from a row
14200 spanning less buffer positions. This may win when one or
14201 both candidate positions are on glyphs that came from
14202 display strings, for which we cannot compare buffer
14204 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14205 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14206 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14209 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14211 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14212 w
->cursor
.y
= row
->y
+ dy
;
14214 if (w
== XWINDOW (selected_window
))
14216 if (!row
->continued_p
14217 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14220 this_line_buffer
= XBUFFER (w
->buffer
);
14222 CHARPOS (this_line_start_pos
)
14223 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14224 BYTEPOS (this_line_start_pos
)
14225 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14227 CHARPOS (this_line_end_pos
)
14228 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14229 BYTEPOS (this_line_end_pos
)
14230 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14232 this_line_y
= w
->cursor
.y
;
14233 this_line_pixel_height
= row
->height
;
14234 this_line_vpos
= w
->cursor
.vpos
;
14235 this_line_start_x
= row
->x
;
14238 CHARPOS (this_line_start_pos
) = 0;
14245 /* Run window scroll functions, if any, for WINDOW with new window
14246 start STARTP. Sets the window start of WINDOW to that position.
14248 We assume that the window's buffer is really current. */
14250 static inline struct text_pos
14251 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14253 struct window
*w
= XWINDOW (window
);
14254 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14256 if (current_buffer
!= XBUFFER (w
->buffer
))
14259 if (!NILP (Vwindow_scroll_functions
))
14261 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14262 make_number (CHARPOS (startp
)));
14263 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14264 /* In case the hook functions switch buffers. */
14265 if (current_buffer
!= XBUFFER (w
->buffer
))
14266 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14273 /* Make sure the line containing the cursor is fully visible.
14274 A value of 1 means there is nothing to be done.
14275 (Either the line is fully visible, or it cannot be made so,
14276 or we cannot tell.)
14278 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14279 is higher than window.
14281 A value of 0 means the caller should do scrolling
14282 as if point had gone off the screen. */
14285 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14287 struct glyph_matrix
*matrix
;
14288 struct glyph_row
*row
;
14291 if (!make_cursor_line_fully_visible_p
)
14294 /* It's not always possible to find the cursor, e.g, when a window
14295 is full of overlay strings. Don't do anything in that case. */
14296 if (w
->cursor
.vpos
< 0)
14299 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14300 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14302 /* If the cursor row is not partially visible, there's nothing to do. */
14303 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14306 /* If the row the cursor is in is taller than the window's height,
14307 it's not clear what to do, so do nothing. */
14308 window_height
= window_box_height (w
);
14309 if (row
->height
>= window_height
)
14311 if (!force_p
|| MINI_WINDOW_P (w
)
14312 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14319 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14320 non-zero means only WINDOW is redisplayed in redisplay_internal.
14321 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14322 in redisplay_window to bring a partially visible line into view in
14323 the case that only the cursor has moved.
14325 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14326 last screen line's vertical height extends past the end of the screen.
14330 1 if scrolling succeeded
14332 0 if scrolling didn't find point.
14334 -1 if new fonts have been loaded so that we must interrupt
14335 redisplay, adjust glyph matrices, and try again. */
14341 SCROLLING_NEED_LARGER_MATRICES
14344 /* If scroll-conservatively is more than this, never recenter.
14346 If you change this, don't forget to update the doc string of
14347 `scroll-conservatively' and the Emacs manual. */
14348 #define SCROLL_LIMIT 100
14351 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14352 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14353 int temp_scroll_step
, int last_line_misfit
)
14355 struct window
*w
= XWINDOW (window
);
14356 struct frame
*f
= XFRAME (w
->frame
);
14357 struct text_pos pos
, startp
;
14359 int this_scroll_margin
, scroll_max
, rc
, height
;
14360 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14361 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14362 Lisp_Object aggressive
;
14363 /* We will never try scrolling more than this number of lines. */
14364 int scroll_limit
= SCROLL_LIMIT
;
14367 debug_method_add (w
, "try_scrolling");
14370 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14372 /* Compute scroll margin height in pixels. We scroll when point is
14373 within this distance from the top or bottom of the window. */
14374 if (scroll_margin
> 0)
14375 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14376 * FRAME_LINE_HEIGHT (f
);
14378 this_scroll_margin
= 0;
14380 /* Force arg_scroll_conservatively to have a reasonable value, to
14381 avoid scrolling too far away with slow move_it_* functions. Note
14382 that the user can supply scroll-conservatively equal to
14383 `most-positive-fixnum', which can be larger than INT_MAX. */
14384 if (arg_scroll_conservatively
> scroll_limit
)
14386 arg_scroll_conservatively
= scroll_limit
+ 1;
14387 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14389 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14390 /* Compute how much we should try to scroll maximally to bring
14391 point into view. */
14392 scroll_max
= (max (scroll_step
,
14393 max (arg_scroll_conservatively
, temp_scroll_step
))
14394 * FRAME_LINE_HEIGHT (f
));
14395 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14396 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14397 /* We're trying to scroll because of aggressive scrolling but no
14398 scroll_step is set. Choose an arbitrary one. */
14399 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14405 /* Decide whether to scroll down. */
14406 if (PT
> CHARPOS (startp
))
14408 int scroll_margin_y
;
14410 /* Compute the pixel ypos of the scroll margin, then move IT to
14411 either that ypos or PT, whichever comes first. */
14412 start_display (&it
, w
, startp
);
14413 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14414 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14415 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14416 (MOVE_TO_POS
| MOVE_TO_Y
));
14418 if (PT
> CHARPOS (it
.current
.pos
))
14420 int y0
= line_bottom_y (&it
);
14421 /* Compute how many pixels below window bottom to stop searching
14422 for PT. This avoids costly search for PT that is far away if
14423 the user limited scrolling by a small number of lines, but
14424 always finds PT if scroll_conservatively is set to a large
14425 number, such as most-positive-fixnum. */
14426 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14427 int y_to_move
= it
.last_visible_y
+ slack
;
14429 /* Compute the distance from the scroll margin to PT or to
14430 the scroll limit, whichever comes first. This should
14431 include the height of the cursor line, to make that line
14433 move_it_to (&it
, PT
, -1, y_to_move
,
14434 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14435 dy
= line_bottom_y (&it
) - y0
;
14437 if (dy
> scroll_max
)
14438 return SCROLLING_FAILED
;
14447 /* Point is in or below the bottom scroll margin, so move the
14448 window start down. If scrolling conservatively, move it just
14449 enough down to make point visible. If scroll_step is set,
14450 move it down by scroll_step. */
14451 if (arg_scroll_conservatively
)
14453 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14454 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14455 else if (scroll_step
|| temp_scroll_step
)
14456 amount_to_scroll
= scroll_max
;
14459 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14460 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14461 if (NUMBERP (aggressive
))
14463 double float_amount
= XFLOATINT (aggressive
) * height
;
14464 amount_to_scroll
= float_amount
;
14465 if (amount_to_scroll
== 0 && float_amount
> 0)
14466 amount_to_scroll
= 1;
14467 /* Don't let point enter the scroll margin near top of
14469 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14470 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14474 if (amount_to_scroll
<= 0)
14475 return SCROLLING_FAILED
;
14477 start_display (&it
, w
, startp
);
14478 if (arg_scroll_conservatively
<= scroll_limit
)
14479 move_it_vertically (&it
, amount_to_scroll
);
14482 /* Extra precision for users who set scroll-conservatively
14483 to a large number: make sure the amount we scroll
14484 the window start is never less than amount_to_scroll,
14485 which was computed as distance from window bottom to
14486 point. This matters when lines at window top and lines
14487 below window bottom have different height. */
14489 void *it1data
= NULL
;
14490 /* We use a temporary it1 because line_bottom_y can modify
14491 its argument, if it moves one line down; see there. */
14494 SAVE_IT (it1
, it
, it1data
);
14495 start_y
= line_bottom_y (&it1
);
14497 RESTORE_IT (&it
, &it
, it1data
);
14498 move_it_by_lines (&it
, 1);
14499 SAVE_IT (it1
, it
, it1data
);
14500 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14503 /* If STARTP is unchanged, move it down another screen line. */
14504 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14505 move_it_by_lines (&it
, 1);
14506 startp
= it
.current
.pos
;
14510 struct text_pos scroll_margin_pos
= startp
;
14512 /* See if point is inside the scroll margin at the top of the
14514 if (this_scroll_margin
)
14516 start_display (&it
, w
, startp
);
14517 move_it_vertically (&it
, this_scroll_margin
);
14518 scroll_margin_pos
= it
.current
.pos
;
14521 if (PT
< CHARPOS (scroll_margin_pos
))
14523 /* Point is in the scroll margin at the top of the window or
14524 above what is displayed in the window. */
14527 /* Compute the vertical distance from PT to the scroll
14528 margin position. Move as far as scroll_max allows, or
14529 one screenful, or 10 screen lines, whichever is largest.
14530 Give up if distance is greater than scroll_max. */
14531 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14532 start_display (&it
, w
, pos
);
14534 y_to_move
= max (it
.last_visible_y
,
14535 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14536 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14538 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14539 dy
= it
.current_y
- y0
;
14540 if (dy
> scroll_max
)
14541 return SCROLLING_FAILED
;
14543 /* Compute new window start. */
14544 start_display (&it
, w
, startp
);
14546 if (arg_scroll_conservatively
)
14547 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14548 max (scroll_step
, temp_scroll_step
));
14549 else if (scroll_step
|| temp_scroll_step
)
14550 amount_to_scroll
= scroll_max
;
14553 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14554 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14555 if (NUMBERP (aggressive
))
14557 double float_amount
= XFLOATINT (aggressive
) * height
;
14558 amount_to_scroll
= float_amount
;
14559 if (amount_to_scroll
== 0 && float_amount
> 0)
14560 amount_to_scroll
= 1;
14561 amount_to_scroll
-=
14562 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14563 /* Don't let point enter the scroll margin near
14564 bottom of the window. */
14565 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14566 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14570 if (amount_to_scroll
<= 0)
14571 return SCROLLING_FAILED
;
14573 move_it_vertically_backward (&it
, amount_to_scroll
);
14574 startp
= it
.current
.pos
;
14578 /* Run window scroll functions. */
14579 startp
= run_window_scroll_functions (window
, startp
);
14581 /* Display the window. Give up if new fonts are loaded, or if point
14583 if (!try_window (window
, startp
, 0))
14584 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14585 else if (w
->cursor
.vpos
< 0)
14587 clear_glyph_matrix (w
->desired_matrix
);
14588 rc
= SCROLLING_FAILED
;
14592 /* Maybe forget recorded base line for line number display. */
14593 if (!just_this_one_p
14594 || current_buffer
->clip_changed
14595 || BEG_UNCHANGED
< CHARPOS (startp
))
14596 w
->base_line_number
= Qnil
;
14598 /* If cursor ends up on a partially visible line,
14599 treat that as being off the bottom of the screen. */
14600 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14601 /* It's possible that the cursor is on the first line of the
14602 buffer, which is partially obscured due to a vscroll
14603 (Bug#7537). In that case, avoid looping forever . */
14604 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14606 clear_glyph_matrix (w
->desired_matrix
);
14607 ++extra_scroll_margin_lines
;
14610 rc
= SCROLLING_SUCCESS
;
14617 /* Compute a suitable window start for window W if display of W starts
14618 on a continuation line. Value is non-zero if a new window start
14621 The new window start will be computed, based on W's width, starting
14622 from the start of the continued line. It is the start of the
14623 screen line with the minimum distance from the old start W->start. */
14626 compute_window_start_on_continuation_line (struct window
*w
)
14628 struct text_pos pos
, start_pos
;
14629 int window_start_changed_p
= 0;
14631 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14633 /* If window start is on a continuation line... Window start may be
14634 < BEGV in case there's invisible text at the start of the
14635 buffer (M-x rmail, for example). */
14636 if (CHARPOS (start_pos
) > BEGV
14637 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14640 struct glyph_row
*row
;
14642 /* Handle the case that the window start is out of range. */
14643 if (CHARPOS (start_pos
) < BEGV
)
14644 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14645 else if (CHARPOS (start_pos
) > ZV
)
14646 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14648 /* Find the start of the continued line. This should be fast
14649 because scan_buffer is fast (newline cache). */
14650 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14651 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14652 row
, DEFAULT_FACE_ID
);
14653 reseat_at_previous_visible_line_start (&it
);
14655 /* If the line start is "too far" away from the window start,
14656 say it takes too much time to compute a new window start. */
14657 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14658 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14660 int min_distance
, distance
;
14662 /* Move forward by display lines to find the new window
14663 start. If window width was enlarged, the new start can
14664 be expected to be > the old start. If window width was
14665 decreased, the new window start will be < the old start.
14666 So, we're looking for the display line start with the
14667 minimum distance from the old window start. */
14668 pos
= it
.current
.pos
;
14669 min_distance
= INFINITY
;
14670 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14671 distance
< min_distance
)
14673 min_distance
= distance
;
14674 pos
= it
.current
.pos
;
14675 move_it_by_lines (&it
, 1);
14678 /* Set the window start there. */
14679 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14680 window_start_changed_p
= 1;
14684 return window_start_changed_p
;
14688 /* Try cursor movement in case text has not changed in window WINDOW,
14689 with window start STARTP. Value is
14691 CURSOR_MOVEMENT_SUCCESS if successful
14693 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14695 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14696 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14697 we want to scroll as if scroll-step were set to 1. See the code.
14699 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14700 which case we have to abort this redisplay, and adjust matrices
14705 CURSOR_MOVEMENT_SUCCESS
,
14706 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14707 CURSOR_MOVEMENT_MUST_SCROLL
,
14708 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14712 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14714 struct window
*w
= XWINDOW (window
);
14715 struct frame
*f
= XFRAME (w
->frame
);
14716 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14719 if (inhibit_try_cursor_movement
)
14723 /* Handle case where text has not changed, only point, and it has
14724 not moved off the frame. */
14725 if (/* Point may be in this window. */
14726 PT
>= CHARPOS (startp
)
14727 /* Selective display hasn't changed. */
14728 && !current_buffer
->clip_changed
14729 /* Function force-mode-line-update is used to force a thorough
14730 redisplay. It sets either windows_or_buffers_changed or
14731 update_mode_lines. So don't take a shortcut here for these
14733 && !update_mode_lines
14734 && !windows_or_buffers_changed
14735 && !cursor_type_changed
14736 /* Can't use this case if highlighting a region. When a
14737 region exists, cursor movement has to do more than just
14739 && !(!NILP (Vtransient_mark_mode
)
14740 && !NILP (BVAR (current_buffer
, mark_active
)))
14741 && NILP (w
->region_showing
)
14742 && NILP (Vshow_trailing_whitespace
)
14743 /* Right after splitting windows, last_point may be nil. */
14744 && INTEGERP (w
->last_point
)
14745 /* This code is not used for mini-buffer for the sake of the case
14746 of redisplaying to replace an echo area message; since in
14747 that case the mini-buffer contents per se are usually
14748 unchanged. This code is of no real use in the mini-buffer
14749 since the handling of this_line_start_pos, etc., in redisplay
14750 handles the same cases. */
14751 && !EQ (window
, minibuf_window
)
14752 /* When splitting windows or for new windows, it happens that
14753 redisplay is called with a nil window_end_vpos or one being
14754 larger than the window. This should really be fixed in
14755 window.c. I don't have this on my list, now, so we do
14756 approximately the same as the old redisplay code. --gerd. */
14757 && INTEGERP (w
->window_end_vpos
)
14758 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14759 && (FRAME_WINDOW_P (f
)
14760 || !overlay_arrow_in_current_buffer_p ()))
14762 int this_scroll_margin
, top_scroll_margin
;
14763 struct glyph_row
*row
= NULL
;
14766 debug_method_add (w
, "cursor movement");
14769 /* Scroll if point within this distance from the top or bottom
14770 of the window. This is a pixel value. */
14771 if (scroll_margin
> 0)
14773 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14774 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14777 this_scroll_margin
= 0;
14779 top_scroll_margin
= this_scroll_margin
;
14780 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14781 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14783 /* Start with the row the cursor was displayed during the last
14784 not paused redisplay. Give up if that row is not valid. */
14785 if (w
->last_cursor
.vpos
< 0
14786 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14787 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14790 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14791 if (row
->mode_line_p
)
14793 if (!row
->enabled_p
)
14794 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14797 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14799 int scroll_p
= 0, must_scroll
= 0;
14800 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14802 if (PT
> XFASTINT (w
->last_point
))
14804 /* Point has moved forward. */
14805 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14806 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14808 xassert (row
->enabled_p
);
14812 /* If the end position of a row equals the start
14813 position of the next row, and PT is at that position,
14814 we would rather display cursor in the next line. */
14815 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14816 && MATRIX_ROW_END_CHARPOS (row
) == PT
14817 && row
< w
->current_matrix
->rows
14818 + w
->current_matrix
->nrows
- 1
14819 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14820 && !cursor_row_p (row
))
14823 /* If within the scroll margin, scroll. Note that
14824 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14825 the next line would be drawn, and that
14826 this_scroll_margin can be zero. */
14827 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14828 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14829 /* Line is completely visible last line in window
14830 and PT is to be set in the next line. */
14831 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14832 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14833 && !row
->ends_at_zv_p
14834 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14837 else if (PT
< XFASTINT (w
->last_point
))
14839 /* Cursor has to be moved backward. Note that PT >=
14840 CHARPOS (startp) because of the outer if-statement. */
14841 while (!row
->mode_line_p
14842 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14843 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14844 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14845 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14846 row
> w
->current_matrix
->rows
14847 && (row
-1)->ends_in_newline_from_string_p
))))
14848 && (row
->y
> top_scroll_margin
14849 || CHARPOS (startp
) == BEGV
))
14851 xassert (row
->enabled_p
);
14855 /* Consider the following case: Window starts at BEGV,
14856 there is invisible, intangible text at BEGV, so that
14857 display starts at some point START > BEGV. It can
14858 happen that we are called with PT somewhere between
14859 BEGV and START. Try to handle that case. */
14860 if (row
< w
->current_matrix
->rows
14861 || row
->mode_line_p
)
14863 row
= w
->current_matrix
->rows
;
14864 if (row
->mode_line_p
)
14868 /* Due to newlines in overlay strings, we may have to
14869 skip forward over overlay strings. */
14870 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14871 && MATRIX_ROW_END_CHARPOS (row
) == PT
14872 && !cursor_row_p (row
))
14875 /* If within the scroll margin, scroll. */
14876 if (row
->y
< top_scroll_margin
14877 && CHARPOS (startp
) != BEGV
)
14882 /* Cursor did not move. So don't scroll even if cursor line
14883 is partially visible, as it was so before. */
14884 rc
= CURSOR_MOVEMENT_SUCCESS
;
14887 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14888 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14890 /* if PT is not in the glyph row, give up. */
14891 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14894 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14895 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14897 /* If rows are bidi-reordered and point moved, back up
14898 until we find a row that does not belong to a
14899 continuation line. This is because we must consider
14900 all rows of a continued line as candidates for the
14901 new cursor positioning, since row start and end
14902 positions change non-linearly with vertical position
14904 /* FIXME: Revisit this when glyph ``spilling'' in
14905 continuation lines' rows is implemented for
14906 bidi-reordered rows. */
14907 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14909 /* If we hit the beginning of the displayed portion
14910 without finding the first row of a continued
14912 if (row
<= w
->current_matrix
->rows
)
14914 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14917 xassert (row
->enabled_p
);
14923 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14924 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14925 && make_cursor_line_fully_visible_p
)
14927 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14928 && !row
->ends_at_zv_p
14929 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14930 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14931 else if (row
->height
> window_box_height (w
))
14933 /* If we end up in a partially visible line, let's
14934 make it fully visible, except when it's taller
14935 than the window, in which case we can't do much
14938 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14942 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14943 if (!cursor_row_fully_visible_p (w
, 0, 1))
14944 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14946 rc
= CURSOR_MOVEMENT_SUCCESS
;
14950 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14951 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14952 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14954 /* With bidi-reordered rows, there could be more than
14955 one candidate row whose start and end positions
14956 occlude point. We need to let set_cursor_from_row
14957 find the best candidate. */
14958 /* FIXME: Revisit this when glyph ``spilling'' in
14959 continuation lines' rows is implemented for
14960 bidi-reordered rows. */
14965 int at_zv_p
= 0, exact_match_p
= 0;
14967 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14968 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14969 && cursor_row_p (row
))
14970 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14972 /* As soon as we've found the exact match for point,
14973 or the first suitable row whose ends_at_zv_p flag
14974 is set, we are done. */
14976 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14978 && w
->cursor
.hpos
>= 0
14979 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14982 struct glyph_row
*candidate
=
14983 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14985 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14986 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14989 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14990 || (INTEGERP (g
->object
)
14991 && (g
->charpos
== PT
14992 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14994 if (rv
&& (at_zv_p
|| exact_match_p
))
14996 rc
= CURSOR_MOVEMENT_SUCCESS
;
14999 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15003 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15004 || row
->continued_p
)
15005 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15006 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15007 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15008 /* If we didn't find any candidate rows, or exited the
15009 loop before all the candidates were examined, signal
15010 to the caller that this method failed. */
15011 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15013 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15014 && !row
->continued_p
))
15015 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15017 rc
= CURSOR_MOVEMENT_SUCCESS
;
15023 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15025 rc
= CURSOR_MOVEMENT_SUCCESS
;
15030 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15031 && MATRIX_ROW_START_CHARPOS (row
) == PT
15032 && cursor_row_p (row
));
15040 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15044 set_vertical_scroll_bar (struct window
*w
)
15046 EMACS_INT start
, end
, whole
;
15048 /* Calculate the start and end positions for the current window.
15049 At some point, it would be nice to choose between scrollbars
15050 which reflect the whole buffer size, with special markers
15051 indicating narrowing, and scrollbars which reflect only the
15054 Note that mini-buffers sometimes aren't displaying any text. */
15055 if (!MINI_WINDOW_P (w
)
15056 || (w
== XWINDOW (minibuf_window
)
15057 && NILP (echo_area_buffer
[0])))
15059 struct buffer
*buf
= XBUFFER (w
->buffer
);
15060 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15061 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15062 /* I don't think this is guaranteed to be right. For the
15063 moment, we'll pretend it is. */
15064 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15068 if (whole
< (end
- start
))
15069 whole
= end
- start
;
15072 start
= end
= whole
= 0;
15074 /* Indicate what this scroll bar ought to be displaying now. */
15075 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15076 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15077 (w
, end
- start
, whole
, start
);
15081 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15082 selected_window is redisplayed.
15084 We can return without actually redisplaying the window if
15085 fonts_changed_p is nonzero. In that case, redisplay_internal will
15089 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15091 struct window
*w
= XWINDOW (window
);
15092 struct frame
*f
= XFRAME (w
->frame
);
15093 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15094 struct buffer
*old
= current_buffer
;
15095 struct text_pos lpoint
, opoint
, startp
;
15096 int update_mode_line
;
15099 /* Record it now because it's overwritten. */
15100 int current_matrix_up_to_date_p
= 0;
15101 int used_current_matrix_p
= 0;
15102 /* This is less strict than current_matrix_up_to_date_p.
15103 It indicates that the buffer contents and narrowing are unchanged. */
15104 int buffer_unchanged_p
= 0;
15105 int temp_scroll_step
= 0;
15106 int count
= SPECPDL_INDEX ();
15108 int centering_position
= -1;
15109 int last_line_misfit
= 0;
15110 EMACS_INT beg_unchanged
, end_unchanged
;
15112 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15115 /* W must be a leaf window here. */
15116 xassert (!NILP (w
->buffer
));
15118 *w
->desired_matrix
->method
= 0;
15122 reconsider_clip_changes (w
, buffer
);
15124 /* Has the mode line to be updated? */
15125 update_mode_line
= (!NILP (w
->update_mode_line
)
15126 || update_mode_lines
15127 || buffer
->clip_changed
15128 || buffer
->prevent_redisplay_optimizations_p
);
15130 if (MINI_WINDOW_P (w
))
15132 if (w
== XWINDOW (echo_area_window
)
15133 && !NILP (echo_area_buffer
[0]))
15135 if (update_mode_line
)
15136 /* We may have to update a tty frame's menu bar or a
15137 tool-bar. Example `M-x C-h C-h C-g'. */
15138 goto finish_menu_bars
;
15140 /* We've already displayed the echo area glyphs in this window. */
15141 goto finish_scroll_bars
;
15143 else if ((w
!= XWINDOW (minibuf_window
)
15144 || minibuf_level
== 0)
15145 /* When buffer is nonempty, redisplay window normally. */
15146 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15147 /* Quail displays non-mini buffers in minibuffer window.
15148 In that case, redisplay the window normally. */
15149 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15151 /* W is a mini-buffer window, but it's not active, so clear
15153 int yb
= window_text_bottom_y (w
);
15154 struct glyph_row
*row
;
15157 for (y
= 0, row
= w
->desired_matrix
->rows
;
15159 y
+= row
->height
, ++row
)
15160 blank_row (w
, row
, y
);
15161 goto finish_scroll_bars
;
15164 clear_glyph_matrix (w
->desired_matrix
);
15167 /* Otherwise set up data on this window; select its buffer and point
15169 /* Really select the buffer, for the sake of buffer-local
15171 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15173 current_matrix_up_to_date_p
15174 = (!NILP (w
->window_end_valid
)
15175 && !current_buffer
->clip_changed
15176 && !current_buffer
->prevent_redisplay_optimizations_p
15177 && XFASTINT (w
->last_modified
) >= MODIFF
15178 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15180 /* Run the window-bottom-change-functions
15181 if it is possible that the text on the screen has changed
15182 (either due to modification of the text, or any other reason). */
15183 if (!current_matrix_up_to_date_p
15184 && !NILP (Vwindow_text_change_functions
))
15186 safe_run_hooks (Qwindow_text_change_functions
);
15190 beg_unchanged
= BEG_UNCHANGED
;
15191 end_unchanged
= END_UNCHANGED
;
15193 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15195 specbind (Qinhibit_point_motion_hooks
, Qt
);
15198 = (!NILP (w
->window_end_valid
)
15199 && !current_buffer
->clip_changed
15200 && XFASTINT (w
->last_modified
) >= MODIFF
15201 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15203 /* When windows_or_buffers_changed is non-zero, we can't rely on
15204 the window end being valid, so set it to nil there. */
15205 if (windows_or_buffers_changed
)
15207 /* If window starts on a continuation line, maybe adjust the
15208 window start in case the window's width changed. */
15209 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15210 compute_window_start_on_continuation_line (w
);
15212 w
->window_end_valid
= Qnil
;
15215 /* Some sanity checks. */
15216 CHECK_WINDOW_END (w
);
15217 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15219 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15222 /* If %c is in mode line, update it if needed. */
15223 if (!NILP (w
->column_number_displayed
)
15224 /* This alternative quickly identifies a common case
15225 where no change is needed. */
15226 && !(PT
== XFASTINT (w
->last_point
)
15227 && XFASTINT (w
->last_modified
) >= MODIFF
15228 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15229 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15230 update_mode_line
= 1;
15232 /* Count number of windows showing the selected buffer. An indirect
15233 buffer counts as its base buffer. */
15234 if (!just_this_one_p
)
15236 struct buffer
*current_base
, *window_base
;
15237 current_base
= current_buffer
;
15238 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15239 if (current_base
->base_buffer
)
15240 current_base
= current_base
->base_buffer
;
15241 if (window_base
->base_buffer
)
15242 window_base
= window_base
->base_buffer
;
15243 if (current_base
== window_base
)
15247 /* Point refers normally to the selected window. For any other
15248 window, set up appropriate value. */
15249 if (!EQ (window
, selected_window
))
15251 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15252 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15256 new_pt_byte
= BEGV_BYTE
;
15257 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15259 else if (new_pt
> (ZV
- 1))
15262 new_pt_byte
= ZV_BYTE
;
15263 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15266 /* We don't use SET_PT so that the point-motion hooks don't run. */
15267 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15270 /* If any of the character widths specified in the display table
15271 have changed, invalidate the width run cache. It's true that
15272 this may be a bit late to catch such changes, but the rest of
15273 redisplay goes (non-fatally) haywire when the display table is
15274 changed, so why should we worry about doing any better? */
15275 if (current_buffer
->width_run_cache
)
15277 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15279 if (! disptab_matches_widthtab (disptab
,
15280 XVECTOR (BVAR (current_buffer
, width_table
))))
15282 invalidate_region_cache (current_buffer
,
15283 current_buffer
->width_run_cache
,
15285 recompute_width_table (current_buffer
, disptab
);
15289 /* If window-start is screwed up, choose a new one. */
15290 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15293 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15295 /* If someone specified a new starting point but did not insist,
15296 check whether it can be used. */
15297 if (!NILP (w
->optional_new_start
)
15298 && CHARPOS (startp
) >= BEGV
15299 && CHARPOS (startp
) <= ZV
)
15301 w
->optional_new_start
= Qnil
;
15302 start_display (&it
, w
, startp
);
15303 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15304 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15305 if (IT_CHARPOS (it
) == PT
)
15306 w
->force_start
= Qt
;
15307 /* IT may overshoot PT if text at PT is invisible. */
15308 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15309 w
->force_start
= Qt
;
15314 /* Handle case where place to start displaying has been specified,
15315 unless the specified location is outside the accessible range. */
15316 if (!NILP (w
->force_start
)
15317 || w
->frozen_window_start_p
)
15319 /* We set this later on if we have to adjust point. */
15322 w
->force_start
= Qnil
;
15324 w
->window_end_valid
= Qnil
;
15326 /* Forget any recorded base line for line number display. */
15327 if (!buffer_unchanged_p
)
15328 w
->base_line_number
= Qnil
;
15330 /* Redisplay the mode line. Select the buffer properly for that.
15331 Also, run the hook window-scroll-functions
15332 because we have scrolled. */
15333 /* Note, we do this after clearing force_start because
15334 if there's an error, it is better to forget about force_start
15335 than to get into an infinite loop calling the hook functions
15336 and having them get more errors. */
15337 if (!update_mode_line
15338 || ! NILP (Vwindow_scroll_functions
))
15340 update_mode_line
= 1;
15341 w
->update_mode_line
= Qt
;
15342 startp
= run_window_scroll_functions (window
, startp
);
15345 w
->last_modified
= make_number (0);
15346 w
->last_overlay_modified
= make_number (0);
15347 if (CHARPOS (startp
) < BEGV
)
15348 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15349 else if (CHARPOS (startp
) > ZV
)
15350 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15352 /* Redisplay, then check if cursor has been set during the
15353 redisplay. Give up if new fonts were loaded. */
15354 /* We used to issue a CHECK_MARGINS argument to try_window here,
15355 but this causes scrolling to fail when point begins inside
15356 the scroll margin (bug#148) -- cyd */
15357 if (!try_window (window
, startp
, 0))
15359 w
->force_start
= Qt
;
15360 clear_glyph_matrix (w
->desired_matrix
);
15361 goto need_larger_matrices
;
15364 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15366 /* If point does not appear, try to move point so it does
15367 appear. The desired matrix has been built above, so we
15368 can use it here. */
15369 new_vpos
= window_box_height (w
) / 2;
15372 if (!cursor_row_fully_visible_p (w
, 0, 0))
15374 /* Point does appear, but on a line partly visible at end of window.
15375 Move it back to a fully-visible line. */
15376 new_vpos
= window_box_height (w
);
15379 /* If we need to move point for either of the above reasons,
15380 now actually do it. */
15383 struct glyph_row
*row
;
15385 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15386 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15389 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15390 MATRIX_ROW_START_BYTEPOS (row
));
15392 if (w
!= XWINDOW (selected_window
))
15393 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15394 else if (current_buffer
== old
)
15395 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15397 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15399 /* If we are highlighting the region, then we just changed
15400 the region, so redisplay to show it. */
15401 if (!NILP (Vtransient_mark_mode
)
15402 && !NILP (BVAR (current_buffer
, mark_active
)))
15404 clear_glyph_matrix (w
->desired_matrix
);
15405 if (!try_window (window
, startp
, 0))
15406 goto need_larger_matrices
;
15411 debug_method_add (w
, "forced window start");
15416 /* Handle case where text has not changed, only point, and it has
15417 not moved off the frame, and we are not retrying after hscroll.
15418 (current_matrix_up_to_date_p is nonzero when retrying.) */
15419 if (current_matrix_up_to_date_p
15420 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15421 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15425 case CURSOR_MOVEMENT_SUCCESS
:
15426 used_current_matrix_p
= 1;
15429 case CURSOR_MOVEMENT_MUST_SCROLL
:
15430 goto try_to_scroll
;
15436 /* If current starting point was originally the beginning of a line
15437 but no longer is, find a new starting point. */
15438 else if (!NILP (w
->start_at_line_beg
)
15439 && !(CHARPOS (startp
) <= BEGV
15440 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15443 debug_method_add (w
, "recenter 1");
15448 /* Try scrolling with try_window_id. Value is > 0 if update has
15449 been done, it is -1 if we know that the same window start will
15450 not work. It is 0 if unsuccessful for some other reason. */
15451 else if ((tem
= try_window_id (w
)) != 0)
15454 debug_method_add (w
, "try_window_id %d", tem
);
15457 if (fonts_changed_p
)
15458 goto need_larger_matrices
;
15462 /* Otherwise try_window_id has returned -1 which means that we
15463 don't want the alternative below this comment to execute. */
15465 else if (CHARPOS (startp
) >= BEGV
15466 && CHARPOS (startp
) <= ZV
15467 && PT
>= CHARPOS (startp
)
15468 && (CHARPOS (startp
) < ZV
15469 /* Avoid starting at end of buffer. */
15470 || CHARPOS (startp
) == BEGV
15471 || (XFASTINT (w
->last_modified
) >= MODIFF
15472 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15474 int d1
, d2
, d3
, d4
, d5
, d6
;
15476 /* If first window line is a continuation line, and window start
15477 is inside the modified region, but the first change is before
15478 current window start, we must select a new window start.
15480 However, if this is the result of a down-mouse event (e.g. by
15481 extending the mouse-drag-overlay), we don't want to select a
15482 new window start, since that would change the position under
15483 the mouse, resulting in an unwanted mouse-movement rather
15484 than a simple mouse-click. */
15485 if (NILP (w
->start_at_line_beg
)
15486 && NILP (do_mouse_tracking
)
15487 && CHARPOS (startp
) > BEGV
15488 && CHARPOS (startp
) > BEG
+ beg_unchanged
15489 && CHARPOS (startp
) <= Z
- end_unchanged
15490 /* Even if w->start_at_line_beg is nil, a new window may
15491 start at a line_beg, since that's how set_buffer_window
15492 sets it. So, we need to check the return value of
15493 compute_window_start_on_continuation_line. (See also
15495 && XMARKER (w
->start
)->buffer
== current_buffer
15496 && compute_window_start_on_continuation_line (w
)
15497 /* It doesn't make sense to force the window start like we
15498 do at label force_start if it is already known that point
15499 will not be visible in the resulting window, because
15500 doing so will move point from its correct position
15501 instead of scrolling the window to bring point into view.
15503 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15505 w
->force_start
= Qt
;
15506 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15511 debug_method_add (w
, "same window start");
15514 /* Try to redisplay starting at same place as before.
15515 If point has not moved off frame, accept the results. */
15516 if (!current_matrix_up_to_date_p
15517 /* Don't use try_window_reusing_current_matrix in this case
15518 because a window scroll function can have changed the
15520 || !NILP (Vwindow_scroll_functions
)
15521 || MINI_WINDOW_P (w
)
15522 || !(used_current_matrix_p
15523 = try_window_reusing_current_matrix (w
)))
15525 IF_DEBUG (debug_method_add (w
, "1"));
15526 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15527 /* -1 means we need to scroll.
15528 0 means we need new matrices, but fonts_changed_p
15529 is set in that case, so we will detect it below. */
15530 goto try_to_scroll
;
15533 if (fonts_changed_p
)
15534 goto need_larger_matrices
;
15536 if (w
->cursor
.vpos
>= 0)
15538 if (!just_this_one_p
15539 || current_buffer
->clip_changed
15540 || BEG_UNCHANGED
< CHARPOS (startp
))
15541 /* Forget any recorded base line for line number display. */
15542 w
->base_line_number
= Qnil
;
15544 if (!cursor_row_fully_visible_p (w
, 1, 0))
15546 clear_glyph_matrix (w
->desired_matrix
);
15547 last_line_misfit
= 1;
15549 /* Drop through and scroll. */
15554 clear_glyph_matrix (w
->desired_matrix
);
15559 w
->last_modified
= make_number (0);
15560 w
->last_overlay_modified
= make_number (0);
15562 /* Redisplay the mode line. Select the buffer properly for that. */
15563 if (!update_mode_line
)
15565 update_mode_line
= 1;
15566 w
->update_mode_line
= Qt
;
15569 /* Try to scroll by specified few lines. */
15570 if ((scroll_conservatively
15571 || emacs_scroll_step
15572 || temp_scroll_step
15573 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15574 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15575 && CHARPOS (startp
) >= BEGV
15576 && CHARPOS (startp
) <= ZV
)
15578 /* The function returns -1 if new fonts were loaded, 1 if
15579 successful, 0 if not successful. */
15580 int ss
= try_scrolling (window
, just_this_one_p
,
15581 scroll_conservatively
,
15583 temp_scroll_step
, last_line_misfit
);
15586 case SCROLLING_SUCCESS
:
15589 case SCROLLING_NEED_LARGER_MATRICES
:
15590 goto need_larger_matrices
;
15592 case SCROLLING_FAILED
:
15600 /* Finally, just choose a place to start which positions point
15601 according to user preferences. */
15606 debug_method_add (w
, "recenter");
15609 /* w->vscroll = 0; */
15611 /* Forget any previously recorded base line for line number display. */
15612 if (!buffer_unchanged_p
)
15613 w
->base_line_number
= Qnil
;
15615 /* Determine the window start relative to point. */
15616 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15617 it
.current_y
= it
.last_visible_y
;
15618 if (centering_position
< 0)
15622 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15624 EMACS_INT margin_pos
= CHARPOS (startp
);
15625 Lisp_Object aggressive
;
15628 /* If there is a scroll margin at the top of the window, find
15629 its character position. */
15631 /* Cannot call start_display if startp is not in the
15632 accessible region of the buffer. This can happen when we
15633 have just switched to a different buffer and/or changed
15634 its restriction. In that case, startp is initialized to
15635 the character position 1 (BEGV) because we did not yet
15636 have chance to display the buffer even once. */
15637 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15640 void *it1data
= NULL
;
15642 SAVE_IT (it1
, it
, it1data
);
15643 start_display (&it1
, w
, startp
);
15644 move_it_vertically (&it1
, margin
* FRAME_LINE_HEIGHT (f
));
15645 margin_pos
= IT_CHARPOS (it1
);
15646 RESTORE_IT (&it
, &it
, it1data
);
15648 scrolling_up
= PT
> margin_pos
;
15651 ? BVAR (current_buffer
, scroll_up_aggressively
)
15652 : BVAR (current_buffer
, scroll_down_aggressively
);
15654 if (!MINI_WINDOW_P (w
)
15655 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15659 /* Setting scroll-conservatively overrides
15660 scroll-*-aggressively. */
15661 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15663 double float_amount
= XFLOATINT (aggressive
);
15665 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15666 if (pt_offset
== 0 && float_amount
> 0)
15668 if (pt_offset
&& margin
> 0)
15671 /* Compute how much to move the window start backward from
15672 point so that point will be displayed where the user
15676 centering_position
= it
.last_visible_y
;
15678 centering_position
-= pt_offset
;
15679 centering_position
-=
15680 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15681 + WINDOW_HEADER_LINE_HEIGHT (w
);
15682 /* Don't let point enter the scroll margin near top of
15684 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15685 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15688 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15691 /* Set the window start half the height of the window backward
15693 centering_position
= window_box_height (w
) / 2;
15695 move_it_vertically_backward (&it
, centering_position
);
15697 xassert (IT_CHARPOS (it
) >= BEGV
);
15699 /* The function move_it_vertically_backward may move over more
15700 than the specified y-distance. If it->w is small, e.g. a
15701 mini-buffer window, we may end up in front of the window's
15702 display area. Start displaying at the start of the line
15703 containing PT in this case. */
15704 if (it
.current_y
<= 0)
15706 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15707 move_it_vertically_backward (&it
, 0);
15711 it
.current_x
= it
.hpos
= 0;
15713 /* Set the window start position here explicitly, to avoid an
15714 infinite loop in case the functions in window-scroll-functions
15716 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15718 /* Run scroll hooks. */
15719 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15721 /* Redisplay the window. */
15722 if (!current_matrix_up_to_date_p
15723 || windows_or_buffers_changed
15724 || cursor_type_changed
15725 /* Don't use try_window_reusing_current_matrix in this case
15726 because it can have changed the buffer. */
15727 || !NILP (Vwindow_scroll_functions
)
15728 || !just_this_one_p
15729 || MINI_WINDOW_P (w
)
15730 || !(used_current_matrix_p
15731 = try_window_reusing_current_matrix (w
)))
15732 try_window (window
, startp
, 0);
15734 /* If new fonts have been loaded (due to fontsets), give up. We
15735 have to start a new redisplay since we need to re-adjust glyph
15737 if (fonts_changed_p
)
15738 goto need_larger_matrices
;
15740 /* If cursor did not appear assume that the middle of the window is
15741 in the first line of the window. Do it again with the next line.
15742 (Imagine a window of height 100, displaying two lines of height
15743 60. Moving back 50 from it->last_visible_y will end in the first
15745 if (w
->cursor
.vpos
< 0)
15747 if (!NILP (w
->window_end_valid
)
15748 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15750 clear_glyph_matrix (w
->desired_matrix
);
15751 move_it_by_lines (&it
, 1);
15752 try_window (window
, it
.current
.pos
, 0);
15754 else if (PT
< IT_CHARPOS (it
))
15756 clear_glyph_matrix (w
->desired_matrix
);
15757 move_it_by_lines (&it
, -1);
15758 try_window (window
, it
.current
.pos
, 0);
15762 /* Not much we can do about it. */
15766 /* Consider the following case: Window starts at BEGV, there is
15767 invisible, intangible text at BEGV, so that display starts at
15768 some point START > BEGV. It can happen that we are called with
15769 PT somewhere between BEGV and START. Try to handle that case. */
15770 if (w
->cursor
.vpos
< 0)
15772 struct glyph_row
*row
= w
->current_matrix
->rows
;
15773 if (row
->mode_line_p
)
15775 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15778 if (!cursor_row_fully_visible_p (w
, 0, 0))
15780 /* If vscroll is enabled, disable it and try again. */
15784 clear_glyph_matrix (w
->desired_matrix
);
15788 /* Users who set scroll-conservatively to a large number want
15789 point just above/below the scroll margin. If we ended up
15790 with point's row partially visible, move the window start to
15791 make that row fully visible and out of the margin. */
15792 if (scroll_conservatively
> SCROLL_LIMIT
)
15796 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15798 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15800 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15801 clear_glyph_matrix (w
->desired_matrix
);
15802 if (1 == try_window (window
, it
.current
.pos
,
15803 TRY_WINDOW_CHECK_MARGINS
))
15807 /* If centering point failed to make the whole line visible,
15808 put point at the top instead. That has to make the whole line
15809 visible, if it can be done. */
15810 if (centering_position
== 0)
15813 clear_glyph_matrix (w
->desired_matrix
);
15814 centering_position
= 0;
15820 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15821 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15822 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15825 /* Display the mode line, if we must. */
15826 if ((update_mode_line
15827 /* If window not full width, must redo its mode line
15828 if (a) the window to its side is being redone and
15829 (b) we do a frame-based redisplay. This is a consequence
15830 of how inverted lines are drawn in frame-based redisplay. */
15831 || (!just_this_one_p
15832 && !FRAME_WINDOW_P (f
)
15833 && !WINDOW_FULL_WIDTH_P (w
))
15834 /* Line number to display. */
15835 || INTEGERP (w
->base_line_pos
)
15836 /* Column number is displayed and different from the one displayed. */
15837 || (!NILP (w
->column_number_displayed
)
15838 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15839 /* This means that the window has a mode line. */
15840 && (WINDOW_WANTS_MODELINE_P (w
)
15841 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15843 display_mode_lines (w
);
15845 /* If mode line height has changed, arrange for a thorough
15846 immediate redisplay using the correct mode line height. */
15847 if (WINDOW_WANTS_MODELINE_P (w
)
15848 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15850 fonts_changed_p
= 1;
15851 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15852 = DESIRED_MODE_LINE_HEIGHT (w
);
15855 /* If header line height has changed, arrange for a thorough
15856 immediate redisplay using the correct header line height. */
15857 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15858 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15860 fonts_changed_p
= 1;
15861 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15862 = DESIRED_HEADER_LINE_HEIGHT (w
);
15865 if (fonts_changed_p
)
15866 goto need_larger_matrices
;
15869 if (!line_number_displayed
15870 && !BUFFERP (w
->base_line_pos
))
15872 w
->base_line_pos
= Qnil
;
15873 w
->base_line_number
= Qnil
;
15878 /* When we reach a frame's selected window, redo the frame's menu bar. */
15879 if (update_mode_line
15880 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15882 int redisplay_menu_p
= 0;
15884 if (FRAME_WINDOW_P (f
))
15886 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15887 || defined (HAVE_NS) || defined (USE_GTK)
15888 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15890 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15894 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15896 if (redisplay_menu_p
)
15897 display_menu_bar (w
);
15899 #ifdef HAVE_WINDOW_SYSTEM
15900 if (FRAME_WINDOW_P (f
))
15902 #if defined (USE_GTK) || defined (HAVE_NS)
15903 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15904 redisplay_tool_bar (f
);
15906 if (WINDOWP (f
->tool_bar_window
)
15907 && (FRAME_TOOL_BAR_LINES (f
) > 0
15908 || !NILP (Vauto_resize_tool_bars
))
15909 && redisplay_tool_bar (f
))
15910 ignore_mouse_drag_p
= 1;
15916 #ifdef HAVE_WINDOW_SYSTEM
15917 if (FRAME_WINDOW_P (f
)
15918 && update_window_fringes (w
, (just_this_one_p
15919 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15920 || w
->pseudo_window_p
)))
15924 if (draw_window_fringes (w
, 1))
15925 x_draw_vertical_border (w
);
15929 #endif /* HAVE_WINDOW_SYSTEM */
15931 /* We go to this label, with fonts_changed_p nonzero,
15932 if it is necessary to try again using larger glyph matrices.
15933 We have to redeem the scroll bar even in this case,
15934 because the loop in redisplay_internal expects that. */
15935 need_larger_matrices
:
15937 finish_scroll_bars
:
15939 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15941 /* Set the thumb's position and size. */
15942 set_vertical_scroll_bar (w
);
15944 /* Note that we actually used the scroll bar attached to this
15945 window, so it shouldn't be deleted at the end of redisplay. */
15946 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15947 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15950 /* Restore current_buffer and value of point in it. The window
15951 update may have changed the buffer, so first make sure `opoint'
15952 is still valid (Bug#6177). */
15953 if (CHARPOS (opoint
) < BEGV
)
15954 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15955 else if (CHARPOS (opoint
) > ZV
)
15956 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15958 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15960 set_buffer_internal_1 (old
);
15961 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15962 shorter. This can be caused by log truncation in *Messages*. */
15963 if (CHARPOS (lpoint
) <= ZV
)
15964 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15966 unbind_to (count
, Qnil
);
15970 /* Build the complete desired matrix of WINDOW with a window start
15971 buffer position POS.
15973 Value is 1 if successful. It is zero if fonts were loaded during
15974 redisplay which makes re-adjusting glyph matrices necessary, and -1
15975 if point would appear in the scroll margins.
15976 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15977 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15981 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15983 struct window
*w
= XWINDOW (window
);
15985 struct glyph_row
*last_text_row
= NULL
;
15986 struct frame
*f
= XFRAME (w
->frame
);
15988 /* Make POS the new window start. */
15989 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15991 /* Mark cursor position as unknown. No overlay arrow seen. */
15992 w
->cursor
.vpos
= -1;
15993 overlay_arrow_seen
= 0;
15995 /* Initialize iterator and info to start at POS. */
15996 start_display (&it
, w
, pos
);
15998 /* Display all lines of W. */
15999 while (it
.current_y
< it
.last_visible_y
)
16001 if (display_line (&it
))
16002 last_text_row
= it
.glyph_row
- 1;
16003 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16007 /* Don't let the cursor end in the scroll margins. */
16008 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16009 && !MINI_WINDOW_P (w
))
16011 int this_scroll_margin
;
16013 if (scroll_margin
> 0)
16015 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16016 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
16019 this_scroll_margin
= 0;
16021 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16022 && w
->cursor
.y
< this_scroll_margin
16023 && CHARPOS (pos
) > BEGV
16024 && IT_CHARPOS (it
) < ZV
)
16025 /* rms: considering make_cursor_line_fully_visible_p here
16026 seems to give wrong results. We don't want to recenter
16027 when the last line is partly visible, we want to allow
16028 that case to be handled in the usual way. */
16029 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16031 w
->cursor
.vpos
= -1;
16032 clear_glyph_matrix (w
->desired_matrix
);
16037 /* If bottom moved off end of frame, change mode line percentage. */
16038 if (XFASTINT (w
->window_end_pos
) <= 0
16039 && Z
!= IT_CHARPOS (it
))
16040 w
->update_mode_line
= Qt
;
16042 /* Set window_end_pos to the offset of the last character displayed
16043 on the window from the end of current_buffer. Set
16044 window_end_vpos to its row number. */
16047 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16048 w
->window_end_bytepos
16049 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16051 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16053 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16054 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
16055 ->displays_text_p
);
16059 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16060 w
->window_end_pos
= make_number (Z
- ZV
);
16061 w
->window_end_vpos
= make_number (0);
16064 /* But that is not valid info until redisplay finishes. */
16065 w
->window_end_valid
= Qnil
;
16071 /************************************************************************
16072 Window redisplay reusing current matrix when buffer has not changed
16073 ************************************************************************/
16075 /* Try redisplay of window W showing an unchanged buffer with a
16076 different window start than the last time it was displayed by
16077 reusing its current matrix. Value is non-zero if successful.
16078 W->start is the new window start. */
16081 try_window_reusing_current_matrix (struct window
*w
)
16083 struct frame
*f
= XFRAME (w
->frame
);
16084 struct glyph_row
*bottom_row
;
16087 struct text_pos start
, new_start
;
16088 int nrows_scrolled
, i
;
16089 struct glyph_row
*last_text_row
;
16090 struct glyph_row
*last_reused_text_row
;
16091 struct glyph_row
*start_row
;
16092 int start_vpos
, min_y
, max_y
;
16095 if (inhibit_try_window_reusing
)
16099 if (/* This function doesn't handle terminal frames. */
16100 !FRAME_WINDOW_P (f
)
16101 /* Don't try to reuse the display if windows have been split
16103 || windows_or_buffers_changed
16104 || cursor_type_changed
)
16107 /* Can't do this if region may have changed. */
16108 if ((!NILP (Vtransient_mark_mode
)
16109 && !NILP (BVAR (current_buffer
, mark_active
)))
16110 || !NILP (w
->region_showing
)
16111 || !NILP (Vshow_trailing_whitespace
))
16114 /* If top-line visibility has changed, give up. */
16115 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16116 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16119 /* Give up if old or new display is scrolled vertically. We could
16120 make this function handle this, but right now it doesn't. */
16121 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16122 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16125 /* The variable new_start now holds the new window start. The old
16126 start `start' can be determined from the current matrix. */
16127 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16128 start
= start_row
->minpos
;
16129 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16131 /* Clear the desired matrix for the display below. */
16132 clear_glyph_matrix (w
->desired_matrix
);
16134 if (CHARPOS (new_start
) <= CHARPOS (start
))
16136 /* Don't use this method if the display starts with an ellipsis
16137 displayed for invisible text. It's not easy to handle that case
16138 below, and it's certainly not worth the effort since this is
16139 not a frequent case. */
16140 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16143 IF_DEBUG (debug_method_add (w
, "twu1"));
16145 /* Display up to a row that can be reused. The variable
16146 last_text_row is set to the last row displayed that displays
16147 text. Note that it.vpos == 0 if or if not there is a
16148 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16149 start_display (&it
, w
, new_start
);
16150 w
->cursor
.vpos
= -1;
16151 last_text_row
= last_reused_text_row
= NULL
;
16153 while (it
.current_y
< it
.last_visible_y
16154 && !fonts_changed_p
)
16156 /* If we have reached into the characters in the START row,
16157 that means the line boundaries have changed. So we
16158 can't start copying with the row START. Maybe it will
16159 work to start copying with the following row. */
16160 while (IT_CHARPOS (it
) > CHARPOS (start
))
16162 /* Advance to the next row as the "start". */
16164 start
= start_row
->minpos
;
16165 /* If there are no more rows to try, or just one, give up. */
16166 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16167 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16168 || CHARPOS (start
) == ZV
)
16170 clear_glyph_matrix (w
->desired_matrix
);
16174 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16176 /* If we have reached alignment, we can copy the rest of the
16178 if (IT_CHARPOS (it
) == CHARPOS (start
)
16179 /* Don't accept "alignment" inside a display vector,
16180 since start_row could have started in the middle of
16181 that same display vector (thus their character
16182 positions match), and we have no way of telling if
16183 that is the case. */
16184 && it
.current
.dpvec_index
< 0)
16187 if (display_line (&it
))
16188 last_text_row
= it
.glyph_row
- 1;
16192 /* A value of current_y < last_visible_y means that we stopped
16193 at the previous window start, which in turn means that we
16194 have at least one reusable row. */
16195 if (it
.current_y
< it
.last_visible_y
)
16197 struct glyph_row
*row
;
16199 /* IT.vpos always starts from 0; it counts text lines. */
16200 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16202 /* Find PT if not already found in the lines displayed. */
16203 if (w
->cursor
.vpos
< 0)
16205 int dy
= it
.current_y
- start_row
->y
;
16207 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16208 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16210 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16211 dy
, nrows_scrolled
);
16214 clear_glyph_matrix (w
->desired_matrix
);
16219 /* Scroll the display. Do it before the current matrix is
16220 changed. The problem here is that update has not yet
16221 run, i.e. part of the current matrix is not up to date.
16222 scroll_run_hook will clear the cursor, and use the
16223 current matrix to get the height of the row the cursor is
16225 run
.current_y
= start_row
->y
;
16226 run
.desired_y
= it
.current_y
;
16227 run
.height
= it
.last_visible_y
- it
.current_y
;
16229 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16232 FRAME_RIF (f
)->update_window_begin_hook (w
);
16233 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16234 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16235 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16239 /* Shift current matrix down by nrows_scrolled lines. */
16240 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16241 rotate_matrix (w
->current_matrix
,
16243 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16246 /* Disable lines that must be updated. */
16247 for (i
= 0; i
< nrows_scrolled
; ++i
)
16248 (start_row
+ i
)->enabled_p
= 0;
16250 /* Re-compute Y positions. */
16251 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16252 max_y
= it
.last_visible_y
;
16253 for (row
= start_row
+ nrows_scrolled
;
16257 row
->y
= it
.current_y
;
16258 row
->visible_height
= row
->height
;
16260 if (row
->y
< min_y
)
16261 row
->visible_height
-= min_y
- row
->y
;
16262 if (row
->y
+ row
->height
> max_y
)
16263 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16264 if (row
->fringe_bitmap_periodic_p
)
16265 row
->redraw_fringe_bitmaps_p
= 1;
16267 it
.current_y
+= row
->height
;
16269 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16270 last_reused_text_row
= row
;
16271 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16275 /* Disable lines in the current matrix which are now
16276 below the window. */
16277 for (++row
; row
< bottom_row
; ++row
)
16278 row
->enabled_p
= row
->mode_line_p
= 0;
16281 /* Update window_end_pos etc.; last_reused_text_row is the last
16282 reused row from the current matrix containing text, if any.
16283 The value of last_text_row is the last displayed line
16284 containing text. */
16285 if (last_reused_text_row
)
16287 w
->window_end_bytepos
16288 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16290 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16292 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16293 w
->current_matrix
));
16295 else if (last_text_row
)
16297 w
->window_end_bytepos
16298 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16300 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16302 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16306 /* This window must be completely empty. */
16307 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16308 w
->window_end_pos
= make_number (Z
- ZV
);
16309 w
->window_end_vpos
= make_number (0);
16311 w
->window_end_valid
= Qnil
;
16313 /* Update hint: don't try scrolling again in update_window. */
16314 w
->desired_matrix
->no_scrolling_p
= 1;
16317 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16321 else if (CHARPOS (new_start
) > CHARPOS (start
))
16323 struct glyph_row
*pt_row
, *row
;
16324 struct glyph_row
*first_reusable_row
;
16325 struct glyph_row
*first_row_to_display
;
16327 int yb
= window_text_bottom_y (w
);
16329 /* Find the row starting at new_start, if there is one. Don't
16330 reuse a partially visible line at the end. */
16331 first_reusable_row
= start_row
;
16332 while (first_reusable_row
->enabled_p
16333 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16334 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16335 < CHARPOS (new_start
)))
16336 ++first_reusable_row
;
16338 /* Give up if there is no row to reuse. */
16339 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16340 || !first_reusable_row
->enabled_p
16341 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16342 != CHARPOS (new_start
)))
16345 /* We can reuse fully visible rows beginning with
16346 first_reusable_row to the end of the window. Set
16347 first_row_to_display to the first row that cannot be reused.
16348 Set pt_row to the row containing point, if there is any. */
16350 for (first_row_to_display
= first_reusable_row
;
16351 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16352 ++first_row_to_display
)
16354 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16355 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16356 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
16357 && first_row_to_display
->ends_at_zv_p
16358 && pt_row
== NULL
)))
16359 pt_row
= first_row_to_display
;
16362 /* Start displaying at the start of first_row_to_display. */
16363 xassert (first_row_to_display
->y
< yb
);
16364 init_to_row_start (&it
, w
, first_row_to_display
);
16366 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16368 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16370 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16371 + WINDOW_HEADER_LINE_HEIGHT (w
));
16373 /* Display lines beginning with first_row_to_display in the
16374 desired matrix. Set last_text_row to the last row displayed
16375 that displays text. */
16376 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16377 if (pt_row
== NULL
)
16378 w
->cursor
.vpos
= -1;
16379 last_text_row
= NULL
;
16380 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16381 if (display_line (&it
))
16382 last_text_row
= it
.glyph_row
- 1;
16384 /* If point is in a reused row, adjust y and vpos of the cursor
16388 w
->cursor
.vpos
-= nrows_scrolled
;
16389 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16392 /* Give up if point isn't in a row displayed or reused. (This
16393 also handles the case where w->cursor.vpos < nrows_scrolled
16394 after the calls to display_line, which can happen with scroll
16395 margins. See bug#1295.) */
16396 if (w
->cursor
.vpos
< 0)
16398 clear_glyph_matrix (w
->desired_matrix
);
16402 /* Scroll the display. */
16403 run
.current_y
= first_reusable_row
->y
;
16404 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16405 run
.height
= it
.last_visible_y
- run
.current_y
;
16406 dy
= run
.current_y
- run
.desired_y
;
16411 FRAME_RIF (f
)->update_window_begin_hook (w
);
16412 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16413 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16414 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16418 /* Adjust Y positions of reused rows. */
16419 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16420 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16421 max_y
= it
.last_visible_y
;
16422 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16425 row
->visible_height
= row
->height
;
16426 if (row
->y
< min_y
)
16427 row
->visible_height
-= min_y
- row
->y
;
16428 if (row
->y
+ row
->height
> max_y
)
16429 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16430 if (row
->fringe_bitmap_periodic_p
)
16431 row
->redraw_fringe_bitmaps_p
= 1;
16434 /* Scroll the current matrix. */
16435 xassert (nrows_scrolled
> 0);
16436 rotate_matrix (w
->current_matrix
,
16438 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16441 /* Disable rows not reused. */
16442 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16443 row
->enabled_p
= 0;
16445 /* Point may have moved to a different line, so we cannot assume that
16446 the previous cursor position is valid; locate the correct row. */
16449 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16451 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
16452 && !row
->ends_at_zv_p
;
16456 w
->cursor
.y
= row
->y
;
16458 if (row
< bottom_row
)
16460 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16461 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16463 /* Can't use this optimization with bidi-reordered glyph
16464 rows, unless cursor is already at point. */
16465 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16467 if (!(w
->cursor
.hpos
>= 0
16468 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16469 && BUFFERP (glyph
->object
)
16470 && glyph
->charpos
== PT
))
16475 && (!BUFFERP (glyph
->object
)
16476 || glyph
->charpos
< PT
);
16480 w
->cursor
.x
+= glyph
->pixel_width
;
16485 /* Adjust window end. A null value of last_text_row means that
16486 the window end is in reused rows which in turn means that
16487 only its vpos can have changed. */
16490 w
->window_end_bytepos
16491 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16493 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16495 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16500 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16503 w
->window_end_valid
= Qnil
;
16504 w
->desired_matrix
->no_scrolling_p
= 1;
16507 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16517 /************************************************************************
16518 Window redisplay reusing current matrix when buffer has changed
16519 ************************************************************************/
16521 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16522 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16523 EMACS_INT
*, EMACS_INT
*);
16524 static struct glyph_row
*
16525 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16526 struct glyph_row
*);
16529 /* Return the last row in MATRIX displaying text. If row START is
16530 non-null, start searching with that row. IT gives the dimensions
16531 of the display. Value is null if matrix is empty; otherwise it is
16532 a pointer to the row found. */
16534 static struct glyph_row
*
16535 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16536 struct glyph_row
*start
)
16538 struct glyph_row
*row
, *row_found
;
16540 /* Set row_found to the last row in IT->w's current matrix
16541 displaying text. The loop looks funny but think of partially
16544 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16545 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16547 xassert (row
->enabled_p
);
16549 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16558 /* Return the last row in the current matrix of W that is not affected
16559 by changes at the start of current_buffer that occurred since W's
16560 current matrix was built. Value is null if no such row exists.
16562 BEG_UNCHANGED us the number of characters unchanged at the start of
16563 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16564 first changed character in current_buffer. Characters at positions <
16565 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16566 when the current matrix was built. */
16568 static struct glyph_row
*
16569 find_last_unchanged_at_beg_row (struct window
*w
)
16571 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16572 struct glyph_row
*row
;
16573 struct glyph_row
*row_found
= NULL
;
16574 int yb
= window_text_bottom_y (w
);
16576 /* Find the last row displaying unchanged text. */
16577 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16578 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16579 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16582 if (/* If row ends before first_changed_pos, it is unchanged,
16583 except in some case. */
16584 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16585 /* When row ends in ZV and we write at ZV it is not
16587 && !row
->ends_at_zv_p
16588 /* When first_changed_pos is the end of a continued line,
16589 row is not unchanged because it may be no longer
16591 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16592 && (row
->continued_p
16593 || row
->exact_window_width_line_p
)))
16596 /* Stop if last visible row. */
16597 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16605 /* Find the first glyph row in the current matrix of W that is not
16606 affected by changes at the end of current_buffer since the
16607 time W's current matrix was built.
16609 Return in *DELTA the number of chars by which buffer positions in
16610 unchanged text at the end of current_buffer must be adjusted.
16612 Return in *DELTA_BYTES the corresponding number of bytes.
16614 Value is null if no such row exists, i.e. all rows are affected by
16617 static struct glyph_row
*
16618 find_first_unchanged_at_end_row (struct window
*w
,
16619 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16621 struct glyph_row
*row
;
16622 struct glyph_row
*row_found
= NULL
;
16624 *delta
= *delta_bytes
= 0;
16626 /* Display must not have been paused, otherwise the current matrix
16627 is not up to date. */
16628 eassert (!NILP (w
->window_end_valid
));
16630 /* A value of window_end_pos >= END_UNCHANGED means that the window
16631 end is in the range of changed text. If so, there is no
16632 unchanged row at the end of W's current matrix. */
16633 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16636 /* Set row to the last row in W's current matrix displaying text. */
16637 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16639 /* If matrix is entirely empty, no unchanged row exists. */
16640 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16642 /* The value of row is the last glyph row in the matrix having a
16643 meaningful buffer position in it. The end position of row
16644 corresponds to window_end_pos. This allows us to translate
16645 buffer positions in the current matrix to current buffer
16646 positions for characters not in changed text. */
16648 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16649 EMACS_INT Z_BYTE_old
=
16650 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16651 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16652 struct glyph_row
*first_text_row
16653 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16655 *delta
= Z
- Z_old
;
16656 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16658 /* Set last_unchanged_pos to the buffer position of the last
16659 character in the buffer that has not been changed. Z is the
16660 index + 1 of the last character in current_buffer, i.e. by
16661 subtracting END_UNCHANGED we get the index of the last
16662 unchanged character, and we have to add BEG to get its buffer
16664 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16665 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16667 /* Search backward from ROW for a row displaying a line that
16668 starts at a minimum position >= last_unchanged_pos_old. */
16669 for (; row
> first_text_row
; --row
)
16671 /* This used to abort, but it can happen.
16672 It is ok to just stop the search instead here. KFS. */
16673 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16676 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16681 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16687 /* Make sure that glyph rows in the current matrix of window W
16688 reference the same glyph memory as corresponding rows in the
16689 frame's frame matrix. This function is called after scrolling W's
16690 current matrix on a terminal frame in try_window_id and
16691 try_window_reusing_current_matrix. */
16694 sync_frame_with_window_matrix_rows (struct window
*w
)
16696 struct frame
*f
= XFRAME (w
->frame
);
16697 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16699 /* Preconditions: W must be a leaf window and full-width. Its frame
16700 must have a frame matrix. */
16701 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16702 xassert (WINDOW_FULL_WIDTH_P (w
));
16703 xassert (!FRAME_WINDOW_P (f
));
16705 /* If W is a full-width window, glyph pointers in W's current matrix
16706 have, by definition, to be the same as glyph pointers in the
16707 corresponding frame matrix. Note that frame matrices have no
16708 marginal areas (see build_frame_matrix). */
16709 window_row
= w
->current_matrix
->rows
;
16710 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16711 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16712 while (window_row
< window_row_end
)
16714 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16715 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16717 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16718 frame_row
->glyphs
[TEXT_AREA
] = start
;
16719 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16720 frame_row
->glyphs
[LAST_AREA
] = end
;
16722 /* Disable frame rows whose corresponding window rows have
16723 been disabled in try_window_id. */
16724 if (!window_row
->enabled_p
)
16725 frame_row
->enabled_p
= 0;
16727 ++window_row
, ++frame_row
;
16732 /* Find the glyph row in window W containing CHARPOS. Consider all
16733 rows between START and END (not inclusive). END null means search
16734 all rows to the end of the display area of W. Value is the row
16735 containing CHARPOS or null. */
16738 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16739 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16741 struct glyph_row
*row
= start
;
16742 struct glyph_row
*best_row
= NULL
;
16743 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16746 /* If we happen to start on a header-line, skip that. */
16747 if (row
->mode_line_p
)
16750 if ((end
&& row
>= end
) || !row
->enabled_p
)
16753 last_y
= window_text_bottom_y (w
) - dy
;
16757 /* Give up if we have gone too far. */
16758 if (end
&& row
>= end
)
16760 /* This formerly returned if they were equal.
16761 I think that both quantities are of a "last plus one" type;
16762 if so, when they are equal, the row is within the screen. -- rms. */
16763 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16766 /* If it is in this row, return this row. */
16767 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16768 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16769 /* The end position of a row equals the start
16770 position of the next row. If CHARPOS is there, we
16771 would rather display it in the next line, except
16772 when this line ends in ZV. */
16773 && !row
->ends_at_zv_p
16774 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16775 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16779 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16780 || (!best_row
&& !row
->continued_p
))
16782 /* In bidi-reordered rows, there could be several rows
16783 occluding point, all of them belonging to the same
16784 continued line. We need to find the row which fits
16785 CHARPOS the best. */
16786 for (g
= row
->glyphs
[TEXT_AREA
];
16787 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16790 if (!STRINGP (g
->object
))
16792 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16794 mindif
= eabs (g
->charpos
- charpos
);
16796 /* Exact match always wins. */
16803 else if (best_row
&& !row
->continued_p
)
16810 /* Try to redisplay window W by reusing its existing display. W's
16811 current matrix must be up to date when this function is called,
16812 i.e. window_end_valid must not be nil.
16816 1 if display has been updated
16817 0 if otherwise unsuccessful
16818 -1 if redisplay with same window start is known not to succeed
16820 The following steps are performed:
16822 1. Find the last row in the current matrix of W that is not
16823 affected by changes at the start of current_buffer. If no such row
16826 2. Find the first row in W's current matrix that is not affected by
16827 changes at the end of current_buffer. Maybe there is no such row.
16829 3. Display lines beginning with the row + 1 found in step 1 to the
16830 row found in step 2 or, if step 2 didn't find a row, to the end of
16833 4. If cursor is not known to appear on the window, give up.
16835 5. If display stopped at the row found in step 2, scroll the
16836 display and current matrix as needed.
16838 6. Maybe display some lines at the end of W, if we must. This can
16839 happen under various circumstances, like a partially visible line
16840 becoming fully visible, or because newly displayed lines are displayed
16841 in smaller font sizes.
16843 7. Update W's window end information. */
16846 try_window_id (struct window
*w
)
16848 struct frame
*f
= XFRAME (w
->frame
);
16849 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16850 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16851 struct glyph_row
*last_unchanged_at_beg_row
;
16852 struct glyph_row
*first_unchanged_at_end_row
;
16853 struct glyph_row
*row
;
16854 struct glyph_row
*bottom_row
;
16857 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16859 struct text_pos start_pos
;
16861 int first_unchanged_at_end_vpos
= 0;
16862 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16863 struct text_pos start
;
16864 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16867 if (inhibit_try_window_id
)
16871 /* This is handy for debugging. */
16873 #define GIVE_UP(X) \
16875 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16879 #define GIVE_UP(X) return 0
16882 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16884 /* Don't use this for mini-windows because these can show
16885 messages and mini-buffers, and we don't handle that here. */
16886 if (MINI_WINDOW_P (w
))
16889 /* This flag is used to prevent redisplay optimizations. */
16890 if (windows_or_buffers_changed
|| cursor_type_changed
)
16893 /* Verify that narrowing has not changed.
16894 Also verify that we were not told to prevent redisplay optimizations.
16895 It would be nice to further
16896 reduce the number of cases where this prevents try_window_id. */
16897 if (current_buffer
->clip_changed
16898 || current_buffer
->prevent_redisplay_optimizations_p
)
16901 /* Window must either use window-based redisplay or be full width. */
16902 if (!FRAME_WINDOW_P (f
)
16903 && (!FRAME_LINE_INS_DEL_OK (f
)
16904 || !WINDOW_FULL_WIDTH_P (w
)))
16907 /* Give up if point is known NOT to appear in W. */
16908 if (PT
< CHARPOS (start
))
16911 /* Another way to prevent redisplay optimizations. */
16912 if (XFASTINT (w
->last_modified
) == 0)
16915 /* Verify that window is not hscrolled. */
16916 if (XFASTINT (w
->hscroll
) != 0)
16919 /* Verify that display wasn't paused. */
16920 if (NILP (w
->window_end_valid
))
16923 /* Can't use this if highlighting a region because a cursor movement
16924 will do more than just set the cursor. */
16925 if (!NILP (Vtransient_mark_mode
)
16926 && !NILP (BVAR (current_buffer
, mark_active
)))
16929 /* Likewise if highlighting trailing whitespace. */
16930 if (!NILP (Vshow_trailing_whitespace
))
16933 /* Likewise if showing a region. */
16934 if (!NILP (w
->region_showing
))
16937 /* Can't use this if overlay arrow position and/or string have
16939 if (overlay_arrows_changed_p ())
16942 /* When word-wrap is on, adding a space to the first word of a
16943 wrapped line can change the wrap position, altering the line
16944 above it. It might be worthwhile to handle this more
16945 intelligently, but for now just redisplay from scratch. */
16946 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16949 /* Under bidi reordering, adding or deleting a character in the
16950 beginning of a paragraph, before the first strong directional
16951 character, can change the base direction of the paragraph (unless
16952 the buffer specifies a fixed paragraph direction), which will
16953 require to redisplay the whole paragraph. It might be worthwhile
16954 to find the paragraph limits and widen the range of redisplayed
16955 lines to that, but for now just give up this optimization and
16956 redisplay from scratch. */
16957 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16958 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16961 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16962 only if buffer has really changed. The reason is that the gap is
16963 initially at Z for freshly visited files. The code below would
16964 set end_unchanged to 0 in that case. */
16965 if (MODIFF
> SAVE_MODIFF
16966 /* This seems to happen sometimes after saving a buffer. */
16967 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16969 if (GPT
- BEG
< BEG_UNCHANGED
)
16970 BEG_UNCHANGED
= GPT
- BEG
;
16971 if (Z
- GPT
< END_UNCHANGED
)
16972 END_UNCHANGED
= Z
- GPT
;
16975 /* The position of the first and last character that has been changed. */
16976 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16977 last_changed_charpos
= Z
- END_UNCHANGED
;
16979 /* If window starts after a line end, and the last change is in
16980 front of that newline, then changes don't affect the display.
16981 This case happens with stealth-fontification. Note that although
16982 the display is unchanged, glyph positions in the matrix have to
16983 be adjusted, of course. */
16984 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16985 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16986 && ((last_changed_charpos
< CHARPOS (start
)
16987 && CHARPOS (start
) == BEGV
)
16988 || (last_changed_charpos
< CHARPOS (start
) - 1
16989 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16991 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16992 struct glyph_row
*r0
;
16994 /* Compute how many chars/bytes have been added to or removed
16995 from the buffer. */
16996 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16997 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16998 Z_delta
= Z
- Z_old
;
16999 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17001 /* Give up if PT is not in the window. Note that it already has
17002 been checked at the start of try_window_id that PT is not in
17003 front of the window start. */
17004 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17007 /* If window start is unchanged, we can reuse the whole matrix
17008 as is, after adjusting glyph positions. No need to compute
17009 the window end again, since its offset from Z hasn't changed. */
17010 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17011 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17012 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17013 /* PT must not be in a partially visible line. */
17014 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17015 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17017 /* Adjust positions in the glyph matrix. */
17018 if (Z_delta
|| Z_delta_bytes
)
17020 struct glyph_row
*r1
17021 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17022 increment_matrix_positions (w
->current_matrix
,
17023 MATRIX_ROW_VPOS (r0
, current_matrix
),
17024 MATRIX_ROW_VPOS (r1
, current_matrix
),
17025 Z_delta
, Z_delta_bytes
);
17028 /* Set the cursor. */
17029 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17031 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17038 /* Handle the case that changes are all below what is displayed in
17039 the window, and that PT is in the window. This shortcut cannot
17040 be taken if ZV is visible in the window, and text has been added
17041 there that is visible in the window. */
17042 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17043 /* ZV is not visible in the window, or there are no
17044 changes at ZV, actually. */
17045 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17046 || first_changed_charpos
== last_changed_charpos
))
17048 struct glyph_row
*r0
;
17050 /* Give up if PT is not in the window. Note that it already has
17051 been checked at the start of try_window_id that PT is not in
17052 front of the window start. */
17053 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17056 /* If window start is unchanged, we can reuse the whole matrix
17057 as is, without changing glyph positions since no text has
17058 been added/removed in front of the window end. */
17059 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17060 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17061 /* PT must not be in a partially visible line. */
17062 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17063 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17065 /* We have to compute the window end anew since text
17066 could have been added/removed after it. */
17068 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17069 w
->window_end_bytepos
17070 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17072 /* Set the cursor. */
17073 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17075 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17082 /* Give up if window start is in the changed area.
17084 The condition used to read
17086 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17088 but why that was tested escapes me at the moment. */
17089 if (CHARPOS (start
) >= first_changed_charpos
17090 && CHARPOS (start
) <= last_changed_charpos
)
17093 /* Check that window start agrees with the start of the first glyph
17094 row in its current matrix. Check this after we know the window
17095 start is not in changed text, otherwise positions would not be
17097 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17098 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17101 /* Give up if the window ends in strings. Overlay strings
17102 at the end are difficult to handle, so don't try. */
17103 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17104 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17107 /* Compute the position at which we have to start displaying new
17108 lines. Some of the lines at the top of the window might be
17109 reusable because they are not displaying changed text. Find the
17110 last row in W's current matrix not affected by changes at the
17111 start of current_buffer. Value is null if changes start in the
17112 first line of window. */
17113 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17114 if (last_unchanged_at_beg_row
)
17116 /* Avoid starting to display in the middle of a character, a TAB
17117 for instance. This is easier than to set up the iterator
17118 exactly, and it's not a frequent case, so the additional
17119 effort wouldn't really pay off. */
17120 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17121 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17122 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17123 --last_unchanged_at_beg_row
;
17125 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17128 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17130 start_pos
= it
.current
.pos
;
17132 /* Start displaying new lines in the desired matrix at the same
17133 vpos we would use in the current matrix, i.e. below
17134 last_unchanged_at_beg_row. */
17135 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17137 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17138 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17140 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17144 /* There are no reusable lines at the start of the window.
17145 Start displaying in the first text line. */
17146 start_display (&it
, w
, start
);
17147 it
.vpos
= it
.first_vpos
;
17148 start_pos
= it
.current
.pos
;
17151 /* Find the first row that is not affected by changes at the end of
17152 the buffer. Value will be null if there is no unchanged row, in
17153 which case we must redisplay to the end of the window. delta
17154 will be set to the value by which buffer positions beginning with
17155 first_unchanged_at_end_row have to be adjusted due to text
17157 first_unchanged_at_end_row
17158 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17159 IF_DEBUG (debug_delta
= delta
);
17160 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17162 /* Set stop_pos to the buffer position up to which we will have to
17163 display new lines. If first_unchanged_at_end_row != NULL, this
17164 is the buffer position of the start of the line displayed in that
17165 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17166 that we don't stop at a buffer position. */
17168 if (first_unchanged_at_end_row
)
17170 xassert (last_unchanged_at_beg_row
== NULL
17171 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17173 /* If this is a continuation line, move forward to the next one
17174 that isn't. Changes in lines above affect this line.
17175 Caution: this may move first_unchanged_at_end_row to a row
17176 not displaying text. */
17177 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17178 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17179 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17180 < it
.last_visible_y
))
17181 ++first_unchanged_at_end_row
;
17183 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17184 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17185 >= it
.last_visible_y
))
17186 first_unchanged_at_end_row
= NULL
;
17189 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17191 first_unchanged_at_end_vpos
17192 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17193 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17196 else if (last_unchanged_at_beg_row
== NULL
)
17202 /* Either there is no unchanged row at the end, or the one we have
17203 now displays text. This is a necessary condition for the window
17204 end pos calculation at the end of this function. */
17205 xassert (first_unchanged_at_end_row
== NULL
17206 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17208 debug_last_unchanged_at_beg_vpos
17209 = (last_unchanged_at_beg_row
17210 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17212 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17214 #endif /* GLYPH_DEBUG != 0 */
17217 /* Display new lines. Set last_text_row to the last new line
17218 displayed which has text on it, i.e. might end up as being the
17219 line where the window_end_vpos is. */
17220 w
->cursor
.vpos
= -1;
17221 last_text_row
= NULL
;
17222 overlay_arrow_seen
= 0;
17223 while (it
.current_y
< it
.last_visible_y
17224 && !fonts_changed_p
17225 && (first_unchanged_at_end_row
== NULL
17226 || IT_CHARPOS (it
) < stop_pos
))
17228 if (display_line (&it
))
17229 last_text_row
= it
.glyph_row
- 1;
17232 if (fonts_changed_p
)
17236 /* Compute differences in buffer positions, y-positions etc. for
17237 lines reused at the bottom of the window. Compute what we can
17239 if (first_unchanged_at_end_row
17240 /* No lines reused because we displayed everything up to the
17241 bottom of the window. */
17242 && it
.current_y
< it
.last_visible_y
)
17245 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17247 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17248 run
.current_y
= first_unchanged_at_end_row
->y
;
17249 run
.desired_y
= run
.current_y
+ dy
;
17250 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17254 delta
= delta_bytes
= dvpos
= dy
17255 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17256 first_unchanged_at_end_row
= NULL
;
17258 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17261 /* Find the cursor if not already found. We have to decide whether
17262 PT will appear on this window (it sometimes doesn't, but this is
17263 not a very frequent case.) This decision has to be made before
17264 the current matrix is altered. A value of cursor.vpos < 0 means
17265 that PT is either in one of the lines beginning at
17266 first_unchanged_at_end_row or below the window. Don't care for
17267 lines that might be displayed later at the window end; as
17268 mentioned, this is not a frequent case. */
17269 if (w
->cursor
.vpos
< 0)
17271 /* Cursor in unchanged rows at the top? */
17272 if (PT
< CHARPOS (start_pos
)
17273 && last_unchanged_at_beg_row
)
17275 row
= row_containing_pos (w
, PT
,
17276 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17277 last_unchanged_at_beg_row
+ 1, 0);
17279 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17282 /* Start from first_unchanged_at_end_row looking for PT. */
17283 else if (first_unchanged_at_end_row
)
17285 row
= row_containing_pos (w
, PT
- delta
,
17286 first_unchanged_at_end_row
, NULL
, 0);
17288 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17289 delta_bytes
, dy
, dvpos
);
17292 /* Give up if cursor was not found. */
17293 if (w
->cursor
.vpos
< 0)
17295 clear_glyph_matrix (w
->desired_matrix
);
17300 /* Don't let the cursor end in the scroll margins. */
17302 int this_scroll_margin
, cursor_height
;
17304 this_scroll_margin
=
17305 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17306 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17307 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17309 if ((w
->cursor
.y
< this_scroll_margin
17310 && CHARPOS (start
) > BEGV
)
17311 /* Old redisplay didn't take scroll margin into account at the bottom,
17312 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17313 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17314 ? cursor_height
+ this_scroll_margin
17315 : 1)) > it
.last_visible_y
)
17317 w
->cursor
.vpos
= -1;
17318 clear_glyph_matrix (w
->desired_matrix
);
17323 /* Scroll the display. Do it before changing the current matrix so
17324 that xterm.c doesn't get confused about where the cursor glyph is
17326 if (dy
&& run
.height
)
17330 if (FRAME_WINDOW_P (f
))
17332 FRAME_RIF (f
)->update_window_begin_hook (w
);
17333 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17334 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17335 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17339 /* Terminal frame. In this case, dvpos gives the number of
17340 lines to scroll by; dvpos < 0 means scroll up. */
17342 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17343 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17344 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17345 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17346 + window_internal_height (w
));
17348 #if defined (HAVE_GPM) || defined (MSDOS)
17349 x_clear_window_mouse_face (w
);
17351 /* Perform the operation on the screen. */
17354 /* Scroll last_unchanged_at_beg_row to the end of the
17355 window down dvpos lines. */
17356 set_terminal_window (f
, end
);
17358 /* On dumb terminals delete dvpos lines at the end
17359 before inserting dvpos empty lines. */
17360 if (!FRAME_SCROLL_REGION_OK (f
))
17361 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17363 /* Insert dvpos empty lines in front of
17364 last_unchanged_at_beg_row. */
17365 ins_del_lines (f
, from
, dvpos
);
17367 else if (dvpos
< 0)
17369 /* Scroll up last_unchanged_at_beg_vpos to the end of
17370 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17371 set_terminal_window (f
, end
);
17373 /* Delete dvpos lines in front of
17374 last_unchanged_at_beg_vpos. ins_del_lines will set
17375 the cursor to the given vpos and emit |dvpos| delete
17377 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17379 /* On a dumb terminal insert dvpos empty lines at the
17381 if (!FRAME_SCROLL_REGION_OK (f
))
17382 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17385 set_terminal_window (f
, 0);
17391 /* Shift reused rows of the current matrix to the right position.
17392 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17394 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17395 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17398 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17399 bottom_vpos
, dvpos
);
17400 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17403 else if (dvpos
> 0)
17405 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17406 bottom_vpos
, dvpos
);
17407 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17408 first_unchanged_at_end_vpos
+ dvpos
, 0);
17411 /* For frame-based redisplay, make sure that current frame and window
17412 matrix are in sync with respect to glyph memory. */
17413 if (!FRAME_WINDOW_P (f
))
17414 sync_frame_with_window_matrix_rows (w
);
17416 /* Adjust buffer positions in reused rows. */
17417 if (delta
|| delta_bytes
)
17418 increment_matrix_positions (current_matrix
,
17419 first_unchanged_at_end_vpos
+ dvpos
,
17420 bottom_vpos
, delta
, delta_bytes
);
17422 /* Adjust Y positions. */
17424 shift_glyph_matrix (w
, current_matrix
,
17425 first_unchanged_at_end_vpos
+ dvpos
,
17428 if (first_unchanged_at_end_row
)
17430 first_unchanged_at_end_row
+= dvpos
;
17431 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17432 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17433 first_unchanged_at_end_row
= NULL
;
17436 /* If scrolling up, there may be some lines to display at the end of
17438 last_text_row_at_end
= NULL
;
17441 /* Scrolling up can leave for example a partially visible line
17442 at the end of the window to be redisplayed. */
17443 /* Set last_row to the glyph row in the current matrix where the
17444 window end line is found. It has been moved up or down in
17445 the matrix by dvpos. */
17446 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17447 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17449 /* If last_row is the window end line, it should display text. */
17450 xassert (last_row
->displays_text_p
);
17452 /* If window end line was partially visible before, begin
17453 displaying at that line. Otherwise begin displaying with the
17454 line following it. */
17455 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17457 init_to_row_start (&it
, w
, last_row
);
17458 it
.vpos
= last_vpos
;
17459 it
.current_y
= last_row
->y
;
17463 init_to_row_end (&it
, w
, last_row
);
17464 it
.vpos
= 1 + last_vpos
;
17465 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17469 /* We may start in a continuation line. If so, we have to
17470 get the right continuation_lines_width and current_x. */
17471 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17472 it
.hpos
= it
.current_x
= 0;
17474 /* Display the rest of the lines at the window end. */
17475 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17476 while (it
.current_y
< it
.last_visible_y
17477 && !fonts_changed_p
)
17479 /* Is it always sure that the display agrees with lines in
17480 the current matrix? I don't think so, so we mark rows
17481 displayed invalid in the current matrix by setting their
17482 enabled_p flag to zero. */
17483 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17484 if (display_line (&it
))
17485 last_text_row_at_end
= it
.glyph_row
- 1;
17489 /* Update window_end_pos and window_end_vpos. */
17490 if (first_unchanged_at_end_row
17491 && !last_text_row_at_end
)
17493 /* Window end line if one of the preserved rows from the current
17494 matrix. Set row to the last row displaying text in current
17495 matrix starting at first_unchanged_at_end_row, after
17497 xassert (first_unchanged_at_end_row
->displays_text_p
);
17498 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17499 first_unchanged_at_end_row
);
17500 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17502 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17503 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17505 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17506 xassert (w
->window_end_bytepos
>= 0);
17507 IF_DEBUG (debug_method_add (w
, "A"));
17509 else if (last_text_row_at_end
)
17512 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17513 w
->window_end_bytepos
17514 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17516 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17517 xassert (w
->window_end_bytepos
>= 0);
17518 IF_DEBUG (debug_method_add (w
, "B"));
17520 else if (last_text_row
)
17522 /* We have displayed either to the end of the window or at the
17523 end of the window, i.e. the last row with text is to be found
17524 in the desired matrix. */
17526 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17527 w
->window_end_bytepos
17528 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17530 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17531 xassert (w
->window_end_bytepos
>= 0);
17533 else if (first_unchanged_at_end_row
== NULL
17534 && last_text_row
== NULL
17535 && last_text_row_at_end
== NULL
)
17537 /* Displayed to end of window, but no line containing text was
17538 displayed. Lines were deleted at the end of the window. */
17539 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17540 int vpos
= XFASTINT (w
->window_end_vpos
);
17541 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17542 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17545 row
== NULL
&& vpos
>= first_vpos
;
17546 --vpos
, --current_row
, --desired_row
)
17548 if (desired_row
->enabled_p
)
17550 if (desired_row
->displays_text_p
)
17553 else if (current_row
->displays_text_p
)
17557 xassert (row
!= NULL
);
17558 w
->window_end_vpos
= make_number (vpos
+ 1);
17559 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17560 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17561 xassert (w
->window_end_bytepos
>= 0);
17562 IF_DEBUG (debug_method_add (w
, "C"));
17567 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17568 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17570 /* Record that display has not been completed. */
17571 w
->window_end_valid
= Qnil
;
17572 w
->desired_matrix
->no_scrolling_p
= 1;
17580 /***********************************************************************
17581 More debugging support
17582 ***********************************************************************/
17586 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17587 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17588 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17591 /* Dump the contents of glyph matrix MATRIX on stderr.
17593 GLYPHS 0 means don't show glyph contents.
17594 GLYPHS 1 means show glyphs in short form
17595 GLYPHS > 1 means show glyphs in long form. */
17598 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17601 for (i
= 0; i
< matrix
->nrows
; ++i
)
17602 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17606 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17607 the glyph row and area where the glyph comes from. */
17610 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17612 if (glyph
->type
== CHAR_GLYPH
)
17615 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17616 glyph
- row
->glyphs
[TEXT_AREA
],
17619 (BUFFERP (glyph
->object
)
17621 : (STRINGP (glyph
->object
)
17624 glyph
->pixel_width
,
17626 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17630 glyph
->left_box_line_p
,
17631 glyph
->right_box_line_p
);
17633 else if (glyph
->type
== STRETCH_GLYPH
)
17636 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17637 glyph
- row
->glyphs
[TEXT_AREA
],
17640 (BUFFERP (glyph
->object
)
17642 : (STRINGP (glyph
->object
)
17645 glyph
->pixel_width
,
17649 glyph
->left_box_line_p
,
17650 glyph
->right_box_line_p
);
17652 else if (glyph
->type
== IMAGE_GLYPH
)
17655 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17656 glyph
- row
->glyphs
[TEXT_AREA
],
17659 (BUFFERP (glyph
->object
)
17661 : (STRINGP (glyph
->object
)
17664 glyph
->pixel_width
,
17668 glyph
->left_box_line_p
,
17669 glyph
->right_box_line_p
);
17671 else if (glyph
->type
== COMPOSITE_GLYPH
)
17674 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17675 glyph
- row
->glyphs
[TEXT_AREA
],
17678 (BUFFERP (glyph
->object
)
17680 : (STRINGP (glyph
->object
)
17683 glyph
->pixel_width
,
17685 if (glyph
->u
.cmp
.automatic
)
17688 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17689 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17691 glyph
->left_box_line_p
,
17692 glyph
->right_box_line_p
);
17697 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17698 GLYPHS 0 means don't show glyph contents.
17699 GLYPHS 1 means show glyphs in short form
17700 GLYPHS > 1 means show glyphs in long form. */
17703 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17707 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17708 fprintf (stderr
, "======================================================================\n");
17710 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17711 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17713 MATRIX_ROW_START_CHARPOS (row
),
17714 MATRIX_ROW_END_CHARPOS (row
),
17715 row
->used
[TEXT_AREA
],
17716 row
->contains_overlapping_glyphs_p
,
17718 row
->truncated_on_left_p
,
17719 row
->truncated_on_right_p
,
17721 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17722 row
->displays_text_p
,
17725 row
->ends_in_middle_of_char_p
,
17726 row
->starts_in_middle_of_char_p
,
17732 row
->visible_height
,
17735 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17736 row
->end
.overlay_string_index
,
17737 row
->continuation_lines_width
);
17738 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17739 CHARPOS (row
->start
.string_pos
),
17740 CHARPOS (row
->end
.string_pos
));
17741 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17742 row
->end
.dpvec_index
);
17749 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17751 struct glyph
*glyph
= row
->glyphs
[area
];
17752 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17754 /* Glyph for a line end in text. */
17755 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17758 if (glyph
< glyph_end
)
17759 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17761 for (; glyph
< glyph_end
; ++glyph
)
17762 dump_glyph (row
, glyph
, area
);
17765 else if (glyphs
== 1)
17769 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17771 char *s
= (char *) alloca (row
->used
[area
] + 1);
17774 for (i
= 0; i
< row
->used
[area
]; ++i
)
17776 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17777 if (glyph
->type
== CHAR_GLYPH
17778 && glyph
->u
.ch
< 0x80
17779 && glyph
->u
.ch
>= ' ')
17780 s
[i
] = glyph
->u
.ch
;
17786 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17792 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17793 Sdump_glyph_matrix
, 0, 1, "p",
17794 doc
: /* Dump the current matrix of the selected window to stderr.
17795 Shows contents of glyph row structures. With non-nil
17796 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17797 glyphs in short form, otherwise show glyphs in long form. */)
17798 (Lisp_Object glyphs
)
17800 struct window
*w
= XWINDOW (selected_window
);
17801 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17803 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17804 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17805 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17806 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17807 fprintf (stderr
, "=============================================\n");
17808 dump_glyph_matrix (w
->current_matrix
,
17809 NILP (glyphs
) ? 0 : XINT (glyphs
));
17814 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17815 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17818 struct frame
*f
= XFRAME (selected_frame
);
17819 dump_glyph_matrix (f
->current_matrix
, 1);
17824 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17825 doc
: /* Dump glyph row ROW to stderr.
17826 GLYPH 0 means don't dump glyphs.
17827 GLYPH 1 means dump glyphs in short form.
17828 GLYPH > 1 or omitted means dump glyphs in long form. */)
17829 (Lisp_Object row
, Lisp_Object glyphs
)
17831 struct glyph_matrix
*matrix
;
17834 CHECK_NUMBER (row
);
17835 matrix
= XWINDOW (selected_window
)->current_matrix
;
17837 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17838 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17840 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17845 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17846 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17847 GLYPH 0 means don't dump glyphs.
17848 GLYPH 1 means dump glyphs in short form.
17849 GLYPH > 1 or omitted means dump glyphs in long form. */)
17850 (Lisp_Object row
, Lisp_Object glyphs
)
17852 struct frame
*sf
= SELECTED_FRAME ();
17853 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17856 CHECK_NUMBER (row
);
17858 if (vpos
>= 0 && vpos
< m
->nrows
)
17859 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17860 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17865 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17866 doc
: /* Toggle tracing of redisplay.
17867 With ARG, turn tracing on if and only if ARG is positive. */)
17871 trace_redisplay_p
= !trace_redisplay_p
;
17874 arg
= Fprefix_numeric_value (arg
);
17875 trace_redisplay_p
= XINT (arg
) > 0;
17882 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17883 doc
: /* Like `format', but print result to stderr.
17884 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17885 (ptrdiff_t nargs
, Lisp_Object
*args
)
17887 Lisp_Object s
= Fformat (nargs
, args
);
17888 fprintf (stderr
, "%s", SDATA (s
));
17892 #endif /* GLYPH_DEBUG */
17896 /***********************************************************************
17897 Building Desired Matrix Rows
17898 ***********************************************************************/
17900 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17901 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17903 static struct glyph_row
*
17904 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17906 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17907 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17908 struct buffer
*old
= current_buffer
;
17909 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17910 int arrow_len
= SCHARS (overlay_arrow_string
);
17911 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17912 const unsigned char *p
;
17915 int n_glyphs_before
;
17917 set_buffer_temp (buffer
);
17918 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17919 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17920 SET_TEXT_POS (it
.position
, 0, 0);
17922 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17924 while (p
< arrow_end
)
17926 Lisp_Object face
, ilisp
;
17928 /* Get the next character. */
17930 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17933 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17934 if (! ASCII_CHAR_P (it
.c
))
17935 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17939 /* Get its face. */
17940 ilisp
= make_number (p
- arrow_string
);
17941 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17942 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17944 /* Compute its width, get its glyphs. */
17945 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17946 SET_TEXT_POS (it
.position
, -1, -1);
17947 PRODUCE_GLYPHS (&it
);
17949 /* If this character doesn't fit any more in the line, we have
17950 to remove some glyphs. */
17951 if (it
.current_x
> it
.last_visible_x
)
17953 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17958 set_buffer_temp (old
);
17959 return it
.glyph_row
;
17963 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17964 glyphs are only inserted for terminal frames since we can't really
17965 win with truncation glyphs when partially visible glyphs are
17966 involved. Which glyphs to insert is determined by
17967 produce_special_glyphs. */
17970 insert_left_trunc_glyphs (struct it
*it
)
17972 struct it truncate_it
;
17973 struct glyph
*from
, *end
, *to
, *toend
;
17975 xassert (!FRAME_WINDOW_P (it
->f
));
17977 /* Get the truncation glyphs. */
17979 truncate_it
.current_x
= 0;
17980 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17981 truncate_it
.glyph_row
= &scratch_glyph_row
;
17982 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17983 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17984 truncate_it
.object
= make_number (0);
17985 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17987 /* Overwrite glyphs from IT with truncation glyphs. */
17988 if (!it
->glyph_row
->reversed_p
)
17990 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17991 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17992 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17993 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17998 /* There may be padding glyphs left over. Overwrite them too. */
17999 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18001 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18007 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18011 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18012 that back to front. */
18013 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18014 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18015 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18016 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18018 while (from
>= end
&& to
>= toend
)
18020 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18023 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18024 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18025 while (from
>= end
&& to
>= toend
)
18030 /* Need to free some room before prepending additional
18032 int move_by
= from
- end
+ 1;
18033 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18034 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18036 for ( ; g
>= g0
; g
--)
18038 while (from
>= end
)
18040 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18045 /* Compute the hash code for ROW. */
18047 row_hash (struct glyph_row
*row
)
18050 unsigned hashval
= 0;
18052 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18053 for (k
= 0; k
< row
->used
[area
]; ++k
)
18054 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18055 + row
->glyphs
[area
][k
].u
.val
18056 + row
->glyphs
[area
][k
].face_id
18057 + row
->glyphs
[area
][k
].padding_p
18058 + (row
->glyphs
[area
][k
].type
<< 2));
18063 /* Compute the pixel height and width of IT->glyph_row.
18065 Most of the time, ascent and height of a display line will be equal
18066 to the max_ascent and max_height values of the display iterator
18067 structure. This is not the case if
18069 1. We hit ZV without displaying anything. In this case, max_ascent
18070 and max_height will be zero.
18072 2. We have some glyphs that don't contribute to the line height.
18073 (The glyph row flag contributes_to_line_height_p is for future
18074 pixmap extensions).
18076 The first case is easily covered by using default values because in
18077 these cases, the line height does not really matter, except that it
18078 must not be zero. */
18081 compute_line_metrics (struct it
*it
)
18083 struct glyph_row
*row
= it
->glyph_row
;
18085 if (FRAME_WINDOW_P (it
->f
))
18087 int i
, min_y
, max_y
;
18089 /* The line may consist of one space only, that was added to
18090 place the cursor on it. If so, the row's height hasn't been
18092 if (row
->height
== 0)
18094 if (it
->max_ascent
+ it
->max_descent
== 0)
18095 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18096 row
->ascent
= it
->max_ascent
;
18097 row
->height
= it
->max_ascent
+ it
->max_descent
;
18098 row
->phys_ascent
= it
->max_phys_ascent
;
18099 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18100 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18103 /* Compute the width of this line. */
18104 row
->pixel_width
= row
->x
;
18105 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18106 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18108 xassert (row
->pixel_width
>= 0);
18109 xassert (row
->ascent
>= 0 && row
->height
> 0);
18111 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18112 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18114 /* If first line's physical ascent is larger than its logical
18115 ascent, use the physical ascent, and make the row taller.
18116 This makes accented characters fully visible. */
18117 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18118 && row
->phys_ascent
> row
->ascent
)
18120 row
->height
+= row
->phys_ascent
- row
->ascent
;
18121 row
->ascent
= row
->phys_ascent
;
18124 /* Compute how much of the line is visible. */
18125 row
->visible_height
= row
->height
;
18127 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18128 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18130 if (row
->y
< min_y
)
18131 row
->visible_height
-= min_y
- row
->y
;
18132 if (row
->y
+ row
->height
> max_y
)
18133 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18137 row
->pixel_width
= row
->used
[TEXT_AREA
];
18138 if (row
->continued_p
)
18139 row
->pixel_width
-= it
->continuation_pixel_width
;
18140 else if (row
->truncated_on_right_p
)
18141 row
->pixel_width
-= it
->truncation_pixel_width
;
18142 row
->ascent
= row
->phys_ascent
= 0;
18143 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18144 row
->extra_line_spacing
= 0;
18147 /* Compute a hash code for this row. */
18148 row
->hash
= row_hash (row
);
18150 it
->max_ascent
= it
->max_descent
= 0;
18151 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18155 /* Append one space to the glyph row of iterator IT if doing a
18156 window-based redisplay. The space has the same face as
18157 IT->face_id. Value is non-zero if a space was added.
18159 This function is called to make sure that there is always one glyph
18160 at the end of a glyph row that the cursor can be set on under
18161 window-systems. (If there weren't such a glyph we would not know
18162 how wide and tall a box cursor should be displayed).
18164 At the same time this space let's a nicely handle clearing to the
18165 end of the line if the row ends in italic text. */
18168 append_space_for_newline (struct it
*it
, int default_face_p
)
18170 if (FRAME_WINDOW_P (it
->f
))
18172 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18174 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18175 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18177 /* Save some values that must not be changed.
18178 Must save IT->c and IT->len because otherwise
18179 ITERATOR_AT_END_P wouldn't work anymore after
18180 append_space_for_newline has been called. */
18181 enum display_element_type saved_what
= it
->what
;
18182 int saved_c
= it
->c
, saved_len
= it
->len
;
18183 int saved_char_to_display
= it
->char_to_display
;
18184 int saved_x
= it
->current_x
;
18185 int saved_face_id
= it
->face_id
;
18186 struct text_pos saved_pos
;
18187 Lisp_Object saved_object
;
18190 saved_object
= it
->object
;
18191 saved_pos
= it
->position
;
18193 it
->what
= IT_CHARACTER
;
18194 memset (&it
->position
, 0, sizeof it
->position
);
18195 it
->object
= make_number (0);
18196 it
->c
= it
->char_to_display
= ' ';
18199 /* If the default face was remapped, be sure to use the
18200 remapped face for the appended newline. */
18201 if (default_face_p
)
18202 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
18203 else if (it
->face_before_selective_p
)
18204 it
->face_id
= it
->saved_face_id
;
18205 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18206 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18208 PRODUCE_GLYPHS (it
);
18210 it
->override_ascent
= -1;
18211 it
->constrain_row_ascent_descent_p
= 0;
18212 it
->current_x
= saved_x
;
18213 it
->object
= saved_object
;
18214 it
->position
= saved_pos
;
18215 it
->what
= saved_what
;
18216 it
->face_id
= saved_face_id
;
18217 it
->len
= saved_len
;
18219 it
->char_to_display
= saved_char_to_display
;
18228 /* Extend the face of the last glyph in the text area of IT->glyph_row
18229 to the end of the display line. Called from display_line. If the
18230 glyph row is empty, add a space glyph to it so that we know the
18231 face to draw. Set the glyph row flag fill_line_p. If the glyph
18232 row is R2L, prepend a stretch glyph to cover the empty space to the
18233 left of the leftmost glyph. */
18236 extend_face_to_end_of_line (struct it
*it
)
18238 struct face
*face
, *default_face
;
18239 struct frame
*f
= it
->f
;
18241 /* If line is already filled, do nothing. Non window-system frames
18242 get a grace of one more ``pixel'' because their characters are
18243 1-``pixel'' wide, so they hit the equality too early. This grace
18244 is needed only for R2L rows that are not continued, to produce
18245 one extra blank where we could display the cursor. */
18246 if (it
->current_x
>= it
->last_visible_x
18247 + (!FRAME_WINDOW_P (f
)
18248 && it
->glyph_row
->reversed_p
18249 && !it
->glyph_row
->continued_p
))
18252 /* The default face, possibly remapped. */
18253 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
18255 /* Face extension extends the background and box of IT->face_id
18256 to the end of the line. If the background equals the background
18257 of the frame, we don't have to do anything. */
18258 if (it
->face_before_selective_p
)
18259 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18261 face
= FACE_FROM_ID (f
, it
->face_id
);
18263 if (FRAME_WINDOW_P (f
)
18264 && it
->glyph_row
->displays_text_p
18265 && face
->box
== FACE_NO_BOX
18266 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18268 && !it
->glyph_row
->reversed_p
)
18271 /* Set the glyph row flag indicating that the face of the last glyph
18272 in the text area has to be drawn to the end of the text area. */
18273 it
->glyph_row
->fill_line_p
= 1;
18275 /* If current character of IT is not ASCII, make sure we have the
18276 ASCII face. This will be automatically undone the next time
18277 get_next_display_element returns a multibyte character. Note
18278 that the character will always be single byte in unibyte
18280 if (!ASCII_CHAR_P (it
->c
))
18282 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18285 if (FRAME_WINDOW_P (f
))
18287 /* If the row is empty, add a space with the current face of IT,
18288 so that we know which face to draw. */
18289 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18291 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18292 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
18293 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18295 #ifdef HAVE_WINDOW_SYSTEM
18296 if (it
->glyph_row
->reversed_p
)
18298 /* Prepend a stretch glyph to the row, such that the
18299 rightmost glyph will be drawn flushed all the way to the
18300 right margin of the window. The stretch glyph that will
18301 occupy the empty space, if any, to the left of the
18303 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18304 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18305 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18307 int row_width
, stretch_ascent
, stretch_width
;
18308 struct text_pos saved_pos
;
18309 int saved_face_id
, saved_avoid_cursor
;
18311 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18312 row_width
+= g
->pixel_width
;
18313 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18314 if (stretch_width
> 0)
18317 (((it
->ascent
+ it
->descent
)
18318 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18319 saved_pos
= it
->position
;
18320 memset (&it
->position
, 0, sizeof it
->position
);
18321 saved_avoid_cursor
= it
->avoid_cursor_p
;
18322 it
->avoid_cursor_p
= 1;
18323 saved_face_id
= it
->face_id
;
18324 /* The last row's stretch glyph should get the default
18325 face, to avoid painting the rest of the window with
18326 the region face, if the region ends at ZV. */
18327 if (it
->glyph_row
->ends_at_zv_p
)
18328 it
->face_id
= default_face
->id
;
18330 it
->face_id
= face
->id
;
18331 append_stretch_glyph (it
, make_number (0), stretch_width
,
18332 it
->ascent
+ it
->descent
, stretch_ascent
);
18333 it
->position
= saved_pos
;
18334 it
->avoid_cursor_p
= saved_avoid_cursor
;
18335 it
->face_id
= saved_face_id
;
18338 #endif /* HAVE_WINDOW_SYSTEM */
18342 /* Save some values that must not be changed. */
18343 int saved_x
= it
->current_x
;
18344 struct text_pos saved_pos
;
18345 Lisp_Object saved_object
;
18346 enum display_element_type saved_what
= it
->what
;
18347 int saved_face_id
= it
->face_id
;
18349 saved_object
= it
->object
;
18350 saved_pos
= it
->position
;
18352 it
->what
= IT_CHARACTER
;
18353 memset (&it
->position
, 0, sizeof it
->position
);
18354 it
->object
= make_number (0);
18355 it
->c
= it
->char_to_display
= ' ';
18357 /* The last row's blank glyphs should get the default face, to
18358 avoid painting the rest of the window with the region face,
18359 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
;
18365 PRODUCE_GLYPHS (it
);
18367 while (it
->current_x
<= it
->last_visible_x
)
18368 PRODUCE_GLYPHS (it
);
18370 /* Don't count these blanks really. It would let us insert a left
18371 truncation glyph below and make us set the cursor on them, maybe. */
18372 it
->current_x
= saved_x
;
18373 it
->object
= saved_object
;
18374 it
->position
= saved_pos
;
18375 it
->what
= saved_what
;
18376 it
->face_id
= saved_face_id
;
18381 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18382 trailing whitespace. */
18385 trailing_whitespace_p (EMACS_INT charpos
)
18387 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18390 while (bytepos
< ZV_BYTE
18391 && (c
= FETCH_CHAR (bytepos
),
18392 c
== ' ' || c
== '\t'))
18395 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18397 if (bytepos
!= PT_BYTE
)
18404 /* Highlight trailing whitespace, if any, in ROW. */
18407 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18409 int used
= row
->used
[TEXT_AREA
];
18413 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18414 struct glyph
*glyph
= start
+ used
- 1;
18416 if (row
->reversed_p
)
18418 /* Right-to-left rows need to be processed in the opposite
18419 direction, so swap the edge pointers. */
18421 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18424 /* Skip over glyphs inserted to display the cursor at the
18425 end of a line, for extending the face of the last glyph
18426 to the end of the line on terminals, and for truncation
18427 and continuation glyphs. */
18428 if (!row
->reversed_p
)
18430 while (glyph
>= start
18431 && glyph
->type
== CHAR_GLYPH
18432 && INTEGERP (glyph
->object
))
18437 while (glyph
<= start
18438 && glyph
->type
== CHAR_GLYPH
18439 && INTEGERP (glyph
->object
))
18443 /* If last glyph is a space or stretch, and it's trailing
18444 whitespace, set the face of all trailing whitespace glyphs in
18445 IT->glyph_row to `trailing-whitespace'. */
18446 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18447 && BUFFERP (glyph
->object
)
18448 && (glyph
->type
== STRETCH_GLYPH
18449 || (glyph
->type
== CHAR_GLYPH
18450 && glyph
->u
.ch
== ' '))
18451 && trailing_whitespace_p (glyph
->charpos
))
18453 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18457 if (!row
->reversed_p
)
18459 while (glyph
>= start
18460 && BUFFERP (glyph
->object
)
18461 && (glyph
->type
== STRETCH_GLYPH
18462 || (glyph
->type
== CHAR_GLYPH
18463 && glyph
->u
.ch
== ' ')))
18464 (glyph
--)->face_id
= face_id
;
18468 while (glyph
<= start
18469 && BUFFERP (glyph
->object
)
18470 && (glyph
->type
== STRETCH_GLYPH
18471 || (glyph
->type
== CHAR_GLYPH
18472 && glyph
->u
.ch
== ' ')))
18473 (glyph
++)->face_id
= face_id
;
18480 /* Value is non-zero if glyph row ROW should be
18481 used to hold the cursor. */
18484 cursor_row_p (struct glyph_row
*row
)
18488 if (PT
== CHARPOS (row
->end
.pos
)
18489 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18491 /* Suppose the row ends on a string.
18492 Unless the row is continued, that means it ends on a newline
18493 in the string. If it's anything other than a display string
18494 (e.g., a before-string from an overlay), we don't want the
18495 cursor there. (This heuristic seems to give the optimal
18496 behavior for the various types of multi-line strings.)
18497 One exception: if the string has `cursor' property on one of
18498 its characters, we _do_ want the cursor there. */
18499 if (CHARPOS (row
->end
.string_pos
) >= 0)
18501 if (row
->continued_p
)
18505 /* Check for `display' property. */
18506 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18507 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18508 struct glyph
*glyph
;
18511 for (glyph
= end
; glyph
>= beg
; --glyph
)
18512 if (STRINGP (glyph
->object
))
18515 = Fget_char_property (make_number (PT
),
18519 && display_prop_string_p (prop
, glyph
->object
));
18520 /* If there's a `cursor' property on one of the
18521 string's characters, this row is a cursor row,
18522 even though this is not a display string. */
18525 Lisp_Object s
= glyph
->object
;
18527 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
18529 EMACS_INT gpos
= glyph
->charpos
;
18531 if (!NILP (Fget_char_property (make_number (gpos
),
18543 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18545 /* If the row ends in middle of a real character,
18546 and the line is continued, we want the cursor here.
18547 That's because CHARPOS (ROW->end.pos) would equal
18548 PT if PT is before the character. */
18549 if (!row
->ends_in_ellipsis_p
)
18550 result
= row
->continued_p
;
18552 /* If the row ends in an ellipsis, then
18553 CHARPOS (ROW->end.pos) will equal point after the
18554 invisible text. We want that position to be displayed
18555 after the ellipsis. */
18558 /* If the row ends at ZV, display the cursor at the end of that
18559 row instead of at the start of the row below. */
18560 else if (row
->ends_at_zv_p
)
18571 /* Push the property PROP so that it will be rendered at the current
18572 position in IT. Return 1 if PROP was successfully pushed, 0
18573 otherwise. Called from handle_line_prefix to handle the
18574 `line-prefix' and `wrap-prefix' properties. */
18577 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
18579 struct text_pos pos
=
18580 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18582 xassert (it
->method
== GET_FROM_BUFFER
18583 || it
->method
== GET_FROM_DISPLAY_VECTOR
18584 || it
->method
== GET_FROM_STRING
);
18586 /* We need to save the current buffer/string position, so it will be
18587 restored by pop_it, because iterate_out_of_display_property
18588 depends on that being set correctly, but some situations leave
18589 it->position not yet set when this function is called. */
18590 push_it (it
, &pos
);
18592 if (STRINGP (prop
))
18594 if (SCHARS (prop
) == 0)
18601 it
->string_from_prefix_prop_p
= 1;
18602 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18603 it
->current
.overlay_string_index
= -1;
18604 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18605 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18606 it
->method
= GET_FROM_STRING
;
18607 it
->stop_charpos
= 0;
18609 it
->base_level_stop
= 0;
18611 /* Force paragraph direction to be that of the parent
18613 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18614 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18616 it
->paragraph_embedding
= L2R
;
18618 /* Set up the bidi iterator for this display string. */
18621 it
->bidi_it
.string
.lstring
= it
->string
;
18622 it
->bidi_it
.string
.s
= NULL
;
18623 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18624 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18625 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18626 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18627 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18630 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18632 it
->method
= GET_FROM_STRETCH
;
18635 #ifdef HAVE_WINDOW_SYSTEM
18636 else if (IMAGEP (prop
))
18638 it
->what
= IT_IMAGE
;
18639 it
->image_id
= lookup_image (it
->f
, prop
);
18640 it
->method
= GET_FROM_IMAGE
;
18642 #endif /* HAVE_WINDOW_SYSTEM */
18645 pop_it (it
); /* bogus display property, give up */
18652 /* Return the character-property PROP at the current position in IT. */
18655 get_it_property (struct it
*it
, Lisp_Object prop
)
18657 Lisp_Object position
;
18659 if (STRINGP (it
->object
))
18660 position
= make_number (IT_STRING_CHARPOS (*it
));
18661 else if (BUFFERP (it
->object
))
18662 position
= make_number (IT_CHARPOS (*it
));
18666 return Fget_char_property (position
, prop
, it
->object
);
18669 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18672 handle_line_prefix (struct it
*it
)
18674 Lisp_Object prefix
;
18676 if (it
->continuation_lines_width
> 0)
18678 prefix
= get_it_property (it
, Qwrap_prefix
);
18680 prefix
= Vwrap_prefix
;
18684 prefix
= get_it_property (it
, Qline_prefix
);
18686 prefix
= Vline_prefix
;
18688 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
18690 /* If the prefix is wider than the window, and we try to wrap
18691 it, it would acquire its own wrap prefix, and so on till the
18692 iterator stack overflows. So, don't wrap the prefix. */
18693 it
->line_wrap
= TRUNCATE
;
18694 it
->avoid_cursor_p
= 1;
18700 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18701 only for R2L lines from display_line and display_string, when they
18702 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18703 the line/string needs to be continued on the next glyph row. */
18705 unproduce_glyphs (struct it
*it
, int n
)
18707 struct glyph
*glyph
, *end
;
18709 xassert (it
->glyph_row
);
18710 xassert (it
->glyph_row
->reversed_p
);
18711 xassert (it
->area
== TEXT_AREA
);
18712 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18714 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18715 n
= it
->glyph_row
->used
[TEXT_AREA
];
18716 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18717 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18718 for ( ; glyph
< end
; glyph
++)
18719 glyph
[-n
] = *glyph
;
18722 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18723 and ROW->maxpos. */
18725 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18726 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18727 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18729 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18730 lines' rows is implemented for bidi-reordered rows. */
18732 /* ROW->minpos is the value of min_pos, the minimal buffer position
18733 we have in ROW, or ROW->start.pos if that is smaller. */
18734 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18735 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18737 /* We didn't find buffer positions smaller than ROW->start, or
18738 didn't find _any_ valid buffer positions in any of the glyphs,
18739 so we must trust the iterator's computed positions. */
18740 row
->minpos
= row
->start
.pos
;
18743 max_pos
= CHARPOS (it
->current
.pos
);
18744 max_bpos
= BYTEPOS (it
->current
.pos
);
18747 /* Here are the various use-cases for ending the row, and the
18748 corresponding values for ROW->maxpos:
18750 Line ends in a newline from buffer eol_pos + 1
18751 Line is continued from buffer max_pos + 1
18752 Line is truncated on right it->current.pos
18753 Line ends in a newline from string max_pos + 1(*)
18754 (*) + 1 only when line ends in a forward scan
18755 Line is continued from string max_pos
18756 Line is continued from display vector max_pos
18757 Line is entirely from a string min_pos == max_pos
18758 Line is entirely from a display vector min_pos == max_pos
18759 Line that ends at ZV ZV
18761 If you discover other use-cases, please add them here as
18763 if (row
->ends_at_zv_p
)
18764 row
->maxpos
= it
->current
.pos
;
18765 else if (row
->used
[TEXT_AREA
])
18767 int seen_this_string
= 0;
18768 struct glyph_row
*r1
= row
- 1;
18770 /* Did we see the same display string on the previous row? */
18771 if (STRINGP (it
->object
)
18772 /* this is not the first row */
18773 && row
> it
->w
->desired_matrix
->rows
18774 /* previous row is not the header line */
18775 && !r1
->mode_line_p
18776 /* previous row also ends in a newline from a string */
18777 && r1
->ends_in_newline_from_string_p
)
18779 struct glyph
*start
, *end
;
18781 /* Search for the last glyph of the previous row that came
18782 from buffer or string. Depending on whether the row is
18783 L2R or R2L, we need to process it front to back or the
18784 other way round. */
18785 if (!r1
->reversed_p
)
18787 start
= r1
->glyphs
[TEXT_AREA
];
18788 end
= start
+ r1
->used
[TEXT_AREA
];
18789 /* Glyphs inserted by redisplay have an integer (zero)
18790 as their object. */
18792 && INTEGERP ((end
- 1)->object
)
18793 && (end
- 1)->charpos
<= 0)
18797 if (EQ ((end
- 1)->object
, it
->object
))
18798 seen_this_string
= 1;
18801 /* If all the glyphs of the previous row were inserted
18802 by redisplay, it means the previous row was
18803 produced from a single newline, which is only
18804 possible if that newline came from the same string
18805 as the one which produced this ROW. */
18806 seen_this_string
= 1;
18810 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18811 start
= end
+ r1
->used
[TEXT_AREA
];
18813 && INTEGERP ((end
+ 1)->object
)
18814 && (end
+ 1)->charpos
<= 0)
18818 if (EQ ((end
+ 1)->object
, it
->object
))
18819 seen_this_string
= 1;
18822 seen_this_string
= 1;
18825 /* Take note of each display string that covers a newline only
18826 once, the first time we see it. This is for when a display
18827 string includes more than one newline in it. */
18828 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18830 /* If we were scanning the buffer forward when we displayed
18831 the string, we want to account for at least one buffer
18832 position that belongs to this row (position covered by
18833 the display string), so that cursor positioning will
18834 consider this row as a candidate when point is at the end
18835 of the visual line represented by this row. This is not
18836 required when scanning back, because max_pos will already
18837 have a much larger value. */
18838 if (CHARPOS (row
->end
.pos
) > max_pos
)
18839 INC_BOTH (max_pos
, max_bpos
);
18840 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18842 else if (CHARPOS (it
->eol_pos
) > 0)
18843 SET_TEXT_POS (row
->maxpos
,
18844 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18845 else if (row
->continued_p
)
18847 /* If max_pos is different from IT's current position, it
18848 means IT->method does not belong to the display element
18849 at max_pos. However, it also means that the display
18850 element at max_pos was displayed in its entirety on this
18851 line, which is equivalent to saying that the next line
18852 starts at the next buffer position. */
18853 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18854 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18857 INC_BOTH (max_pos
, max_bpos
);
18858 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18861 else if (row
->truncated_on_right_p
)
18862 /* display_line already called reseat_at_next_visible_line_start,
18863 which puts the iterator at the beginning of the next line, in
18864 the logical order. */
18865 row
->maxpos
= it
->current
.pos
;
18866 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18867 /* A line that is entirely from a string/image/stretch... */
18868 row
->maxpos
= row
->minpos
;
18873 row
->maxpos
= it
->current
.pos
;
18876 /* Construct the glyph row IT->glyph_row in the desired matrix of
18877 IT->w from text at the current position of IT. See dispextern.h
18878 for an overview of struct it. Value is non-zero if
18879 IT->glyph_row displays text, as opposed to a line displaying ZV
18883 display_line (struct it
*it
)
18885 struct glyph_row
*row
= it
->glyph_row
;
18886 Lisp_Object overlay_arrow_string
;
18888 void *wrap_data
= NULL
;
18889 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18890 int wrap_row_used
= -1;
18891 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18892 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18893 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18894 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18895 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18897 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18898 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18900 /* We always start displaying at hpos zero even if hscrolled. */
18901 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18903 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18904 >= it
->w
->desired_matrix
->nrows
)
18906 it
->w
->nrows_scale_factor
++;
18907 fonts_changed_p
= 1;
18911 /* Is IT->w showing the region? */
18912 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18914 /* Clear the result glyph row and enable it. */
18915 prepare_desired_row (row
);
18917 row
->y
= it
->current_y
;
18918 row
->start
= it
->start
;
18919 row
->continuation_lines_width
= it
->continuation_lines_width
;
18920 row
->displays_text_p
= 1;
18921 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18922 it
->starts_in_middle_of_char_p
= 0;
18924 /* Arrange the overlays nicely for our purposes. Usually, we call
18925 display_line on only one line at a time, in which case this
18926 can't really hurt too much, or we call it on lines which appear
18927 one after another in the buffer, in which case all calls to
18928 recenter_overlay_lists but the first will be pretty cheap. */
18929 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18931 /* Move over display elements that are not visible because we are
18932 hscrolled. This may stop at an x-position < IT->first_visible_x
18933 if the first glyph is partially visible or if we hit a line end. */
18934 if (it
->current_x
< it
->first_visible_x
)
18936 this_line_min_pos
= row
->start
.pos
;
18937 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18938 MOVE_TO_POS
| MOVE_TO_X
);
18939 /* Record the smallest positions seen while we moved over
18940 display elements that are not visible. This is needed by
18941 redisplay_internal for optimizing the case where the cursor
18942 stays inside the same line. The rest of this function only
18943 considers positions that are actually displayed, so
18944 RECORD_MAX_MIN_POS will not otherwise record positions that
18945 are hscrolled to the left of the left edge of the window. */
18946 min_pos
= CHARPOS (this_line_min_pos
);
18947 min_bpos
= BYTEPOS (this_line_min_pos
);
18951 /* We only do this when not calling `move_it_in_display_line_to'
18952 above, because move_it_in_display_line_to calls
18953 handle_line_prefix itself. */
18954 handle_line_prefix (it
);
18957 /* Get the initial row height. This is either the height of the
18958 text hscrolled, if there is any, or zero. */
18959 row
->ascent
= it
->max_ascent
;
18960 row
->height
= it
->max_ascent
+ it
->max_descent
;
18961 row
->phys_ascent
= it
->max_phys_ascent
;
18962 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18963 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18965 /* Utility macro to record max and min buffer positions seen until now. */
18966 #define RECORD_MAX_MIN_POS(IT) \
18969 int composition_p = !STRINGP ((IT)->string) \
18970 && ((IT)->what == IT_COMPOSITION); \
18971 EMACS_INT current_pos = \
18972 composition_p ? (IT)->cmp_it.charpos \
18973 : IT_CHARPOS (*(IT)); \
18974 EMACS_INT current_bpos = \
18975 composition_p ? CHAR_TO_BYTE (current_pos) \
18976 : IT_BYTEPOS (*(IT)); \
18977 if (current_pos < min_pos) \
18979 min_pos = current_pos; \
18980 min_bpos = current_bpos; \
18982 if (IT_CHARPOS (*it) > max_pos) \
18984 max_pos = IT_CHARPOS (*it); \
18985 max_bpos = IT_BYTEPOS (*it); \
18990 /* Loop generating characters. The loop is left with IT on the next
18991 character to display. */
18994 int n_glyphs_before
, hpos_before
, x_before
;
18996 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18998 /* Retrieve the next thing to display. Value is zero if end of
19000 if (!get_next_display_element (it
))
19002 /* Maybe add a space at the end of this line that is used to
19003 display the cursor there under X. Set the charpos of the
19004 first glyph of blank lines not corresponding to any text
19006 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19007 row
->exact_window_width_line_p
= 1;
19008 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19009 || row
->used
[TEXT_AREA
] == 0)
19011 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19012 row
->displays_text_p
= 0;
19014 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
19015 && (!MINI_WINDOW_P (it
->w
)
19016 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19017 row
->indicate_empty_line_p
= 1;
19020 it
->continuation_lines_width
= 0;
19021 row
->ends_at_zv_p
= 1;
19022 /* A row that displays right-to-left text must always have
19023 its last face extended all the way to the end of line,
19024 even if this row ends in ZV, because we still write to
19025 the screen left to right. We also need to extend the
19026 last face if the default face is remapped to some
19027 different face, otherwise the functions that clear
19028 portions of the screen will clear with the default face's
19029 background color. */
19030 if (row
->reversed_p
19031 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19032 extend_face_to_end_of_line (it
);
19036 /* Now, get the metrics of what we want to display. This also
19037 generates glyphs in `row' (which is IT->glyph_row). */
19038 n_glyphs_before
= row
->used
[TEXT_AREA
];
19041 /* Remember the line height so far in case the next element doesn't
19042 fit on the line. */
19043 if (it
->line_wrap
!= TRUNCATE
)
19045 ascent
= it
->max_ascent
;
19046 descent
= it
->max_descent
;
19047 phys_ascent
= it
->max_phys_ascent
;
19048 phys_descent
= it
->max_phys_descent
;
19050 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19052 if (IT_DISPLAYING_WHITESPACE (it
))
19056 SAVE_IT (wrap_it
, *it
, wrap_data
);
19058 wrap_row_used
= row
->used
[TEXT_AREA
];
19059 wrap_row_ascent
= row
->ascent
;
19060 wrap_row_height
= row
->height
;
19061 wrap_row_phys_ascent
= row
->phys_ascent
;
19062 wrap_row_phys_height
= row
->phys_height
;
19063 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
19064 wrap_row_min_pos
= min_pos
;
19065 wrap_row_min_bpos
= min_bpos
;
19066 wrap_row_max_pos
= max_pos
;
19067 wrap_row_max_bpos
= max_bpos
;
19073 PRODUCE_GLYPHS (it
);
19075 /* If this display element was in marginal areas, continue with
19077 if (it
->area
!= TEXT_AREA
)
19079 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19080 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19081 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19082 row
->phys_height
= max (row
->phys_height
,
19083 it
->max_phys_ascent
+ it
->max_phys_descent
);
19084 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19085 it
->max_extra_line_spacing
);
19086 set_iterator_to_next (it
, 1);
19090 /* Does the display element fit on the line? If we truncate
19091 lines, we should draw past the right edge of the window. If
19092 we don't truncate, we want to stop so that we can display the
19093 continuation glyph before the right margin. If lines are
19094 continued, there are two possible strategies for characters
19095 resulting in more than 1 glyph (e.g. tabs): Display as many
19096 glyphs as possible in this line and leave the rest for the
19097 continuation line, or display the whole element in the next
19098 line. Original redisplay did the former, so we do it also. */
19099 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
19100 hpos_before
= it
->hpos
;
19103 if (/* Not a newline. */
19105 /* Glyphs produced fit entirely in the line. */
19106 && it
->current_x
< it
->last_visible_x
)
19108 it
->hpos
+= nglyphs
;
19109 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19110 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19111 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19112 row
->phys_height
= max (row
->phys_height
,
19113 it
->max_phys_ascent
+ it
->max_phys_descent
);
19114 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19115 it
->max_extra_line_spacing
);
19116 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19117 row
->x
= x
- it
->first_visible_x
;
19118 /* Record the maximum and minimum buffer positions seen so
19119 far in glyphs that will be displayed by this row. */
19121 RECORD_MAX_MIN_POS (it
);
19126 struct glyph
*glyph
;
19128 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19130 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19131 new_x
= x
+ glyph
->pixel_width
;
19133 if (/* Lines are continued. */
19134 it
->line_wrap
!= TRUNCATE
19135 && (/* Glyph doesn't fit on the line. */
19136 new_x
> it
->last_visible_x
19137 /* Or it fits exactly on a window system frame. */
19138 || (new_x
== it
->last_visible_x
19139 && FRAME_WINDOW_P (it
->f
))))
19141 /* End of a continued line. */
19144 || (new_x
== it
->last_visible_x
19145 && FRAME_WINDOW_P (it
->f
)))
19147 /* Current glyph is the only one on the line or
19148 fits exactly on the line. We must continue
19149 the line because we can't draw the cursor
19150 after the glyph. */
19151 row
->continued_p
= 1;
19152 it
->current_x
= new_x
;
19153 it
->continuation_lines_width
+= new_x
;
19155 if (i
== nglyphs
- 1)
19157 /* If line-wrap is on, check if a previous
19158 wrap point was found. */
19159 if (wrap_row_used
> 0
19160 /* Even if there is a previous wrap
19161 point, continue the line here as
19162 usual, if (i) the previous character
19163 was a space or tab AND (ii) the
19164 current character is not. */
19166 || IT_DISPLAYING_WHITESPACE (it
)))
19169 /* Record the maximum and minimum buffer
19170 positions seen so far in glyphs that will be
19171 displayed by this row. */
19173 RECORD_MAX_MIN_POS (it
);
19174 set_iterator_to_next (it
, 1);
19175 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19177 if (!get_next_display_element (it
))
19179 row
->exact_window_width_line_p
= 1;
19180 it
->continuation_lines_width
= 0;
19181 row
->continued_p
= 0;
19182 row
->ends_at_zv_p
= 1;
19184 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19186 row
->continued_p
= 0;
19187 row
->exact_window_width_line_p
= 1;
19191 else if (it
->bidi_p
)
19192 RECORD_MAX_MIN_POS (it
);
19194 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19195 && !FRAME_WINDOW_P (it
->f
))
19197 /* A padding glyph that doesn't fit on this line.
19198 This means the whole character doesn't fit
19200 if (row
->reversed_p
)
19201 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19202 - n_glyphs_before
);
19203 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19205 /* Fill the rest of the row with continuation
19206 glyphs like in 20.x. */
19207 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19208 < row
->glyphs
[1 + TEXT_AREA
])
19209 produce_special_glyphs (it
, IT_CONTINUATION
);
19211 row
->continued_p
= 1;
19212 it
->current_x
= x_before
;
19213 it
->continuation_lines_width
+= x_before
;
19215 /* Restore the height to what it was before the
19216 element not fitting on the line. */
19217 it
->max_ascent
= ascent
;
19218 it
->max_descent
= descent
;
19219 it
->max_phys_ascent
= phys_ascent
;
19220 it
->max_phys_descent
= phys_descent
;
19222 else if (wrap_row_used
> 0)
19225 if (row
->reversed_p
)
19226 unproduce_glyphs (it
,
19227 row
->used
[TEXT_AREA
] - wrap_row_used
);
19228 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19229 it
->continuation_lines_width
+= wrap_x
;
19230 row
->used
[TEXT_AREA
] = wrap_row_used
;
19231 row
->ascent
= wrap_row_ascent
;
19232 row
->height
= wrap_row_height
;
19233 row
->phys_ascent
= wrap_row_phys_ascent
;
19234 row
->phys_height
= wrap_row_phys_height
;
19235 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19236 min_pos
= wrap_row_min_pos
;
19237 min_bpos
= wrap_row_min_bpos
;
19238 max_pos
= wrap_row_max_pos
;
19239 max_bpos
= wrap_row_max_bpos
;
19240 row
->continued_p
= 1;
19241 row
->ends_at_zv_p
= 0;
19242 row
->exact_window_width_line_p
= 0;
19243 it
->continuation_lines_width
+= x
;
19245 /* Make sure that a non-default face is extended
19246 up to the right margin of the window. */
19247 extend_face_to_end_of_line (it
);
19249 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19251 /* A TAB that extends past the right edge of the
19252 window. This produces a single glyph on
19253 window system frames. We leave the glyph in
19254 this row and let it fill the row, but don't
19255 consume the TAB. */
19256 it
->continuation_lines_width
+= it
->last_visible_x
;
19257 row
->ends_in_middle_of_char_p
= 1;
19258 row
->continued_p
= 1;
19259 glyph
->pixel_width
= it
->last_visible_x
- x
;
19260 it
->starts_in_middle_of_char_p
= 1;
19264 /* Something other than a TAB that draws past
19265 the right edge of the window. Restore
19266 positions to values before the element. */
19267 if (row
->reversed_p
)
19268 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19269 - (n_glyphs_before
+ i
));
19270 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19272 /* Display continuation glyphs. */
19273 if (!FRAME_WINDOW_P (it
->f
))
19274 produce_special_glyphs (it
, IT_CONTINUATION
);
19275 row
->continued_p
= 1;
19277 it
->current_x
= x_before
;
19278 it
->continuation_lines_width
+= x
;
19279 extend_face_to_end_of_line (it
);
19281 if (nglyphs
> 1 && i
> 0)
19283 row
->ends_in_middle_of_char_p
= 1;
19284 it
->starts_in_middle_of_char_p
= 1;
19287 /* Restore the height to what it was before the
19288 element not fitting on the line. */
19289 it
->max_ascent
= ascent
;
19290 it
->max_descent
= descent
;
19291 it
->max_phys_ascent
= phys_ascent
;
19292 it
->max_phys_descent
= phys_descent
;
19297 else if (new_x
> it
->first_visible_x
)
19299 /* Increment number of glyphs actually displayed. */
19302 /* Record the maximum and minimum buffer positions
19303 seen so far in glyphs that will be displayed by
19306 RECORD_MAX_MIN_POS (it
);
19308 if (x
< it
->first_visible_x
)
19309 /* Glyph is partially visible, i.e. row starts at
19310 negative X position. */
19311 row
->x
= x
- it
->first_visible_x
;
19315 /* Glyph is completely off the left margin of the
19316 window. This should not happen because of the
19317 move_it_in_display_line at the start of this
19318 function, unless the text display area of the
19319 window is empty. */
19320 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19323 /* Even if this display element produced no glyphs at all,
19324 we want to record its position. */
19325 if (it
->bidi_p
&& nglyphs
== 0)
19326 RECORD_MAX_MIN_POS (it
);
19328 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19329 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19330 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19331 row
->phys_height
= max (row
->phys_height
,
19332 it
->max_phys_ascent
+ it
->max_phys_descent
);
19333 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19334 it
->max_extra_line_spacing
);
19336 /* End of this display line if row is continued. */
19337 if (row
->continued_p
|| row
->ends_at_zv_p
)
19342 /* Is this a line end? If yes, we're also done, after making
19343 sure that a non-default face is extended up to the right
19344 margin of the window. */
19345 if (ITERATOR_AT_END_OF_LINE_P (it
))
19347 int used_before
= row
->used
[TEXT_AREA
];
19349 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19351 /* Add a space at the end of the line that is used to
19352 display the cursor there. */
19353 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19354 append_space_for_newline (it
, 0);
19356 /* Extend the face to the end of the line. */
19357 extend_face_to_end_of_line (it
);
19359 /* Make sure we have the position. */
19360 if (used_before
== 0)
19361 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19363 /* Record the position of the newline, for use in
19365 it
->eol_pos
= it
->current
.pos
;
19367 /* Consume the line end. This skips over invisible lines. */
19368 set_iterator_to_next (it
, 1);
19369 it
->continuation_lines_width
= 0;
19373 /* Proceed with next display element. Note that this skips
19374 over lines invisible because of selective display. */
19375 set_iterator_to_next (it
, 1);
19377 /* If we truncate lines, we are done when the last displayed
19378 glyphs reach past the right margin of the window. */
19379 if (it
->line_wrap
== TRUNCATE
19380 && (FRAME_WINDOW_P (it
->f
)
19381 ? (it
->current_x
>= it
->last_visible_x
)
19382 : (it
->current_x
> it
->last_visible_x
)))
19384 /* Maybe add truncation glyphs. */
19385 if (!FRAME_WINDOW_P (it
->f
))
19389 if (!row
->reversed_p
)
19391 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19392 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19397 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19398 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19400 /* Remove any padding glyphs at the front of ROW, to
19401 make room for the truncation glyphs we will be
19402 adding below. The loop below always inserts at
19403 least one truncation glyph, so also remove the
19404 last glyph added to ROW. */
19405 unproduce_glyphs (it
, i
+ 1);
19406 /* Adjust i for the loop below. */
19407 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19410 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19412 row
->used
[TEXT_AREA
] = i
;
19413 produce_special_glyphs (it
, IT_TRUNCATION
);
19416 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19418 /* Don't truncate if we can overflow newline into fringe. */
19419 if (!get_next_display_element (it
))
19421 it
->continuation_lines_width
= 0;
19422 row
->ends_at_zv_p
= 1;
19423 row
->exact_window_width_line_p
= 1;
19426 if (ITERATOR_AT_END_OF_LINE_P (it
))
19428 row
->exact_window_width_line_p
= 1;
19429 goto at_end_of_line
;
19433 row
->truncated_on_right_p
= 1;
19434 it
->continuation_lines_width
= 0;
19435 reseat_at_next_visible_line_start (it
, 0);
19436 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19437 it
->hpos
= hpos_before
;
19438 it
->current_x
= x_before
;
19444 bidi_unshelve_cache (wrap_data
, 1);
19446 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19447 at the left window margin. */
19448 if (it
->first_visible_x
19449 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19451 if (!FRAME_WINDOW_P (it
->f
))
19452 insert_left_trunc_glyphs (it
);
19453 row
->truncated_on_left_p
= 1;
19456 /* Remember the position at which this line ends.
19458 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19459 cannot be before the call to find_row_edges below, since that is
19460 where these positions are determined. */
19461 row
->end
= it
->current
;
19464 row
->minpos
= row
->start
.pos
;
19465 row
->maxpos
= row
->end
.pos
;
19469 /* ROW->minpos and ROW->maxpos must be the smallest and
19470 `1 + the largest' buffer positions in ROW. But if ROW was
19471 bidi-reordered, these two positions can be anywhere in the
19472 row, so we must determine them now. */
19473 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19476 /* If the start of this line is the overlay arrow-position, then
19477 mark this glyph row as the one containing the overlay arrow.
19478 This is clearly a mess with variable size fonts. It would be
19479 better to let it be displayed like cursors under X. */
19480 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19481 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19482 !NILP (overlay_arrow_string
)))
19484 /* Overlay arrow in window redisplay is a fringe bitmap. */
19485 if (STRINGP (overlay_arrow_string
))
19487 struct glyph_row
*arrow_row
19488 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19489 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19490 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19491 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19492 struct glyph
*p2
, *end
;
19494 /* Copy the arrow glyphs. */
19495 while (glyph
< arrow_end
)
19498 /* Throw away padding glyphs. */
19500 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19501 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19507 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19512 xassert (INTEGERP (overlay_arrow_string
));
19513 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19515 overlay_arrow_seen
= 1;
19518 /* Highlight trailing whitespace. */
19519 if (!NILP (Vshow_trailing_whitespace
))
19520 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19522 /* Compute pixel dimensions of this line. */
19523 compute_line_metrics (it
);
19525 /* Implementation note: No changes in the glyphs of ROW or in their
19526 faces can be done past this point, because compute_line_metrics
19527 computes ROW's hash value and stores it within the glyph_row
19530 /* Record whether this row ends inside an ellipsis. */
19531 row
->ends_in_ellipsis_p
19532 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19533 && it
->ellipsis_p
);
19535 /* Save fringe bitmaps in this row. */
19536 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19537 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19538 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19539 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19541 it
->left_user_fringe_bitmap
= 0;
19542 it
->left_user_fringe_face_id
= 0;
19543 it
->right_user_fringe_bitmap
= 0;
19544 it
->right_user_fringe_face_id
= 0;
19546 /* Maybe set the cursor. */
19547 cvpos
= it
->w
->cursor
.vpos
;
19549 /* In bidi-reordered rows, keep checking for proper cursor
19550 position even if one has been found already, because buffer
19551 positions in such rows change non-linearly with ROW->VPOS,
19552 when a line is continued. One exception: when we are at ZV,
19553 display cursor on the first suitable glyph row, since all
19554 the empty rows after that also have their position set to ZV. */
19555 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19556 lines' rows is implemented for bidi-reordered rows. */
19558 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19559 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19560 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19561 && cursor_row_p (row
))
19562 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19564 /* Prepare for the next line. This line starts horizontally at (X
19565 HPOS) = (0 0). Vertical positions are incremented. As a
19566 convenience for the caller, IT->glyph_row is set to the next
19568 it
->current_x
= it
->hpos
= 0;
19569 it
->current_y
+= row
->height
;
19570 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19573 /* The next row should by default use the same value of the
19574 reversed_p flag as this one. set_iterator_to_next decides when
19575 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19576 the flag accordingly. */
19577 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19578 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19579 it
->start
= row
->end
;
19580 return row
->displays_text_p
;
19582 #undef RECORD_MAX_MIN_POS
19585 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19586 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19587 doc
: /* Return paragraph direction at point in BUFFER.
19588 Value is either `left-to-right' or `right-to-left'.
19589 If BUFFER is omitted or nil, it defaults to the current buffer.
19591 Paragraph direction determines how the text in the paragraph is displayed.
19592 In left-to-right paragraphs, text begins at the left margin of the window
19593 and the reading direction is generally left to right. In right-to-left
19594 paragraphs, text begins at the right margin and is read from right to left.
19596 See also `bidi-paragraph-direction'. */)
19597 (Lisp_Object buffer
)
19599 struct buffer
*buf
= current_buffer
;
19600 struct buffer
*old
= buf
;
19602 if (! NILP (buffer
))
19604 CHECK_BUFFER (buffer
);
19605 buf
= XBUFFER (buffer
);
19608 if (NILP (BVAR (buf
, bidi_display_reordering
))
19609 || NILP (BVAR (buf
, enable_multibyte_characters
))
19610 /* When we are loading loadup.el, the character property tables
19611 needed for bidi iteration are not yet available. */
19612 || !NILP (Vpurify_flag
))
19613 return Qleft_to_right
;
19614 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19615 return BVAR (buf
, bidi_paragraph_direction
);
19618 /* Determine the direction from buffer text. We could try to
19619 use current_matrix if it is up to date, but this seems fast
19620 enough as it is. */
19621 struct bidi_it itb
;
19622 EMACS_INT pos
= BUF_PT (buf
);
19623 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19625 void *itb_data
= bidi_shelve_cache ();
19627 set_buffer_temp (buf
);
19628 /* bidi_paragraph_init finds the base direction of the paragraph
19629 by searching forward from paragraph start. We need the base
19630 direction of the current or _previous_ paragraph, so we need
19631 to make sure we are within that paragraph. To that end, find
19632 the previous non-empty line. */
19633 if (pos
>= ZV
&& pos
> BEGV
)
19636 bytepos
= CHAR_TO_BYTE (pos
);
19638 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19639 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19641 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19642 || c
== ' ' || c
== '\t' || c
== '\f')
19644 if (bytepos
<= BEGV_BYTE
)
19649 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19652 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19653 itb
.paragraph_dir
= NEUTRAL_DIR
;
19654 itb
.string
.s
= NULL
;
19655 itb
.string
.lstring
= Qnil
;
19656 itb
.string
.bufpos
= 0;
19657 itb
.string
.unibyte
= 0;
19658 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19659 bidi_unshelve_cache (itb_data
, 0);
19660 set_buffer_temp (old
);
19661 switch (itb
.paragraph_dir
)
19664 return Qleft_to_right
;
19667 return Qright_to_left
;
19677 /***********************************************************************
19679 ***********************************************************************/
19681 /* Redisplay the menu bar in the frame for window W.
19683 The menu bar of X frames that don't have X toolkit support is
19684 displayed in a special window W->frame->menu_bar_window.
19686 The menu bar of terminal frames is treated specially as far as
19687 glyph matrices are concerned. Menu bar lines are not part of
19688 windows, so the update is done directly on the frame matrix rows
19689 for the menu bar. */
19692 display_menu_bar (struct window
*w
)
19694 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19699 /* Don't do all this for graphical frames. */
19701 if (FRAME_W32_P (f
))
19704 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19710 if (FRAME_NS_P (f
))
19712 #endif /* HAVE_NS */
19714 #ifdef USE_X_TOOLKIT
19715 xassert (!FRAME_WINDOW_P (f
));
19716 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19717 it
.first_visible_x
= 0;
19718 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19719 #else /* not USE_X_TOOLKIT */
19720 if (FRAME_WINDOW_P (f
))
19722 /* Menu bar lines are displayed in the desired matrix of the
19723 dummy window menu_bar_window. */
19724 struct window
*menu_w
;
19725 xassert (WINDOWP (f
->menu_bar_window
));
19726 menu_w
= XWINDOW (f
->menu_bar_window
);
19727 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19729 it
.first_visible_x
= 0;
19730 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19734 /* This is a TTY frame, i.e. character hpos/vpos are used as
19736 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19738 it
.first_visible_x
= 0;
19739 it
.last_visible_x
= FRAME_COLS (f
);
19741 #endif /* not USE_X_TOOLKIT */
19743 /* FIXME: This should be controlled by a user option. See the
19744 comments in redisplay_tool_bar and display_mode_line about
19746 it
.paragraph_embedding
= L2R
;
19748 if (! mode_line_inverse_video
)
19749 /* Force the menu-bar to be displayed in the default face. */
19750 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19752 /* Clear all rows of the menu bar. */
19753 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19755 struct glyph_row
*row
= it
.glyph_row
+ i
;
19756 clear_glyph_row (row
);
19757 row
->enabled_p
= 1;
19758 row
->full_width_p
= 1;
19761 /* Display all items of the menu bar. */
19762 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19763 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19765 Lisp_Object string
;
19767 /* Stop at nil string. */
19768 string
= AREF (items
, i
+ 1);
19772 /* Remember where item was displayed. */
19773 ASET (items
, i
+ 3, make_number (it
.hpos
));
19775 /* Display the item, pad with one space. */
19776 if (it
.current_x
< it
.last_visible_x
)
19777 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19778 SCHARS (string
) + 1, 0, 0, -1);
19781 /* Fill out the line with spaces. */
19782 if (it
.current_x
< it
.last_visible_x
)
19783 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19785 /* Compute the total height of the lines. */
19786 compute_line_metrics (&it
);
19791 /***********************************************************************
19793 ***********************************************************************/
19795 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19796 FORCE is non-zero, redisplay mode lines unconditionally.
19797 Otherwise, redisplay only mode lines that are garbaged. Value is
19798 the number of windows whose mode lines were redisplayed. */
19801 redisplay_mode_lines (Lisp_Object window
, int force
)
19805 while (!NILP (window
))
19807 struct window
*w
= XWINDOW (window
);
19809 if (WINDOWP (w
->hchild
))
19810 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19811 else if (WINDOWP (w
->vchild
))
19812 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19814 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19815 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19817 struct text_pos lpoint
;
19818 struct buffer
*old
= current_buffer
;
19820 /* Set the window's buffer for the mode line display. */
19821 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19822 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19824 /* Point refers normally to the selected window. For any
19825 other window, set up appropriate value. */
19826 if (!EQ (window
, selected_window
))
19828 struct text_pos pt
;
19830 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19831 if (CHARPOS (pt
) < BEGV
)
19832 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19833 else if (CHARPOS (pt
) > (ZV
- 1))
19834 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19836 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19839 /* Display mode lines. */
19840 clear_glyph_matrix (w
->desired_matrix
);
19841 if (display_mode_lines (w
))
19844 w
->must_be_updated_p
= 1;
19847 /* Restore old settings. */
19848 set_buffer_internal_1 (old
);
19849 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19859 /* Display the mode and/or header line of window W. Value is the
19860 sum number of mode lines and header lines displayed. */
19863 display_mode_lines (struct window
*w
)
19865 Lisp_Object old_selected_window
, old_selected_frame
;
19868 old_selected_frame
= selected_frame
;
19869 selected_frame
= w
->frame
;
19870 old_selected_window
= selected_window
;
19871 XSETWINDOW (selected_window
, w
);
19873 /* These will be set while the mode line specs are processed. */
19874 line_number_displayed
= 0;
19875 w
->column_number_displayed
= Qnil
;
19877 if (WINDOW_WANTS_MODELINE_P (w
))
19879 struct window
*sel_w
= XWINDOW (old_selected_window
);
19881 /* Select mode line face based on the real selected window. */
19882 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19883 BVAR (current_buffer
, mode_line_format
));
19887 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19889 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19890 BVAR (current_buffer
, header_line_format
));
19894 selected_frame
= old_selected_frame
;
19895 selected_window
= old_selected_window
;
19900 /* Display mode or header line of window W. FACE_ID specifies which
19901 line to display; it is either MODE_LINE_FACE_ID or
19902 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19903 display. Value is the pixel height of the mode/header line
19907 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19911 int count
= SPECPDL_INDEX ();
19913 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19914 /* Don't extend on a previously drawn mode-line.
19915 This may happen if called from pos_visible_p. */
19916 it
.glyph_row
->enabled_p
= 0;
19917 prepare_desired_row (it
.glyph_row
);
19919 it
.glyph_row
->mode_line_p
= 1;
19921 if (! mode_line_inverse_video
)
19922 /* Force the mode-line to be displayed in the default face. */
19923 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19925 /* FIXME: This should be controlled by a user option. But
19926 supporting such an option is not trivial, since the mode line is
19927 made up of many separate strings. */
19928 it
.paragraph_embedding
= L2R
;
19930 record_unwind_protect (unwind_format_mode_line
,
19931 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19933 mode_line_target
= MODE_LINE_DISPLAY
;
19935 /* Temporarily make frame's keyboard the current kboard so that
19936 kboard-local variables in the mode_line_format will get the right
19938 push_kboard (FRAME_KBOARD (it
.f
));
19939 record_unwind_save_match_data ();
19940 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19943 unbind_to (count
, Qnil
);
19945 /* Fill up with spaces. */
19946 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19948 compute_line_metrics (&it
);
19949 it
.glyph_row
->full_width_p
= 1;
19950 it
.glyph_row
->continued_p
= 0;
19951 it
.glyph_row
->truncated_on_left_p
= 0;
19952 it
.glyph_row
->truncated_on_right_p
= 0;
19954 /* Make a 3D mode-line have a shadow at its right end. */
19955 face
= FACE_FROM_ID (it
.f
, face_id
);
19956 extend_face_to_end_of_line (&it
);
19957 if (face
->box
!= FACE_NO_BOX
)
19959 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19960 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19961 last
->right_box_line_p
= 1;
19964 return it
.glyph_row
->height
;
19967 /* Move element ELT in LIST to the front of LIST.
19968 Return the updated list. */
19971 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19973 register Lisp_Object tail
, prev
;
19974 register Lisp_Object tem
;
19978 while (CONSP (tail
))
19984 /* Splice out the link TAIL. */
19986 list
= XCDR (tail
);
19988 Fsetcdr (prev
, XCDR (tail
));
19990 /* Now make it the first. */
19991 Fsetcdr (tail
, list
);
19996 tail
= XCDR (tail
);
20000 /* Not found--return unchanged LIST. */
20004 /* Contribute ELT to the mode line for window IT->w. How it
20005 translates into text depends on its data type.
20007 IT describes the display environment in which we display, as usual.
20009 DEPTH is the depth in recursion. It is used to prevent
20010 infinite recursion here.
20012 FIELD_WIDTH is the number of characters the display of ELT should
20013 occupy in the mode line, and PRECISION is the maximum number of
20014 characters to display from ELT's representation. See
20015 display_string for details.
20017 Returns the hpos of the end of the text generated by ELT.
20019 PROPS is a property list to add to any string we encounter.
20021 If RISKY is nonzero, remove (disregard) any properties in any string
20022 we encounter, and ignore :eval and :propertize.
20024 The global variable `mode_line_target' determines whether the
20025 output is passed to `store_mode_line_noprop',
20026 `store_mode_line_string', or `display_string'. */
20029 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
20030 Lisp_Object elt
, Lisp_Object props
, int risky
)
20032 int n
= 0, field
, prec
;
20037 elt
= build_string ("*too-deep*");
20041 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
20045 /* A string: output it and check for %-constructs within it. */
20047 EMACS_INT offset
= 0;
20049 if (SCHARS (elt
) > 0
20050 && (!NILP (props
) || risky
))
20052 Lisp_Object oprops
, aelt
;
20053 oprops
= Ftext_properties_at (make_number (0), elt
);
20055 /* If the starting string's properties are not what
20056 we want, translate the string. Also, if the string
20057 is risky, do that anyway. */
20059 if (NILP (Fequal (props
, oprops
)) || risky
)
20061 /* If the starting string has properties,
20062 merge the specified ones onto the existing ones. */
20063 if (! NILP (oprops
) && !risky
)
20067 oprops
= Fcopy_sequence (oprops
);
20069 while (CONSP (tem
))
20071 oprops
= Fplist_put (oprops
, XCAR (tem
),
20072 XCAR (XCDR (tem
)));
20073 tem
= XCDR (XCDR (tem
));
20078 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
20079 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
20081 /* AELT is what we want. Move it to the front
20082 without consing. */
20084 mode_line_proptrans_alist
20085 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
20091 /* If AELT has the wrong props, it is useless.
20092 so get rid of it. */
20094 mode_line_proptrans_alist
20095 = Fdelq (aelt
, mode_line_proptrans_alist
);
20097 elt
= Fcopy_sequence (elt
);
20098 Fset_text_properties (make_number (0), Flength (elt
),
20100 /* Add this item to mode_line_proptrans_alist. */
20101 mode_line_proptrans_alist
20102 = Fcons (Fcons (elt
, props
),
20103 mode_line_proptrans_alist
);
20104 /* Truncate mode_line_proptrans_alist
20105 to at most 50 elements. */
20106 tem
= Fnthcdr (make_number (50),
20107 mode_line_proptrans_alist
);
20109 XSETCDR (tem
, Qnil
);
20118 prec
= precision
- n
;
20119 switch (mode_line_target
)
20121 case MODE_LINE_NOPROP
:
20122 case MODE_LINE_TITLE
:
20123 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20125 case MODE_LINE_STRING
:
20126 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20128 case MODE_LINE_DISPLAY
:
20129 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20130 0, prec
, 0, STRING_MULTIBYTE (elt
));
20137 /* Handle the non-literal case. */
20139 while ((precision
<= 0 || n
< precision
)
20140 && SREF (elt
, offset
) != 0
20141 && (mode_line_target
!= MODE_LINE_DISPLAY
20142 || it
->current_x
< it
->last_visible_x
))
20144 EMACS_INT last_offset
= offset
;
20146 /* Advance to end of string or next format specifier. */
20147 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20150 if (offset
- 1 != last_offset
)
20152 EMACS_INT nchars
, nbytes
;
20154 /* Output to end of string or up to '%'. Field width
20155 is length of string. Don't output more than
20156 PRECISION allows us. */
20159 prec
= c_string_width (SDATA (elt
) + last_offset
,
20160 offset
- last_offset
, precision
- n
,
20163 switch (mode_line_target
)
20165 case MODE_LINE_NOPROP
:
20166 case MODE_LINE_TITLE
:
20167 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20169 case MODE_LINE_STRING
:
20171 EMACS_INT bytepos
= last_offset
;
20172 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20173 EMACS_INT endpos
= (precision
<= 0
20174 ? string_byte_to_char (elt
, offset
)
20175 : charpos
+ nchars
);
20177 n
+= store_mode_line_string (NULL
,
20178 Fsubstring (elt
, make_number (charpos
),
20179 make_number (endpos
)),
20183 case MODE_LINE_DISPLAY
:
20185 EMACS_INT bytepos
= last_offset
;
20186 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20188 if (precision
<= 0)
20189 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20190 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20192 STRING_MULTIBYTE (elt
));
20197 else /* c == '%' */
20199 EMACS_INT percent_position
= offset
;
20201 /* Get the specified minimum width. Zero means
20204 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20205 field
= field
* 10 + c
- '0';
20207 /* Don't pad beyond the total padding allowed. */
20208 if (field_width
- n
> 0 && field
> field_width
- n
)
20209 field
= field_width
- n
;
20211 /* Note that either PRECISION <= 0 or N < PRECISION. */
20212 prec
= precision
- n
;
20215 n
+= display_mode_element (it
, depth
, field
, prec
,
20216 Vglobal_mode_string
, props
,
20221 EMACS_INT bytepos
, charpos
;
20223 Lisp_Object string
;
20225 bytepos
= percent_position
;
20226 charpos
= (STRING_MULTIBYTE (elt
)
20227 ? string_byte_to_char (elt
, bytepos
)
20229 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20230 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20232 switch (mode_line_target
)
20234 case MODE_LINE_NOPROP
:
20235 case MODE_LINE_TITLE
:
20236 n
+= store_mode_line_noprop (spec
, field
, prec
);
20238 case MODE_LINE_STRING
:
20240 Lisp_Object tem
= build_string (spec
);
20241 props
= Ftext_properties_at (make_number (charpos
), elt
);
20242 /* Should only keep face property in props */
20243 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20246 case MODE_LINE_DISPLAY
:
20248 int nglyphs_before
, nwritten
;
20250 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20251 nwritten
= display_string (spec
, string
, elt
,
20256 /* Assign to the glyphs written above the
20257 string where the `%x' came from, position
20261 struct glyph
*glyph
20262 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20266 for (i
= 0; i
< nwritten
; ++i
)
20268 glyph
[i
].object
= elt
;
20269 glyph
[i
].charpos
= charpos
;
20286 /* A symbol: process the value of the symbol recursively
20287 as if it appeared here directly. Avoid error if symbol void.
20288 Special case: if value of symbol is a string, output the string
20291 register Lisp_Object tem
;
20293 /* If the variable is not marked as risky to set
20294 then its contents are risky to use. */
20295 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20298 tem
= Fboundp (elt
);
20301 tem
= Fsymbol_value (elt
);
20302 /* If value is a string, output that string literally:
20303 don't check for % within it. */
20307 if (!EQ (tem
, elt
))
20309 /* Give up right away for nil or t. */
20319 register Lisp_Object car
, tem
;
20321 /* A cons cell: five distinct cases.
20322 If first element is :eval or :propertize, do something special.
20323 If first element is a string or a cons, process all the elements
20324 and effectively concatenate them.
20325 If first element is a negative number, truncate displaying cdr to
20326 at most that many characters. If positive, pad (with spaces)
20327 to at least that many characters.
20328 If first element is a symbol, process the cadr or caddr recursively
20329 according to whether the symbol's value is non-nil or nil. */
20331 if (EQ (car
, QCeval
))
20333 /* An element of the form (:eval FORM) means evaluate FORM
20334 and use the result as mode line elements. */
20339 if (CONSP (XCDR (elt
)))
20342 spec
= safe_eval (XCAR (XCDR (elt
)));
20343 n
+= display_mode_element (it
, depth
, field_width
- n
,
20344 precision
- n
, spec
, props
,
20348 else if (EQ (car
, QCpropertize
))
20350 /* An element of the form (:propertize ELT PROPS...)
20351 means display ELT but applying properties PROPS. */
20356 if (CONSP (XCDR (elt
)))
20357 n
+= display_mode_element (it
, depth
, field_width
- n
,
20358 precision
- n
, XCAR (XCDR (elt
)),
20359 XCDR (XCDR (elt
)), risky
);
20361 else if (SYMBOLP (car
))
20363 tem
= Fboundp (car
);
20367 /* elt is now the cdr, and we know it is a cons cell.
20368 Use its car if CAR has a non-nil value. */
20371 tem
= Fsymbol_value (car
);
20378 /* Symbol's value is nil (or symbol is unbound)
20379 Get the cddr of the original list
20380 and if possible find the caddr and use that. */
20384 else if (!CONSP (elt
))
20389 else if (INTEGERP (car
))
20391 register int lim
= XINT (car
);
20395 /* Negative int means reduce maximum width. */
20396 if (precision
<= 0)
20399 precision
= min (precision
, -lim
);
20403 /* Padding specified. Don't let it be more than
20404 current maximum. */
20406 lim
= min (precision
, lim
);
20408 /* If that's more padding than already wanted, queue it.
20409 But don't reduce padding already specified even if
20410 that is beyond the current truncation point. */
20411 field_width
= max (lim
, field_width
);
20415 else if (STRINGP (car
) || CONSP (car
))
20417 Lisp_Object halftail
= elt
;
20421 && (precision
<= 0 || n
< precision
))
20423 n
+= display_mode_element (it
, depth
,
20424 /* Do padding only after the last
20425 element in the list. */
20426 (! CONSP (XCDR (elt
))
20429 precision
- n
, XCAR (elt
),
20433 if ((len
& 1) == 0)
20434 halftail
= XCDR (halftail
);
20435 /* Check for cycle. */
20436 if (EQ (halftail
, elt
))
20445 elt
= build_string ("*invalid*");
20449 /* Pad to FIELD_WIDTH. */
20450 if (field_width
> 0 && n
< field_width
)
20452 switch (mode_line_target
)
20454 case MODE_LINE_NOPROP
:
20455 case MODE_LINE_TITLE
:
20456 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20458 case MODE_LINE_STRING
:
20459 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20461 case MODE_LINE_DISPLAY
:
20462 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20471 /* Store a mode-line string element in mode_line_string_list.
20473 If STRING is non-null, display that C string. Otherwise, the Lisp
20474 string LISP_STRING is displayed.
20476 FIELD_WIDTH is the minimum number of output glyphs to produce.
20477 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20478 with spaces. FIELD_WIDTH <= 0 means don't pad.
20480 PRECISION is the maximum number of characters to output from
20481 STRING. PRECISION <= 0 means don't truncate the string.
20483 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20484 properties to the string.
20486 PROPS are the properties to add to the string.
20487 The mode_line_string_face face property is always added to the string.
20491 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20492 int field_width
, int precision
, Lisp_Object props
)
20497 if (string
!= NULL
)
20499 len
= strlen (string
);
20500 if (precision
> 0 && len
> precision
)
20502 lisp_string
= make_string (string
, len
);
20504 props
= mode_line_string_face_prop
;
20505 else if (!NILP (mode_line_string_face
))
20507 Lisp_Object face
= Fplist_get (props
, Qface
);
20508 props
= Fcopy_sequence (props
);
20510 face
= mode_line_string_face
;
20512 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20513 props
= Fplist_put (props
, Qface
, face
);
20515 Fadd_text_properties (make_number (0), make_number (len
),
20516 props
, lisp_string
);
20520 len
= XFASTINT (Flength (lisp_string
));
20521 if (precision
> 0 && len
> precision
)
20524 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20527 if (!NILP (mode_line_string_face
))
20531 props
= Ftext_properties_at (make_number (0), lisp_string
);
20532 face
= Fplist_get (props
, Qface
);
20534 face
= mode_line_string_face
;
20536 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20537 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20539 lisp_string
= Fcopy_sequence (lisp_string
);
20542 Fadd_text_properties (make_number (0), make_number (len
),
20543 props
, lisp_string
);
20548 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20552 if (field_width
> len
)
20554 field_width
-= len
;
20555 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20557 Fadd_text_properties (make_number (0), make_number (field_width
),
20558 props
, lisp_string
);
20559 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20567 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20569 doc
: /* Format a string out of a mode line format specification.
20570 First arg FORMAT specifies the mode line format (see `mode-line-format'
20571 for details) to use.
20573 By default, the format is evaluated for the currently selected window.
20575 Optional second arg FACE specifies the face property to put on all
20576 characters for which no face is specified. The value nil means the
20577 default face. The value t means whatever face the window's mode line
20578 currently uses (either `mode-line' or `mode-line-inactive',
20579 depending on whether the window is the selected window or not).
20580 An integer value means the value string has no text
20583 Optional third and fourth args WINDOW and BUFFER specify the window
20584 and buffer to use as the context for the formatting (defaults
20585 are the selected window and the WINDOW's buffer). */)
20586 (Lisp_Object format
, Lisp_Object face
,
20587 Lisp_Object window
, Lisp_Object buffer
)
20592 struct buffer
*old_buffer
= NULL
;
20594 int no_props
= INTEGERP (face
);
20595 int count
= SPECPDL_INDEX ();
20597 int string_start
= 0;
20600 window
= selected_window
;
20601 CHECK_WINDOW (window
);
20602 w
= XWINDOW (window
);
20605 buffer
= w
->buffer
;
20606 CHECK_BUFFER (buffer
);
20608 /* Make formatting the modeline a non-op when noninteractive, otherwise
20609 there will be problems later caused by a partially initialized frame. */
20610 if (NILP (format
) || noninteractive
)
20611 return empty_unibyte_string
;
20616 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20617 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20618 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20619 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20620 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20621 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20622 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20625 if (XBUFFER (buffer
) != current_buffer
)
20626 old_buffer
= current_buffer
;
20628 /* Save things including mode_line_proptrans_alist,
20629 and set that to nil so that we don't alter the outer value. */
20630 record_unwind_protect (unwind_format_mode_line
,
20631 format_mode_line_unwind_data
20632 (old_buffer
, selected_window
, 1));
20633 mode_line_proptrans_alist
= Qnil
;
20635 Fselect_window (window
, Qt
);
20637 set_buffer_internal_1 (XBUFFER (buffer
));
20639 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20643 mode_line_target
= MODE_LINE_NOPROP
;
20644 mode_line_string_face_prop
= Qnil
;
20645 mode_line_string_list
= Qnil
;
20646 string_start
= MODE_LINE_NOPROP_LEN (0);
20650 mode_line_target
= MODE_LINE_STRING
;
20651 mode_line_string_list
= Qnil
;
20652 mode_line_string_face
= face
;
20653 mode_line_string_face_prop
20654 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20657 push_kboard (FRAME_KBOARD (it
.f
));
20658 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20663 len
= MODE_LINE_NOPROP_LEN (string_start
);
20664 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20668 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20669 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20670 empty_unibyte_string
);
20673 unbind_to (count
, Qnil
);
20677 /* Write a null-terminated, right justified decimal representation of
20678 the positive integer D to BUF using a minimal field width WIDTH. */
20681 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20683 register char *p
= buf
;
20691 *p
++ = d
% 10 + '0';
20696 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20707 /* Write a null-terminated, right justified decimal and "human
20708 readable" representation of the nonnegative integer D to BUF using
20709 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20711 static const char power_letter
[] =
20725 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20727 /* We aim to represent the nonnegative integer D as
20728 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20729 EMACS_INT quotient
= d
;
20731 /* -1 means: do not use TENTHS. */
20735 /* Length of QUOTIENT.TENTHS as a string. */
20741 if (1000 <= quotient
)
20743 /* Scale to the appropriate EXPONENT. */
20746 remainder
= quotient
% 1000;
20750 while (1000 <= quotient
);
20752 /* Round to nearest and decide whether to use TENTHS or not. */
20755 tenths
= remainder
/ 100;
20756 if (50 <= remainder
% 100)
20763 if (quotient
== 10)
20771 if (500 <= remainder
)
20773 if (quotient
< 999)
20784 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20785 if (tenths
== -1 && quotient
<= 99)
20792 p
= psuffix
= buf
+ max (width
, length
);
20794 /* Print EXPONENT. */
20795 *psuffix
++ = power_letter
[exponent
];
20798 /* Print TENTHS. */
20801 *--p
= '0' + tenths
;
20805 /* Print QUOTIENT. */
20808 int digit
= quotient
% 10;
20809 *--p
= '0' + digit
;
20811 while ((quotient
/= 10) != 0);
20813 /* Print leading spaces. */
20818 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20819 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20820 type of CODING_SYSTEM. Return updated pointer into BUF. */
20822 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20825 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20828 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20829 const unsigned char *eol_str
;
20831 /* The EOL conversion we are using. */
20832 Lisp_Object eoltype
;
20834 val
= CODING_SYSTEM_SPEC (coding_system
);
20837 if (!VECTORP (val
)) /* Not yet decided. */
20842 eoltype
= eol_mnemonic_undecided
;
20843 /* Don't mention EOL conversion if it isn't decided. */
20848 Lisp_Object eolvalue
;
20850 attrs
= AREF (val
, 0);
20851 eolvalue
= AREF (val
, 2);
20854 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20858 /* The EOL conversion that is normal on this system. */
20860 if (NILP (eolvalue
)) /* Not yet decided. */
20861 eoltype
= eol_mnemonic_undecided
;
20862 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20863 eoltype
= eol_mnemonic_undecided
;
20864 else /* eolvalue is Qunix, Qdos, or Qmac. */
20865 eoltype
= (EQ (eolvalue
, Qunix
)
20866 ? eol_mnemonic_unix
20867 : (EQ (eolvalue
, Qdos
) == 1
20868 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20874 /* Mention the EOL conversion if it is not the usual one. */
20875 if (STRINGP (eoltype
))
20877 eol_str
= SDATA (eoltype
);
20878 eol_str_len
= SBYTES (eoltype
);
20880 else if (CHARACTERP (eoltype
))
20882 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20883 int c
= XFASTINT (eoltype
);
20884 eol_str_len
= CHAR_STRING (c
, tmp
);
20889 eol_str
= invalid_eol_type
;
20890 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20892 memcpy (buf
, eol_str
, eol_str_len
);
20893 buf
+= eol_str_len
;
20899 /* Return a string for the output of a mode line %-spec for window W,
20900 generated by character C. FIELD_WIDTH > 0 means pad the string
20901 returned with spaces to that value. Return a Lisp string in
20902 *STRING if the resulting string is taken from that Lisp string.
20904 Note we operate on the current buffer for most purposes,
20905 the exception being w->base_line_pos. */
20907 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20909 static const char *
20910 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20911 Lisp_Object
*string
)
20914 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20915 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20916 struct buffer
*b
= current_buffer
;
20924 if (!NILP (BVAR (b
, read_only
)))
20926 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20931 /* This differs from %* only for a modified read-only buffer. */
20932 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20934 if (!NILP (BVAR (b
, read_only
)))
20939 /* This differs from %* in ignoring read-only-ness. */
20940 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20952 if (command_loop_level
> 5)
20954 p
= decode_mode_spec_buf
;
20955 for (i
= 0; i
< command_loop_level
; i
++)
20958 return decode_mode_spec_buf
;
20966 if (command_loop_level
> 5)
20968 p
= decode_mode_spec_buf
;
20969 for (i
= 0; i
< command_loop_level
; i
++)
20972 return decode_mode_spec_buf
;
20979 /* Let lots_of_dashes be a string of infinite length. */
20980 if (mode_line_target
== MODE_LINE_NOPROP
||
20981 mode_line_target
== MODE_LINE_STRING
)
20983 if (field_width
<= 0
20984 || field_width
> sizeof (lots_of_dashes
))
20986 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20987 decode_mode_spec_buf
[i
] = '-';
20988 decode_mode_spec_buf
[i
] = '\0';
20989 return decode_mode_spec_buf
;
20992 return lots_of_dashes
;
20996 obj
= BVAR (b
, name
);
21000 /* %c and %l are ignored in `frame-title-format'.
21001 (In redisplay_internal, the frame title is drawn _before_ the
21002 windows are updated, so the stuff which depends on actual
21003 window contents (such as %l) may fail to render properly, or
21004 even crash emacs.) */
21005 if (mode_line_target
== MODE_LINE_TITLE
)
21009 EMACS_INT col
= current_column ();
21010 w
->column_number_displayed
= make_number (col
);
21011 pint2str (decode_mode_spec_buf
, field_width
, col
);
21012 return decode_mode_spec_buf
;
21016 #ifndef SYSTEM_MALLOC
21018 if (NILP (Vmemory_full
))
21021 return "!MEM FULL! ";
21028 /* %F displays the frame name. */
21029 if (!NILP (f
->title
))
21030 return SSDATA (f
->title
);
21031 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
21032 return SSDATA (f
->name
);
21036 obj
= BVAR (b
, filename
);
21041 EMACS_INT size
= ZV
- BEGV
;
21042 pint2str (decode_mode_spec_buf
, field_width
, size
);
21043 return decode_mode_spec_buf
;
21048 EMACS_INT size
= ZV
- BEGV
;
21049 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
21050 return decode_mode_spec_buf
;
21055 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
21056 EMACS_INT topline
, nlines
, height
;
21059 /* %c and %l are ignored in `frame-title-format'. */
21060 if (mode_line_target
== MODE_LINE_TITLE
)
21063 startpos
= XMARKER (w
->start
)->charpos
;
21064 startpos_byte
= marker_byte_position (w
->start
);
21065 height
= WINDOW_TOTAL_LINES (w
);
21067 /* If we decided that this buffer isn't suitable for line numbers,
21068 don't forget that too fast. */
21069 if (EQ (w
->base_line_pos
, w
->buffer
))
21071 /* But do forget it, if the window shows a different buffer now. */
21072 else if (BUFFERP (w
->base_line_pos
))
21073 w
->base_line_pos
= Qnil
;
21075 /* If the buffer is very big, don't waste time. */
21076 if (INTEGERP (Vline_number_display_limit
)
21077 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
21079 w
->base_line_pos
= Qnil
;
21080 w
->base_line_number
= Qnil
;
21084 if (INTEGERP (w
->base_line_number
)
21085 && INTEGERP (w
->base_line_pos
)
21086 && XFASTINT (w
->base_line_pos
) <= startpos
)
21088 line
= XFASTINT (w
->base_line_number
);
21089 linepos
= XFASTINT (w
->base_line_pos
);
21090 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
21095 linepos
= BUF_BEGV (b
);
21096 linepos_byte
= BUF_BEGV_BYTE (b
);
21099 /* Count lines from base line to window start position. */
21100 nlines
= display_count_lines (linepos_byte
,
21104 topline
= nlines
+ line
;
21106 /* Determine a new base line, if the old one is too close
21107 or too far away, or if we did not have one.
21108 "Too close" means it's plausible a scroll-down would
21109 go back past it. */
21110 if (startpos
== BUF_BEGV (b
))
21112 w
->base_line_number
= make_number (topline
);
21113 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21115 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21116 || linepos
== BUF_BEGV (b
))
21118 EMACS_INT limit
= BUF_BEGV (b
);
21119 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
21120 EMACS_INT position
;
21121 EMACS_INT distance
=
21122 (height
* 2 + 30) * line_number_display_limit_width
;
21124 if (startpos
- distance
> limit
)
21126 limit
= startpos
- distance
;
21127 limit_byte
= CHAR_TO_BYTE (limit
);
21130 nlines
= display_count_lines (startpos_byte
,
21132 - (height
* 2 + 30),
21134 /* If we couldn't find the lines we wanted within
21135 line_number_display_limit_width chars per line,
21136 give up on line numbers for this window. */
21137 if (position
== limit_byte
&& limit
== startpos
- distance
)
21139 w
->base_line_pos
= w
->buffer
;
21140 w
->base_line_number
= Qnil
;
21144 w
->base_line_number
= make_number (topline
- nlines
);
21145 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21148 /* Now count lines from the start pos to point. */
21149 nlines
= display_count_lines (startpos_byte
,
21150 PT_BYTE
, PT
, &junk
);
21152 /* Record that we did display the line number. */
21153 line_number_displayed
= 1;
21155 /* Make the string to show. */
21156 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21157 return decode_mode_spec_buf
;
21160 char* p
= decode_mode_spec_buf
;
21161 int pad
= field_width
- 2;
21167 return decode_mode_spec_buf
;
21173 obj
= BVAR (b
, mode_name
);
21177 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21183 EMACS_INT pos
= marker_position (w
->start
);
21184 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21186 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21188 if (pos
<= BUF_BEGV (b
))
21193 else if (pos
<= BUF_BEGV (b
))
21197 if (total
> 1000000)
21198 /* Do it differently for a large value, to avoid overflow. */
21199 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21201 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21202 /* We can't normally display a 3-digit number,
21203 so get us a 2-digit number that is close. */
21206 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21207 return decode_mode_spec_buf
;
21211 /* Display percentage of size above the bottom of the screen. */
21214 EMACS_INT toppos
= marker_position (w
->start
);
21215 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21216 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21218 if (botpos
>= BUF_ZV (b
))
21220 if (toppos
<= BUF_BEGV (b
))
21227 if (total
> 1000000)
21228 /* Do it differently for a large value, to avoid overflow. */
21229 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21231 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21232 /* We can't normally display a 3-digit number,
21233 so get us a 2-digit number that is close. */
21236 if (toppos
<= BUF_BEGV (b
))
21237 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21239 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21240 return decode_mode_spec_buf
;
21245 /* status of process */
21246 obj
= Fget_buffer_process (Fcurrent_buffer ());
21248 return "no process";
21250 obj
= Fsymbol_name (Fprocess_status (obj
));
21256 int count
= inhibit_garbage_collection ();
21257 Lisp_Object val
= call1 (intern ("file-remote-p"),
21258 BVAR (current_buffer
, directory
));
21259 unbind_to (count
, Qnil
);
21267 case 't': /* indicate TEXT or BINARY */
21271 /* coding-system (not including end-of-line format) */
21273 /* coding-system (including end-of-line type) */
21275 int eol_flag
= (c
== 'Z');
21276 char *p
= decode_mode_spec_buf
;
21278 if (! FRAME_WINDOW_P (f
))
21280 /* No need to mention EOL here--the terminal never needs
21281 to do EOL conversion. */
21282 p
= decode_mode_spec_coding (CODING_ID_NAME
21283 (FRAME_KEYBOARD_CODING (f
)->id
),
21285 p
= decode_mode_spec_coding (CODING_ID_NAME
21286 (FRAME_TERMINAL_CODING (f
)->id
),
21289 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21292 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21293 #ifdef subprocesses
21294 obj
= Fget_buffer_process (Fcurrent_buffer ());
21295 if (PROCESSP (obj
))
21297 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21299 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21302 #endif /* subprocesses */
21305 return decode_mode_spec_buf
;
21312 return SSDATA (obj
);
21319 /* Count up to COUNT lines starting from START_BYTE.
21320 But don't go beyond LIMIT_BYTE.
21321 Return the number of lines thus found (always nonnegative).
21323 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21326 display_count_lines (EMACS_INT start_byte
,
21327 EMACS_INT limit_byte
, EMACS_INT count
,
21328 EMACS_INT
*byte_pos_ptr
)
21330 register unsigned char *cursor
;
21331 unsigned char *base
;
21333 register EMACS_INT ceiling
;
21334 register unsigned char *ceiling_addr
;
21335 EMACS_INT orig_count
= count
;
21337 /* If we are not in selective display mode,
21338 check only for newlines. */
21339 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21340 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21344 while (start_byte
< limit_byte
)
21346 ceiling
= BUFFER_CEILING_OF (start_byte
);
21347 ceiling
= min (limit_byte
- 1, ceiling
);
21348 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21349 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21352 if (selective_display
)
21353 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21356 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21359 if (cursor
!= ceiling_addr
)
21363 start_byte
+= cursor
- base
+ 1;
21364 *byte_pos_ptr
= start_byte
;
21368 if (++cursor
== ceiling_addr
)
21374 start_byte
+= cursor
- base
;
21379 while (start_byte
> limit_byte
)
21381 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21382 ceiling
= max (limit_byte
, ceiling
);
21383 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21384 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21387 if (selective_display
)
21388 while (--cursor
!= ceiling_addr
21389 && *cursor
!= '\n' && *cursor
!= 015)
21392 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21395 if (cursor
!= ceiling_addr
)
21399 start_byte
+= cursor
- base
+ 1;
21400 *byte_pos_ptr
= start_byte
;
21401 /* When scanning backwards, we should
21402 not count the newline posterior to which we stop. */
21403 return - orig_count
- 1;
21409 /* Here we add 1 to compensate for the last decrement
21410 of CURSOR, which took it past the valid range. */
21411 start_byte
+= cursor
- base
+ 1;
21415 *byte_pos_ptr
= limit_byte
;
21418 return - orig_count
+ count
;
21419 return orig_count
- count
;
21425 /***********************************************************************
21427 ***********************************************************************/
21429 /* Display a NUL-terminated string, starting with index START.
21431 If STRING is non-null, display that C string. Otherwise, the Lisp
21432 string LISP_STRING is displayed. There's a case that STRING is
21433 non-null and LISP_STRING is not nil. It means STRING is a string
21434 data of LISP_STRING. In that case, we display LISP_STRING while
21435 ignoring its text properties.
21437 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21438 FACE_STRING. Display STRING or LISP_STRING with the face at
21439 FACE_STRING_POS in FACE_STRING:
21441 Display the string in the environment given by IT, but use the
21442 standard display table, temporarily.
21444 FIELD_WIDTH is the minimum number of output glyphs to produce.
21445 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21446 with spaces. If STRING has more characters, more than FIELD_WIDTH
21447 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21449 PRECISION is the maximum number of characters to output from
21450 STRING. PRECISION < 0 means don't truncate the string.
21452 This is roughly equivalent to printf format specifiers:
21454 FIELD_WIDTH PRECISION PRINTF
21455 ----------------------------------------
21461 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21462 display them, and < 0 means obey the current buffer's value of
21463 enable_multibyte_characters.
21465 Value is the number of columns displayed. */
21468 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21469 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21470 int field_width
, int precision
, int max_x
, int multibyte
)
21472 int hpos_at_start
= it
->hpos
;
21473 int saved_face_id
= it
->face_id
;
21474 struct glyph_row
*row
= it
->glyph_row
;
21475 EMACS_INT it_charpos
;
21477 /* Initialize the iterator IT for iteration over STRING beginning
21478 with index START. */
21479 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21480 precision
, field_width
, multibyte
);
21481 if (string
&& STRINGP (lisp_string
))
21482 /* LISP_STRING is the one returned by decode_mode_spec. We should
21483 ignore its text properties. */
21484 it
->stop_charpos
= it
->end_charpos
;
21486 /* If displaying STRING, set up the face of the iterator from
21487 FACE_STRING, if that's given. */
21488 if (STRINGP (face_string
))
21494 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21495 0, it
->region_beg_charpos
,
21496 it
->region_end_charpos
,
21497 &endptr
, it
->base_face_id
, 0);
21498 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21499 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21502 /* Set max_x to the maximum allowed X position. Don't let it go
21503 beyond the right edge of the window. */
21505 max_x
= it
->last_visible_x
;
21507 max_x
= min (max_x
, it
->last_visible_x
);
21509 /* Skip over display elements that are not visible. because IT->w is
21511 if (it
->current_x
< it
->first_visible_x
)
21512 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21513 MOVE_TO_POS
| MOVE_TO_X
);
21515 row
->ascent
= it
->max_ascent
;
21516 row
->height
= it
->max_ascent
+ it
->max_descent
;
21517 row
->phys_ascent
= it
->max_phys_ascent
;
21518 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21519 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21521 if (STRINGP (it
->string
))
21522 it_charpos
= IT_STRING_CHARPOS (*it
);
21524 it_charpos
= IT_CHARPOS (*it
);
21526 /* This condition is for the case that we are called with current_x
21527 past last_visible_x. */
21528 while (it
->current_x
< max_x
)
21530 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21532 /* Get the next display element. */
21533 if (!get_next_display_element (it
))
21536 /* Produce glyphs. */
21537 x_before
= it
->current_x
;
21538 n_glyphs_before
= row
->used
[TEXT_AREA
];
21539 PRODUCE_GLYPHS (it
);
21541 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21544 while (i
< nglyphs
)
21546 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21548 if (it
->line_wrap
!= TRUNCATE
21549 && x
+ glyph
->pixel_width
> max_x
)
21551 /* End of continued line or max_x reached. */
21552 if (CHAR_GLYPH_PADDING_P (*glyph
))
21554 /* A wide character is unbreakable. */
21555 if (row
->reversed_p
)
21556 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21557 - n_glyphs_before
);
21558 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21559 it
->current_x
= x_before
;
21563 if (row
->reversed_p
)
21564 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21565 - (n_glyphs_before
+ i
));
21566 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21571 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21573 /* Glyph is at least partially visible. */
21575 if (x
< it
->first_visible_x
)
21576 row
->x
= x
- it
->first_visible_x
;
21580 /* Glyph is off the left margin of the display area.
21581 Should not happen. */
21585 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21586 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21587 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21588 row
->phys_height
= max (row
->phys_height
,
21589 it
->max_phys_ascent
+ it
->max_phys_descent
);
21590 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21591 it
->max_extra_line_spacing
);
21592 x
+= glyph
->pixel_width
;
21596 /* Stop if max_x reached. */
21600 /* Stop at line ends. */
21601 if (ITERATOR_AT_END_OF_LINE_P (it
))
21603 it
->continuation_lines_width
= 0;
21607 set_iterator_to_next (it
, 1);
21608 if (STRINGP (it
->string
))
21609 it_charpos
= IT_STRING_CHARPOS (*it
);
21611 it_charpos
= IT_CHARPOS (*it
);
21613 /* Stop if truncating at the right edge. */
21614 if (it
->line_wrap
== TRUNCATE
21615 && it
->current_x
>= it
->last_visible_x
)
21617 /* Add truncation mark, but don't do it if the line is
21618 truncated at a padding space. */
21619 if (it_charpos
< it
->string_nchars
)
21621 if (!FRAME_WINDOW_P (it
->f
))
21625 if (it
->current_x
> it
->last_visible_x
)
21627 if (!row
->reversed_p
)
21629 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21630 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21635 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21636 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21638 unproduce_glyphs (it
, ii
+ 1);
21639 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21641 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21643 row
->used
[TEXT_AREA
] = ii
;
21644 produce_special_glyphs (it
, IT_TRUNCATION
);
21647 produce_special_glyphs (it
, IT_TRUNCATION
);
21649 row
->truncated_on_right_p
= 1;
21655 /* Maybe insert a truncation at the left. */
21656 if (it
->first_visible_x
21659 if (!FRAME_WINDOW_P (it
->f
))
21660 insert_left_trunc_glyphs (it
);
21661 row
->truncated_on_left_p
= 1;
21664 it
->face_id
= saved_face_id
;
21666 /* Value is number of columns displayed. */
21667 return it
->hpos
- hpos_at_start
;
21672 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21673 appears as an element of LIST or as the car of an element of LIST.
21674 If PROPVAL is a list, compare each element against LIST in that
21675 way, and return 1/2 if any element of PROPVAL is found in LIST.
21676 Otherwise return 0. This function cannot quit.
21677 The return value is 2 if the text is invisible but with an ellipsis
21678 and 1 if it's invisible and without an ellipsis. */
21681 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21683 register Lisp_Object tail
, proptail
;
21685 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21687 register Lisp_Object tem
;
21689 if (EQ (propval
, tem
))
21691 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21692 return NILP (XCDR (tem
)) ? 1 : 2;
21695 if (CONSP (propval
))
21697 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21699 Lisp_Object propelt
;
21700 propelt
= XCAR (proptail
);
21701 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21703 register Lisp_Object tem
;
21705 if (EQ (propelt
, tem
))
21707 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21708 return NILP (XCDR (tem
)) ? 1 : 2;
21716 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21717 doc
: /* Non-nil if the property makes the text invisible.
21718 POS-OR-PROP can be a marker or number, in which case it is taken to be
21719 a position in the current buffer and the value of the `invisible' property
21720 is checked; or it can be some other value, which is then presumed to be the
21721 value of the `invisible' property of the text of interest.
21722 The non-nil value returned can be t for truly invisible text or something
21723 else if the text is replaced by an ellipsis. */)
21724 (Lisp_Object pos_or_prop
)
21727 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21728 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21730 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21731 return (invis
== 0 ? Qnil
21733 : make_number (invis
));
21736 /* Calculate a width or height in pixels from a specification using
21737 the following elements:
21740 NUM - a (fractional) multiple of the default font width/height
21741 (NUM) - specifies exactly NUM pixels
21742 UNIT - a fixed number of pixels, see below.
21743 ELEMENT - size of a display element in pixels, see below.
21744 (NUM . SPEC) - equals NUM * SPEC
21745 (+ SPEC SPEC ...) - add pixel values
21746 (- SPEC SPEC ...) - subtract pixel values
21747 (- SPEC) - negate pixel value
21750 INT or FLOAT - a number constant
21751 SYMBOL - use symbol's (buffer local) variable binding.
21754 in - pixels per inch *)
21755 mm - pixels per 1/1000 meter *)
21756 cm - pixels per 1/100 meter *)
21757 width - width of current font in pixels.
21758 height - height of current font in pixels.
21760 *) using the ratio(s) defined in display-pixels-per-inch.
21764 left-fringe - left fringe width in pixels
21765 right-fringe - right fringe width in pixels
21767 left-margin - left margin width in pixels
21768 right-margin - right margin width in pixels
21770 scroll-bar - scroll-bar area width in pixels
21774 Pixels corresponding to 5 inches:
21777 Total width of non-text areas on left side of window (if scroll-bar is on left):
21778 '(space :width (+ left-fringe left-margin scroll-bar))
21780 Align to first text column (in header line):
21781 '(space :align-to 0)
21783 Align to middle of text area minus half the width of variable `my-image'
21784 containing a loaded image:
21785 '(space :align-to (0.5 . (- text my-image)))
21787 Width of left margin minus width of 1 character in the default font:
21788 '(space :width (- left-margin 1))
21790 Width of left margin minus width of 2 characters in the current font:
21791 '(space :width (- left-margin (2 . width)))
21793 Center 1 character over left-margin (in header line):
21794 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21796 Different ways to express width of left fringe plus left margin minus one pixel:
21797 '(space :width (- (+ left-fringe left-margin) (1)))
21798 '(space :width (+ left-fringe left-margin (- (1))))
21799 '(space :width (+ left-fringe left-margin (-1)))
21803 #define NUMVAL(X) \
21804 ((INTEGERP (X) || FLOATP (X)) \
21809 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21810 struct font
*font
, int width_p
, int *align_to
)
21814 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21815 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21818 return OK_PIXELS (0);
21820 xassert (FRAME_LIVE_P (it
->f
));
21822 if (SYMBOLP (prop
))
21824 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21826 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21828 if (unit
[0] == 'i' && unit
[1] == 'n')
21830 else if (unit
[0] == 'm' && unit
[1] == 'm')
21832 else if (unit
[0] == 'c' && unit
[1] == 'm')
21839 #ifdef HAVE_WINDOW_SYSTEM
21840 if (FRAME_WINDOW_P (it
->f
)
21842 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21843 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21845 return OK_PIXELS (ppi
/ pixels
);
21848 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21849 || (CONSP (Vdisplay_pixels_per_inch
)
21851 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21852 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21854 return OK_PIXELS (ppi
/ pixels
);
21860 #ifdef HAVE_WINDOW_SYSTEM
21861 if (EQ (prop
, Qheight
))
21862 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21863 if (EQ (prop
, Qwidth
))
21864 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21866 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21867 return OK_PIXELS (1);
21870 if (EQ (prop
, Qtext
))
21871 return OK_PIXELS (width_p
21872 ? window_box_width (it
->w
, TEXT_AREA
)
21873 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21875 if (align_to
&& *align_to
< 0)
21878 if (EQ (prop
, Qleft
))
21879 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21880 if (EQ (prop
, Qright
))
21881 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21882 if (EQ (prop
, Qcenter
))
21883 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21884 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21885 if (EQ (prop
, Qleft_fringe
))
21886 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21887 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21888 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21889 if (EQ (prop
, Qright_fringe
))
21890 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21891 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21892 : window_box_right_offset (it
->w
, TEXT_AREA
));
21893 if (EQ (prop
, Qleft_margin
))
21894 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21895 if (EQ (prop
, Qright_margin
))
21896 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21897 if (EQ (prop
, Qscroll_bar
))
21898 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21900 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21901 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21902 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21907 if (EQ (prop
, Qleft_fringe
))
21908 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21909 if (EQ (prop
, Qright_fringe
))
21910 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21911 if (EQ (prop
, Qleft_margin
))
21912 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21913 if (EQ (prop
, Qright_margin
))
21914 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21915 if (EQ (prop
, Qscroll_bar
))
21916 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21919 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21922 if (INTEGERP (prop
) || FLOATP (prop
))
21924 int base_unit
= (width_p
21925 ? FRAME_COLUMN_WIDTH (it
->f
)
21926 : FRAME_LINE_HEIGHT (it
->f
));
21927 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21932 Lisp_Object car
= XCAR (prop
);
21933 Lisp_Object cdr
= XCDR (prop
);
21937 #ifdef HAVE_WINDOW_SYSTEM
21938 if (FRAME_WINDOW_P (it
->f
)
21939 && valid_image_p (prop
))
21941 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21942 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21944 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21947 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21953 while (CONSP (cdr
))
21955 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21956 font
, width_p
, align_to
))
21959 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21964 if (EQ (car
, Qminus
))
21966 return OK_PIXELS (pixels
);
21969 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21972 if (INTEGERP (car
) || FLOATP (car
))
21975 pixels
= XFLOATINT (car
);
21977 return OK_PIXELS (pixels
);
21978 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21979 font
, width_p
, align_to
))
21980 return OK_PIXELS (pixels
* fact
);
21991 /***********************************************************************
21993 ***********************************************************************/
21995 #ifdef HAVE_WINDOW_SYSTEM
22000 dump_glyph_string (struct glyph_string
*s
)
22002 fprintf (stderr
, "glyph string\n");
22003 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
22004 s
->x
, s
->y
, s
->width
, s
->height
);
22005 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
22006 fprintf (stderr
, " hl = %d\n", s
->hl
);
22007 fprintf (stderr
, " left overhang = %d, right = %d\n",
22008 s
->left_overhang
, s
->right_overhang
);
22009 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
22010 fprintf (stderr
, " extends to end of line = %d\n",
22011 s
->extends_to_end_of_line_p
);
22012 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
22013 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
22016 #endif /* GLYPH_DEBUG */
22018 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
22019 of XChar2b structures for S; it can't be allocated in
22020 init_glyph_string because it must be allocated via `alloca'. W
22021 is the window on which S is drawn. ROW and AREA are the glyph row
22022 and area within the row from which S is constructed. START is the
22023 index of the first glyph structure covered by S. HL is a
22024 face-override for drawing S. */
22027 #define OPTIONAL_HDC(hdc) HDC hdc,
22028 #define DECLARE_HDC(hdc) HDC hdc;
22029 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
22030 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
22033 #ifndef OPTIONAL_HDC
22034 #define OPTIONAL_HDC(hdc)
22035 #define DECLARE_HDC(hdc)
22036 #define ALLOCATE_HDC(hdc, f)
22037 #define RELEASE_HDC(hdc, f)
22041 init_glyph_string (struct glyph_string
*s
,
22043 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
22044 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
22046 memset (s
, 0, sizeof *s
);
22048 s
->f
= XFRAME (w
->frame
);
22052 s
->display
= FRAME_X_DISPLAY (s
->f
);
22053 s
->window
= FRAME_X_WINDOW (s
->f
);
22054 s
->char2b
= char2b
;
22058 s
->first_glyph
= row
->glyphs
[area
] + start
;
22059 s
->height
= row
->height
;
22060 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
22061 s
->ybase
= s
->y
+ row
->ascent
;
22065 /* Append the list of glyph strings with head H and tail T to the list
22066 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
22069 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22070 struct glyph_string
*h
, struct glyph_string
*t
)
22084 /* Prepend the list of glyph strings with head H and tail T to the
22085 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
22089 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
22090 struct glyph_string
*h
, struct glyph_string
*t
)
22104 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22105 Set *HEAD and *TAIL to the resulting list. */
22108 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22109 struct glyph_string
*s
)
22111 s
->next
= s
->prev
= NULL
;
22112 append_glyph_string_lists (head
, tail
, s
, s
);
22116 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22117 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22118 make sure that X resources for the face returned are allocated.
22119 Value is a pointer to a realized face that is ready for display if
22120 DISPLAY_P is non-zero. */
22122 static inline struct face
*
22123 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22124 XChar2b
*char2b
, int display_p
)
22126 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22130 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22132 if (code
!= FONT_INVALID_CODE
)
22133 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22135 STORE_XCHAR2B (char2b
, 0, 0);
22138 /* Make sure X resources of the face are allocated. */
22139 #ifdef HAVE_X_WINDOWS
22143 xassert (face
!= NULL
);
22144 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22151 /* Get face and two-byte form of character glyph GLYPH on frame F.
22152 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22153 a pointer to a realized face that is ready for display. */
22155 static inline struct face
*
22156 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22157 XChar2b
*char2b
, int *two_byte_p
)
22161 xassert (glyph
->type
== CHAR_GLYPH
);
22162 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22171 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22172 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22174 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22176 if (code
!= FONT_INVALID_CODE
)
22177 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22179 STORE_XCHAR2B (char2b
, 0, 0);
22182 /* Make sure X resources of the face are allocated. */
22183 xassert (face
!= NULL
);
22184 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22189 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22190 Return 1 if FONT has a glyph for C, otherwise return 0. */
22193 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22197 if (CHAR_BYTE8_P (c
))
22198 code
= CHAR_TO_BYTE8 (c
);
22200 code
= font
->driver
->encode_char (font
, c
);
22202 if (code
== FONT_INVALID_CODE
)
22204 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22209 /* Fill glyph string S with composition components specified by S->cmp.
22211 BASE_FACE is the base face of the composition.
22212 S->cmp_from is the index of the first component for S.
22214 OVERLAPS non-zero means S should draw the foreground only, and use
22215 its physical height for clipping. See also draw_glyphs.
22217 Value is the index of a component not in S. */
22220 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22224 /* For all glyphs of this composition, starting at the offset
22225 S->cmp_from, until we reach the end of the definition or encounter a
22226 glyph that requires the different face, add it to S. */
22231 s
->for_overlaps
= overlaps
;
22234 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22236 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22238 /* TAB in a composition means display glyphs with padding space
22239 on the left or right. */
22242 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22245 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22252 s
->font
= s
->face
->font
;
22254 else if (s
->face
!= face
)
22262 if (s
->face
== NULL
)
22264 s
->face
= base_face
->ascii_face
;
22265 s
->font
= s
->face
->font
;
22268 /* All glyph strings for the same composition has the same width,
22269 i.e. the width set for the first component of the composition. */
22270 s
->width
= s
->first_glyph
->pixel_width
;
22272 /* If the specified font could not be loaded, use the frame's
22273 default font, but record the fact that we couldn't load it in
22274 the glyph string so that we can draw rectangles for the
22275 characters of the glyph string. */
22276 if (s
->font
== NULL
)
22278 s
->font_not_found_p
= 1;
22279 s
->font
= FRAME_FONT (s
->f
);
22282 /* Adjust base line for subscript/superscript text. */
22283 s
->ybase
+= s
->first_glyph
->voffset
;
22285 /* This glyph string must always be drawn with 16-bit functions. */
22292 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22293 int start
, int end
, int overlaps
)
22295 struct glyph
*glyph
, *last
;
22296 Lisp_Object lgstring
;
22299 s
->for_overlaps
= overlaps
;
22300 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22301 last
= s
->row
->glyphs
[s
->area
] + end
;
22302 s
->cmp_id
= glyph
->u
.cmp
.id
;
22303 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22304 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22305 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22306 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22307 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22309 while (glyph
< last
22310 && glyph
->u
.cmp
.automatic
22311 && glyph
->u
.cmp
.id
== s
->cmp_id
22312 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22313 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22315 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22317 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22318 unsigned code
= LGLYPH_CODE (lglyph
);
22320 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22322 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22323 return glyph
- s
->row
->glyphs
[s
->area
];
22327 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22328 See the comment of fill_glyph_string for arguments.
22329 Value is the index of the first glyph not in S. */
22333 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22334 int start
, int end
, int overlaps
)
22336 struct glyph
*glyph
, *last
;
22339 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22340 s
->for_overlaps
= overlaps
;
22341 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22342 last
= s
->row
->glyphs
[s
->area
] + end
;
22343 voffset
= glyph
->voffset
;
22344 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22345 s
->font
= s
->face
->font
;
22347 s
->width
= glyph
->pixel_width
;
22349 while (glyph
< last
22350 && glyph
->type
== GLYPHLESS_GLYPH
22351 && glyph
->voffset
== voffset
22352 && glyph
->face_id
== face_id
)
22355 s
->width
+= glyph
->pixel_width
;
22358 s
->ybase
+= voffset
;
22359 return glyph
- s
->row
->glyphs
[s
->area
];
22363 /* Fill glyph string S from a sequence of character glyphs.
22365 FACE_ID is the face id of the string. START is the index of the
22366 first glyph to consider, END is the index of the last + 1.
22367 OVERLAPS non-zero means S should draw the foreground only, and use
22368 its physical height for clipping. See also draw_glyphs.
22370 Value is the index of the first glyph not in S. */
22373 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22374 int start
, int end
, int overlaps
)
22376 struct glyph
*glyph
, *last
;
22378 int glyph_not_available_p
;
22380 xassert (s
->f
== XFRAME (s
->w
->frame
));
22381 xassert (s
->nchars
== 0);
22382 xassert (start
>= 0 && end
> start
);
22384 s
->for_overlaps
= overlaps
;
22385 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22386 last
= s
->row
->glyphs
[s
->area
] + end
;
22387 voffset
= glyph
->voffset
;
22388 s
->padding_p
= glyph
->padding_p
;
22389 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22391 while (glyph
< last
22392 && glyph
->type
== CHAR_GLYPH
22393 && glyph
->voffset
== voffset
22394 /* Same face id implies same font, nowadays. */
22395 && glyph
->face_id
== face_id
22396 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22400 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22401 s
->char2b
+ s
->nchars
,
22403 s
->two_byte_p
= two_byte_p
;
22405 xassert (s
->nchars
<= end
- start
);
22406 s
->width
+= glyph
->pixel_width
;
22407 if (glyph
++->padding_p
!= s
->padding_p
)
22411 s
->font
= s
->face
->font
;
22413 /* If the specified font could not be loaded, use the frame's font,
22414 but record the fact that we couldn't load it in
22415 S->font_not_found_p so that we can draw rectangles for the
22416 characters of the glyph string. */
22417 if (s
->font
== NULL
|| glyph_not_available_p
)
22419 s
->font_not_found_p
= 1;
22420 s
->font
= FRAME_FONT (s
->f
);
22423 /* Adjust base line for subscript/superscript text. */
22424 s
->ybase
+= voffset
;
22426 xassert (s
->face
&& s
->face
->gc
);
22427 return glyph
- s
->row
->glyphs
[s
->area
];
22431 /* Fill glyph string S from image glyph S->first_glyph. */
22434 fill_image_glyph_string (struct glyph_string
*s
)
22436 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22437 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22439 s
->slice
= s
->first_glyph
->slice
.img
;
22440 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22441 s
->font
= s
->face
->font
;
22442 s
->width
= s
->first_glyph
->pixel_width
;
22444 /* Adjust base line for subscript/superscript text. */
22445 s
->ybase
+= s
->first_glyph
->voffset
;
22449 /* Fill glyph string S from a sequence of stretch glyphs.
22451 START is the index of the first glyph to consider,
22452 END is the index of the last + 1.
22454 Value is the index of the first glyph not in S. */
22457 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22459 struct glyph
*glyph
, *last
;
22460 int voffset
, face_id
;
22462 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22464 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22465 last
= s
->row
->glyphs
[s
->area
] + end
;
22466 face_id
= glyph
->face_id
;
22467 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22468 s
->font
= s
->face
->font
;
22469 s
->width
= glyph
->pixel_width
;
22471 voffset
= glyph
->voffset
;
22475 && glyph
->type
== STRETCH_GLYPH
22476 && glyph
->voffset
== voffset
22477 && glyph
->face_id
== face_id
);
22479 s
->width
+= glyph
->pixel_width
;
22481 /* Adjust base line for subscript/superscript text. */
22482 s
->ybase
+= voffset
;
22484 /* The case that face->gc == 0 is handled when drawing the glyph
22485 string by calling PREPARE_FACE_FOR_DISPLAY. */
22487 return glyph
- s
->row
->glyphs
[s
->area
];
22490 static struct font_metrics
*
22491 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22493 static struct font_metrics metrics
;
22494 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22496 if (! font
|| code
== FONT_INVALID_CODE
)
22498 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22503 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22504 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22505 assumed to be zero. */
22508 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22510 *left
= *right
= 0;
22512 if (glyph
->type
== CHAR_GLYPH
)
22516 struct font_metrics
*pcm
;
22518 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22519 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22521 if (pcm
->rbearing
> pcm
->width
)
22522 *right
= pcm
->rbearing
- pcm
->width
;
22523 if (pcm
->lbearing
< 0)
22524 *left
= -pcm
->lbearing
;
22527 else if (glyph
->type
== COMPOSITE_GLYPH
)
22529 if (! glyph
->u
.cmp
.automatic
)
22531 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22533 if (cmp
->rbearing
> cmp
->pixel_width
)
22534 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22535 if (cmp
->lbearing
< 0)
22536 *left
= - cmp
->lbearing
;
22540 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22541 struct font_metrics metrics
;
22543 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22544 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22545 if (metrics
.rbearing
> metrics
.width
)
22546 *right
= metrics
.rbearing
- metrics
.width
;
22547 if (metrics
.lbearing
< 0)
22548 *left
= - metrics
.lbearing
;
22554 /* Return the index of the first glyph preceding glyph string S that
22555 is overwritten by S because of S's left overhang. Value is -1
22556 if no glyphs are overwritten. */
22559 left_overwritten (struct glyph_string
*s
)
22563 if (s
->left_overhang
)
22566 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22567 int first
= s
->first_glyph
- glyphs
;
22569 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22570 x
-= glyphs
[i
].pixel_width
;
22581 /* Return the index of the first glyph preceding glyph string S that
22582 is overwriting S because of its right overhang. Value is -1 if no
22583 glyph in front of S overwrites S. */
22586 left_overwriting (struct glyph_string
*s
)
22589 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22590 int first
= s
->first_glyph
- glyphs
;
22594 for (i
= first
- 1; i
>= 0; --i
)
22597 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22600 x
-= glyphs
[i
].pixel_width
;
22607 /* Return the index of the last glyph following glyph string S that is
22608 overwritten by S because of S's right overhang. Value is -1 if
22609 no such glyph is found. */
22612 right_overwritten (struct glyph_string
*s
)
22616 if (s
->right_overhang
)
22619 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22620 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22621 int end
= s
->row
->used
[s
->area
];
22623 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22624 x
+= glyphs
[i
].pixel_width
;
22633 /* Return the index of the last glyph following glyph string S that
22634 overwrites S because of its left overhang. Value is negative
22635 if no such glyph is found. */
22638 right_overwriting (struct glyph_string
*s
)
22641 int end
= s
->row
->used
[s
->area
];
22642 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22643 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22647 for (i
= first
; i
< end
; ++i
)
22650 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22653 x
+= glyphs
[i
].pixel_width
;
22660 /* Set background width of glyph string S. START is the index of the
22661 first glyph following S. LAST_X is the right-most x-position + 1
22662 in the drawing area. */
22665 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22667 /* If the face of this glyph string has to be drawn to the end of
22668 the drawing area, set S->extends_to_end_of_line_p. */
22670 if (start
== s
->row
->used
[s
->area
]
22671 && s
->area
== TEXT_AREA
22672 && ((s
->row
->fill_line_p
22673 && (s
->hl
== DRAW_NORMAL_TEXT
22674 || s
->hl
== DRAW_IMAGE_RAISED
22675 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22676 || s
->hl
== DRAW_MOUSE_FACE
))
22677 s
->extends_to_end_of_line_p
= 1;
22679 /* If S extends its face to the end of the line, set its
22680 background_width to the distance to the right edge of the drawing
22682 if (s
->extends_to_end_of_line_p
)
22683 s
->background_width
= last_x
- s
->x
+ 1;
22685 s
->background_width
= s
->width
;
22689 /* Compute overhangs and x-positions for glyph string S and its
22690 predecessors, or successors. X is the starting x-position for S.
22691 BACKWARD_P non-zero means process predecessors. */
22694 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22700 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22701 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22711 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22712 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22722 /* The following macros are only called from draw_glyphs below.
22723 They reference the following parameters of that function directly:
22724 `w', `row', `area', and `overlap_p'
22725 as well as the following local variables:
22726 `s', `f', and `hdc' (in W32) */
22729 /* On W32, silently add local `hdc' variable to argument list of
22730 init_glyph_string. */
22731 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22732 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22734 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22735 init_glyph_string (s, char2b, w, row, area, start, hl)
22738 /* Add a glyph string for a stretch glyph to the list of strings
22739 between HEAD and TAIL. START is the index of the stretch glyph in
22740 row area AREA of glyph row ROW. END is the index of the last glyph
22741 in that glyph row area. X is the current output position assigned
22742 to the new glyph string constructed. HL overrides that face of the
22743 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22744 is the right-most x-position of the drawing area. */
22746 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22747 and below -- keep them on one line. */
22748 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22751 s = (struct glyph_string *) alloca (sizeof *s); \
22752 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22753 START = fill_stretch_glyph_string (s, START, END); \
22754 append_glyph_string (&HEAD, &TAIL, s); \
22760 /* Add a glyph string for an image glyph to the list of strings
22761 between HEAD and TAIL. START is the index of the image glyph in
22762 row area AREA of glyph row ROW. END is the index of the last glyph
22763 in that glyph row area. X is the current output position assigned
22764 to the new glyph string constructed. HL overrides that face of the
22765 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22766 is the right-most x-position of the drawing area. */
22768 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22771 s = (struct glyph_string *) alloca (sizeof *s); \
22772 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22773 fill_image_glyph_string (s); \
22774 append_glyph_string (&HEAD, &TAIL, s); \
22781 /* Add a glyph string for a sequence of character glyphs to the list
22782 of strings between HEAD and TAIL. START is the index of the first
22783 glyph in row area AREA of glyph row ROW that is part of the new
22784 glyph string. END is the index of the last glyph in that glyph row
22785 area. X is the current output position assigned to the new glyph
22786 string constructed. HL overrides that face of the glyph; e.g. it
22787 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22788 right-most x-position of the drawing area. */
22790 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22796 face_id = (row)->glyphs[area][START].face_id; \
22798 s = (struct glyph_string *) alloca (sizeof *s); \
22799 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22800 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22801 append_glyph_string (&HEAD, &TAIL, s); \
22803 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22808 /* Add a glyph string for a composite sequence to the list of strings
22809 between HEAD and TAIL. START is the index of the first glyph in
22810 row area AREA of glyph row ROW that is part of the new glyph
22811 string. END is the index of the last glyph in that glyph row area.
22812 X is the current output position assigned to the new glyph string
22813 constructed. HL overrides that face of the glyph; e.g. it is
22814 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22815 x-position of the drawing area. */
22817 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22819 int face_id = (row)->glyphs[area][START].face_id; \
22820 struct face *base_face = FACE_FROM_ID (f, face_id); \
22821 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22822 struct composition *cmp = composition_table[cmp_id]; \
22824 struct glyph_string *first_s = NULL; \
22827 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22829 /* Make glyph_strings for each glyph sequence that is drawable by \
22830 the same face, and append them to HEAD/TAIL. */ \
22831 for (n = 0; n < cmp->glyph_len;) \
22833 s = (struct glyph_string *) alloca (sizeof *s); \
22834 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22835 append_glyph_string (&(HEAD), &(TAIL), s); \
22841 n = fill_composite_glyph_string (s, base_face, overlaps); \
22849 /* Add a glyph string for a glyph-string sequence to the list of strings
22850 between HEAD and TAIL. */
22852 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22856 Lisp_Object gstring; \
22858 face_id = (row)->glyphs[area][START].face_id; \
22859 gstring = (composition_gstring_from_id \
22860 ((row)->glyphs[area][START].u.cmp.id)); \
22861 s = (struct glyph_string *) alloca (sizeof *s); \
22862 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22863 * LGSTRING_GLYPH_LEN (gstring)); \
22864 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22865 append_glyph_string (&(HEAD), &(TAIL), s); \
22867 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22871 /* Add a glyph string for a sequence of glyphless character's glyphs
22872 to the list of strings between HEAD and TAIL. The meanings of
22873 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22875 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22880 face_id = (row)->glyphs[area][START].face_id; \
22882 s = (struct glyph_string *) alloca (sizeof *s); \
22883 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22884 append_glyph_string (&HEAD, &TAIL, s); \
22886 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22892 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22893 of AREA of glyph row ROW on window W between indices START and END.
22894 HL overrides the face for drawing glyph strings, e.g. it is
22895 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22896 x-positions of the drawing area.
22898 This is an ugly monster macro construct because we must use alloca
22899 to allocate glyph strings (because draw_glyphs can be called
22900 asynchronously). */
22902 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22905 HEAD = TAIL = NULL; \
22906 while (START < END) \
22908 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22909 switch (first_glyph->type) \
22912 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22916 case COMPOSITE_GLYPH: \
22917 if (first_glyph->u.cmp.automatic) \
22918 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22921 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22925 case STRETCH_GLYPH: \
22926 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22930 case IMAGE_GLYPH: \
22931 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22935 case GLYPHLESS_GLYPH: \
22936 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22946 set_glyph_string_background_width (s, START, LAST_X); \
22953 /* Draw glyphs between START and END in AREA of ROW on window W,
22954 starting at x-position X. X is relative to AREA in W. HL is a
22955 face-override with the following meaning:
22957 DRAW_NORMAL_TEXT draw normally
22958 DRAW_CURSOR draw in cursor face
22959 DRAW_MOUSE_FACE draw in mouse face.
22960 DRAW_INVERSE_VIDEO draw in mode line face
22961 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22962 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22964 If OVERLAPS is non-zero, draw only the foreground of characters and
22965 clip to the physical height of ROW. Non-zero value also defines
22966 the overlapping part to be drawn:
22968 OVERLAPS_PRED overlap with preceding rows
22969 OVERLAPS_SUCC overlap with succeeding rows
22970 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22971 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22973 Value is the x-position reached, relative to AREA of W. */
22976 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22977 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22978 enum draw_glyphs_face hl
, int overlaps
)
22980 struct glyph_string
*head
, *tail
;
22981 struct glyph_string
*s
;
22982 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22983 int i
, j
, x_reached
, last_x
, area_left
= 0;
22984 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22987 ALLOCATE_HDC (hdc
, f
);
22989 /* Let's rather be paranoid than getting a SEGV. */
22990 end
= min (end
, row
->used
[area
]);
22991 start
= max (0, start
);
22992 start
= min (end
, start
);
22994 /* Translate X to frame coordinates. Set last_x to the right
22995 end of the drawing area. */
22996 if (row
->full_width_p
)
22998 /* X is relative to the left edge of W, without scroll bars
23000 area_left
= WINDOW_LEFT_EDGE_X (w
);
23001 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
23005 area_left
= window_box_left (w
, area
);
23006 last_x
= area_left
+ window_box_width (w
, area
);
23010 /* Build a doubly-linked list of glyph_string structures between
23011 head and tail from what we have to draw. Note that the macro
23012 BUILD_GLYPH_STRINGS will modify its start parameter. That's
23013 the reason we use a separate variable `i'. */
23015 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
23017 x_reached
= tail
->x
+ tail
->background_width
;
23021 /* If there are any glyphs with lbearing < 0 or rbearing > width in
23022 the row, redraw some glyphs in front or following the glyph
23023 strings built above. */
23024 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
23026 struct glyph_string
*h
, *t
;
23027 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
23028 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
23029 int check_mouse_face
= 0;
23032 /* If mouse highlighting is on, we may need to draw adjacent
23033 glyphs using mouse-face highlighting. */
23034 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
23036 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
23038 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
23039 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
23041 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
23043 check_mouse_face
= 1;
23044 mouse_beg_col
= (row
== mouse_beg_row
)
23045 ? hlinfo
->mouse_face_beg_col
: 0;
23046 mouse_end_col
= (row
== mouse_end_row
)
23047 ? hlinfo
->mouse_face_end_col
23048 : row
->used
[TEXT_AREA
];
23052 /* Compute overhangs for all glyph strings. */
23053 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
23054 for (s
= head
; s
; s
= s
->next
)
23055 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
23057 /* Prepend glyph strings for glyphs in front of the first glyph
23058 string that are overwritten because of the first glyph
23059 string's left overhang. The background of all strings
23060 prepended must be drawn because the first glyph string
23062 i
= left_overwritten (head
);
23065 enum draw_glyphs_face overlap_hl
;
23067 /* If this row contains mouse highlighting, attempt to draw
23068 the overlapped glyphs with the correct highlight. This
23069 code fails if the overlap encompasses more than one glyph
23070 and mouse-highlight spans only some of these glyphs.
23071 However, making it work perfectly involves a lot more
23072 code, and I don't know if the pathological case occurs in
23073 practice, so we'll stick to this for now. --- cyd */
23074 if (check_mouse_face
23075 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23076 overlap_hl
= DRAW_MOUSE_FACE
;
23078 overlap_hl
= DRAW_NORMAL_TEXT
;
23081 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
23082 overlap_hl
, dummy_x
, last_x
);
23084 compute_overhangs_and_x (t
, head
->x
, 1);
23085 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23089 /* Prepend glyph strings for glyphs in front of the first glyph
23090 string that overwrite that glyph string because of their
23091 right overhang. For these strings, only the foreground must
23092 be drawn, because it draws over the glyph string at `head'.
23093 The background must not be drawn because this would overwrite
23094 right overhangs of preceding glyphs for which no glyph
23096 i
= left_overwriting (head
);
23099 enum draw_glyphs_face overlap_hl
;
23101 if (check_mouse_face
23102 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23103 overlap_hl
= DRAW_MOUSE_FACE
;
23105 overlap_hl
= DRAW_NORMAL_TEXT
;
23108 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23109 overlap_hl
, dummy_x
, last_x
);
23110 for (s
= h
; s
; s
= s
->next
)
23111 s
->background_filled_p
= 1;
23112 compute_overhangs_and_x (t
, head
->x
, 1);
23113 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23116 /* Append glyphs strings for glyphs following the last glyph
23117 string tail that are overwritten by tail. The background of
23118 these strings has to be drawn because tail's foreground draws
23120 i
= right_overwritten (tail
);
23123 enum draw_glyphs_face overlap_hl
;
23125 if (check_mouse_face
23126 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23127 overlap_hl
= DRAW_MOUSE_FACE
;
23129 overlap_hl
= DRAW_NORMAL_TEXT
;
23131 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23132 overlap_hl
, x
, last_x
);
23133 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23134 we don't have `end = i;' here. */
23135 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23136 append_glyph_string_lists (&head
, &tail
, h
, t
);
23140 /* Append glyph strings for glyphs following the last glyph
23141 string tail that overwrite tail. The foreground of such
23142 glyphs has to be drawn because it writes into the background
23143 of tail. The background must not be drawn because it could
23144 paint over the foreground of following glyphs. */
23145 i
= right_overwriting (tail
);
23148 enum draw_glyphs_face overlap_hl
;
23149 if (check_mouse_face
23150 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23151 overlap_hl
= DRAW_MOUSE_FACE
;
23153 overlap_hl
= DRAW_NORMAL_TEXT
;
23156 i
++; /* We must include the Ith glyph. */
23157 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23158 overlap_hl
, x
, last_x
);
23159 for (s
= h
; s
; s
= s
->next
)
23160 s
->background_filled_p
= 1;
23161 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23162 append_glyph_string_lists (&head
, &tail
, h
, t
);
23164 if (clip_head
|| clip_tail
)
23165 for (s
= head
; s
; s
= s
->next
)
23167 s
->clip_head
= clip_head
;
23168 s
->clip_tail
= clip_tail
;
23172 /* Draw all strings. */
23173 for (s
= head
; s
; s
= s
->next
)
23174 FRAME_RIF (f
)->draw_glyph_string (s
);
23177 /* When focus a sole frame and move horizontally, this sets on_p to 0
23178 causing a failure to erase prev cursor position. */
23179 if (area
== TEXT_AREA
23180 && !row
->full_width_p
23181 /* When drawing overlapping rows, only the glyph strings'
23182 foreground is drawn, which doesn't erase a cursor
23186 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23187 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23188 : (tail
? tail
->x
+ tail
->background_width
: x
));
23192 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23193 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23197 /* Value is the x-position up to which drawn, relative to AREA of W.
23198 This doesn't include parts drawn because of overhangs. */
23199 if (row
->full_width_p
)
23200 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23202 x_reached
-= area_left
;
23204 RELEASE_HDC (hdc
, f
);
23209 /* Expand row matrix if too narrow. Don't expand if area
23212 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23214 if (!fonts_changed_p \
23215 && (it->glyph_row->glyphs[area] \
23216 < it->glyph_row->glyphs[area + 1])) \
23218 it->w->ncols_scale_factor++; \
23219 fonts_changed_p = 1; \
23223 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23224 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23227 append_glyph (struct it
*it
)
23229 struct glyph
*glyph
;
23230 enum glyph_row_area area
= it
->area
;
23232 xassert (it
->glyph_row
);
23233 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23235 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23236 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23238 /* If the glyph row is reversed, we need to prepend the glyph
23239 rather than append it. */
23240 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23244 /* Make room for the additional glyph. */
23245 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23247 glyph
= it
->glyph_row
->glyphs
[area
];
23249 glyph
->charpos
= CHARPOS (it
->position
);
23250 glyph
->object
= it
->object
;
23251 if (it
->pixel_width
> 0)
23253 glyph
->pixel_width
= it
->pixel_width
;
23254 glyph
->padding_p
= 0;
23258 /* Assure at least 1-pixel width. Otherwise, cursor can't
23259 be displayed correctly. */
23260 glyph
->pixel_width
= 1;
23261 glyph
->padding_p
= 1;
23263 glyph
->ascent
= it
->ascent
;
23264 glyph
->descent
= it
->descent
;
23265 glyph
->voffset
= it
->voffset
;
23266 glyph
->type
= CHAR_GLYPH
;
23267 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23268 glyph
->multibyte_p
= it
->multibyte_p
;
23269 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23270 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23271 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23272 || it
->phys_descent
> it
->descent
);
23273 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23274 glyph
->face_id
= it
->face_id
;
23275 glyph
->u
.ch
= it
->char_to_display
;
23276 glyph
->slice
.img
= null_glyph_slice
;
23277 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23280 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23281 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23283 glyph
->bidi_type
= it
->bidi_it
.type
;
23287 glyph
->resolved_level
= 0;
23288 glyph
->bidi_type
= UNKNOWN_BT
;
23290 ++it
->glyph_row
->used
[area
];
23293 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23296 /* Store one glyph for the composition IT->cmp_it.id in
23297 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23301 append_composite_glyph (struct it
*it
)
23303 struct glyph
*glyph
;
23304 enum glyph_row_area area
= it
->area
;
23306 xassert (it
->glyph_row
);
23308 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23309 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23311 /* If the glyph row is reversed, we need to prepend the glyph
23312 rather than append it. */
23313 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23317 /* Make room for the new glyph. */
23318 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23320 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23322 glyph
->charpos
= it
->cmp_it
.charpos
;
23323 glyph
->object
= it
->object
;
23324 glyph
->pixel_width
= it
->pixel_width
;
23325 glyph
->ascent
= it
->ascent
;
23326 glyph
->descent
= it
->descent
;
23327 glyph
->voffset
= it
->voffset
;
23328 glyph
->type
= COMPOSITE_GLYPH
;
23329 if (it
->cmp_it
.ch
< 0)
23331 glyph
->u
.cmp
.automatic
= 0;
23332 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23333 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23337 glyph
->u
.cmp
.automatic
= 1;
23338 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23339 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23340 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23342 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23343 glyph
->multibyte_p
= it
->multibyte_p
;
23344 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23345 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23346 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23347 || it
->phys_descent
> it
->descent
);
23348 glyph
->padding_p
= 0;
23349 glyph
->glyph_not_available_p
= 0;
23350 glyph
->face_id
= it
->face_id
;
23351 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23354 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23355 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23357 glyph
->bidi_type
= it
->bidi_it
.type
;
23359 ++it
->glyph_row
->used
[area
];
23362 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23366 /* Change IT->ascent and IT->height according to the setting of
23370 take_vertical_position_into_account (struct it
*it
)
23374 if (it
->voffset
< 0)
23375 /* Increase the ascent so that we can display the text higher
23377 it
->ascent
-= it
->voffset
;
23379 /* Increase the descent so that we can display the text lower
23381 it
->descent
+= it
->voffset
;
23386 /* Produce glyphs/get display metrics for the image IT is loaded with.
23387 See the description of struct display_iterator in dispextern.h for
23388 an overview of struct display_iterator. */
23391 produce_image_glyph (struct it
*it
)
23395 int glyph_ascent
, crop
;
23396 struct glyph_slice slice
;
23398 xassert (it
->what
== IT_IMAGE
);
23400 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23402 /* Make sure X resources of the face is loaded. */
23403 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23405 if (it
->image_id
< 0)
23407 /* Fringe bitmap. */
23408 it
->ascent
= it
->phys_ascent
= 0;
23409 it
->descent
= it
->phys_descent
= 0;
23410 it
->pixel_width
= 0;
23415 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23417 /* Make sure X resources of the image is loaded. */
23418 prepare_image_for_display (it
->f
, img
);
23420 slice
.x
= slice
.y
= 0;
23421 slice
.width
= img
->width
;
23422 slice
.height
= img
->height
;
23424 if (INTEGERP (it
->slice
.x
))
23425 slice
.x
= XINT (it
->slice
.x
);
23426 else if (FLOATP (it
->slice
.x
))
23427 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23429 if (INTEGERP (it
->slice
.y
))
23430 slice
.y
= XINT (it
->slice
.y
);
23431 else if (FLOATP (it
->slice
.y
))
23432 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23434 if (INTEGERP (it
->slice
.width
))
23435 slice
.width
= XINT (it
->slice
.width
);
23436 else if (FLOATP (it
->slice
.width
))
23437 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23439 if (INTEGERP (it
->slice
.height
))
23440 slice
.height
= XINT (it
->slice
.height
);
23441 else if (FLOATP (it
->slice
.height
))
23442 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23444 if (slice
.x
>= img
->width
)
23445 slice
.x
= img
->width
;
23446 if (slice
.y
>= img
->height
)
23447 slice
.y
= img
->height
;
23448 if (slice
.x
+ slice
.width
>= img
->width
)
23449 slice
.width
= img
->width
- slice
.x
;
23450 if (slice
.y
+ slice
.height
> img
->height
)
23451 slice
.height
= img
->height
- slice
.y
;
23453 if (slice
.width
== 0 || slice
.height
== 0)
23456 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23458 it
->descent
= slice
.height
- glyph_ascent
;
23460 it
->descent
+= img
->vmargin
;
23461 if (slice
.y
+ slice
.height
== img
->height
)
23462 it
->descent
+= img
->vmargin
;
23463 it
->phys_descent
= it
->descent
;
23465 it
->pixel_width
= slice
.width
;
23467 it
->pixel_width
+= img
->hmargin
;
23468 if (slice
.x
+ slice
.width
== img
->width
)
23469 it
->pixel_width
+= img
->hmargin
;
23471 /* It's quite possible for images to have an ascent greater than
23472 their height, so don't get confused in that case. */
23473 if (it
->descent
< 0)
23478 if (face
->box
!= FACE_NO_BOX
)
23480 if (face
->box_line_width
> 0)
23483 it
->ascent
+= face
->box_line_width
;
23484 if (slice
.y
+ slice
.height
== img
->height
)
23485 it
->descent
+= face
->box_line_width
;
23488 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23489 it
->pixel_width
+= eabs (face
->box_line_width
);
23490 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23491 it
->pixel_width
+= eabs (face
->box_line_width
);
23494 take_vertical_position_into_account (it
);
23496 /* Automatically crop wide image glyphs at right edge so we can
23497 draw the cursor on same display row. */
23498 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23499 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23501 it
->pixel_width
-= crop
;
23502 slice
.width
-= crop
;
23507 struct glyph
*glyph
;
23508 enum glyph_row_area area
= it
->area
;
23510 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23511 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23513 glyph
->charpos
= CHARPOS (it
->position
);
23514 glyph
->object
= it
->object
;
23515 glyph
->pixel_width
= it
->pixel_width
;
23516 glyph
->ascent
= glyph_ascent
;
23517 glyph
->descent
= it
->descent
;
23518 glyph
->voffset
= it
->voffset
;
23519 glyph
->type
= IMAGE_GLYPH
;
23520 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23521 glyph
->multibyte_p
= it
->multibyte_p
;
23522 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23523 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23524 glyph
->overlaps_vertically_p
= 0;
23525 glyph
->padding_p
= 0;
23526 glyph
->glyph_not_available_p
= 0;
23527 glyph
->face_id
= it
->face_id
;
23528 glyph
->u
.img_id
= img
->id
;
23529 glyph
->slice
.img
= slice
;
23530 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23533 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23534 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23536 glyph
->bidi_type
= it
->bidi_it
.type
;
23538 ++it
->glyph_row
->used
[area
];
23541 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23546 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23547 of the glyph, WIDTH and HEIGHT are the width and height of the
23548 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23551 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23552 int width
, int height
, int ascent
)
23554 struct glyph
*glyph
;
23555 enum glyph_row_area area
= it
->area
;
23557 xassert (ascent
>= 0 && ascent
<= height
);
23559 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23560 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23562 /* If the glyph row is reversed, we need to prepend the glyph
23563 rather than append it. */
23564 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23568 /* Make room for the additional glyph. */
23569 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23571 glyph
= it
->glyph_row
->glyphs
[area
];
23573 glyph
->charpos
= CHARPOS (it
->position
);
23574 glyph
->object
= object
;
23575 glyph
->pixel_width
= width
;
23576 glyph
->ascent
= ascent
;
23577 glyph
->descent
= height
- ascent
;
23578 glyph
->voffset
= it
->voffset
;
23579 glyph
->type
= STRETCH_GLYPH
;
23580 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23581 glyph
->multibyte_p
= it
->multibyte_p
;
23582 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23583 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23584 glyph
->overlaps_vertically_p
= 0;
23585 glyph
->padding_p
= 0;
23586 glyph
->glyph_not_available_p
= 0;
23587 glyph
->face_id
= it
->face_id
;
23588 glyph
->u
.stretch
.ascent
= ascent
;
23589 glyph
->u
.stretch
.height
= height
;
23590 glyph
->slice
.img
= null_glyph_slice
;
23591 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23594 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23595 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23597 glyph
->bidi_type
= it
->bidi_it
.type
;
23601 glyph
->resolved_level
= 0;
23602 glyph
->bidi_type
= UNKNOWN_BT
;
23604 ++it
->glyph_row
->used
[area
];
23607 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23610 #endif /* HAVE_WINDOW_SYSTEM */
23612 /* Produce a stretch glyph for iterator IT. IT->object is the value
23613 of the glyph property displayed. The value must be a list
23614 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23617 1. `:width WIDTH' specifies that the space should be WIDTH *
23618 canonical char width wide. WIDTH may be an integer or floating
23621 2. `:relative-width FACTOR' specifies that the width of the stretch
23622 should be computed from the width of the first character having the
23623 `glyph' property, and should be FACTOR times that width.
23625 3. `:align-to HPOS' specifies that the space should be wide enough
23626 to reach HPOS, a value in canonical character units.
23628 Exactly one of the above pairs must be present.
23630 4. `:height HEIGHT' specifies that the height of the stretch produced
23631 should be HEIGHT, measured in canonical character units.
23633 5. `:relative-height FACTOR' specifies that the height of the
23634 stretch should be FACTOR times the height of the characters having
23635 the glyph property.
23637 Either none or exactly one of 4 or 5 must be present.
23639 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23640 of the stretch should be used for the ascent of the stretch.
23641 ASCENT must be in the range 0 <= ASCENT <= 100. */
23644 produce_stretch_glyph (struct it
*it
)
23646 /* (space :width WIDTH :height HEIGHT ...) */
23647 Lisp_Object prop
, plist
;
23648 int width
= 0, height
= 0, align_to
= -1;
23649 int zero_width_ok_p
= 0;
23652 struct face
*face
= NULL
;
23653 struct font
*font
= NULL
;
23655 #ifdef HAVE_WINDOW_SYSTEM
23656 int zero_height_ok_p
= 0;
23658 if (FRAME_WINDOW_P (it
->f
))
23660 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23661 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23662 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23666 /* List should start with `space'. */
23667 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23668 plist
= XCDR (it
->object
);
23670 /* Compute the width of the stretch. */
23671 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23672 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23674 /* Absolute width `:width WIDTH' specified and valid. */
23675 zero_width_ok_p
= 1;
23678 #ifdef HAVE_WINDOW_SYSTEM
23679 else if (FRAME_WINDOW_P (it
->f
)
23680 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23682 /* Relative width `:relative-width FACTOR' specified and valid.
23683 Compute the width of the characters having the `glyph'
23686 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23689 if (it
->multibyte_p
)
23690 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23693 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23694 if (! ASCII_CHAR_P (it2
.c
))
23695 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23698 it2
.glyph_row
= NULL
;
23699 it2
.what
= IT_CHARACTER
;
23700 x_produce_glyphs (&it2
);
23701 width
= NUMVAL (prop
) * it2
.pixel_width
;
23703 #endif /* HAVE_WINDOW_SYSTEM */
23704 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23705 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23707 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23708 align_to
= (align_to
< 0
23710 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23711 else if (align_to
< 0)
23712 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23713 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23714 zero_width_ok_p
= 1;
23717 /* Nothing specified -> width defaults to canonical char width. */
23718 width
= FRAME_COLUMN_WIDTH (it
->f
);
23720 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23723 #ifdef HAVE_WINDOW_SYSTEM
23724 /* Compute height. */
23725 if (FRAME_WINDOW_P (it
->f
))
23727 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23728 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23731 zero_height_ok_p
= 1;
23733 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23735 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23737 height
= FONT_HEIGHT (font
);
23739 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23742 /* Compute percentage of height used for ascent. If
23743 `:ascent ASCENT' is present and valid, use that. Otherwise,
23744 derive the ascent from the font in use. */
23745 if (prop
= Fplist_get (plist
, QCascent
),
23746 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23747 ascent
= height
* NUMVAL (prop
) / 100.0;
23748 else if (!NILP (prop
)
23749 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23750 ascent
= min (max (0, (int)tem
), height
);
23752 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23755 #endif /* HAVE_WINDOW_SYSTEM */
23758 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23759 && it
->current_x
+ width
> it
->last_visible_x
)
23761 width
= it
->last_visible_x
- it
->current_x
;
23762 #ifdef HAVE_WINDOW_SYSTEM
23763 /* Subtract one more pixel from the stretch width, but only on
23764 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23765 width
-= FRAME_WINDOW_P (it
->f
);
23769 if (width
> 0 && height
> 0 && it
->glyph_row
)
23771 Lisp_Object o_object
= it
->object
;
23772 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23775 if (!STRINGP (object
))
23776 object
= it
->w
->buffer
;
23777 #ifdef HAVE_WINDOW_SYSTEM
23778 if (FRAME_WINDOW_P (it
->f
))
23779 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23783 it
->object
= object
;
23784 it
->char_to_display
= ' ';
23785 it
->pixel_width
= it
->len
= 1;
23787 tty_append_glyph (it
);
23788 it
->object
= o_object
;
23792 it
->pixel_width
= width
;
23793 #ifdef HAVE_WINDOW_SYSTEM
23794 if (FRAME_WINDOW_P (it
->f
))
23796 it
->ascent
= it
->phys_ascent
= ascent
;
23797 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23798 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23799 take_vertical_position_into_account (it
);
23803 it
->nglyphs
= width
;
23806 #ifdef HAVE_WINDOW_SYSTEM
23808 /* Calculate line-height and line-spacing properties.
23809 An integer value specifies explicit pixel value.
23810 A float value specifies relative value to current face height.
23811 A cons (float . face-name) specifies relative value to
23812 height of specified face font.
23814 Returns height in pixels, or nil. */
23818 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23819 int boff
, int override
)
23821 Lisp_Object face_name
= Qnil
;
23822 int ascent
, descent
, height
;
23824 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23829 face_name
= XCAR (val
);
23831 if (!NUMBERP (val
))
23832 val
= make_number (1);
23833 if (NILP (face_name
))
23835 height
= it
->ascent
+ it
->descent
;
23840 if (NILP (face_name
))
23842 font
= FRAME_FONT (it
->f
);
23843 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23845 else if (EQ (face_name
, Qt
))
23854 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23856 return make_number (-1);
23858 face
= FACE_FROM_ID (it
->f
, face_id
);
23861 return make_number (-1);
23862 boff
= font
->baseline_offset
;
23863 if (font
->vertical_centering
)
23864 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23867 ascent
= FONT_BASE (font
) + boff
;
23868 descent
= FONT_DESCENT (font
) - boff
;
23872 it
->override_ascent
= ascent
;
23873 it
->override_descent
= descent
;
23874 it
->override_boff
= boff
;
23877 height
= ascent
+ descent
;
23881 height
= (int)(XFLOAT_DATA (val
) * height
);
23882 else if (INTEGERP (val
))
23883 height
*= XINT (val
);
23885 return make_number (height
);
23889 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23890 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23891 and only if this is for a character for which no font was found.
23893 If the display method (it->glyphless_method) is
23894 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23895 length of the acronym or the hexadecimal string, UPPER_XOFF and
23896 UPPER_YOFF are pixel offsets for the upper part of the string,
23897 LOWER_XOFF and LOWER_YOFF are for the lower part.
23899 For the other display methods, LEN through LOWER_YOFF are zero. */
23902 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23903 short upper_xoff
, short upper_yoff
,
23904 short lower_xoff
, short lower_yoff
)
23906 struct glyph
*glyph
;
23907 enum glyph_row_area area
= it
->area
;
23909 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23910 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23912 /* If the glyph row is reversed, we need to prepend the glyph
23913 rather than append it. */
23914 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23918 /* Make room for the additional glyph. */
23919 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23921 glyph
= it
->glyph_row
->glyphs
[area
];
23923 glyph
->charpos
= CHARPOS (it
->position
);
23924 glyph
->object
= it
->object
;
23925 glyph
->pixel_width
= it
->pixel_width
;
23926 glyph
->ascent
= it
->ascent
;
23927 glyph
->descent
= it
->descent
;
23928 glyph
->voffset
= it
->voffset
;
23929 glyph
->type
= GLYPHLESS_GLYPH
;
23930 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23931 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23932 glyph
->u
.glyphless
.len
= len
;
23933 glyph
->u
.glyphless
.ch
= it
->c
;
23934 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23935 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23936 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23937 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23938 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23939 glyph
->multibyte_p
= it
->multibyte_p
;
23940 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23941 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23942 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23943 || it
->phys_descent
> it
->descent
);
23944 glyph
->padding_p
= 0;
23945 glyph
->glyph_not_available_p
= 0;
23946 glyph
->face_id
= face_id
;
23947 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23950 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23951 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23953 glyph
->bidi_type
= it
->bidi_it
.type
;
23955 ++it
->glyph_row
->used
[area
];
23958 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23962 /* Produce a glyph for a glyphless character for iterator IT.
23963 IT->glyphless_method specifies which method to use for displaying
23964 the character. See the description of enum
23965 glyphless_display_method in dispextern.h for the detail.
23967 FOR_NO_FONT is nonzero if and only if this is for a character for
23968 which no font was found. ACRONYM, if non-nil, is an acronym string
23969 for the character. */
23972 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23977 int base_width
, base_height
, width
, height
;
23978 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23981 /* Get the metrics of the base font. We always refer to the current
23983 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23984 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23985 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23986 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23987 base_height
= it
->ascent
+ it
->descent
;
23988 base_width
= font
->average_width
;
23990 /* Get a face ID for the glyph by utilizing a cache (the same way as
23991 done for `escape-glyph' in get_next_display_element). */
23992 if (it
->f
== last_glyphless_glyph_frame
23993 && it
->face_id
== last_glyphless_glyph_face_id
)
23995 face_id
= last_glyphless_glyph_merged_face_id
;
23999 /* Merge the `glyphless-char' face into the current face. */
24000 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
24001 last_glyphless_glyph_frame
= it
->f
;
24002 last_glyphless_glyph_face_id
= it
->face_id
;
24003 last_glyphless_glyph_merged_face_id
= face_id
;
24006 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
24008 it
->pixel_width
= THIN_SPACE_WIDTH
;
24010 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24012 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
24014 width
= CHAR_WIDTH (it
->c
);
24017 else if (width
> 4)
24019 it
->pixel_width
= base_width
* width
;
24021 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
24027 unsigned int code
[6];
24029 int ascent
, descent
;
24030 struct font_metrics metrics_upper
, metrics_lower
;
24032 face
= FACE_FROM_ID (it
->f
, face_id
);
24033 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
24034 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
24036 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
24038 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
24039 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
24040 if (CONSP (acronym
))
24041 acronym
= XCAR (acronym
);
24042 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
24046 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
24047 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
24050 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]) && len
< 6; len
++)
24051 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
24052 upper_len
= (len
+ 1) / 2;
24053 font
->driver
->text_extents (font
, code
, upper_len
,
24055 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
24060 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
24061 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
24062 upper_xoff
= upper_yoff
= 2; /* the typical case */
24063 if (base_width
>= width
)
24065 /* Align the upper to the left, the lower to the right. */
24066 it
->pixel_width
= base_width
;
24067 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
24071 /* Center the shorter one. */
24072 it
->pixel_width
= width
;
24073 if (metrics_upper
.width
>= metrics_lower
.width
)
24074 lower_xoff
= (width
- metrics_lower
.width
) / 2;
24077 /* FIXME: This code doesn't look right. It formerly was
24078 missing the "lower_xoff = 0;", which couldn't have
24079 been right since it left lower_xoff uninitialized. */
24081 upper_xoff
= (width
- metrics_upper
.width
) / 2;
24085 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
24086 top, bottom, and between upper and lower strings. */
24087 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
24088 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
24089 /* Center vertically.
24090 H:base_height, D:base_descent
24091 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
24093 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
24094 descent = D - H/2 + h/2;
24095 lower_yoff = descent - 2 - ld;
24096 upper_yoff = lower_yoff - la - 1 - ud; */
24097 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
24098 descent
= it
->descent
- (base_height
- height
) / 2;
24099 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
24100 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
24101 - metrics_upper
.descent
);
24102 /* Don't make the height shorter than the base height. */
24103 if (height
> base_height
)
24105 it
->ascent
= ascent
;
24106 it
->descent
= descent
;
24110 it
->phys_ascent
= it
->ascent
;
24111 it
->phys_descent
= it
->descent
;
24113 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24114 upper_xoff
, upper_yoff
,
24115 lower_xoff
, lower_yoff
);
24117 take_vertical_position_into_account (it
);
24122 Produce glyphs/get display metrics for the display element IT is
24123 loaded with. See the description of struct it in dispextern.h
24124 for an overview of struct it. */
24127 x_produce_glyphs (struct it
*it
)
24129 int extra_line_spacing
= it
->extra_line_spacing
;
24131 it
->glyph_not_available_p
= 0;
24133 if (it
->what
== IT_CHARACTER
)
24136 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24137 struct font
*font
= face
->font
;
24138 struct font_metrics
*pcm
= NULL
;
24139 int boff
; /* baseline offset */
24143 /* When no suitable font is found, display this character by
24144 the method specified in the first extra slot of
24145 Vglyphless_char_display. */
24146 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24148 xassert (it
->what
== IT_GLYPHLESS
);
24149 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24153 boff
= font
->baseline_offset
;
24154 if (font
->vertical_centering
)
24155 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24157 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24163 if (it
->override_ascent
>= 0)
24165 it
->ascent
= it
->override_ascent
;
24166 it
->descent
= it
->override_descent
;
24167 boff
= it
->override_boff
;
24171 it
->ascent
= FONT_BASE (font
) + boff
;
24172 it
->descent
= FONT_DESCENT (font
) - boff
;
24175 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24177 pcm
= get_per_char_metric (font
, &char2b
);
24178 if (pcm
->width
== 0
24179 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24185 it
->phys_ascent
= pcm
->ascent
+ boff
;
24186 it
->phys_descent
= pcm
->descent
- boff
;
24187 it
->pixel_width
= pcm
->width
;
24191 it
->glyph_not_available_p
= 1;
24192 it
->phys_ascent
= it
->ascent
;
24193 it
->phys_descent
= it
->descent
;
24194 it
->pixel_width
= font
->space_width
;
24197 if (it
->constrain_row_ascent_descent_p
)
24199 if (it
->descent
> it
->max_descent
)
24201 it
->ascent
+= it
->descent
- it
->max_descent
;
24202 it
->descent
= it
->max_descent
;
24204 if (it
->ascent
> it
->max_ascent
)
24206 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24207 it
->ascent
= it
->max_ascent
;
24209 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24210 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24211 extra_line_spacing
= 0;
24214 /* If this is a space inside a region of text with
24215 `space-width' property, change its width. */
24216 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24218 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24220 /* If face has a box, add the box thickness to the character
24221 height. If character has a box line to the left and/or
24222 right, add the box line width to the character's width. */
24223 if (face
->box
!= FACE_NO_BOX
)
24225 int thick
= face
->box_line_width
;
24229 it
->ascent
+= thick
;
24230 it
->descent
+= thick
;
24235 if (it
->start_of_box_run_p
)
24236 it
->pixel_width
+= thick
;
24237 if (it
->end_of_box_run_p
)
24238 it
->pixel_width
+= thick
;
24241 /* If face has an overline, add the height of the overline
24242 (1 pixel) and a 1 pixel margin to the character height. */
24243 if (face
->overline_p
)
24244 it
->ascent
+= overline_margin
;
24246 if (it
->constrain_row_ascent_descent_p
)
24248 if (it
->ascent
> it
->max_ascent
)
24249 it
->ascent
= it
->max_ascent
;
24250 if (it
->descent
> it
->max_descent
)
24251 it
->descent
= it
->max_descent
;
24254 take_vertical_position_into_account (it
);
24256 /* If we have to actually produce glyphs, do it. */
24261 /* Translate a space with a `space-width' property
24262 into a stretch glyph. */
24263 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24264 / FONT_HEIGHT (font
));
24265 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24266 it
->ascent
+ it
->descent
, ascent
);
24271 /* If characters with lbearing or rbearing are displayed
24272 in this line, record that fact in a flag of the
24273 glyph row. This is used to optimize X output code. */
24274 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24275 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24277 if (! stretched_p
&& it
->pixel_width
== 0)
24278 /* We assure that all visible glyphs have at least 1-pixel
24280 it
->pixel_width
= 1;
24282 else if (it
->char_to_display
== '\n')
24284 /* A newline has no width, but we need the height of the
24285 line. But if previous part of the line sets a height,
24286 don't increase that height */
24288 Lisp_Object height
;
24289 Lisp_Object total_height
= Qnil
;
24291 it
->override_ascent
= -1;
24292 it
->pixel_width
= 0;
24295 height
= get_it_property (it
, Qline_height
);
24296 /* Split (line-height total-height) list */
24298 && CONSP (XCDR (height
))
24299 && NILP (XCDR (XCDR (height
))))
24301 total_height
= XCAR (XCDR (height
));
24302 height
= XCAR (height
);
24304 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24306 if (it
->override_ascent
>= 0)
24308 it
->ascent
= it
->override_ascent
;
24309 it
->descent
= it
->override_descent
;
24310 boff
= it
->override_boff
;
24314 it
->ascent
= FONT_BASE (font
) + boff
;
24315 it
->descent
= FONT_DESCENT (font
) - boff
;
24318 if (EQ (height
, Qt
))
24320 if (it
->descent
> it
->max_descent
)
24322 it
->ascent
+= it
->descent
- it
->max_descent
;
24323 it
->descent
= it
->max_descent
;
24325 if (it
->ascent
> it
->max_ascent
)
24327 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24328 it
->ascent
= it
->max_ascent
;
24330 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24331 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24332 it
->constrain_row_ascent_descent_p
= 1;
24333 extra_line_spacing
= 0;
24337 Lisp_Object spacing
;
24339 it
->phys_ascent
= it
->ascent
;
24340 it
->phys_descent
= it
->descent
;
24342 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24343 && face
->box
!= FACE_NO_BOX
24344 && face
->box_line_width
> 0)
24346 it
->ascent
+= face
->box_line_width
;
24347 it
->descent
+= face
->box_line_width
;
24350 && XINT (height
) > it
->ascent
+ it
->descent
)
24351 it
->ascent
= XINT (height
) - it
->descent
;
24353 if (!NILP (total_height
))
24354 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24357 spacing
= get_it_property (it
, Qline_spacing
);
24358 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24360 if (INTEGERP (spacing
))
24362 extra_line_spacing
= XINT (spacing
);
24363 if (!NILP (total_height
))
24364 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24368 else /* i.e. (it->char_to_display == '\t') */
24370 if (font
->space_width
> 0)
24372 int tab_width
= it
->tab_width
* font
->space_width
;
24373 int x
= it
->current_x
+ it
->continuation_lines_width
;
24374 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24376 /* If the distance from the current position to the next tab
24377 stop is less than a space character width, use the
24378 tab stop after that. */
24379 if (next_tab_x
- x
< font
->space_width
)
24380 next_tab_x
+= tab_width
;
24382 it
->pixel_width
= next_tab_x
- x
;
24384 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24385 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24389 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24390 it
->ascent
+ it
->descent
, it
->ascent
);
24395 it
->pixel_width
= 0;
24400 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24402 /* A static composition.
24404 Note: A composition is represented as one glyph in the
24405 glyph matrix. There are no padding glyphs.
24407 Important note: pixel_width, ascent, and descent are the
24408 values of what is drawn by draw_glyphs (i.e. the values of
24409 the overall glyphs composed). */
24410 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24411 int boff
; /* baseline offset */
24412 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24413 int glyph_len
= cmp
->glyph_len
;
24414 struct font
*font
= face
->font
;
24418 /* If we have not yet calculated pixel size data of glyphs of
24419 the composition for the current face font, calculate them
24420 now. Theoretically, we have to check all fonts for the
24421 glyphs, but that requires much time and memory space. So,
24422 here we check only the font of the first glyph. This may
24423 lead to incorrect display, but it's very rare, and C-l
24424 (recenter-top-bottom) can correct the display anyway. */
24425 if (! cmp
->font
|| cmp
->font
!= font
)
24427 /* Ascent and descent of the font of the first character
24428 of this composition (adjusted by baseline offset).
24429 Ascent and descent of overall glyphs should not be less
24430 than these, respectively. */
24431 int font_ascent
, font_descent
, font_height
;
24432 /* Bounding box of the overall glyphs. */
24433 int leftmost
, rightmost
, lowest
, highest
;
24434 int lbearing
, rbearing
;
24435 int i
, width
, ascent
, descent
;
24436 int left_padded
= 0, right_padded
= 0;
24437 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24439 struct font_metrics
*pcm
;
24440 int font_not_found_p
;
24443 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24444 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24446 if (glyph_len
< cmp
->glyph_len
)
24448 for (i
= 0; i
< glyph_len
; i
++)
24450 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24452 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24457 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24458 : IT_CHARPOS (*it
));
24459 /* If no suitable font is found, use the default font. */
24460 font_not_found_p
= font
== NULL
;
24461 if (font_not_found_p
)
24463 face
= face
->ascii_face
;
24466 boff
= font
->baseline_offset
;
24467 if (font
->vertical_centering
)
24468 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24469 font_ascent
= FONT_BASE (font
) + boff
;
24470 font_descent
= FONT_DESCENT (font
) - boff
;
24471 font_height
= FONT_HEIGHT (font
);
24473 cmp
->font
= (void *) font
;
24476 if (! font_not_found_p
)
24478 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24480 pcm
= get_per_char_metric (font
, &char2b
);
24483 /* Initialize the bounding box. */
24486 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
24487 ascent
= pcm
->ascent
;
24488 descent
= pcm
->descent
;
24489 lbearing
= pcm
->lbearing
;
24490 rbearing
= pcm
->rbearing
;
24494 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
24495 ascent
= FONT_BASE (font
);
24496 descent
= FONT_DESCENT (font
);
24503 lowest
= - descent
+ boff
;
24504 highest
= ascent
+ boff
;
24506 if (! font_not_found_p
24507 && font
->default_ascent
24508 && CHAR_TABLE_P (Vuse_default_ascent
)
24509 && !NILP (Faref (Vuse_default_ascent
,
24510 make_number (it
->char_to_display
))))
24511 highest
= font
->default_ascent
+ boff
;
24513 /* Draw the first glyph at the normal position. It may be
24514 shifted to right later if some other glyphs are drawn
24516 cmp
->offsets
[i
* 2] = 0;
24517 cmp
->offsets
[i
* 2 + 1] = boff
;
24518 cmp
->lbearing
= lbearing
;
24519 cmp
->rbearing
= rbearing
;
24521 /* Set cmp->offsets for the remaining glyphs. */
24522 for (i
++; i
< glyph_len
; i
++)
24524 int left
, right
, btm
, top
;
24525 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24527 struct face
*this_face
;
24531 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24532 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24533 font
= this_face
->font
;
24539 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24541 pcm
= get_per_char_metric (font
, &char2b
);
24544 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24547 width
= pcm
->width
;
24548 ascent
= pcm
->ascent
;
24549 descent
= pcm
->descent
;
24550 lbearing
= pcm
->lbearing
;
24551 rbearing
= pcm
->rbearing
;
24552 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24554 /* Relative composition with or without
24555 alternate chars. */
24556 left
= (leftmost
+ rightmost
- width
) / 2;
24557 btm
= - descent
+ boff
;
24558 if (font
->relative_compose
24559 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24560 || NILP (Faref (Vignore_relative_composition
,
24561 make_number (ch
)))))
24564 if (- descent
>= font
->relative_compose
)
24565 /* One extra pixel between two glyphs. */
24567 else if (ascent
<= 0)
24568 /* One extra pixel between two glyphs. */
24569 btm
= lowest
- 1 - ascent
- descent
;
24574 /* A composition rule is specified by an integer
24575 value that encodes global and new reference
24576 points (GREF and NREF). GREF and NREF are
24577 specified by numbers as below:
24579 0---1---2 -- ascent
24583 9--10--11 -- center
24585 ---3---4---5--- baseline
24587 6---7---8 -- descent
24589 int rule
= COMPOSITION_RULE (cmp
, i
);
24590 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24592 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24593 grefx
= gref
% 3, nrefx
= nref
% 3;
24594 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24596 xoff
= font_height
* (xoff
- 128) / 256;
24598 yoff
= font_height
* (yoff
- 128) / 256;
24601 + grefx
* (rightmost
- leftmost
) / 2
24602 - nrefx
* width
/ 2
24605 btm
= ((grefy
== 0 ? highest
24607 : grefy
== 2 ? lowest
24608 : (highest
+ lowest
) / 2)
24609 - (nrefy
== 0 ? ascent
+ descent
24610 : nrefy
== 1 ? descent
- boff
24612 : (ascent
+ descent
) / 2)
24616 cmp
->offsets
[i
* 2] = left
;
24617 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24619 /* Update the bounding box of the overall glyphs. */
24622 right
= left
+ width
;
24623 if (left
< leftmost
)
24625 if (right
> rightmost
)
24628 top
= btm
+ descent
+ ascent
;
24634 if (cmp
->lbearing
> left
+ lbearing
)
24635 cmp
->lbearing
= left
+ lbearing
;
24636 if (cmp
->rbearing
< left
+ rbearing
)
24637 cmp
->rbearing
= left
+ rbearing
;
24641 /* If there are glyphs whose x-offsets are negative,
24642 shift all glyphs to the right and make all x-offsets
24646 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24647 cmp
->offsets
[i
* 2] -= leftmost
;
24648 rightmost
-= leftmost
;
24649 cmp
->lbearing
-= leftmost
;
24650 cmp
->rbearing
-= leftmost
;
24653 if (left_padded
&& cmp
->lbearing
< 0)
24655 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24656 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24657 rightmost
-= cmp
->lbearing
;
24658 cmp
->rbearing
-= cmp
->lbearing
;
24661 if (right_padded
&& rightmost
< cmp
->rbearing
)
24663 rightmost
= cmp
->rbearing
;
24666 cmp
->pixel_width
= rightmost
;
24667 cmp
->ascent
= highest
;
24668 cmp
->descent
= - lowest
;
24669 if (cmp
->ascent
< font_ascent
)
24670 cmp
->ascent
= font_ascent
;
24671 if (cmp
->descent
< font_descent
)
24672 cmp
->descent
= font_descent
;
24676 && (cmp
->lbearing
< 0
24677 || cmp
->rbearing
> cmp
->pixel_width
))
24678 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24680 it
->pixel_width
= cmp
->pixel_width
;
24681 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24682 it
->descent
= it
->phys_descent
= cmp
->descent
;
24683 if (face
->box
!= FACE_NO_BOX
)
24685 int thick
= face
->box_line_width
;
24689 it
->ascent
+= thick
;
24690 it
->descent
+= thick
;
24695 if (it
->start_of_box_run_p
)
24696 it
->pixel_width
+= thick
;
24697 if (it
->end_of_box_run_p
)
24698 it
->pixel_width
+= thick
;
24701 /* If face has an overline, add the height of the overline
24702 (1 pixel) and a 1 pixel margin to the character height. */
24703 if (face
->overline_p
)
24704 it
->ascent
+= overline_margin
;
24706 take_vertical_position_into_account (it
);
24707 if (it
->ascent
< 0)
24709 if (it
->descent
< 0)
24712 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
24713 append_composite_glyph (it
);
24715 else if (it
->what
== IT_COMPOSITION
)
24717 /* A dynamic (automatic) composition. */
24718 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24719 Lisp_Object gstring
;
24720 struct font_metrics metrics
;
24724 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24726 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24729 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24730 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24731 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24732 it
->descent
= it
->phys_descent
= metrics
.descent
;
24733 if (face
->box
!= FACE_NO_BOX
)
24735 int thick
= face
->box_line_width
;
24739 it
->ascent
+= thick
;
24740 it
->descent
+= thick
;
24745 if (it
->start_of_box_run_p
)
24746 it
->pixel_width
+= thick
;
24747 if (it
->end_of_box_run_p
)
24748 it
->pixel_width
+= thick
;
24750 /* If face has an overline, add the height of the overline
24751 (1 pixel) and a 1 pixel margin to the character height. */
24752 if (face
->overline_p
)
24753 it
->ascent
+= overline_margin
;
24754 take_vertical_position_into_account (it
);
24755 if (it
->ascent
< 0)
24757 if (it
->descent
< 0)
24761 append_composite_glyph (it
);
24763 else if (it
->what
== IT_GLYPHLESS
)
24764 produce_glyphless_glyph (it
, 0, Qnil
);
24765 else if (it
->what
== IT_IMAGE
)
24766 produce_image_glyph (it
);
24767 else if (it
->what
== IT_STRETCH
)
24768 produce_stretch_glyph (it
);
24771 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24772 because this isn't true for images with `:ascent 100'. */
24773 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24774 if (it
->area
== TEXT_AREA
)
24775 it
->current_x
+= it
->pixel_width
;
24777 if (extra_line_spacing
> 0)
24779 it
->descent
+= extra_line_spacing
;
24780 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24781 it
->max_extra_line_spacing
= extra_line_spacing
;
24784 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24785 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24786 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24787 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24791 Output LEN glyphs starting at START at the nominal cursor position.
24792 Advance the nominal cursor over the text. The global variable
24793 updated_window contains the window being updated, updated_row is
24794 the glyph row being updated, and updated_area is the area of that
24795 row being updated. */
24798 x_write_glyphs (struct glyph
*start
, int len
)
24800 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
24802 xassert (updated_window
&& updated_row
);
24803 /* When the window is hscrolled, cursor hpos can legitimately be out
24804 of bounds, but we draw the cursor at the corresponding window
24805 margin in that case. */
24806 if (!updated_row
->reversed_p
&& chpos
< 0)
24808 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
24809 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
24813 /* Write glyphs. */
24815 hpos
= start
- updated_row
->glyphs
[updated_area
];
24816 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24817 updated_row
, updated_area
,
24819 DRAW_NORMAL_TEXT
, 0);
24821 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24822 if (updated_area
== TEXT_AREA
24823 && updated_window
->phys_cursor_on_p
24824 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24826 && chpos
< hpos
+ len
)
24827 updated_window
->phys_cursor_on_p
= 0;
24831 /* Advance the output cursor. */
24832 output_cursor
.hpos
+= len
;
24833 output_cursor
.x
= x
;
24838 Insert LEN glyphs from START at the nominal cursor position. */
24841 x_insert_glyphs (struct glyph
*start
, int len
)
24845 int line_height
, shift_by_width
, shifted_region_width
;
24846 struct glyph_row
*row
;
24847 struct glyph
*glyph
;
24848 int frame_x
, frame_y
;
24851 xassert (updated_window
&& updated_row
);
24853 w
= updated_window
;
24854 f
= XFRAME (WINDOW_FRAME (w
));
24856 /* Get the height of the line we are in. */
24858 line_height
= row
->height
;
24860 /* Get the width of the glyphs to insert. */
24861 shift_by_width
= 0;
24862 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24863 shift_by_width
+= glyph
->pixel_width
;
24865 /* Get the width of the region to shift right. */
24866 shifted_region_width
= (window_box_width (w
, updated_area
)
24871 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24872 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24874 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24875 line_height
, shift_by_width
);
24877 /* Write the glyphs. */
24878 hpos
= start
- row
->glyphs
[updated_area
];
24879 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24881 DRAW_NORMAL_TEXT
, 0);
24883 /* Advance the output cursor. */
24884 output_cursor
.hpos
+= len
;
24885 output_cursor
.x
+= shift_by_width
;
24891 Erase the current text line from the nominal cursor position
24892 (inclusive) to pixel column TO_X (exclusive). The idea is that
24893 everything from TO_X onward is already erased.
24895 TO_X is a pixel position relative to updated_area of
24896 updated_window. TO_X == -1 means clear to the end of this area. */
24899 x_clear_end_of_line (int to_x
)
24902 struct window
*w
= updated_window
;
24903 int max_x
, min_y
, max_y
;
24904 int from_x
, from_y
, to_y
;
24906 xassert (updated_window
&& updated_row
);
24907 f
= XFRAME (w
->frame
);
24909 if (updated_row
->full_width_p
)
24910 max_x
= WINDOW_TOTAL_WIDTH (w
);
24912 max_x
= window_box_width (w
, updated_area
);
24913 max_y
= window_text_bottom_y (w
);
24915 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24916 of window. For TO_X > 0, truncate to end of drawing area. */
24922 to_x
= min (to_x
, max_x
);
24924 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24926 /* Notice if the cursor will be cleared by this operation. */
24927 if (!updated_row
->full_width_p
)
24928 notice_overwritten_cursor (w
, updated_area
,
24929 output_cursor
.x
, -1,
24931 MATRIX_ROW_BOTTOM_Y (updated_row
));
24933 from_x
= output_cursor
.x
;
24935 /* Translate to frame coordinates. */
24936 if (updated_row
->full_width_p
)
24938 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24939 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24943 int area_left
= window_box_left (w
, updated_area
);
24944 from_x
+= area_left
;
24948 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24949 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24950 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24952 /* Prevent inadvertently clearing to end of the X window. */
24953 if (to_x
> from_x
&& to_y
> from_y
)
24956 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24957 to_x
- from_x
, to_y
- from_y
);
24962 #endif /* HAVE_WINDOW_SYSTEM */
24966 /***********************************************************************
24968 ***********************************************************************/
24970 /* Value is the internal representation of the specified cursor type
24971 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24972 of the bar cursor. */
24974 static enum text_cursor_kinds
24975 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24977 enum text_cursor_kinds type
;
24982 if (EQ (arg
, Qbox
))
24983 return FILLED_BOX_CURSOR
;
24985 if (EQ (arg
, Qhollow
))
24986 return HOLLOW_BOX_CURSOR
;
24988 if (EQ (arg
, Qbar
))
24995 && EQ (XCAR (arg
), Qbar
)
24996 && INTEGERP (XCDR (arg
))
24997 && XINT (XCDR (arg
)) >= 0)
24999 *width
= XINT (XCDR (arg
));
25003 if (EQ (arg
, Qhbar
))
25006 return HBAR_CURSOR
;
25010 && EQ (XCAR (arg
), Qhbar
)
25011 && INTEGERP (XCDR (arg
))
25012 && XINT (XCDR (arg
)) >= 0)
25014 *width
= XINT (XCDR (arg
));
25015 return HBAR_CURSOR
;
25018 /* Treat anything unknown as "hollow box cursor".
25019 It was bad to signal an error; people have trouble fixing
25020 .Xdefaults with Emacs, when it has something bad in it. */
25021 type
= HOLLOW_BOX_CURSOR
;
25026 /* Set the default cursor types for specified frame. */
25028 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
25033 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
25034 FRAME_CURSOR_WIDTH (f
) = width
;
25036 /* By default, set up the blink-off state depending on the on-state. */
25038 tem
= Fassoc (arg
, Vblink_cursor_alist
);
25041 FRAME_BLINK_OFF_CURSOR (f
)
25042 = get_specified_cursor_type (XCDR (tem
), &width
);
25043 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
25046 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
25050 #ifdef HAVE_WINDOW_SYSTEM
25052 /* Return the cursor we want to be displayed in window W. Return
25053 width of bar/hbar cursor through WIDTH arg. Return with
25054 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
25055 (i.e. if the `system caret' should track this cursor).
25057 In a mini-buffer window, we want the cursor only to appear if we
25058 are reading input from this window. For the selected window, we
25059 want the cursor type given by the frame parameter or buffer local
25060 setting of cursor-type. If explicitly marked off, draw no cursor.
25061 In all other cases, we want a hollow box cursor. */
25063 static enum text_cursor_kinds
25064 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
25065 int *active_cursor
)
25067 struct frame
*f
= XFRAME (w
->frame
);
25068 struct buffer
*b
= XBUFFER (w
->buffer
);
25069 int cursor_type
= DEFAULT_CURSOR
;
25070 Lisp_Object alt_cursor
;
25071 int non_selected
= 0;
25073 *active_cursor
= 1;
25076 if (cursor_in_echo_area
25077 && FRAME_HAS_MINIBUF_P (f
)
25078 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
25080 if (w
== XWINDOW (echo_area_window
))
25082 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
25084 *width
= FRAME_CURSOR_WIDTH (f
);
25085 return FRAME_DESIRED_CURSOR (f
);
25088 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25091 *active_cursor
= 0;
25095 /* Detect a nonselected window or nonselected frame. */
25096 else if (w
!= XWINDOW (f
->selected_window
)
25097 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
25099 *active_cursor
= 0;
25101 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25107 /* Never display a cursor in a window in which cursor-type is nil. */
25108 if (NILP (BVAR (b
, cursor_type
)))
25111 /* Get the normal cursor type for this window. */
25112 if (EQ (BVAR (b
, cursor_type
), Qt
))
25114 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25115 *width
= FRAME_CURSOR_WIDTH (f
);
25118 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25120 /* Use cursor-in-non-selected-windows instead
25121 for non-selected window or frame. */
25124 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25125 if (!EQ (Qt
, alt_cursor
))
25126 return get_specified_cursor_type (alt_cursor
, width
);
25127 /* t means modify the normal cursor type. */
25128 if (cursor_type
== FILLED_BOX_CURSOR
)
25129 cursor_type
= HOLLOW_BOX_CURSOR
;
25130 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25132 return cursor_type
;
25135 /* Use normal cursor if not blinked off. */
25136 if (!w
->cursor_off_p
)
25138 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25140 if (cursor_type
== FILLED_BOX_CURSOR
)
25142 /* Using a block cursor on large images can be very annoying.
25143 So use a hollow cursor for "large" images.
25144 If image is not transparent (no mask), also use hollow cursor. */
25145 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25146 if (img
!= NULL
&& IMAGEP (img
->spec
))
25148 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25149 where N = size of default frame font size.
25150 This should cover most of the "tiny" icons people may use. */
25152 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25153 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25154 cursor_type
= HOLLOW_BOX_CURSOR
;
25157 else if (cursor_type
!= NO_CURSOR
)
25159 /* Display current only supports BOX and HOLLOW cursors for images.
25160 So for now, unconditionally use a HOLLOW cursor when cursor is
25161 not a solid box cursor. */
25162 cursor_type
= HOLLOW_BOX_CURSOR
;
25165 return cursor_type
;
25168 /* Cursor is blinked off, so determine how to "toggle" it. */
25170 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25171 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25172 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25174 /* Then see if frame has specified a specific blink off cursor type. */
25175 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25177 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25178 return FRAME_BLINK_OFF_CURSOR (f
);
25182 /* Some people liked having a permanently visible blinking cursor,
25183 while others had very strong opinions against it. So it was
25184 decided to remove it. KFS 2003-09-03 */
25186 /* Finally perform built-in cursor blinking:
25187 filled box <-> hollow box
25188 wide [h]bar <-> narrow [h]bar
25189 narrow [h]bar <-> no cursor
25190 other type <-> no cursor */
25192 if (cursor_type
== FILLED_BOX_CURSOR
)
25193 return HOLLOW_BOX_CURSOR
;
25195 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25198 return cursor_type
;
25206 /* Notice when the text cursor of window W has been completely
25207 overwritten by a drawing operation that outputs glyphs in AREA
25208 starting at X0 and ending at X1 in the line starting at Y0 and
25209 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25210 the rest of the line after X0 has been written. Y coordinates
25211 are window-relative. */
25214 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25215 int x0
, int x1
, int y0
, int y1
)
25217 int cx0
, cx1
, cy0
, cy1
;
25218 struct glyph_row
*row
;
25220 if (!w
->phys_cursor_on_p
)
25222 if (area
!= TEXT_AREA
)
25225 if (w
->phys_cursor
.vpos
< 0
25226 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25227 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25228 !(row
->enabled_p
&& row
->displays_text_p
)))
25231 if (row
->cursor_in_fringe_p
)
25233 row
->cursor_in_fringe_p
= 0;
25234 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25235 w
->phys_cursor_on_p
= 0;
25239 cx0
= w
->phys_cursor
.x
;
25240 cx1
= cx0
+ w
->phys_cursor_width
;
25241 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25244 /* The cursor image will be completely removed from the
25245 screen if the output area intersects the cursor area in
25246 y-direction. When we draw in [y0 y1[, and some part of
25247 the cursor is at y < y0, that part must have been drawn
25248 before. When scrolling, the cursor is erased before
25249 actually scrolling, so we don't come here. When not
25250 scrolling, the rows above the old cursor row must have
25251 changed, and in this case these rows must have written
25252 over the cursor image.
25254 Likewise if part of the cursor is below y1, with the
25255 exception of the cursor being in the first blank row at
25256 the buffer and window end because update_text_area
25257 doesn't draw that row. (Except when it does, but
25258 that's handled in update_text_area.) */
25260 cy0
= w
->phys_cursor
.y
;
25261 cy1
= cy0
+ w
->phys_cursor_height
;
25262 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25265 w
->phys_cursor_on_p
= 0;
25268 #endif /* HAVE_WINDOW_SYSTEM */
25271 /************************************************************************
25273 ************************************************************************/
25275 #ifdef HAVE_WINDOW_SYSTEM
25278 Fix the display of area AREA of overlapping row ROW in window W
25279 with respect to the overlapping part OVERLAPS. */
25282 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25283 enum glyph_row_area area
, int overlaps
)
25290 for (i
= 0; i
< row
->used
[area
];)
25292 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25294 int start
= i
, start_x
= x
;
25298 x
+= row
->glyphs
[area
][i
].pixel_width
;
25301 while (i
< row
->used
[area
]
25302 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25304 draw_glyphs (w
, start_x
, row
, area
,
25306 DRAW_NORMAL_TEXT
, overlaps
);
25310 x
+= row
->glyphs
[area
][i
].pixel_width
;
25320 Draw the cursor glyph of window W in glyph row ROW. See the
25321 comment of draw_glyphs for the meaning of HL. */
25324 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25325 enum draw_glyphs_face hl
)
25327 /* If cursor hpos is out of bounds, don't draw garbage. This can
25328 happen in mini-buffer windows when switching between echo area
25329 glyphs and mini-buffer. */
25330 if ((row
->reversed_p
25331 ? (w
->phys_cursor
.hpos
>= 0)
25332 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25334 int on_p
= w
->phys_cursor_on_p
;
25336 int hpos
= w
->phys_cursor
.hpos
;
25338 /* When the window is hscrolled, cursor hpos can legitimately be
25339 out of bounds, but we draw the cursor at the corresponding
25340 window margin in that case. */
25341 if (!row
->reversed_p
&& hpos
< 0)
25343 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25344 hpos
= row
->used
[TEXT_AREA
] - 1;
25346 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25348 w
->phys_cursor_on_p
= on_p
;
25350 if (hl
== DRAW_CURSOR
)
25351 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25352 /* When we erase the cursor, and ROW is overlapped by other
25353 rows, make sure that these overlapping parts of other rows
25355 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25357 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25359 if (row
> w
->current_matrix
->rows
25360 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25361 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25362 OVERLAPS_ERASED_CURSOR
);
25364 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25365 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25366 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25367 OVERLAPS_ERASED_CURSOR
);
25374 Erase the image of a cursor of window W from the screen. */
25377 erase_phys_cursor (struct window
*w
)
25379 struct frame
*f
= XFRAME (w
->frame
);
25380 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25381 int hpos
= w
->phys_cursor
.hpos
;
25382 int vpos
= w
->phys_cursor
.vpos
;
25383 int mouse_face_here_p
= 0;
25384 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25385 struct glyph_row
*cursor_row
;
25386 struct glyph
*cursor_glyph
;
25387 enum draw_glyphs_face hl
;
25389 /* No cursor displayed or row invalidated => nothing to do on the
25391 if (w
->phys_cursor_type
== NO_CURSOR
)
25392 goto mark_cursor_off
;
25394 /* VPOS >= active_glyphs->nrows means that window has been resized.
25395 Don't bother to erase the cursor. */
25396 if (vpos
>= active_glyphs
->nrows
)
25397 goto mark_cursor_off
;
25399 /* If row containing cursor is marked invalid, there is nothing we
25401 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25402 if (!cursor_row
->enabled_p
)
25403 goto mark_cursor_off
;
25405 /* If line spacing is > 0, old cursor may only be partially visible in
25406 window after split-window. So adjust visible height. */
25407 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25408 window_text_bottom_y (w
) - cursor_row
->y
);
25410 /* If row is completely invisible, don't attempt to delete a cursor which
25411 isn't there. This can happen if cursor is at top of a window, and
25412 we switch to a buffer with a header line in that window. */
25413 if (cursor_row
->visible_height
<= 0)
25414 goto mark_cursor_off
;
25416 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25417 if (cursor_row
->cursor_in_fringe_p
)
25419 cursor_row
->cursor_in_fringe_p
= 0;
25420 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25421 goto mark_cursor_off
;
25424 /* This can happen when the new row is shorter than the old one.
25425 In this case, either draw_glyphs or clear_end_of_line
25426 should have cleared the cursor. Note that we wouldn't be
25427 able to erase the cursor in this case because we don't have a
25428 cursor glyph at hand. */
25429 if ((cursor_row
->reversed_p
25430 ? (w
->phys_cursor
.hpos
< 0)
25431 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25432 goto mark_cursor_off
;
25434 /* When the window is hscrolled, cursor hpos can legitimately be out
25435 of bounds, but we draw the cursor at the corresponding window
25436 margin in that case. */
25437 if (!cursor_row
->reversed_p
&& hpos
< 0)
25439 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25440 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25442 /* If the cursor is in the mouse face area, redisplay that when
25443 we clear the cursor. */
25444 if (! NILP (hlinfo
->mouse_face_window
)
25445 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25446 /* Don't redraw the cursor's spot in mouse face if it is at the
25447 end of a line (on a newline). The cursor appears there, but
25448 mouse highlighting does not. */
25449 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25450 mouse_face_here_p
= 1;
25452 /* Maybe clear the display under the cursor. */
25453 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25456 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25459 cursor_glyph
= get_phys_cursor_glyph (w
);
25460 if (cursor_glyph
== NULL
)
25461 goto mark_cursor_off
;
25463 width
= cursor_glyph
->pixel_width
;
25464 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25465 x
= w
->phys_cursor
.x
;
25467 width
-= left_x
- x
;
25468 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25469 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25470 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25473 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25476 /* Erase the cursor by redrawing the character underneath it. */
25477 if (mouse_face_here_p
)
25478 hl
= DRAW_MOUSE_FACE
;
25480 hl
= DRAW_NORMAL_TEXT
;
25481 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25484 w
->phys_cursor_on_p
= 0;
25485 w
->phys_cursor_type
= NO_CURSOR
;
25490 Display or clear cursor of window W. If ON is zero, clear the
25491 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25492 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25495 display_and_set_cursor (struct window
*w
, int on
,
25496 int hpos
, int vpos
, int x
, int y
)
25498 struct frame
*f
= XFRAME (w
->frame
);
25499 int new_cursor_type
;
25500 int new_cursor_width
;
25502 struct glyph_row
*glyph_row
;
25503 struct glyph
*glyph
;
25505 /* This is pointless on invisible frames, and dangerous on garbaged
25506 windows and frames; in the latter case, the frame or window may
25507 be in the midst of changing its size, and x and y may be off the
25509 if (! FRAME_VISIBLE_P (f
)
25510 || FRAME_GARBAGED_P (f
)
25511 || vpos
>= w
->current_matrix
->nrows
25512 || hpos
>= w
->current_matrix
->matrix_w
)
25515 /* If cursor is off and we want it off, return quickly. */
25516 if (!on
&& !w
->phys_cursor_on_p
)
25519 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25520 /* If cursor row is not enabled, we don't really know where to
25521 display the cursor. */
25522 if (!glyph_row
->enabled_p
)
25524 w
->phys_cursor_on_p
= 0;
25529 if (!glyph_row
->exact_window_width_line_p
25530 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25531 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25533 xassert (interrupt_input_blocked
);
25535 /* Set new_cursor_type to the cursor we want to be displayed. */
25536 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25537 &new_cursor_width
, &active_cursor
);
25539 /* If cursor is currently being shown and we don't want it to be or
25540 it is in the wrong place, or the cursor type is not what we want,
25542 if (w
->phys_cursor_on_p
25544 || w
->phys_cursor
.x
!= x
25545 || w
->phys_cursor
.y
!= y
25546 || new_cursor_type
!= w
->phys_cursor_type
25547 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25548 && new_cursor_width
!= w
->phys_cursor_width
)))
25549 erase_phys_cursor (w
);
25551 /* Don't check phys_cursor_on_p here because that flag is only set
25552 to zero in some cases where we know that the cursor has been
25553 completely erased, to avoid the extra work of erasing the cursor
25554 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25555 still not be visible, or it has only been partly erased. */
25558 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25559 w
->phys_cursor_height
= glyph_row
->height
;
25561 /* Set phys_cursor_.* before x_draw_.* is called because some
25562 of them may need the information. */
25563 w
->phys_cursor
.x
= x
;
25564 w
->phys_cursor
.y
= glyph_row
->y
;
25565 w
->phys_cursor
.hpos
= hpos
;
25566 w
->phys_cursor
.vpos
= vpos
;
25569 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25570 new_cursor_type
, new_cursor_width
,
25571 on
, active_cursor
);
25575 /* Switch the display of W's cursor on or off, according to the value
25579 update_window_cursor (struct window
*w
, int on
)
25581 /* Don't update cursor in windows whose frame is in the process
25582 of being deleted. */
25583 if (w
->current_matrix
)
25585 int hpos
= w
->phys_cursor
.hpos
;
25586 int vpos
= w
->phys_cursor
.vpos
;
25587 struct glyph_row
*row
;
25589 if (vpos
>= w
->current_matrix
->nrows
25590 || hpos
>= w
->current_matrix
->matrix_w
)
25593 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25595 /* When the window is hscrolled, cursor hpos can legitimately be
25596 out of bounds, but we draw the cursor at the corresponding
25597 window margin in that case. */
25598 if (!row
->reversed_p
&& hpos
< 0)
25600 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25601 hpos
= row
->used
[TEXT_AREA
] - 1;
25604 display_and_set_cursor (w
, on
, hpos
, vpos
,
25605 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25611 /* Call update_window_cursor with parameter ON_P on all leaf windows
25612 in the window tree rooted at W. */
25615 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25619 if (!NILP (w
->hchild
))
25620 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25621 else if (!NILP (w
->vchild
))
25622 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25624 update_window_cursor (w
, on_p
);
25626 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25632 Display the cursor on window W, or clear it, according to ON_P.
25633 Don't change the cursor's position. */
25636 x_update_cursor (struct frame
*f
, int on_p
)
25638 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25643 Clear the cursor of window W to background color, and mark the
25644 cursor as not shown. This is used when the text where the cursor
25645 is about to be rewritten. */
25648 x_clear_cursor (struct window
*w
)
25650 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25651 update_window_cursor (w
, 0);
25654 #endif /* HAVE_WINDOW_SYSTEM */
25656 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25659 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25660 int start_hpos
, int end_hpos
,
25661 enum draw_glyphs_face draw
)
25663 #ifdef HAVE_WINDOW_SYSTEM
25664 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25666 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25670 #if defined (HAVE_GPM) || defined (MSDOS)
25671 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25675 /* Display the active region described by mouse_face_* according to DRAW. */
25678 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25680 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25681 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25683 if (/* If window is in the process of being destroyed, don't bother
25685 w
->current_matrix
!= NULL
25686 /* Don't update mouse highlight if hidden */
25687 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25688 /* Recognize when we are called to operate on rows that don't exist
25689 anymore. This can happen when a window is split. */
25690 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25692 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25693 struct glyph_row
*row
, *first
, *last
;
25695 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25696 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25698 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25700 int start_hpos
, end_hpos
, start_x
;
25702 /* For all but the first row, the highlight starts at column 0. */
25705 /* R2L rows have BEG and END in reversed order, but the
25706 screen drawing geometry is always left to right. So
25707 we need to mirror the beginning and end of the
25708 highlighted area in R2L rows. */
25709 if (!row
->reversed_p
)
25711 start_hpos
= hlinfo
->mouse_face_beg_col
;
25712 start_x
= hlinfo
->mouse_face_beg_x
;
25714 else if (row
== last
)
25716 start_hpos
= hlinfo
->mouse_face_end_col
;
25717 start_x
= hlinfo
->mouse_face_end_x
;
25725 else if (row
->reversed_p
&& row
== last
)
25727 start_hpos
= hlinfo
->mouse_face_end_col
;
25728 start_x
= hlinfo
->mouse_face_end_x
;
25738 if (!row
->reversed_p
)
25739 end_hpos
= hlinfo
->mouse_face_end_col
;
25740 else if (row
== first
)
25741 end_hpos
= hlinfo
->mouse_face_beg_col
;
25744 end_hpos
= row
->used
[TEXT_AREA
];
25745 if (draw
== DRAW_NORMAL_TEXT
)
25746 row
->fill_line_p
= 1; /* Clear to end of line */
25749 else if (row
->reversed_p
&& row
== first
)
25750 end_hpos
= hlinfo
->mouse_face_beg_col
;
25753 end_hpos
= row
->used
[TEXT_AREA
];
25754 if (draw
== DRAW_NORMAL_TEXT
)
25755 row
->fill_line_p
= 1; /* Clear to end of line */
25758 if (end_hpos
> start_hpos
)
25760 draw_row_with_mouse_face (w
, start_x
, row
,
25761 start_hpos
, end_hpos
, draw
);
25764 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25768 #ifdef HAVE_WINDOW_SYSTEM
25769 /* When we've written over the cursor, arrange for it to
25770 be displayed again. */
25771 if (FRAME_WINDOW_P (f
)
25772 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25774 int hpos
= w
->phys_cursor
.hpos
;
25776 /* When the window is hscrolled, cursor hpos can legitimately be
25777 out of bounds, but we draw the cursor at the corresponding
25778 window margin in that case. */
25779 if (!row
->reversed_p
&& hpos
< 0)
25781 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25782 hpos
= row
->used
[TEXT_AREA
] - 1;
25785 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
25786 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25789 #endif /* HAVE_WINDOW_SYSTEM */
25792 #ifdef HAVE_WINDOW_SYSTEM
25793 /* Change the mouse cursor. */
25794 if (FRAME_WINDOW_P (f
))
25796 if (draw
== DRAW_NORMAL_TEXT
25797 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25798 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25799 else if (draw
== DRAW_MOUSE_FACE
)
25800 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25802 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25804 #endif /* HAVE_WINDOW_SYSTEM */
25808 Clear out the mouse-highlighted active region.
25809 Redraw it un-highlighted first. Value is non-zero if mouse
25810 face was actually drawn unhighlighted. */
25813 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25817 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25819 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25823 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25824 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25825 hlinfo
->mouse_face_window
= Qnil
;
25826 hlinfo
->mouse_face_overlay
= Qnil
;
25830 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25831 within the mouse face on that window. */
25833 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25835 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25837 /* Quickly resolve the easy cases. */
25838 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25839 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25841 if (vpos
< hlinfo
->mouse_face_beg_row
25842 || vpos
> hlinfo
->mouse_face_end_row
)
25844 if (vpos
> hlinfo
->mouse_face_beg_row
25845 && vpos
< hlinfo
->mouse_face_end_row
)
25848 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25850 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25852 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25855 else if ((vpos
== hlinfo
->mouse_face_beg_row
25856 && hpos
>= hlinfo
->mouse_face_beg_col
)
25857 || (vpos
== hlinfo
->mouse_face_end_row
25858 && hpos
< hlinfo
->mouse_face_end_col
))
25863 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25865 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25868 else if ((vpos
== hlinfo
->mouse_face_beg_row
25869 && hpos
<= hlinfo
->mouse_face_beg_col
)
25870 || (vpos
== hlinfo
->mouse_face_end_row
25871 && hpos
> hlinfo
->mouse_face_end_col
))
25879 Non-zero if physical cursor of window W is within mouse face. */
25882 cursor_in_mouse_face_p (struct window
*w
)
25884 int hpos
= w
->phys_cursor
.hpos
;
25885 int vpos
= w
->phys_cursor
.vpos
;
25886 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25888 /* When the window is hscrolled, cursor hpos can legitimately be out
25889 of bounds, but we draw the cursor at the corresponding window
25890 margin in that case. */
25891 if (!row
->reversed_p
&& hpos
< 0)
25893 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25894 hpos
= row
->used
[TEXT_AREA
] - 1;
25896 return coords_in_mouse_face_p (w
, hpos
, vpos
);
25901 /* Find the glyph rows START_ROW and END_ROW of window W that display
25902 characters between buffer positions START_CHARPOS and END_CHARPOS
25903 (excluding END_CHARPOS). DISP_STRING is a display string that
25904 covers these buffer positions. This is similar to
25905 row_containing_pos, but is more accurate when bidi reordering makes
25906 buffer positions change non-linearly with glyph rows. */
25908 rows_from_pos_range (struct window
*w
,
25909 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25910 Lisp_Object disp_string
,
25911 struct glyph_row
**start
, struct glyph_row
**end
)
25913 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25914 int last_y
= window_text_bottom_y (w
);
25915 struct glyph_row
*row
;
25920 while (!first
->enabled_p
25921 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25924 /* Find the START row. */
25926 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25929 /* A row can potentially be the START row if the range of the
25930 characters it displays intersects the range
25931 [START_CHARPOS..END_CHARPOS). */
25932 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25933 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25934 /* See the commentary in row_containing_pos, for the
25935 explanation of the complicated way to check whether
25936 some position is beyond the end of the characters
25937 displayed by a row. */
25938 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25939 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25940 && !row
->ends_at_zv_p
25941 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25942 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25943 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25944 && !row
->ends_at_zv_p
25945 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25947 /* Found a candidate row. Now make sure at least one of the
25948 glyphs it displays has a charpos from the range
25949 [START_CHARPOS..END_CHARPOS).
25951 This is not obvious because bidi reordering could make
25952 buffer positions of a row be 1,2,3,102,101,100, and if we
25953 want to highlight characters in [50..60), we don't want
25954 this row, even though [50..60) does intersect [1..103),
25955 the range of character positions given by the row's start
25956 and end positions. */
25957 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25958 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25962 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25963 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25964 /* A glyph that comes from DISP_STRING is by
25965 definition to be highlighted. */
25966 || EQ (g
->object
, disp_string
))
25975 /* Find the END row. */
25977 /* If the last row is partially visible, start looking for END
25978 from that row, instead of starting from FIRST. */
25979 && !(row
->enabled_p
25980 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25982 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25984 struct glyph_row
*next
= row
+ 1;
25985 EMACS_INT next_start
= MATRIX_ROW_START_CHARPOS (next
);
25987 if (!next
->enabled_p
25988 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25989 /* The first row >= START whose range of displayed characters
25990 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25991 is the row END + 1. */
25992 || (start_charpos
< next_start
25993 && end_charpos
< next_start
)
25994 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25995 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25996 && !next
->ends_at_zv_p
25997 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25998 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25999 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
26000 && !next
->ends_at_zv_p
26001 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
26008 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
26009 but none of the characters it displays are in the range, it is
26011 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
26012 struct glyph
*s
= g
;
26013 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
26017 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
26018 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
26019 /* If the buffer position of the first glyph in
26020 the row is equal to END_CHARPOS, it means
26021 the last character to be highlighted is the
26022 newline of ROW, and we must consider NEXT as
26024 || (((!next
->reversed_p
&& g
== s
)
26025 || (next
->reversed_p
&& g
== e
- 1))
26026 && (g
->charpos
== end_charpos
26027 /* Special case for when NEXT is an
26028 empty line at ZV. */
26029 || (g
->charpos
== -1
26030 && !row
->ends_at_zv_p
26031 && next_start
== end_charpos
)))))
26032 /* A glyph that comes from DISP_STRING is by
26033 definition to be highlighted. */
26034 || EQ (g
->object
, disp_string
))
26043 /* The first row that ends at ZV must be the last to be
26045 else if (next
->ends_at_zv_p
)
26054 /* This function sets the mouse_face_* elements of HLINFO, assuming
26055 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
26056 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
26057 for the overlay or run of text properties specifying the mouse
26058 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
26059 before-string and after-string that must also be highlighted.
26060 DISP_STRING, if non-nil, is a display string that may cover some
26061 or all of the highlighted text. */
26064 mouse_face_from_buffer_pos (Lisp_Object window
,
26065 Mouse_HLInfo
*hlinfo
,
26066 EMACS_INT mouse_charpos
,
26067 EMACS_INT start_charpos
,
26068 EMACS_INT end_charpos
,
26069 Lisp_Object before_string
,
26070 Lisp_Object after_string
,
26071 Lisp_Object disp_string
)
26073 struct window
*w
= XWINDOW (window
);
26074 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26075 struct glyph_row
*r1
, *r2
;
26076 struct glyph
*glyph
, *end
;
26077 EMACS_INT ignore
, pos
;
26080 xassert (NILP (disp_string
) || STRINGP (disp_string
));
26081 xassert (NILP (before_string
) || STRINGP (before_string
));
26082 xassert (NILP (after_string
) || STRINGP (after_string
));
26084 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
26085 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
26087 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26088 /* If the before-string or display-string contains newlines,
26089 rows_from_pos_range skips to its last row. Move back. */
26090 if (!NILP (before_string
) || !NILP (disp_string
))
26092 struct glyph_row
*prev
;
26093 while ((prev
= r1
- 1, prev
>= first
)
26094 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
26095 && prev
->used
[TEXT_AREA
] > 0)
26097 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
26098 glyph
= beg
+ prev
->used
[TEXT_AREA
];
26099 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
26101 || !(EQ (glyph
->object
, before_string
)
26102 || EQ (glyph
->object
, disp_string
)))
26109 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26110 hlinfo
->mouse_face_past_end
= 1;
26112 else if (!NILP (after_string
))
26114 /* If the after-string has newlines, advance to its last row. */
26115 struct glyph_row
*next
;
26116 struct glyph_row
*last
26117 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
26119 for (next
= r2
+ 1;
26121 && next
->used
[TEXT_AREA
] > 0
26122 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
26126 /* The rest of the display engine assumes that mouse_face_beg_row is
26127 either above mouse_face_end_row or identical to it. But with
26128 bidi-reordered continued lines, the row for START_CHARPOS could
26129 be below the row for END_CHARPOS. If so, swap the rows and store
26130 them in correct order. */
26133 struct glyph_row
*tem
= r2
;
26139 hlinfo
->mouse_face_beg_y
= r1
->y
;
26140 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26141 hlinfo
->mouse_face_end_y
= r2
->y
;
26142 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26144 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26145 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26146 could be anywhere in the row and in any order. The strategy
26147 below is to find the leftmost and the rightmost glyph that
26148 belongs to either of these 3 strings, or whose position is
26149 between START_CHARPOS and END_CHARPOS, and highlight all the
26150 glyphs between those two. This may cover more than just the text
26151 between START_CHARPOS and END_CHARPOS if the range of characters
26152 strides the bidi level boundary, e.g. if the beginning is in R2L
26153 text while the end is in L2R text or vice versa. */
26154 if (!r1
->reversed_p
)
26156 /* This row is in a left to right paragraph. Scan it left to
26158 glyph
= r1
->glyphs
[TEXT_AREA
];
26159 end
= glyph
+ r1
->used
[TEXT_AREA
];
26162 /* Skip truncation glyphs at the start of the glyph row. */
26163 if (r1
->displays_text_p
)
26165 && INTEGERP (glyph
->object
)
26166 && glyph
->charpos
< 0;
26168 x
+= glyph
->pixel_width
;
26170 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26171 or DISP_STRING, and the first glyph from buffer whose
26172 position is between START_CHARPOS and END_CHARPOS. */
26174 && !INTEGERP (glyph
->object
)
26175 && !EQ (glyph
->object
, disp_string
)
26176 && !(BUFFERP (glyph
->object
)
26177 && (glyph
->charpos
>= start_charpos
26178 && glyph
->charpos
< end_charpos
));
26181 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26182 are present at buffer positions between START_CHARPOS and
26183 END_CHARPOS, or if they come from an overlay. */
26184 if (EQ (glyph
->object
, before_string
))
26186 pos
= string_buffer_position (before_string
,
26188 /* If pos == 0, it means before_string came from an
26189 overlay, not from a buffer position. */
26190 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26193 else if (EQ (glyph
->object
, after_string
))
26195 pos
= string_buffer_position (after_string
, end_charpos
);
26196 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26199 x
+= glyph
->pixel_width
;
26201 hlinfo
->mouse_face_beg_x
= x
;
26202 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26206 /* This row is in a right to left paragraph. Scan it right to
26210 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26211 glyph
= end
+ r1
->used
[TEXT_AREA
];
26213 /* Skip truncation glyphs at the start of the glyph row. */
26214 if (r1
->displays_text_p
)
26216 && INTEGERP (glyph
->object
)
26217 && glyph
->charpos
< 0;
26221 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26222 or DISP_STRING, and the first glyph from buffer whose
26223 position is between START_CHARPOS and END_CHARPOS. */
26225 && !INTEGERP (glyph
->object
)
26226 && !EQ (glyph
->object
, disp_string
)
26227 && !(BUFFERP (glyph
->object
)
26228 && (glyph
->charpos
>= start_charpos
26229 && glyph
->charpos
< end_charpos
));
26232 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26233 are present at buffer positions between START_CHARPOS and
26234 END_CHARPOS, or if they come from an overlay. */
26235 if (EQ (glyph
->object
, before_string
))
26237 pos
= string_buffer_position (before_string
, start_charpos
);
26238 /* If pos == 0, it means before_string came from an
26239 overlay, not from a buffer position. */
26240 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26243 else if (EQ (glyph
->object
, after_string
))
26245 pos
= string_buffer_position (after_string
, end_charpos
);
26246 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26251 glyph
++; /* first glyph to the right of the highlighted area */
26252 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26253 x
+= g
->pixel_width
;
26254 hlinfo
->mouse_face_beg_x
= x
;
26255 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26258 /* If the highlight ends in a different row, compute GLYPH and END
26259 for the end row. Otherwise, reuse the values computed above for
26260 the row where the highlight begins. */
26263 if (!r2
->reversed_p
)
26265 glyph
= r2
->glyphs
[TEXT_AREA
];
26266 end
= glyph
+ r2
->used
[TEXT_AREA
];
26271 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26272 glyph
= end
+ r2
->used
[TEXT_AREA
];
26276 if (!r2
->reversed_p
)
26278 /* Skip truncation and continuation glyphs near the end of the
26279 row, and also blanks and stretch glyphs inserted by
26280 extend_face_to_end_of_line. */
26282 && INTEGERP ((end
- 1)->object
))
26284 /* Scan the rest of the glyph row from the end, looking for the
26285 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26286 DISP_STRING, or whose position is between START_CHARPOS
26290 && !INTEGERP (end
->object
)
26291 && !EQ (end
->object
, disp_string
)
26292 && !(BUFFERP (end
->object
)
26293 && (end
->charpos
>= start_charpos
26294 && end
->charpos
< end_charpos
));
26297 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26298 are present at buffer positions between START_CHARPOS and
26299 END_CHARPOS, or if they come from an overlay. */
26300 if (EQ (end
->object
, before_string
))
26302 pos
= string_buffer_position (before_string
, start_charpos
);
26303 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26306 else if (EQ (end
->object
, after_string
))
26308 pos
= string_buffer_position (after_string
, end_charpos
);
26309 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26313 /* Find the X coordinate of the last glyph to be highlighted. */
26314 for (; glyph
<= end
; ++glyph
)
26315 x
+= glyph
->pixel_width
;
26317 hlinfo
->mouse_face_end_x
= x
;
26318 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26322 /* Skip truncation and continuation glyphs near the end of the
26323 row, and also blanks and stretch glyphs inserted by
26324 extend_face_to_end_of_line. */
26328 && INTEGERP (end
->object
))
26330 x
+= end
->pixel_width
;
26333 /* Scan the rest of the glyph row from the end, looking for the
26334 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26335 DISP_STRING, or whose position is between START_CHARPOS
26339 && !INTEGERP (end
->object
)
26340 && !EQ (end
->object
, disp_string
)
26341 && !(BUFFERP (end
->object
)
26342 && (end
->charpos
>= start_charpos
26343 && end
->charpos
< end_charpos
));
26346 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26347 are present at buffer positions between START_CHARPOS and
26348 END_CHARPOS, or if they come from an overlay. */
26349 if (EQ (end
->object
, before_string
))
26351 pos
= string_buffer_position (before_string
, start_charpos
);
26352 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26355 else if (EQ (end
->object
, after_string
))
26357 pos
= string_buffer_position (after_string
, end_charpos
);
26358 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26361 x
+= end
->pixel_width
;
26363 /* If we exited the above loop because we arrived at the last
26364 glyph of the row, and its buffer position is still not in
26365 range, it means the last character in range is the preceding
26366 newline. Bump the end column and x values to get past the
26369 && BUFFERP (end
->object
)
26370 && (end
->charpos
< start_charpos
26371 || end
->charpos
>= end_charpos
))
26373 x
+= end
->pixel_width
;
26376 hlinfo
->mouse_face_end_x
= x
;
26377 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26380 hlinfo
->mouse_face_window
= window
;
26381 hlinfo
->mouse_face_face_id
26382 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26384 !hlinfo
->mouse_face_hidden
, -1);
26385 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26388 /* The following function is not used anymore (replaced with
26389 mouse_face_from_string_pos), but I leave it here for the time
26390 being, in case someone would. */
26392 #if 0 /* not used */
26394 /* Find the position of the glyph for position POS in OBJECT in
26395 window W's current matrix, and return in *X, *Y the pixel
26396 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26398 RIGHT_P non-zero means return the position of the right edge of the
26399 glyph, RIGHT_P zero means return the left edge position.
26401 If no glyph for POS exists in the matrix, return the position of
26402 the glyph with the next smaller position that is in the matrix, if
26403 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26404 exists in the matrix, return the position of the glyph with the
26405 next larger position in OBJECT.
26407 Value is non-zero if a glyph was found. */
26410 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26411 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26413 int yb
= window_text_bottom_y (w
);
26414 struct glyph_row
*r
;
26415 struct glyph
*best_glyph
= NULL
;
26416 struct glyph_row
*best_row
= NULL
;
26419 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26420 r
->enabled_p
&& r
->y
< yb
;
26423 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26424 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26427 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26428 if (EQ (g
->object
, object
))
26430 if (g
->charpos
== pos
)
26437 else if (best_glyph
== NULL
26438 || ((eabs (g
->charpos
- pos
)
26439 < eabs (best_glyph
->charpos
- pos
))
26442 : g
->charpos
> pos
)))
26456 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26460 *x
+= best_glyph
->pixel_width
;
26465 *vpos
= best_row
- w
->current_matrix
->rows
;
26468 return best_glyph
!= NULL
;
26470 #endif /* not used */
26472 /* Find the positions of the first and the last glyphs in window W's
26473 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26474 (assumed to be a string), and return in HLINFO's mouse_face_*
26475 members the pixel and column/row coordinates of those glyphs. */
26478 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26479 Lisp_Object object
,
26480 EMACS_INT startpos
, EMACS_INT endpos
)
26482 int yb
= window_text_bottom_y (w
);
26483 struct glyph_row
*r
;
26484 struct glyph
*g
, *e
;
26488 /* Find the glyph row with at least one position in the range
26489 [STARTPOS..ENDPOS], and the first glyph in that row whose
26490 position belongs to that range. */
26491 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26492 r
->enabled_p
&& r
->y
< yb
;
26495 if (!r
->reversed_p
)
26497 g
= r
->glyphs
[TEXT_AREA
];
26498 e
= g
+ r
->used
[TEXT_AREA
];
26499 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26500 if (EQ (g
->object
, object
)
26501 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26503 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26504 hlinfo
->mouse_face_beg_y
= r
->y
;
26505 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26506 hlinfo
->mouse_face_beg_x
= gx
;
26515 e
= r
->glyphs
[TEXT_AREA
];
26516 g
= e
+ r
->used
[TEXT_AREA
];
26517 for ( ; g
> e
; --g
)
26518 if (EQ ((g
-1)->object
, object
)
26519 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26521 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26522 hlinfo
->mouse_face_beg_y
= r
->y
;
26523 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26524 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26525 gx
+= g1
->pixel_width
;
26526 hlinfo
->mouse_face_beg_x
= gx
;
26538 /* Starting with the next row, look for the first row which does NOT
26539 include any glyphs whose positions are in the range. */
26540 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26542 g
= r
->glyphs
[TEXT_AREA
];
26543 e
= g
+ r
->used
[TEXT_AREA
];
26545 for ( ; g
< e
; ++g
)
26546 if (EQ (g
->object
, object
)
26547 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26556 /* The highlighted region ends on the previous row. */
26559 /* Set the end row and its vertical pixel coordinate. */
26560 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26561 hlinfo
->mouse_face_end_y
= r
->y
;
26563 /* Compute and set the end column and the end column's horizontal
26564 pixel coordinate. */
26565 if (!r
->reversed_p
)
26567 g
= r
->glyphs
[TEXT_AREA
];
26568 e
= g
+ r
->used
[TEXT_AREA
];
26569 for ( ; e
> g
; --e
)
26570 if (EQ ((e
-1)->object
, object
)
26571 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26573 hlinfo
->mouse_face_end_col
= e
- g
;
26575 for (gx
= r
->x
; g
< e
; ++g
)
26576 gx
+= g
->pixel_width
;
26577 hlinfo
->mouse_face_end_x
= gx
;
26581 e
= r
->glyphs
[TEXT_AREA
];
26582 g
= e
+ r
->used
[TEXT_AREA
];
26583 for (gx
= r
->x
; e
< g
; ++e
)
26585 if (EQ (e
->object
, object
)
26586 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26588 gx
+= e
->pixel_width
;
26590 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26591 hlinfo
->mouse_face_end_x
= gx
;
26595 #ifdef HAVE_WINDOW_SYSTEM
26597 /* See if position X, Y is within a hot-spot of an image. */
26600 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26602 if (!CONSP (hot_spot
))
26605 if (EQ (XCAR (hot_spot
), Qrect
))
26607 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26608 Lisp_Object rect
= XCDR (hot_spot
);
26612 if (!CONSP (XCAR (rect
)))
26614 if (!CONSP (XCDR (rect
)))
26616 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26618 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26620 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26622 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26626 else if (EQ (XCAR (hot_spot
), Qcircle
))
26628 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26629 Lisp_Object circ
= XCDR (hot_spot
);
26630 Lisp_Object lr
, lx0
, ly0
;
26632 && CONSP (XCAR (circ
))
26633 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26634 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26635 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26637 double r
= XFLOATINT (lr
);
26638 double dx
= XINT (lx0
) - x
;
26639 double dy
= XINT (ly0
) - y
;
26640 return (dx
* dx
+ dy
* dy
<= r
* r
);
26643 else if (EQ (XCAR (hot_spot
), Qpoly
))
26645 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26646 if (VECTORP (XCDR (hot_spot
)))
26648 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26649 Lisp_Object
*poly
= v
->contents
;
26650 int n
= v
->header
.size
;
26653 Lisp_Object lx
, ly
;
26656 /* Need an even number of coordinates, and at least 3 edges. */
26657 if (n
< 6 || n
& 1)
26660 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26661 If count is odd, we are inside polygon. Pixels on edges
26662 may or may not be included depending on actual geometry of the
26664 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26665 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26667 x0
= XINT (lx
), y0
= XINT (ly
);
26668 for (i
= 0; i
< n
; i
+= 2)
26670 int x1
= x0
, y1
= y0
;
26671 if ((lx
= poly
[i
], !INTEGERP (lx
))
26672 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26674 x0
= XINT (lx
), y0
= XINT (ly
);
26676 /* Does this segment cross the X line? */
26684 if (y
> y0
&& y
> y1
)
26686 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26696 find_hot_spot (Lisp_Object map
, int x
, int y
)
26698 while (CONSP (map
))
26700 if (CONSP (XCAR (map
))
26701 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26709 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26711 doc
: /* Lookup in image map MAP coordinates X and Y.
26712 An image map is an alist where each element has the format (AREA ID PLIST).
26713 An AREA is specified as either a rectangle, a circle, or a polygon:
26714 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26715 pixel coordinates of the upper left and bottom right corners.
26716 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26717 and the radius of the circle; r may be a float or integer.
26718 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26719 vector describes one corner in the polygon.
26720 Returns the alist element for the first matching AREA in MAP. */)
26721 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26729 return find_hot_spot (map
, XINT (x
), XINT (y
));
26733 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26735 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26737 /* Do not change cursor shape while dragging mouse. */
26738 if (!NILP (do_mouse_tracking
))
26741 if (!NILP (pointer
))
26743 if (EQ (pointer
, Qarrow
))
26744 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26745 else if (EQ (pointer
, Qhand
))
26746 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26747 else if (EQ (pointer
, Qtext
))
26748 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26749 else if (EQ (pointer
, intern ("hdrag")))
26750 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26751 #ifdef HAVE_X_WINDOWS
26752 else if (EQ (pointer
, intern ("vdrag")))
26753 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26755 else if (EQ (pointer
, intern ("hourglass")))
26756 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26757 else if (EQ (pointer
, Qmodeline
))
26758 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26760 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26763 if (cursor
!= No_Cursor
)
26764 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26767 #endif /* HAVE_WINDOW_SYSTEM */
26769 /* Take proper action when mouse has moved to the mode or header line
26770 or marginal area AREA of window W, x-position X and y-position Y.
26771 X is relative to the start of the text display area of W, so the
26772 width of bitmap areas and scroll bars must be subtracted to get a
26773 position relative to the start of the mode line. */
26776 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26777 enum window_part area
)
26779 struct window
*w
= XWINDOW (window
);
26780 struct frame
*f
= XFRAME (w
->frame
);
26781 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26782 #ifdef HAVE_WINDOW_SYSTEM
26783 Display_Info
*dpyinfo
;
26785 Cursor cursor
= No_Cursor
;
26786 Lisp_Object pointer
= Qnil
;
26787 int dx
, dy
, width
, height
;
26789 Lisp_Object string
, object
= Qnil
;
26790 Lisp_Object pos
, help
;
26792 Lisp_Object mouse_face
;
26793 int original_x_pixel
= x
;
26794 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26795 struct glyph_row
*row
;
26797 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26802 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26803 returns them in row/column units! */
26804 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26805 &object
, &dx
, &dy
, &width
, &height
);
26807 row
= (area
== ON_MODE_LINE
26808 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26809 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26811 /* Find the glyph under the mouse pointer. */
26812 if (row
->mode_line_p
&& row
->enabled_p
)
26814 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26815 end
= glyph
+ row
->used
[TEXT_AREA
];
26817 for (x0
= original_x_pixel
;
26818 glyph
< end
&& x0
>= glyph
->pixel_width
;
26820 x0
-= glyph
->pixel_width
;
26828 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26829 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26830 returns them in row/column units! */
26831 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26832 &object
, &dx
, &dy
, &width
, &height
);
26837 #ifdef HAVE_WINDOW_SYSTEM
26838 if (IMAGEP (object
))
26840 Lisp_Object image_map
, hotspot
;
26841 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26843 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26845 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26849 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26850 If so, we could look for mouse-enter, mouse-leave
26851 properties in PLIST (and do something...). */
26852 hotspot
= XCDR (hotspot
);
26853 if (CONSP (hotspot
)
26854 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26856 pointer
= Fplist_get (plist
, Qpointer
);
26857 if (NILP (pointer
))
26859 help
= Fplist_get (plist
, Qhelp_echo
);
26862 help_echo_string
= help
;
26863 /* Is this correct? ++kfs */
26864 XSETWINDOW (help_echo_window
, w
);
26865 help_echo_object
= w
->buffer
;
26866 help_echo_pos
= charpos
;
26870 if (NILP (pointer
))
26871 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26873 #endif /* HAVE_WINDOW_SYSTEM */
26875 if (STRINGP (string
))
26877 pos
= make_number (charpos
);
26878 /* If we're on a string with `help-echo' text property, arrange
26879 for the help to be displayed. This is done by setting the
26880 global variable help_echo_string to the help string. */
26883 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26886 help_echo_string
= help
;
26887 XSETWINDOW (help_echo_window
, w
);
26888 help_echo_object
= string
;
26889 help_echo_pos
= charpos
;
26893 #ifdef HAVE_WINDOW_SYSTEM
26894 if (FRAME_WINDOW_P (f
))
26896 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26897 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26898 if (NILP (pointer
))
26899 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26901 /* Change the mouse pointer according to what is under X/Y. */
26903 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26906 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26907 if (!KEYMAPP (map
))
26908 map
= Fget_text_property (pos
, Qkeymap
, string
);
26909 if (!KEYMAPP (map
))
26910 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26915 /* Change the mouse face according to what is under X/Y. */
26916 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26917 if (!NILP (mouse_face
)
26918 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26923 struct glyph
* tmp_glyph
;
26927 int total_pixel_width
;
26928 EMACS_INT begpos
, endpos
, ignore
;
26932 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26933 Qmouse_face
, string
, Qnil
);
26939 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26941 endpos
= SCHARS (string
);
26945 /* Calculate the glyph position GPOS of GLYPH in the
26946 displayed string, relative to the beginning of the
26947 highlighted part of the string.
26949 Note: GPOS is different from CHARPOS. CHARPOS is the
26950 position of GLYPH in the internal string object. A mode
26951 line string format has structures which are converted to
26952 a flattened string by the Emacs Lisp interpreter. The
26953 internal string is an element of those structures. The
26954 displayed string is the flattened string. */
26955 tmp_glyph
= row_start_glyph
;
26956 while (tmp_glyph
< glyph
26957 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26958 && begpos
<= tmp_glyph
->charpos
26959 && tmp_glyph
->charpos
< endpos
)))
26961 gpos
= glyph
- tmp_glyph
;
26963 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26964 the highlighted part of the displayed string to which
26965 GLYPH belongs. Note: GSEQ_LENGTH is different from
26966 SCHARS (STRING), because the latter returns the length of
26967 the internal string. */
26968 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26970 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26971 && begpos
<= tmp_glyph
->charpos
26972 && tmp_glyph
->charpos
< endpos
));
26975 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26977 /* Calculate the total pixel width of all the glyphs between
26978 the beginning of the highlighted area and GLYPH. */
26979 total_pixel_width
= 0;
26980 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26981 total_pixel_width
+= tmp_glyph
->pixel_width
;
26983 /* Pre calculation of re-rendering position. Note: X is in
26984 column units here, after the call to mode_line_string or
26985 marginal_area_string. */
26987 vpos
= (area
== ON_MODE_LINE
26988 ? (w
->current_matrix
)->nrows
- 1
26991 /* If GLYPH's position is included in the region that is
26992 already drawn in mouse face, we have nothing to do. */
26993 if ( EQ (window
, hlinfo
->mouse_face_window
)
26994 && (!row
->reversed_p
26995 ? (hlinfo
->mouse_face_beg_col
<= hpos
26996 && hpos
< hlinfo
->mouse_face_end_col
)
26997 /* In R2L rows we swap BEG and END, see below. */
26998 : (hlinfo
->mouse_face_end_col
<= hpos
26999 && hpos
< hlinfo
->mouse_face_beg_col
))
27000 && hlinfo
->mouse_face_beg_row
== vpos
)
27003 if (clear_mouse_face (hlinfo
))
27004 cursor
= No_Cursor
;
27006 if (!row
->reversed_p
)
27008 hlinfo
->mouse_face_beg_col
= hpos
;
27009 hlinfo
->mouse_face_beg_x
= original_x_pixel
27010 - (total_pixel_width
+ dx
);
27011 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
27012 hlinfo
->mouse_face_end_x
= 0;
27016 /* In R2L rows, show_mouse_face expects BEG and END
27017 coordinates to be swapped. */
27018 hlinfo
->mouse_face_end_col
= hpos
;
27019 hlinfo
->mouse_face_end_x
= original_x_pixel
27020 - (total_pixel_width
+ dx
);
27021 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
27022 hlinfo
->mouse_face_beg_x
= 0;
27025 hlinfo
->mouse_face_beg_row
= vpos
;
27026 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
27027 hlinfo
->mouse_face_beg_y
= 0;
27028 hlinfo
->mouse_face_end_y
= 0;
27029 hlinfo
->mouse_face_past_end
= 0;
27030 hlinfo
->mouse_face_window
= window
;
27032 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
27038 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27040 if (NILP (pointer
))
27043 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
27044 clear_mouse_face (hlinfo
);
27046 #ifdef HAVE_WINDOW_SYSTEM
27047 if (FRAME_WINDOW_P (f
))
27048 define_frame_cursor1 (f
, cursor
, pointer
);
27054 Take proper action when the mouse has moved to position X, Y on
27055 frame F as regards highlighting characters that have mouse-face
27056 properties. Also de-highlighting chars where the mouse was before.
27057 X and Y can be negative or out of range. */
27060 note_mouse_highlight (struct frame
*f
, int x
, int y
)
27062 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27063 enum window_part part
= ON_NOTHING
;
27064 Lisp_Object window
;
27066 Cursor cursor
= No_Cursor
;
27067 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
27070 /* When a menu is active, don't highlight because this looks odd. */
27071 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
27072 if (popup_activated ())
27076 if (NILP (Vmouse_highlight
)
27077 || !f
->glyphs_initialized_p
27078 || f
->pointer_invisible
)
27081 hlinfo
->mouse_face_mouse_x
= x
;
27082 hlinfo
->mouse_face_mouse_y
= y
;
27083 hlinfo
->mouse_face_mouse_frame
= f
;
27085 if (hlinfo
->mouse_face_defer
)
27088 if (gc_in_progress
)
27090 hlinfo
->mouse_face_deferred_gc
= 1;
27094 /* Which window is that in? */
27095 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
27097 /* If displaying active text in another window, clear that. */
27098 if (! EQ (window
, hlinfo
->mouse_face_window
)
27099 /* Also clear if we move out of text area in same window. */
27100 || (!NILP (hlinfo
->mouse_face_window
)
27103 && part
!= ON_MODE_LINE
27104 && part
!= ON_HEADER_LINE
))
27105 clear_mouse_face (hlinfo
);
27107 /* Not on a window -> return. */
27108 if (!WINDOWP (window
))
27111 /* Reset help_echo_string. It will get recomputed below. */
27112 help_echo_string
= Qnil
;
27114 /* Convert to window-relative pixel coordinates. */
27115 w
= XWINDOW (window
);
27116 frame_to_window_pixel_xy (w
, &x
, &y
);
27118 #ifdef HAVE_WINDOW_SYSTEM
27119 /* Handle tool-bar window differently since it doesn't display a
27121 if (EQ (window
, f
->tool_bar_window
))
27123 note_tool_bar_highlight (f
, x
, y
);
27128 /* Mouse is on the mode, header line or margin? */
27129 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
27130 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
27132 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
27136 #ifdef HAVE_WINDOW_SYSTEM
27137 if (part
== ON_VERTICAL_BORDER
)
27139 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
27140 help_echo_string
= build_string ("drag-mouse-1: resize");
27142 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
27143 || part
== ON_SCROLL_BAR
)
27144 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27146 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27149 /* Are we in a window whose display is up to date?
27150 And verify the buffer's text has not changed. */
27151 b
= XBUFFER (w
->buffer
);
27152 if (part
== ON_TEXT
27153 && EQ (w
->window_end_valid
, w
->buffer
)
27154 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27155 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27157 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27159 struct glyph
*glyph
;
27160 Lisp_Object object
;
27161 Lisp_Object mouse_face
= Qnil
, position
;
27162 Lisp_Object
*overlay_vec
= NULL
;
27163 ptrdiff_t i
, noverlays
;
27164 struct buffer
*obuf
;
27165 EMACS_INT obegv
, ozv
;
27168 /* Find the glyph under X/Y. */
27169 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27171 #ifdef HAVE_WINDOW_SYSTEM
27172 /* Look for :pointer property on image. */
27173 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27175 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27176 if (img
!= NULL
&& IMAGEP (img
->spec
))
27178 Lisp_Object image_map
, hotspot
;
27179 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27181 && (hotspot
= find_hot_spot (image_map
,
27182 glyph
->slice
.img
.x
+ dx
,
27183 glyph
->slice
.img
.y
+ dy
),
27185 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27189 /* Could check XCAR (hotspot) to see if we enter/leave
27191 If so, we could look for mouse-enter, mouse-leave
27192 properties in PLIST (and do something...). */
27193 hotspot
= XCDR (hotspot
);
27194 if (CONSP (hotspot
)
27195 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27197 pointer
= Fplist_get (plist
, Qpointer
);
27198 if (NILP (pointer
))
27200 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27201 if (!NILP (help_echo_string
))
27203 help_echo_window
= window
;
27204 help_echo_object
= glyph
->object
;
27205 help_echo_pos
= glyph
->charpos
;
27209 if (NILP (pointer
))
27210 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27213 #endif /* HAVE_WINDOW_SYSTEM */
27215 /* Clear mouse face if X/Y not over text. */
27217 || area
!= TEXT_AREA
27218 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27219 /* Glyph's OBJECT is an integer for glyphs inserted by the
27220 display engine for its internal purposes, like truncation
27221 and continuation glyphs and blanks beyond the end of
27222 line's text on text terminals. If we are over such a
27223 glyph, we are not over any text. */
27224 || INTEGERP (glyph
->object
)
27225 /* R2L rows have a stretch glyph at their front, which
27226 stands for no text, whereas L2R rows have no glyphs at
27227 all beyond the end of text. Treat such stretch glyphs
27228 like we do with NULL glyphs in L2R rows. */
27229 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27230 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27231 && glyph
->type
== STRETCH_GLYPH
27232 && glyph
->avoid_cursor_p
))
27234 if (clear_mouse_face (hlinfo
))
27235 cursor
= No_Cursor
;
27236 #ifdef HAVE_WINDOW_SYSTEM
27237 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27239 if (area
!= TEXT_AREA
)
27240 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27242 pointer
= Vvoid_text_area_pointer
;
27248 pos
= glyph
->charpos
;
27249 object
= glyph
->object
;
27250 if (!STRINGP (object
) && !BUFFERP (object
))
27253 /* If we get an out-of-range value, return now; avoid an error. */
27254 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27257 /* Make the window's buffer temporarily current for
27258 overlays_at and compute_char_face. */
27259 obuf
= current_buffer
;
27260 current_buffer
= b
;
27266 /* Is this char mouse-active or does it have help-echo? */
27267 position
= make_number (pos
);
27269 if (BUFFERP (object
))
27271 /* Put all the overlays we want in a vector in overlay_vec. */
27272 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27273 /* Sort overlays into increasing priority order. */
27274 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27279 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27282 cursor
= No_Cursor
;
27284 /* Check mouse-face highlighting. */
27286 /* If there exists an overlay with mouse-face overlapping
27287 the one we are currently highlighting, we have to
27288 check if we enter the overlapping overlay, and then
27289 highlight only that. */
27290 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27291 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27293 /* Find the highest priority overlay with a mouse-face. */
27294 Lisp_Object overlay
= Qnil
;
27295 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27297 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27298 if (!NILP (mouse_face
))
27299 overlay
= overlay_vec
[i
];
27302 /* If we're highlighting the same overlay as before, there's
27303 no need to do that again. */
27304 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27305 goto check_help_echo
;
27306 hlinfo
->mouse_face_overlay
= overlay
;
27308 /* Clear the display of the old active region, if any. */
27309 if (clear_mouse_face (hlinfo
))
27310 cursor
= No_Cursor
;
27312 /* If no overlay applies, get a text property. */
27313 if (NILP (overlay
))
27314 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27316 /* Next, compute the bounds of the mouse highlighting and
27318 if (!NILP (mouse_face
) && STRINGP (object
))
27320 /* The mouse-highlighting comes from a display string
27321 with a mouse-face. */
27325 s
= Fprevious_single_property_change
27326 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27327 e
= Fnext_single_property_change
27328 (position
, Qmouse_face
, object
, Qnil
);
27330 s
= make_number (0);
27332 e
= make_number (SCHARS (object
) - 1);
27333 mouse_face_from_string_pos (w
, hlinfo
, object
,
27334 XINT (s
), XINT (e
));
27335 hlinfo
->mouse_face_past_end
= 0;
27336 hlinfo
->mouse_face_window
= window
;
27337 hlinfo
->mouse_face_face_id
27338 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27339 glyph
->face_id
, 1);
27340 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27341 cursor
= No_Cursor
;
27345 /* The mouse-highlighting, if any, comes from an overlay
27346 or text property in the buffer. */
27347 Lisp_Object buffer
IF_LINT (= Qnil
);
27348 Lisp_Object disp_string
IF_LINT (= Qnil
);
27350 if (STRINGP (object
))
27352 /* If we are on a display string with no mouse-face,
27353 check if the text under it has one. */
27354 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27355 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27356 pos
= string_buffer_position (object
, start
);
27359 mouse_face
= get_char_property_and_overlay
27360 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27361 buffer
= w
->buffer
;
27362 disp_string
= object
;
27368 disp_string
= Qnil
;
27371 if (!NILP (mouse_face
))
27373 Lisp_Object before
, after
;
27374 Lisp_Object before_string
, after_string
;
27375 /* To correctly find the limits of mouse highlight
27376 in a bidi-reordered buffer, we must not use the
27377 optimization of limiting the search in
27378 previous-single-property-change and
27379 next-single-property-change, because
27380 rows_from_pos_range needs the real start and end
27381 positions to DTRT in this case. That's because
27382 the first row visible in a window does not
27383 necessarily display the character whose position
27384 is the smallest. */
27386 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27387 ? Fmarker_position (w
->start
)
27390 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27391 ? make_number (BUF_Z (XBUFFER (buffer
))
27392 - XFASTINT (w
->window_end_pos
))
27395 if (NILP (overlay
))
27397 /* Handle the text property case. */
27398 before
= Fprevious_single_property_change
27399 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27400 after
= Fnext_single_property_change
27401 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27402 before_string
= after_string
= Qnil
;
27406 /* Handle the overlay case. */
27407 before
= Foverlay_start (overlay
);
27408 after
= Foverlay_end (overlay
);
27409 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27410 after_string
= Foverlay_get (overlay
, Qafter_string
);
27412 if (!STRINGP (before_string
)) before_string
= Qnil
;
27413 if (!STRINGP (after_string
)) after_string
= Qnil
;
27416 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27419 : XFASTINT (before
),
27421 ? BUF_Z (XBUFFER (buffer
))
27422 : XFASTINT (after
),
27423 before_string
, after_string
,
27425 cursor
= No_Cursor
;
27432 /* Look for a `help-echo' property. */
27433 if (NILP (help_echo_string
)) {
27434 Lisp_Object help
, overlay
;
27436 /* Check overlays first. */
27437 help
= overlay
= Qnil
;
27438 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27440 overlay
= overlay_vec
[i
];
27441 help
= Foverlay_get (overlay
, Qhelp_echo
);
27446 help_echo_string
= help
;
27447 help_echo_window
= window
;
27448 help_echo_object
= overlay
;
27449 help_echo_pos
= pos
;
27453 Lisp_Object obj
= glyph
->object
;
27454 EMACS_INT charpos
= glyph
->charpos
;
27456 /* Try text properties. */
27459 && charpos
< SCHARS (obj
))
27461 help
= Fget_text_property (make_number (charpos
),
27465 /* If the string itself doesn't specify a help-echo,
27466 see if the buffer text ``under'' it does. */
27467 struct glyph_row
*r
27468 = MATRIX_ROW (w
->current_matrix
, vpos
);
27469 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27470 EMACS_INT p
= string_buffer_position (obj
, start
);
27473 help
= Fget_char_property (make_number (p
),
27474 Qhelp_echo
, w
->buffer
);
27483 else if (BUFFERP (obj
)
27486 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27491 help_echo_string
= help
;
27492 help_echo_window
= window
;
27493 help_echo_object
= obj
;
27494 help_echo_pos
= charpos
;
27499 #ifdef HAVE_WINDOW_SYSTEM
27500 /* Look for a `pointer' property. */
27501 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27503 /* Check overlays first. */
27504 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27505 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27507 if (NILP (pointer
))
27509 Lisp_Object obj
= glyph
->object
;
27510 EMACS_INT charpos
= glyph
->charpos
;
27512 /* Try text properties. */
27515 && charpos
< SCHARS (obj
))
27517 pointer
= Fget_text_property (make_number (charpos
),
27519 if (NILP (pointer
))
27521 /* If the string itself doesn't specify a pointer,
27522 see if the buffer text ``under'' it does. */
27523 struct glyph_row
*r
27524 = MATRIX_ROW (w
->current_matrix
, vpos
);
27525 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27526 EMACS_INT p
= string_buffer_position (obj
, start
);
27528 pointer
= Fget_char_property (make_number (p
),
27529 Qpointer
, w
->buffer
);
27532 else if (BUFFERP (obj
)
27535 pointer
= Fget_text_property (make_number (charpos
),
27539 #endif /* HAVE_WINDOW_SYSTEM */
27543 current_buffer
= obuf
;
27548 #ifdef HAVE_WINDOW_SYSTEM
27549 if (FRAME_WINDOW_P (f
))
27550 define_frame_cursor1 (f
, cursor
, pointer
);
27552 /* This is here to prevent a compiler error, about "label at end of
27553 compound statement". */
27560 Clear any mouse-face on window W. This function is part of the
27561 redisplay interface, and is called from try_window_id and similar
27562 functions to ensure the mouse-highlight is off. */
27565 x_clear_window_mouse_face (struct window
*w
)
27567 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27568 Lisp_Object window
;
27571 XSETWINDOW (window
, w
);
27572 if (EQ (window
, hlinfo
->mouse_face_window
))
27573 clear_mouse_face (hlinfo
);
27579 Just discard the mouse face information for frame F, if any.
27580 This is used when the size of F is changed. */
27583 cancel_mouse_face (struct frame
*f
)
27585 Lisp_Object window
;
27586 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27588 window
= hlinfo
->mouse_face_window
;
27589 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27591 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27592 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27593 hlinfo
->mouse_face_window
= Qnil
;
27599 /***********************************************************************
27601 ***********************************************************************/
27603 #ifdef HAVE_WINDOW_SYSTEM
27605 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27606 which intersects rectangle R. R is in window-relative coordinates. */
27609 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27610 enum glyph_row_area area
)
27612 struct glyph
*first
= row
->glyphs
[area
];
27613 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27614 struct glyph
*last
;
27615 int first_x
, start_x
, x
;
27617 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27618 /* If row extends face to end of line write the whole line. */
27619 draw_glyphs (w
, 0, row
, area
,
27620 0, row
->used
[area
],
27621 DRAW_NORMAL_TEXT
, 0);
27624 /* Set START_X to the window-relative start position for drawing glyphs of
27625 AREA. The first glyph of the text area can be partially visible.
27626 The first glyphs of other areas cannot. */
27627 start_x
= window_box_left_offset (w
, area
);
27629 if (area
== TEXT_AREA
)
27632 /* Find the first glyph that must be redrawn. */
27634 && x
+ first
->pixel_width
< r
->x
)
27636 x
+= first
->pixel_width
;
27640 /* Find the last one. */
27644 && x
< r
->x
+ r
->width
)
27646 x
+= last
->pixel_width
;
27652 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27653 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27654 DRAW_NORMAL_TEXT
, 0);
27659 /* Redraw the parts of the glyph row ROW on window W intersecting
27660 rectangle R. R is in window-relative coordinates. Value is
27661 non-zero if mouse-face was overwritten. */
27664 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27666 xassert (row
->enabled_p
);
27668 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27669 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27670 0, row
->used
[TEXT_AREA
],
27671 DRAW_NORMAL_TEXT
, 0);
27674 if (row
->used
[LEFT_MARGIN_AREA
])
27675 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27676 if (row
->used
[TEXT_AREA
])
27677 expose_area (w
, row
, r
, TEXT_AREA
);
27678 if (row
->used
[RIGHT_MARGIN_AREA
])
27679 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27680 draw_row_fringe_bitmaps (w
, row
);
27683 return row
->mouse_face_p
;
27687 /* Redraw those parts of glyphs rows during expose event handling that
27688 overlap other rows. Redrawing of an exposed line writes over parts
27689 of lines overlapping that exposed line; this function fixes that.
27691 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27692 row in W's current matrix that is exposed and overlaps other rows.
27693 LAST_OVERLAPPING_ROW is the last such row. */
27696 expose_overlaps (struct window
*w
,
27697 struct glyph_row
*first_overlapping_row
,
27698 struct glyph_row
*last_overlapping_row
,
27701 struct glyph_row
*row
;
27703 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27704 if (row
->overlapping_p
)
27706 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27709 if (row
->used
[LEFT_MARGIN_AREA
])
27710 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27712 if (row
->used
[TEXT_AREA
])
27713 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27715 if (row
->used
[RIGHT_MARGIN_AREA
])
27716 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27722 /* Return non-zero if W's cursor intersects rectangle R. */
27725 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27727 XRectangle cr
, result
;
27728 struct glyph
*cursor_glyph
;
27729 struct glyph_row
*row
;
27731 if (w
->phys_cursor
.vpos
>= 0
27732 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27733 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27735 && row
->cursor_in_fringe_p
)
27737 /* Cursor is in the fringe. */
27738 cr
.x
= window_box_right_offset (w
,
27739 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27740 ? RIGHT_MARGIN_AREA
27743 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27744 cr
.height
= row
->height
;
27745 return x_intersect_rectangles (&cr
, r
, &result
);
27748 cursor_glyph
= get_phys_cursor_glyph (w
);
27751 /* r is relative to W's box, but w->phys_cursor.x is relative
27752 to left edge of W's TEXT area. Adjust it. */
27753 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27754 cr
.y
= w
->phys_cursor
.y
;
27755 cr
.width
= cursor_glyph
->pixel_width
;
27756 cr
.height
= w
->phys_cursor_height
;
27757 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27758 I assume the effect is the same -- and this is portable. */
27759 return x_intersect_rectangles (&cr
, r
, &result
);
27761 /* If we don't understand the format, pretend we're not in the hot-spot. */
27767 Draw a vertical window border to the right of window W if W doesn't
27768 have vertical scroll bars. */
27771 x_draw_vertical_border (struct window
*w
)
27773 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27775 /* We could do better, if we knew what type of scroll-bar the adjacent
27776 windows (on either side) have... But we don't :-(
27777 However, I think this works ok. ++KFS 2003-04-25 */
27779 /* Redraw borders between horizontally adjacent windows. Don't
27780 do it for frames with vertical scroll bars because either the
27781 right scroll bar of a window, or the left scroll bar of its
27782 neighbor will suffice as a border. */
27783 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27786 if (!WINDOW_RIGHTMOST_P (w
)
27787 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27789 int x0
, x1
, y0
, y1
;
27791 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27794 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27797 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27799 else if (!WINDOW_LEFTMOST_P (w
)
27800 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27802 int x0
, x1
, y0
, y1
;
27804 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27807 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27810 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27815 /* Redraw the part of window W intersection rectangle FR. Pixel
27816 coordinates in FR are frame-relative. Call this function with
27817 input blocked. Value is non-zero if the exposure overwrites
27821 expose_window (struct window
*w
, XRectangle
*fr
)
27823 struct frame
*f
= XFRAME (w
->frame
);
27825 int mouse_face_overwritten_p
= 0;
27827 /* If window is not yet fully initialized, do nothing. This can
27828 happen when toolkit scroll bars are used and a window is split.
27829 Reconfiguring the scroll bar will generate an expose for a newly
27831 if (w
->current_matrix
== NULL
)
27834 /* When we're currently updating the window, display and current
27835 matrix usually don't agree. Arrange for a thorough display
27837 if (w
== updated_window
)
27839 SET_FRAME_GARBAGED (f
);
27843 /* Frame-relative pixel rectangle of W. */
27844 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27845 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27846 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27847 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27849 if (x_intersect_rectangles (fr
, &wr
, &r
))
27851 int yb
= window_text_bottom_y (w
);
27852 struct glyph_row
*row
;
27853 int cursor_cleared_p
, phys_cursor_on_p
;
27854 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27856 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27857 r
.x
, r
.y
, r
.width
, r
.height
));
27859 /* Convert to window coordinates. */
27860 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27861 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27863 /* Turn off the cursor. */
27864 if (!w
->pseudo_window_p
27865 && phys_cursor_in_rect_p (w
, &r
))
27867 x_clear_cursor (w
);
27868 cursor_cleared_p
= 1;
27871 cursor_cleared_p
= 0;
27873 /* If the row containing the cursor extends face to end of line,
27874 then expose_area might overwrite the cursor outside the
27875 rectangle and thus notice_overwritten_cursor might clear
27876 w->phys_cursor_on_p. We remember the original value and
27877 check later if it is changed. */
27878 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27880 /* Update lines intersecting rectangle R. */
27881 first_overlapping_row
= last_overlapping_row
= NULL
;
27882 for (row
= w
->current_matrix
->rows
;
27887 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27889 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27890 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27891 || (r
.y
>= y0
&& r
.y
< y1
)
27892 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27894 /* A header line may be overlapping, but there is no need
27895 to fix overlapping areas for them. KFS 2005-02-12 */
27896 if (row
->overlapping_p
&& !row
->mode_line_p
)
27898 if (first_overlapping_row
== NULL
)
27899 first_overlapping_row
= row
;
27900 last_overlapping_row
= row
;
27904 if (expose_line (w
, row
, &r
))
27905 mouse_face_overwritten_p
= 1;
27908 else if (row
->overlapping_p
)
27910 /* We must redraw a row overlapping the exposed area. */
27912 ? y0
+ row
->phys_height
> r
.y
27913 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27915 if (first_overlapping_row
== NULL
)
27916 first_overlapping_row
= row
;
27917 last_overlapping_row
= row
;
27925 /* Display the mode line if there is one. */
27926 if (WINDOW_WANTS_MODELINE_P (w
)
27927 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27929 && row
->y
< r
.y
+ r
.height
)
27931 if (expose_line (w
, row
, &r
))
27932 mouse_face_overwritten_p
= 1;
27935 if (!w
->pseudo_window_p
)
27937 /* Fix the display of overlapping rows. */
27938 if (first_overlapping_row
)
27939 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27942 /* Draw border between windows. */
27943 x_draw_vertical_border (w
);
27945 /* Turn the cursor on again. */
27946 if (cursor_cleared_p
27947 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27948 update_window_cursor (w
, 1);
27952 return mouse_face_overwritten_p
;
27957 /* Redraw (parts) of all windows in the window tree rooted at W that
27958 intersect R. R contains frame pixel coordinates. Value is
27959 non-zero if the exposure overwrites mouse-face. */
27962 expose_window_tree (struct window
*w
, XRectangle
*r
)
27964 struct frame
*f
= XFRAME (w
->frame
);
27965 int mouse_face_overwritten_p
= 0;
27967 while (w
&& !FRAME_GARBAGED_P (f
))
27969 if (!NILP (w
->hchild
))
27970 mouse_face_overwritten_p
27971 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27972 else if (!NILP (w
->vchild
))
27973 mouse_face_overwritten_p
27974 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27976 mouse_face_overwritten_p
|= expose_window (w
, r
);
27978 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27981 return mouse_face_overwritten_p
;
27986 Redisplay an exposed area of frame F. X and Y are the upper-left
27987 corner of the exposed rectangle. W and H are width and height of
27988 the exposed area. All are pixel values. W or H zero means redraw
27989 the entire frame. */
27992 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27995 int mouse_face_overwritten_p
= 0;
27997 TRACE ((stderr
, "expose_frame "));
27999 /* No need to redraw if frame will be redrawn soon. */
28000 if (FRAME_GARBAGED_P (f
))
28002 TRACE ((stderr
, " garbaged\n"));
28006 /* If basic faces haven't been realized yet, there is no point in
28007 trying to redraw anything. This can happen when we get an expose
28008 event while Emacs is starting, e.g. by moving another window. */
28009 if (FRAME_FACE_CACHE (f
) == NULL
28010 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
28012 TRACE ((stderr
, " no faces\n"));
28016 if (w
== 0 || h
== 0)
28019 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
28020 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
28030 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
28031 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
28033 if (WINDOWP (f
->tool_bar_window
))
28034 mouse_face_overwritten_p
28035 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
28037 #ifdef HAVE_X_WINDOWS
28039 #ifndef USE_X_TOOLKIT
28040 if (WINDOWP (f
->menu_bar_window
))
28041 mouse_face_overwritten_p
28042 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
28043 #endif /* not USE_X_TOOLKIT */
28047 /* Some window managers support a focus-follows-mouse style with
28048 delayed raising of frames. Imagine a partially obscured frame,
28049 and moving the mouse into partially obscured mouse-face on that
28050 frame. The visible part of the mouse-face will be highlighted,
28051 then the WM raises the obscured frame. With at least one WM, KDE
28052 2.1, Emacs is not getting any event for the raising of the frame
28053 (even tried with SubstructureRedirectMask), only Expose events.
28054 These expose events will draw text normally, i.e. not
28055 highlighted. Which means we must redo the highlight here.
28056 Subsume it under ``we love X''. --gerd 2001-08-15 */
28057 /* Included in Windows version because Windows most likely does not
28058 do the right thing if any third party tool offers
28059 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
28060 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
28062 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28063 if (f
== hlinfo
->mouse_face_mouse_frame
)
28065 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
28066 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
28067 clear_mouse_face (hlinfo
);
28068 note_mouse_highlight (f
, mouse_x
, mouse_y
);
28075 Determine the intersection of two rectangles R1 and R2. Return
28076 the intersection in *RESULT. Value is non-zero if RESULT is not
28080 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
28082 XRectangle
*left
, *right
;
28083 XRectangle
*upper
, *lower
;
28084 int intersection_p
= 0;
28086 /* Rearrange so that R1 is the left-most rectangle. */
28088 left
= r1
, right
= r2
;
28090 left
= r2
, right
= r1
;
28092 /* X0 of the intersection is right.x0, if this is inside R1,
28093 otherwise there is no intersection. */
28094 if (right
->x
<= left
->x
+ left
->width
)
28096 result
->x
= right
->x
;
28098 /* The right end of the intersection is the minimum of
28099 the right ends of left and right. */
28100 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
28103 /* Same game for Y. */
28105 upper
= r1
, lower
= r2
;
28107 upper
= r2
, lower
= r1
;
28109 /* The upper end of the intersection is lower.y0, if this is inside
28110 of upper. Otherwise, there is no intersection. */
28111 if (lower
->y
<= upper
->y
+ upper
->height
)
28113 result
->y
= lower
->y
;
28115 /* The lower end of the intersection is the minimum of the lower
28116 ends of upper and lower. */
28117 result
->height
= (min (lower
->y
+ lower
->height
,
28118 upper
->y
+ upper
->height
)
28120 intersection_p
= 1;
28124 return intersection_p
;
28127 #endif /* HAVE_WINDOW_SYSTEM */
28130 /***********************************************************************
28132 ***********************************************************************/
28135 syms_of_xdisp (void)
28137 Vwith_echo_area_save_vector
= Qnil
;
28138 staticpro (&Vwith_echo_area_save_vector
);
28140 Vmessage_stack
= Qnil
;
28141 staticpro (&Vmessage_stack
);
28143 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
28145 message_dolog_marker1
= Fmake_marker ();
28146 staticpro (&message_dolog_marker1
);
28147 message_dolog_marker2
= Fmake_marker ();
28148 staticpro (&message_dolog_marker2
);
28149 message_dolog_marker3
= Fmake_marker ();
28150 staticpro (&message_dolog_marker3
);
28153 defsubr (&Sdump_frame_glyph_matrix
);
28154 defsubr (&Sdump_glyph_matrix
);
28155 defsubr (&Sdump_glyph_row
);
28156 defsubr (&Sdump_tool_bar_row
);
28157 defsubr (&Strace_redisplay
);
28158 defsubr (&Strace_to_stderr
);
28160 #ifdef HAVE_WINDOW_SYSTEM
28161 defsubr (&Stool_bar_lines_needed
);
28162 defsubr (&Slookup_image_map
);
28164 defsubr (&Sformat_mode_line
);
28165 defsubr (&Sinvisible_p
);
28166 defsubr (&Scurrent_bidi_paragraph_direction
);
28168 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28169 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28170 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28171 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28172 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28173 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28174 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28175 DEFSYM (Qeval
, "eval");
28176 DEFSYM (QCdata
, ":data");
28177 DEFSYM (Qdisplay
, "display");
28178 DEFSYM (Qspace_width
, "space-width");
28179 DEFSYM (Qraise
, "raise");
28180 DEFSYM (Qslice
, "slice");
28181 DEFSYM (Qspace
, "space");
28182 DEFSYM (Qmargin
, "margin");
28183 DEFSYM (Qpointer
, "pointer");
28184 DEFSYM (Qleft_margin
, "left-margin");
28185 DEFSYM (Qright_margin
, "right-margin");
28186 DEFSYM (Qcenter
, "center");
28187 DEFSYM (Qline_height
, "line-height");
28188 DEFSYM (QCalign_to
, ":align-to");
28189 DEFSYM (QCrelative_width
, ":relative-width");
28190 DEFSYM (QCrelative_height
, ":relative-height");
28191 DEFSYM (QCeval
, ":eval");
28192 DEFSYM (QCpropertize
, ":propertize");
28193 DEFSYM (QCfile
, ":file");
28194 DEFSYM (Qfontified
, "fontified");
28195 DEFSYM (Qfontification_functions
, "fontification-functions");
28196 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28197 DEFSYM (Qescape_glyph
, "escape-glyph");
28198 DEFSYM (Qnobreak_space
, "nobreak-space");
28199 DEFSYM (Qimage
, "image");
28200 DEFSYM (Qtext
, "text");
28201 DEFSYM (Qboth
, "both");
28202 DEFSYM (Qboth_horiz
, "both-horiz");
28203 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28204 DEFSYM (QCmap
, ":map");
28205 DEFSYM (QCpointer
, ":pointer");
28206 DEFSYM (Qrect
, "rect");
28207 DEFSYM (Qcircle
, "circle");
28208 DEFSYM (Qpoly
, "poly");
28209 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28210 DEFSYM (Qgrow_only
, "grow-only");
28211 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28212 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28213 DEFSYM (Qposition
, "position");
28214 DEFSYM (Qbuffer_position
, "buffer-position");
28215 DEFSYM (Qobject
, "object");
28216 DEFSYM (Qbar
, "bar");
28217 DEFSYM (Qhbar
, "hbar");
28218 DEFSYM (Qbox
, "box");
28219 DEFSYM (Qhollow
, "hollow");
28220 DEFSYM (Qhand
, "hand");
28221 DEFSYM (Qarrow
, "arrow");
28222 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28224 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28225 Fcons (intern_c_string ("void-variable"), Qnil
)),
28227 staticpro (&list_of_error
);
28229 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28230 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28231 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28232 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28234 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28235 staticpro (&echo_buffer
[0]);
28236 staticpro (&echo_buffer
[1]);
28238 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28239 staticpro (&echo_area_buffer
[0]);
28240 staticpro (&echo_area_buffer
[1]);
28242 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28243 staticpro (&Vmessages_buffer_name
);
28245 mode_line_proptrans_alist
= Qnil
;
28246 staticpro (&mode_line_proptrans_alist
);
28247 mode_line_string_list
= Qnil
;
28248 staticpro (&mode_line_string_list
);
28249 mode_line_string_face
= Qnil
;
28250 staticpro (&mode_line_string_face
);
28251 mode_line_string_face_prop
= Qnil
;
28252 staticpro (&mode_line_string_face_prop
);
28253 Vmode_line_unwind_vector
= Qnil
;
28254 staticpro (&Vmode_line_unwind_vector
);
28256 help_echo_string
= Qnil
;
28257 staticpro (&help_echo_string
);
28258 help_echo_object
= Qnil
;
28259 staticpro (&help_echo_object
);
28260 help_echo_window
= Qnil
;
28261 staticpro (&help_echo_window
);
28262 previous_help_echo_string
= Qnil
;
28263 staticpro (&previous_help_echo_string
);
28264 help_echo_pos
= -1;
28266 DEFSYM (Qright_to_left
, "right-to-left");
28267 DEFSYM (Qleft_to_right
, "left-to-right");
28269 #ifdef HAVE_WINDOW_SYSTEM
28270 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28271 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
28272 For example, if a block cursor is over a tab, it will be drawn as
28273 wide as that tab on the display. */);
28274 x_stretch_cursor_p
= 0;
28277 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28278 doc
: /* *Non-nil means highlight trailing whitespace.
28279 The face used for trailing whitespace is `trailing-whitespace'. */);
28280 Vshow_trailing_whitespace
= Qnil
;
28282 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28283 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28284 If the value is t, Emacs highlights non-ASCII chars which have the
28285 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28286 or `escape-glyph' face respectively.
28288 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28289 U+2011 (non-breaking hyphen) are affected.
28291 Any other non-nil value means to display these characters as a escape
28292 glyph followed by an ordinary space or hyphen.
28294 A value of nil means no special handling of these characters. */);
28295 Vnobreak_char_display
= Qt
;
28297 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28298 doc
: /* *The pointer shape to show in void text areas.
28299 A value of nil means to show the text pointer. Other options are `arrow',
28300 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28301 Vvoid_text_area_pointer
= Qarrow
;
28303 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28304 doc
: /* Non-nil means don't actually do any redisplay.
28305 This is used for internal purposes. */);
28306 Vinhibit_redisplay
= Qnil
;
28308 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28309 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28310 Vglobal_mode_string
= Qnil
;
28312 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28313 doc
: /* Marker for where to display an arrow on top of the buffer text.
28314 This must be the beginning of a line in order to work.
28315 See also `overlay-arrow-string'. */);
28316 Voverlay_arrow_position
= Qnil
;
28318 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28319 doc
: /* String to display as an arrow in non-window frames.
28320 See also `overlay-arrow-position'. */);
28321 Voverlay_arrow_string
= make_pure_c_string ("=>");
28323 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28324 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28325 The symbols on this list are examined during redisplay to determine
28326 where to display overlay arrows. */);
28327 Voverlay_arrow_variable_list
28328 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28330 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28331 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28332 If that fails to bring point back on frame, point is centered instead.
28333 If this is zero, point is always centered after it moves off frame.
28334 If you want scrolling to always be a line at a time, you should set
28335 `scroll-conservatively' to a large value rather than set this to 1. */);
28337 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28338 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28339 If point moves off-screen, redisplay will scroll by up to
28340 `scroll-conservatively' lines in order to bring point just barely
28341 onto the screen again. If that cannot be done, then redisplay
28342 recenters point as usual.
28344 If the value is greater than 100, redisplay will never recenter point,
28345 but will always scroll just enough text to bring point into view, even
28346 if you move far away.
28348 A value of zero means always recenter point if it moves off screen. */);
28349 scroll_conservatively
= 0;
28351 DEFVAR_INT ("scroll-margin", scroll_margin
,
28352 doc
: /* *Number of lines of margin at the top and bottom of a window.
28353 Recenter the window whenever point gets within this many lines
28354 of the top or bottom of the window. */);
28357 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28358 doc
: /* Pixels per inch value for non-window system displays.
28359 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28360 Vdisplay_pixels_per_inch
= make_float (72.0);
28363 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28366 DEFVAR_LISP ("truncate-partial-width-windows",
28367 Vtruncate_partial_width_windows
,
28368 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28369 For an integer value, truncate lines in each window narrower than the
28370 full frame width, provided the window width is less than that integer;
28371 otherwise, respect the value of `truncate-lines'.
28373 For any other non-nil value, truncate lines in all windows that do
28374 not span the full frame width.
28376 A value of nil means to respect the value of `truncate-lines'.
28378 If `word-wrap' is enabled, you might want to reduce this. */);
28379 Vtruncate_partial_width_windows
= make_number (50);
28381 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28382 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28383 Any other value means to use the appropriate face, `mode-line',
28384 `header-line', or `menu' respectively. */);
28385 mode_line_inverse_video
= 1;
28387 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28388 doc
: /* *Maximum buffer size for which line number should be displayed.
28389 If the buffer is bigger than this, the line number does not appear
28390 in the mode line. A value of nil means no limit. */);
28391 Vline_number_display_limit
= Qnil
;
28393 DEFVAR_INT ("line-number-display-limit-width",
28394 line_number_display_limit_width
,
28395 doc
: /* *Maximum line width (in characters) for line number display.
28396 If the average length of the lines near point is bigger than this, then the
28397 line number may be omitted from the mode line. */);
28398 line_number_display_limit_width
= 200;
28400 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28401 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28402 highlight_nonselected_windows
= 0;
28404 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28405 doc
: /* Non-nil if more than one frame is visible on this display.
28406 Minibuffer-only frames don't count, but iconified frames do.
28407 This variable is not guaranteed to be accurate except while processing
28408 `frame-title-format' and `icon-title-format'. */);
28410 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28411 doc
: /* Template for displaying the title bar of visible frames.
28412 \(Assuming the window manager supports this feature.)
28414 This variable has the same structure as `mode-line-format', except that
28415 the %c and %l constructs are ignored. It is used only on frames for
28416 which no explicit name has been set \(see `modify-frame-parameters'). */);
28418 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28419 doc
: /* Template for displaying the title bar of an iconified frame.
28420 \(Assuming the window manager supports this feature.)
28421 This variable has the same structure as `mode-line-format' (which see),
28422 and is used only on frames for which no explicit name has been set
28423 \(see `modify-frame-parameters'). */);
28425 = Vframe_title_format
28426 = pure_cons (intern_c_string ("multiple-frames"),
28427 pure_cons (make_pure_c_string ("%b"),
28428 pure_cons (pure_cons (empty_unibyte_string
,
28429 pure_cons (intern_c_string ("invocation-name"),
28430 pure_cons (make_pure_c_string ("@"),
28431 pure_cons (intern_c_string ("system-name"),
28435 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28436 doc
: /* Maximum number of lines to keep in the message log buffer.
28437 If nil, disable message logging. If t, log messages but don't truncate
28438 the buffer when it becomes large. */);
28439 Vmessage_log_max
= make_number (100);
28441 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28442 doc
: /* Functions called before redisplay, if window sizes have changed.
28443 The value should be a list of functions that take one argument.
28444 Just before redisplay, for each frame, if any of its windows have changed
28445 size since the last redisplay, or have been split or deleted,
28446 all the functions in the list are called, with the frame as argument. */);
28447 Vwindow_size_change_functions
= Qnil
;
28449 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28450 doc
: /* List of functions to call before redisplaying a window with scrolling.
28451 Each function is called with two arguments, the window and its new
28452 display-start position. Note that these functions are also called by
28453 `set-window-buffer'. Also note that the value of `window-end' is not
28454 valid when these functions are called.
28456 Warning: Do not use this feature to alter the way the window
28457 is scrolled. It is not designed for that, and such use probably won't
28459 Vwindow_scroll_functions
= Qnil
;
28461 DEFVAR_LISP ("window-text-change-functions",
28462 Vwindow_text_change_functions
,
28463 doc
: /* Functions to call in redisplay when text in the window might change. */);
28464 Vwindow_text_change_functions
= Qnil
;
28466 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28467 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28468 Each function is called with two arguments, the window and the end trigger value.
28469 See `set-window-redisplay-end-trigger'. */);
28470 Vredisplay_end_trigger_functions
= Qnil
;
28472 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28473 doc
: /* *Non-nil means autoselect window with mouse pointer.
28474 If nil, do not autoselect windows.
28475 A positive number means delay autoselection by that many seconds: a
28476 window is autoselected only after the mouse has remained in that
28477 window for the duration of the delay.
28478 A negative number has a similar effect, but causes windows to be
28479 autoselected only after the mouse has stopped moving. \(Because of
28480 the way Emacs compares mouse events, you will occasionally wait twice
28481 that time before the window gets selected.\)
28482 Any other value means to autoselect window instantaneously when the
28483 mouse pointer enters it.
28485 Autoselection selects the minibuffer only if it is active, and never
28486 unselects the minibuffer if it is active.
28488 When customizing this variable make sure that the actual value of
28489 `focus-follows-mouse' matches the behavior of your window manager. */);
28490 Vmouse_autoselect_window
= Qnil
;
28492 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28493 doc
: /* *Non-nil means automatically resize tool-bars.
28494 This dynamically changes the tool-bar's height to the minimum height
28495 that is needed to make all tool-bar items visible.
28496 If value is `grow-only', the tool-bar's height is only increased
28497 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28498 Vauto_resize_tool_bars
= Qt
;
28500 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28501 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28502 auto_raise_tool_bar_buttons_p
= 1;
28504 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28505 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28506 make_cursor_line_fully_visible_p
= 1;
28508 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28509 doc
: /* *Border below tool-bar in pixels.
28510 If an integer, use it as the height of the border.
28511 If it is one of `internal-border-width' or `border-width', use the
28512 value of the corresponding frame parameter.
28513 Otherwise, no border is added below the tool-bar. */);
28514 Vtool_bar_border
= Qinternal_border_width
;
28516 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28517 doc
: /* *Margin around tool-bar buttons in pixels.
28518 If an integer, use that for both horizontal and vertical margins.
28519 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28520 HORZ specifying the horizontal margin, and VERT specifying the
28521 vertical margin. */);
28522 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28524 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28525 doc
: /* *Relief thickness of tool-bar buttons. */);
28526 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28528 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28529 doc
: /* Tool bar style to use.
28531 image - show images only
28532 text - show text only
28533 both - show both, text below image
28534 both-horiz - show text to the right of the image
28535 text-image-horiz - show text to the left of the image
28536 any other - use system default or image if no system default. */);
28537 Vtool_bar_style
= Qnil
;
28539 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28540 doc
: /* *Maximum number of characters a label can have to be shown.
28541 The tool bar style must also show labels for this to have any effect, see
28542 `tool-bar-style'. */);
28543 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28545 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28546 doc
: /* List of functions to call to fontify regions of text.
28547 Each function is called with one argument POS. Functions must
28548 fontify a region starting at POS in the current buffer, and give
28549 fontified regions the property `fontified'. */);
28550 Vfontification_functions
= Qnil
;
28551 Fmake_variable_buffer_local (Qfontification_functions
);
28553 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28554 unibyte_display_via_language_environment
,
28555 doc
: /* *Non-nil means display unibyte text according to language environment.
28556 Specifically, this means that raw bytes in the range 160-255 decimal
28557 are displayed by converting them to the equivalent multibyte characters
28558 according to the current language environment. As a result, they are
28559 displayed according to the current fontset.
28561 Note that this variable affects only how these bytes are displayed,
28562 but does not change the fact they are interpreted as raw bytes. */);
28563 unibyte_display_via_language_environment
= 0;
28565 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28566 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28567 If a float, it specifies a fraction of the mini-window frame's height.
28568 If an integer, it specifies a number of lines. */);
28569 Vmax_mini_window_height
= make_float (0.25);
28571 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28572 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28573 A value of nil means don't automatically resize mini-windows.
28574 A value of t means resize them to fit the text displayed in them.
28575 A value of `grow-only', the default, means let mini-windows grow only;
28576 they return to their normal size when the minibuffer is closed, or the
28577 echo area becomes empty. */);
28578 Vresize_mini_windows
= Qgrow_only
;
28580 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28581 doc
: /* Alist specifying how to blink the cursor off.
28582 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28583 `cursor-type' frame-parameter or variable equals ON-STATE,
28584 comparing using `equal', Emacs uses OFF-STATE to specify
28585 how to blink it off. ON-STATE and OFF-STATE are values for
28586 the `cursor-type' frame parameter.
28588 If a frame's ON-STATE has no entry in this list,
28589 the frame's other specifications determine how to blink the cursor off. */);
28590 Vblink_cursor_alist
= Qnil
;
28592 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28593 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28594 If non-nil, windows are automatically scrolled horizontally to make
28595 point visible. */);
28596 automatic_hscrolling_p
= 1;
28597 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28599 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28600 doc
: /* *How many columns away from the window edge point is allowed to get
28601 before automatic hscrolling will horizontally scroll the window. */);
28602 hscroll_margin
= 5;
28604 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28605 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28606 When point is less than `hscroll-margin' columns from the window
28607 edge, automatic hscrolling will scroll the window by the amount of columns
28608 determined by this variable. If its value is a positive integer, scroll that
28609 many columns. If it's a positive floating-point number, it specifies the
28610 fraction of the window's width to scroll. If it's nil or zero, point will be
28611 centered horizontally after the scroll. Any other value, including negative
28612 numbers, are treated as if the value were zero.
28614 Automatic hscrolling always moves point outside the scroll margin, so if
28615 point was more than scroll step columns inside the margin, the window will
28616 scroll more than the value given by the scroll step.
28618 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28619 and `scroll-right' overrides this variable's effect. */);
28620 Vhscroll_step
= make_number (0);
28622 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28623 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28624 Bind this around calls to `message' to let it take effect. */);
28625 message_truncate_lines
= 0;
28627 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28628 doc
: /* Normal hook run to update the menu bar definitions.
28629 Redisplay runs this hook before it redisplays the menu bar.
28630 This is used to update submenus such as Buffers,
28631 whose contents depend on various data. */);
28632 Vmenu_bar_update_hook
= Qnil
;
28634 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28635 doc
: /* Frame for which we are updating a menu.
28636 The enable predicate for a menu binding should check this variable. */);
28637 Vmenu_updating_frame
= Qnil
;
28639 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28640 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28641 inhibit_menubar_update
= 0;
28643 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28644 doc
: /* Prefix prepended to all continuation lines at display time.
28645 The value may be a string, an image, or a stretch-glyph; it is
28646 interpreted in the same way as the value of a `display' text property.
28648 This variable is overridden by any `wrap-prefix' text or overlay
28651 To add a prefix to non-continuation lines, use `line-prefix'. */);
28652 Vwrap_prefix
= Qnil
;
28653 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28654 Fmake_variable_buffer_local (Qwrap_prefix
);
28656 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28657 doc
: /* Prefix prepended to all non-continuation lines at display time.
28658 The value may be a string, an image, or a stretch-glyph; it is
28659 interpreted in the same way as the value of a `display' text property.
28661 This variable is overridden by any `line-prefix' text or overlay
28664 To add a prefix to continuation lines, use `wrap-prefix'. */);
28665 Vline_prefix
= Qnil
;
28666 DEFSYM (Qline_prefix
, "line-prefix");
28667 Fmake_variable_buffer_local (Qline_prefix
);
28669 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28670 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28671 inhibit_eval_during_redisplay
= 0;
28673 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28674 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28675 inhibit_free_realized_faces
= 0;
28678 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28679 doc
: /* Inhibit try_window_id display optimization. */);
28680 inhibit_try_window_id
= 0;
28682 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28683 doc
: /* Inhibit try_window_reusing display optimization. */);
28684 inhibit_try_window_reusing
= 0;
28686 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28687 doc
: /* Inhibit try_cursor_movement display optimization. */);
28688 inhibit_try_cursor_movement
= 0;
28689 #endif /* GLYPH_DEBUG */
28691 DEFVAR_INT ("overline-margin", overline_margin
,
28692 doc
: /* *Space between overline and text, in pixels.
28693 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28694 margin to the character height. */);
28695 overline_margin
= 2;
28697 DEFVAR_INT ("underline-minimum-offset",
28698 underline_minimum_offset
,
28699 doc
: /* Minimum distance between baseline and underline.
28700 This can improve legibility of underlined text at small font sizes,
28701 particularly when using variable `x-use-underline-position-properties'
28702 with fonts that specify an UNDERLINE_POSITION relatively close to the
28703 baseline. The default value is 1. */);
28704 underline_minimum_offset
= 1;
28706 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28707 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28708 This feature only works when on a window system that can change
28709 cursor shapes. */);
28710 display_hourglass_p
= 1;
28712 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28713 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28714 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28716 hourglass_atimer
= NULL
;
28717 hourglass_shown_p
= 0;
28719 DEFSYM (Qglyphless_char
, "glyphless-char");
28720 DEFSYM (Qhex_code
, "hex-code");
28721 DEFSYM (Qempty_box
, "empty-box");
28722 DEFSYM (Qthin_space
, "thin-space");
28723 DEFSYM (Qzero_width
, "zero-width");
28725 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28726 /* Intern this now in case it isn't already done.
28727 Setting this variable twice is harmless.
28728 But don't staticpro it here--that is done in alloc.c. */
28729 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28730 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28732 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28733 doc
: /* Char-table defining glyphless characters.
28734 Each element, if non-nil, should be one of the following:
28735 an ASCII acronym string: display this string in a box
28736 `hex-code': display the hexadecimal code of a character in a box
28737 `empty-box': display as an empty box
28738 `thin-space': display as 1-pixel width space
28739 `zero-width': don't display
28740 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28741 display method for graphical terminals and text terminals respectively.
28742 GRAPHICAL and TEXT should each have one of the values listed above.
28744 The char-table has one extra slot to control the display of a character for
28745 which no font is found. This slot only takes effect on graphical terminals.
28746 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28747 `thin-space'. The default is `empty-box'. */);
28748 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28749 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28754 /* Initialize this module when Emacs starts. */
28759 current_header_line_height
= current_mode_line_height
= -1;
28761 CHARPOS (this_line_start_pos
) = 0;
28763 if (!noninteractive
)
28765 struct window
*m
= XWINDOW (minibuf_window
);
28766 Lisp_Object frame
= m
->frame
;
28767 struct frame
*f
= XFRAME (frame
);
28768 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28769 struct window
*r
= XWINDOW (root
);
28772 echo_area_window
= minibuf_window
;
28774 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28775 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28776 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28777 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28778 XSETFASTINT (m
->total_lines
, 1);
28779 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28781 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28782 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28783 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28785 /* The default ellipsis glyphs `...'. */
28786 for (i
= 0; i
< 3; ++i
)
28787 default_invis_vector
[i
] = make_number ('.');
28791 /* Allocate the buffer for frame titles.
28792 Also used for `format-mode-line'. */
28794 mode_line_noprop_buf
= (char *) xmalloc (size
);
28795 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28796 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28797 mode_line_target
= MODE_LINE_DISPLAY
;
28800 help_echo_showing_p
= 0;
28803 /* Since w32 does not support atimers, it defines its own implementation of
28804 the following three functions in w32fns.c. */
28807 /* Platform-independent portion of hourglass implementation. */
28809 /* Return non-zero if hourglass timer has been started or hourglass is
28812 hourglass_started (void)
28814 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28817 /* Cancel a currently active hourglass timer, and start a new one. */
28819 start_hourglass (void)
28821 #if defined (HAVE_WINDOW_SYSTEM)
28823 int secs
, usecs
= 0;
28825 cancel_hourglass ();
28827 if (INTEGERP (Vhourglass_delay
)
28828 && XINT (Vhourglass_delay
) > 0)
28829 secs
= XFASTINT (Vhourglass_delay
);
28830 else if (FLOATP (Vhourglass_delay
)
28831 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28834 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28835 secs
= XFASTINT (tem
);
28836 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28839 secs
= DEFAULT_HOURGLASS_DELAY
;
28841 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28842 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28843 show_hourglass
, NULL
);
28848 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28851 cancel_hourglass (void)
28853 #if defined (HAVE_WINDOW_SYSTEM)
28854 if (hourglass_atimer
)
28856 cancel_atimer (hourglass_atimer
);
28857 hourglass_atimer
= NULL
;
28860 if (hourglass_shown_p
)
28864 #endif /* ! WINDOWSNT */