1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache(); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1214 /* Return 1 if position CHARPOS is visible in window W.
1215 CHARPOS < 0 means return info about WINDOW_END position.
1216 If visible, set *X and *Y to pixel coordinates of top left corner.
1217 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1218 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1221 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1222 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1225 void *itdata
= bidi_shelve_cache ();
1226 struct text_pos top
;
1228 struct buffer
*old_buffer
= NULL
;
1230 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1233 if (XBUFFER (w
->buffer
) != current_buffer
)
1235 old_buffer
= current_buffer
;
1236 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1239 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1241 /* Compute exact mode line heights. */
1242 if (WINDOW_WANTS_MODELINE_P (w
))
1243 current_mode_line_height
1244 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1245 BVAR (current_buffer
, mode_line_format
));
1247 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1248 current_header_line_height
1249 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1250 BVAR (current_buffer
, header_line_format
));
1252 start_display (&it
, w
, top
);
1253 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1254 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1257 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1258 && IT_CHARPOS (it
) >= charpos
)
1259 /* When scanning backwards under bidi iteration, move_it_to
1260 stops at or _before_ CHARPOS, because it stops at or to
1261 the _right_ of the character at CHARPOS. */
1262 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1263 && IT_CHARPOS (it
) <= charpos
)))
1265 /* We have reached CHARPOS, or passed it. How the call to
1266 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1267 or covered by a display property, move_it_to stops at the end
1268 of the invisible text, to the right of CHARPOS. (ii) If
1269 CHARPOS is in a display vector, move_it_to stops on its last
1271 int top_x
= it
.current_x
;
1272 int top_y
= it
.current_y
;
1273 enum it_method it_method
= it
.method
;
1274 /* Calling line_bottom_y may change it.method, it.position, etc. */
1275 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1276 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1278 if (top_y
< window_top_y
)
1279 visible_p
= bottom_y
> window_top_y
;
1280 else if (top_y
< it
.last_visible_y
)
1284 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1286 /* We stopped on the last glyph of a display vector.
1287 Try and recompute. Hack alert! */
1288 if (charpos
< 2 || top
.charpos
>= charpos
)
1289 top_x
= it
.glyph_row
->x
;
1293 start_display (&it2
, w
, top
);
1294 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1295 get_next_display_element (&it2
);
1296 PRODUCE_GLYPHS (&it2
);
1297 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1298 || it2
.current_x
> it2
.last_visible_x
)
1299 top_x
= it
.glyph_row
->x
;
1302 top_x
= it2
.current_x
;
1303 top_y
= it2
.current_y
;
1309 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1310 *rtop
= max (0, window_top_y
- top_y
);
1311 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1312 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1313 - max (top_y
, window_top_y
)));
1319 /* We were asked to provide info about WINDOW_END. */
1321 void *it2data
= NULL
;
1323 SAVE_IT (it2
, it
, it2data
);
1324 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1325 move_it_by_lines (&it
, 1);
1326 if (charpos
< IT_CHARPOS (it
)
1327 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1330 RESTORE_IT (&it2
, &it2
, it2data
);
1331 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1333 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1334 *rtop
= max (0, -it2
.current_y
);
1335 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1336 - it
.last_visible_y
));
1337 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1339 - max (it2
.current_y
,
1340 WINDOW_HEADER_LINE_HEIGHT (w
))));
1344 bidi_unshelve_cache (it2data
, 1);
1346 bidi_unshelve_cache (itdata
, 0);
1349 set_buffer_internal_1 (old_buffer
);
1351 current_header_line_height
= current_mode_line_height
= -1;
1353 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1354 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1357 /* Debugging code. */
1359 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1360 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1362 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1369 /* Return the next character from STR. Return in *LEN the length of
1370 the character. This is like STRING_CHAR_AND_LENGTH but never
1371 returns an invalid character. If we find one, we return a `?', but
1372 with the length of the invalid character. */
1375 string_char_and_length (const unsigned char *str
, int *len
)
1379 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1380 if (!CHAR_VALID_P (c
))
1381 /* We may not change the length here because other places in Emacs
1382 don't use this function, i.e. they silently accept invalid
1391 /* Given a position POS containing a valid character and byte position
1392 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1394 static struct text_pos
1395 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1397 xassert (STRINGP (string
) && nchars
>= 0);
1399 if (STRING_MULTIBYTE (string
))
1401 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1406 string_char_and_length (p
, &len
);
1409 BYTEPOS (pos
) += len
;
1413 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1419 /* Value is the text position, i.e. character and byte position,
1420 for character position CHARPOS in STRING. */
1422 static inline struct text_pos
1423 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1425 struct text_pos pos
;
1426 xassert (STRINGP (string
));
1427 xassert (charpos
>= 0);
1428 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1433 /* Value is a text position, i.e. character and byte position, for
1434 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1435 means recognize multibyte characters. */
1437 static struct text_pos
1438 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1440 struct text_pos pos
;
1442 xassert (s
!= NULL
);
1443 xassert (charpos
>= 0);
1449 SET_TEXT_POS (pos
, 0, 0);
1452 string_char_and_length ((const unsigned char *) s
, &len
);
1455 BYTEPOS (pos
) += len
;
1459 SET_TEXT_POS (pos
, charpos
, charpos
);
1465 /* Value is the number of characters in C string S. MULTIBYTE_P
1466 non-zero means recognize multibyte characters. */
1469 number_of_chars (const char *s
, int multibyte_p
)
1475 EMACS_INT rest
= strlen (s
);
1477 const unsigned char *p
= (const unsigned char *) s
;
1479 for (nchars
= 0; rest
> 0; ++nchars
)
1481 string_char_and_length (p
, &len
);
1482 rest
-= len
, p
+= len
;
1486 nchars
= strlen (s
);
1492 /* Compute byte position NEWPOS->bytepos corresponding to
1493 NEWPOS->charpos. POS is a known position in string STRING.
1494 NEWPOS->charpos must be >= POS.charpos. */
1497 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1499 xassert (STRINGP (string
));
1500 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1502 if (STRING_MULTIBYTE (string
))
1503 *newpos
= string_pos_nchars_ahead (pos
, string
,
1504 CHARPOS (*newpos
) - CHARPOS (pos
));
1506 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1510 Return an estimation of the pixel height of mode or header lines on
1511 frame F. FACE_ID specifies what line's height to estimate. */
1514 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1516 #ifdef HAVE_WINDOW_SYSTEM
1517 if (FRAME_WINDOW_P (f
))
1519 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1521 /* This function is called so early when Emacs starts that the face
1522 cache and mode line face are not yet initialized. */
1523 if (FRAME_FACE_CACHE (f
))
1525 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1529 height
= FONT_HEIGHT (face
->font
);
1530 if (face
->box_line_width
> 0)
1531 height
+= 2 * face
->box_line_width
;
1542 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1543 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1544 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1545 not force the value into range. */
1548 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1549 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1552 #ifdef HAVE_WINDOW_SYSTEM
1553 if (FRAME_WINDOW_P (f
))
1555 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1556 even for negative values. */
1558 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1560 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1562 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1563 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1566 STORE_NATIVE_RECT (*bounds
,
1567 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1568 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1569 FRAME_COLUMN_WIDTH (f
) - 1,
1570 FRAME_LINE_HEIGHT (f
) - 1);
1576 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1577 pix_x
= FRAME_TOTAL_COLS (f
);
1581 else if (pix_y
> FRAME_LINES (f
))
1582 pix_y
= FRAME_LINES (f
);
1592 /* Find the glyph under window-relative coordinates X/Y in window W.
1593 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1594 strings. Return in *HPOS and *VPOS the row and column number of
1595 the glyph found. Return in *AREA the glyph area containing X.
1596 Value is a pointer to the glyph found or null if X/Y is not on
1597 text, or we can't tell because W's current matrix is not up to
1602 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1603 int *dx
, int *dy
, int *area
)
1605 struct glyph
*glyph
, *end
;
1606 struct glyph_row
*row
= NULL
;
1609 /* Find row containing Y. Give up if some row is not enabled. */
1610 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1612 row
= MATRIX_ROW (w
->current_matrix
, i
);
1613 if (!row
->enabled_p
)
1615 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1622 /* Give up if Y is not in the window. */
1623 if (i
== w
->current_matrix
->nrows
)
1626 /* Get the glyph area containing X. */
1627 if (w
->pseudo_window_p
)
1634 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1636 *area
= LEFT_MARGIN_AREA
;
1637 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1639 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1642 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1646 *area
= RIGHT_MARGIN_AREA
;
1647 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1651 /* Find glyph containing X. */
1652 glyph
= row
->glyphs
[*area
];
1653 end
= glyph
+ row
->used
[*area
];
1655 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1657 x
-= glyph
->pixel_width
;
1667 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1670 *hpos
= glyph
- row
->glyphs
[*area
];
1674 /* Convert frame-relative x/y to coordinates relative to window W.
1675 Takes pseudo-windows into account. */
1678 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1680 if (w
->pseudo_window_p
)
1682 /* A pseudo-window is always full-width, and starts at the
1683 left edge of the frame, plus a frame border. */
1684 struct frame
*f
= XFRAME (w
->frame
);
1685 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1686 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1690 *x
-= WINDOW_LEFT_EDGE_X (w
);
1691 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1695 #ifdef HAVE_WINDOW_SYSTEM
1698 Return in RECTS[] at most N clipping rectangles for glyph string S.
1699 Return the number of stored rectangles. */
1702 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1709 if (s
->row
->full_width_p
)
1711 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1712 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1713 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1715 /* Unless displaying a mode or menu bar line, which are always
1716 fully visible, clip to the visible part of the row. */
1717 if (s
->w
->pseudo_window_p
)
1718 r
.height
= s
->row
->visible_height
;
1720 r
.height
= s
->height
;
1724 /* This is a text line that may be partially visible. */
1725 r
.x
= window_box_left (s
->w
, s
->area
);
1726 r
.width
= window_box_width (s
->w
, s
->area
);
1727 r
.height
= s
->row
->visible_height
;
1731 if (r
.x
< s
->clip_head
->x
)
1733 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1734 r
.width
-= s
->clip_head
->x
- r
.x
;
1737 r
.x
= s
->clip_head
->x
;
1740 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1742 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1743 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1748 /* If S draws overlapping rows, it's sufficient to use the top and
1749 bottom of the window for clipping because this glyph string
1750 intentionally draws over other lines. */
1751 if (s
->for_overlaps
)
1753 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1754 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1756 /* Alas, the above simple strategy does not work for the
1757 environments with anti-aliased text: if the same text is
1758 drawn onto the same place multiple times, it gets thicker.
1759 If the overlap we are processing is for the erased cursor, we
1760 take the intersection with the rectagle of the cursor. */
1761 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1763 XRectangle rc
, r_save
= r
;
1765 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1766 rc
.y
= s
->w
->phys_cursor
.y
;
1767 rc
.width
= s
->w
->phys_cursor_width
;
1768 rc
.height
= s
->w
->phys_cursor_height
;
1770 x_intersect_rectangles (&r_save
, &rc
, &r
);
1775 /* Don't use S->y for clipping because it doesn't take partially
1776 visible lines into account. For example, it can be negative for
1777 partially visible lines at the top of a window. */
1778 if (!s
->row
->full_width_p
1779 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1780 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1782 r
.y
= max (0, s
->row
->y
);
1785 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1787 /* If drawing the cursor, don't let glyph draw outside its
1788 advertised boundaries. Cleartype does this under some circumstances. */
1789 if (s
->hl
== DRAW_CURSOR
)
1791 struct glyph
*glyph
= s
->first_glyph
;
1796 r
.width
-= s
->x
- r
.x
;
1799 r
.width
= min (r
.width
, glyph
->pixel_width
);
1801 /* If r.y is below window bottom, ensure that we still see a cursor. */
1802 height
= min (glyph
->ascent
+ glyph
->descent
,
1803 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1804 max_y
= window_text_bottom_y (s
->w
) - height
;
1805 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1806 if (s
->ybase
- glyph
->ascent
> max_y
)
1813 /* Don't draw cursor glyph taller than our actual glyph. */
1814 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1815 if (height
< r
.height
)
1817 max_y
= r
.y
+ r
.height
;
1818 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1819 r
.height
= min (max_y
- r
.y
, height
);
1826 XRectangle r_save
= r
;
1828 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1832 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1833 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1835 #ifdef CONVERT_FROM_XRECT
1836 CONVERT_FROM_XRECT (r
, *rects
);
1844 /* If we are processing overlapping and allowed to return
1845 multiple clipping rectangles, we exclude the row of the glyph
1846 string from the clipping rectangle. This is to avoid drawing
1847 the same text on the environment with anti-aliasing. */
1848 #ifdef CONVERT_FROM_XRECT
1851 XRectangle
*rs
= rects
;
1853 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
1855 if (s
->for_overlaps
& OVERLAPS_PRED
)
1858 if (r
.y
+ r
.height
> row_y
)
1861 rs
[i
].height
= row_y
- r
.y
;
1867 if (s
->for_overlaps
& OVERLAPS_SUCC
)
1870 if (r
.y
< row_y
+ s
->row
->visible_height
)
1872 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
1874 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
1875 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
1884 #ifdef CONVERT_FROM_XRECT
1885 for (i
= 0; i
< n
; i
++)
1886 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
1893 Return in *NR the clipping rectangle for glyph string S. */
1896 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
1898 get_glyph_string_clip_rects (s
, nr
, 1);
1903 Return the position and height of the phys cursor in window W.
1904 Set w->phys_cursor_width to width of phys cursor.
1908 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
1909 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
1911 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
1912 int x
, y
, wd
, h
, h0
, y0
;
1914 /* Compute the width of the rectangle to draw. If on a stretch
1915 glyph, and `x-stretch-block-cursor' is nil, don't draw a
1916 rectangle as wide as the glyph, but use a canonical character
1918 wd
= glyph
->pixel_width
- 1;
1919 #if defined(HAVE_NTGUI) || defined(HAVE_NS)
1923 x
= w
->phys_cursor
.x
;
1930 if (glyph
->type
== STRETCH_GLYPH
1931 && !x_stretch_cursor_p
)
1932 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
1933 w
->phys_cursor_width
= wd
;
1935 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
1937 /* If y is below window bottom, ensure that we still see a cursor. */
1938 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
1940 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
1941 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
1943 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
1946 h
= max (h
- (y0
- y
) + 1, h0
);
1951 y0
= window_text_bottom_y (w
) - h0
;
1959 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
1960 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
1965 * Remember which glyph the mouse is over.
1969 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
1973 struct glyph_row
*r
, *gr
, *end_row
;
1974 enum window_part part
;
1975 enum glyph_row_area area
;
1976 int x
, y
, width
, height
;
1978 /* Try to determine frame pixel position and size of the glyph under
1979 frame pixel coordinates X/Y on frame F. */
1981 if (!f
->glyphs_initialized_p
1982 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
1985 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
1986 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
1990 w
= XWINDOW (window
);
1991 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
1992 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
1994 x
= window_relative_x_coord (w
, part
, gx
);
1995 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
1997 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
1998 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2000 if (w
->pseudo_window_p
)
2003 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2009 case ON_LEFT_MARGIN
:
2010 area
= LEFT_MARGIN_AREA
;
2013 case ON_RIGHT_MARGIN
:
2014 area
= RIGHT_MARGIN_AREA
;
2017 case ON_HEADER_LINE
:
2019 gr
= (part
== ON_HEADER_LINE
2020 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2021 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2024 goto text_glyph_row_found
;
2031 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2032 if (r
->y
+ r
->height
> y
)
2038 text_glyph_row_found
:
2041 struct glyph
*g
= gr
->glyphs
[area
];
2042 struct glyph
*end
= g
+ gr
->used
[area
];
2044 height
= gr
->height
;
2045 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2046 if (gx
+ g
->pixel_width
> x
)
2051 if (g
->type
== IMAGE_GLYPH
)
2053 /* Don't remember when mouse is over image, as
2054 image may have hot-spots. */
2055 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2058 width
= g
->pixel_width
;
2062 /* Use nominal char spacing at end of line. */
2064 gx
+= (x
/ width
) * width
;
2067 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2068 gx
+= window_box_left_offset (w
, area
);
2072 /* Use nominal line height at end of window. */
2073 gx
= (x
/ width
) * width
;
2075 gy
+= (y
/ height
) * height
;
2079 case ON_LEFT_FRINGE
:
2080 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2081 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2082 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2083 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2086 case ON_RIGHT_FRINGE
:
2087 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2088 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2089 : window_box_right_offset (w
, TEXT_AREA
));
2090 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2094 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2096 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2097 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2098 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2100 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2104 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2105 if (r
->y
+ r
->height
> y
)
2112 height
= gr
->height
;
2115 /* Use nominal line height at end of window. */
2117 gy
+= (y
/ height
) * height
;
2124 /* If there is no glyph under the mouse, then we divide the screen
2125 into a grid of the smallest glyph in the frame, and use that
2128 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2129 round down even for negative values. */
2135 gx
= (gx
/ width
) * width
;
2136 gy
= (gy
/ height
) * height
;
2141 gx
+= WINDOW_LEFT_EDGE_X (w
);
2142 gy
+= WINDOW_TOP_EDGE_Y (w
);
2145 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2147 /* Visible feedback for debugging. */
2150 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2151 f
->output_data
.x
->normal_gc
,
2152 gx
, gy
, width
, height
);
2158 #endif /* HAVE_WINDOW_SYSTEM */
2161 /***********************************************************************
2162 Lisp form evaluation
2163 ***********************************************************************/
2165 /* Error handler for safe_eval and safe_call. */
2168 safe_eval_handler (Lisp_Object arg
)
2170 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2175 /* Evaluate SEXPR and return the result, or nil if something went
2176 wrong. Prevent redisplay during the evaluation. */
2178 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2179 Return the result, or nil if something went wrong. Prevent
2180 redisplay during the evaluation. */
2183 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2187 if (inhibit_eval_during_redisplay
)
2191 int count
= SPECPDL_INDEX ();
2192 struct gcpro gcpro1
;
2195 gcpro1
.nvars
= nargs
;
2196 specbind (Qinhibit_redisplay
, Qt
);
2197 /* Use Qt to ensure debugger does not run,
2198 so there is no possibility of wanting to redisplay. */
2199 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2202 val
= unbind_to (count
, val
);
2209 /* Call function FN with one argument ARG.
2210 Return the result, or nil if something went wrong. */
2213 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2215 Lisp_Object args
[2];
2218 return safe_call (2, args
);
2221 static Lisp_Object Qeval
;
2224 safe_eval (Lisp_Object sexpr
)
2226 return safe_call1 (Qeval
, sexpr
);
2229 /* Call function FN with one argument ARG.
2230 Return the result, or nil if something went wrong. */
2233 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2235 Lisp_Object args
[3];
2239 return safe_call (3, args
);
2244 /***********************************************************************
2246 ***********************************************************************/
2250 /* Define CHECK_IT to perform sanity checks on iterators.
2251 This is for debugging. It is too slow to do unconditionally. */
2254 check_it (struct it
*it
)
2256 if (it
->method
== GET_FROM_STRING
)
2258 xassert (STRINGP (it
->string
));
2259 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2263 xassert (IT_STRING_CHARPOS (*it
) < 0);
2264 if (it
->method
== GET_FROM_BUFFER
)
2266 /* Check that character and byte positions agree. */
2267 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2272 xassert (it
->current
.dpvec_index
>= 0);
2274 xassert (it
->current
.dpvec_index
< 0);
2277 #define CHECK_IT(IT) check_it ((IT))
2281 #define CHECK_IT(IT) (void) 0
2286 #if GLYPH_DEBUG && XASSERTS
2288 /* Check that the window end of window W is what we expect it
2289 to be---the last row in the current matrix displaying text. */
2292 check_window_end (struct window
*w
)
2294 if (!MINI_WINDOW_P (w
)
2295 && !NILP (w
->window_end_valid
))
2297 struct glyph_row
*row
;
2298 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2299 XFASTINT (w
->window_end_vpos
)),
2301 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2302 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2306 #define CHECK_WINDOW_END(W) check_window_end ((W))
2310 #define CHECK_WINDOW_END(W) (void) 0
2316 /***********************************************************************
2317 Iterator initialization
2318 ***********************************************************************/
2320 /* Initialize IT for displaying current_buffer in window W, starting
2321 at character position CHARPOS. CHARPOS < 0 means that no buffer
2322 position is specified which is useful when the iterator is assigned
2323 a position later. BYTEPOS is the byte position corresponding to
2324 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2326 If ROW is not null, calls to produce_glyphs with IT as parameter
2327 will produce glyphs in that row.
2329 BASE_FACE_ID is the id of a base face to use. It must be one of
2330 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2331 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2332 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2334 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2335 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2336 will be initialized to use the corresponding mode line glyph row of
2337 the desired matrix of W. */
2340 init_iterator (struct it
*it
, struct window
*w
,
2341 EMACS_INT charpos
, EMACS_INT bytepos
,
2342 struct glyph_row
*row
, enum face_id base_face_id
)
2344 int highlight_region_p
;
2345 enum face_id remapped_base_face_id
= base_face_id
;
2347 /* Some precondition checks. */
2348 xassert (w
!= NULL
&& it
!= NULL
);
2349 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2352 /* If face attributes have been changed since the last redisplay,
2353 free realized faces now because they depend on face definitions
2354 that might have changed. Don't free faces while there might be
2355 desired matrices pending which reference these faces. */
2356 if (face_change_count
&& !inhibit_free_realized_faces
)
2358 face_change_count
= 0;
2359 free_all_realized_faces (Qnil
);
2362 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2363 if (! NILP (Vface_remapping_alist
))
2364 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2366 /* Use one of the mode line rows of W's desired matrix if
2370 if (base_face_id
== MODE_LINE_FACE_ID
2371 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2372 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2373 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2374 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2378 memset (it
, 0, sizeof *it
);
2379 it
->current
.overlay_string_index
= -1;
2380 it
->current
.dpvec_index
= -1;
2381 it
->base_face_id
= remapped_base_face_id
;
2383 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2384 it
->paragraph_embedding
= L2R
;
2385 it
->bidi_it
.string
.lstring
= Qnil
;
2386 it
->bidi_it
.string
.s
= NULL
;
2387 it
->bidi_it
.string
.bufpos
= 0;
2389 /* The window in which we iterate over current_buffer: */
2390 XSETWINDOW (it
->window
, w
);
2392 it
->f
= XFRAME (w
->frame
);
2396 /* Extra space between lines (on window systems only). */
2397 if (base_face_id
== DEFAULT_FACE_ID
2398 && FRAME_WINDOW_P (it
->f
))
2400 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2401 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2402 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2403 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2404 * FRAME_LINE_HEIGHT (it
->f
));
2405 else if (it
->f
->extra_line_spacing
> 0)
2406 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2407 it
->max_extra_line_spacing
= 0;
2410 /* If realized faces have been removed, e.g. because of face
2411 attribute changes of named faces, recompute them. When running
2412 in batch mode, the face cache of the initial frame is null. If
2413 we happen to get called, make a dummy face cache. */
2414 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2415 init_frame_faces (it
->f
);
2416 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2417 recompute_basic_faces (it
->f
);
2419 /* Current value of the `slice', `space-width', and 'height' properties. */
2420 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2421 it
->space_width
= Qnil
;
2422 it
->font_height
= Qnil
;
2423 it
->override_ascent
= -1;
2425 /* Are control characters displayed as `^C'? */
2426 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2428 /* -1 means everything between a CR and the following line end
2429 is invisible. >0 means lines indented more than this value are
2431 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2432 ? XINT (BVAR (current_buffer
, selective_display
))
2433 : (!NILP (BVAR (current_buffer
, selective_display
))
2435 it
->selective_display_ellipsis_p
2436 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2438 /* Display table to use. */
2439 it
->dp
= window_display_table (w
);
2441 /* Are multibyte characters enabled in current_buffer? */
2442 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2444 /* Non-zero if we should highlight the region. */
2446 = (!NILP (Vtransient_mark_mode
)
2447 && !NILP (BVAR (current_buffer
, mark_active
))
2448 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2450 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2451 start and end of a visible region in window IT->w. Set both to
2452 -1 to indicate no region. */
2453 if (highlight_region_p
2454 /* Maybe highlight only in selected window. */
2455 && (/* Either show region everywhere. */
2456 highlight_nonselected_windows
2457 /* Or show region in the selected window. */
2458 || w
== XWINDOW (selected_window
)
2459 /* Or show the region if we are in the mini-buffer and W is
2460 the window the mini-buffer refers to. */
2461 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2462 && WINDOWP (minibuf_selected_window
)
2463 && w
== XWINDOW (minibuf_selected_window
))))
2465 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2466 it
->region_beg_charpos
= min (PT
, markpos
);
2467 it
->region_end_charpos
= max (PT
, markpos
);
2470 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2472 /* Get the position at which the redisplay_end_trigger hook should
2473 be run, if it is to be run at all. */
2474 if (MARKERP (w
->redisplay_end_trigger
)
2475 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2476 it
->redisplay_end_trigger_charpos
2477 = marker_position (w
->redisplay_end_trigger
);
2478 else if (INTEGERP (w
->redisplay_end_trigger
))
2479 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2481 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2483 /* Are lines in the display truncated? */
2484 if (base_face_id
!= DEFAULT_FACE_ID
2485 || XINT (it
->w
->hscroll
)
2486 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2487 && ((!NILP (Vtruncate_partial_width_windows
)
2488 && !INTEGERP (Vtruncate_partial_width_windows
))
2489 || (INTEGERP (Vtruncate_partial_width_windows
)
2490 && (WINDOW_TOTAL_COLS (it
->w
)
2491 < XINT (Vtruncate_partial_width_windows
))))))
2492 it
->line_wrap
= TRUNCATE
;
2493 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2494 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2495 ? WINDOW_WRAP
: WORD_WRAP
;
2497 it
->line_wrap
= TRUNCATE
;
2499 /* Get dimensions of truncation and continuation glyphs. These are
2500 displayed as fringe bitmaps under X, so we don't need them for such
2502 if (!FRAME_WINDOW_P (it
->f
))
2504 if (it
->line_wrap
== TRUNCATE
)
2506 /* We will need the truncation glyph. */
2507 xassert (it
->glyph_row
== NULL
);
2508 produce_special_glyphs (it
, IT_TRUNCATION
);
2509 it
->truncation_pixel_width
= it
->pixel_width
;
2513 /* We will need the continuation glyph. */
2514 xassert (it
->glyph_row
== NULL
);
2515 produce_special_glyphs (it
, IT_CONTINUATION
);
2516 it
->continuation_pixel_width
= it
->pixel_width
;
2519 /* Reset these values to zero because the produce_special_glyphs
2520 above has changed them. */
2521 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2522 it
->phys_ascent
= it
->phys_descent
= 0;
2525 /* Set this after getting the dimensions of truncation and
2526 continuation glyphs, so that we don't produce glyphs when calling
2527 produce_special_glyphs, above. */
2528 it
->glyph_row
= row
;
2529 it
->area
= TEXT_AREA
;
2531 /* Forget any previous info about this row being reversed. */
2533 it
->glyph_row
->reversed_p
= 0;
2535 /* Get the dimensions of the display area. The display area
2536 consists of the visible window area plus a horizontally scrolled
2537 part to the left of the window. All x-values are relative to the
2538 start of this total display area. */
2539 if (base_face_id
!= DEFAULT_FACE_ID
)
2541 /* Mode lines, menu bar in terminal frames. */
2542 it
->first_visible_x
= 0;
2543 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2548 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2549 it
->last_visible_x
= (it
->first_visible_x
2550 + window_box_width (w
, TEXT_AREA
));
2552 /* If we truncate lines, leave room for the truncator glyph(s) at
2553 the right margin. Otherwise, leave room for the continuation
2554 glyph(s). Truncation and continuation glyphs are not inserted
2555 for window-based redisplay. */
2556 if (!FRAME_WINDOW_P (it
->f
))
2558 if (it
->line_wrap
== TRUNCATE
)
2559 it
->last_visible_x
-= it
->truncation_pixel_width
;
2561 it
->last_visible_x
-= it
->continuation_pixel_width
;
2564 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2565 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2568 /* Leave room for a border glyph. */
2569 if (!FRAME_WINDOW_P (it
->f
)
2570 && !WINDOW_RIGHTMOST_P (it
->w
))
2571 it
->last_visible_x
-= 1;
2573 it
->last_visible_y
= window_text_bottom_y (w
);
2575 /* For mode lines and alike, arrange for the first glyph having a
2576 left box line if the face specifies a box. */
2577 if (base_face_id
!= DEFAULT_FACE_ID
)
2581 it
->face_id
= remapped_base_face_id
;
2583 /* If we have a boxed mode line, make the first character appear
2584 with a left box line. */
2585 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2586 if (face
->box
!= FACE_NO_BOX
)
2587 it
->start_of_box_run_p
= 1;
2590 /* If a buffer position was specified, set the iterator there,
2591 getting overlays and face properties from that position. */
2592 if (charpos
>= BUF_BEG (current_buffer
))
2594 it
->end_charpos
= ZV
;
2596 IT_CHARPOS (*it
) = charpos
;
2598 /* Compute byte position if not specified. */
2599 if (bytepos
< charpos
)
2600 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2602 IT_BYTEPOS (*it
) = bytepos
;
2604 it
->start
= it
->current
;
2605 /* Do we need to reorder bidirectional text? Not if this is a
2606 unibyte buffer: by definition, none of the single-byte
2607 characters are strong R2L, so no reordering is needed. And
2608 bidi.c doesn't support unibyte buffers anyway. */
2610 !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2613 /* If we are to reorder bidirectional text, init the bidi
2617 /* Note the paragraph direction that this buffer wants to
2619 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2621 it
->paragraph_embedding
= L2R
;
2622 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2624 it
->paragraph_embedding
= R2L
;
2626 it
->paragraph_embedding
= NEUTRAL_DIR
;
2627 bidi_unshelve_cache (NULL
, 0);
2628 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2632 /* Compute faces etc. */
2633 reseat (it
, it
->current
.pos
, 1);
2640 /* Initialize IT for the display of window W with window start POS. */
2643 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2645 struct glyph_row
*row
;
2646 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2648 row
= w
->desired_matrix
->rows
+ first_vpos
;
2649 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2650 it
->first_vpos
= first_vpos
;
2652 /* Don't reseat to previous visible line start if current start
2653 position is in a string or image. */
2654 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2656 int start_at_line_beg_p
;
2657 int first_y
= it
->current_y
;
2659 /* If window start is not at a line start, skip forward to POS to
2660 get the correct continuation lines width. */
2661 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2662 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2663 if (!start_at_line_beg_p
)
2667 reseat_at_previous_visible_line_start (it
);
2668 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2670 new_x
= it
->current_x
+ it
->pixel_width
;
2672 /* If lines are continued, this line may end in the middle
2673 of a multi-glyph character (e.g. a control character
2674 displayed as \003, or in the middle of an overlay
2675 string). In this case move_it_to above will not have
2676 taken us to the start of the continuation line but to the
2677 end of the continued line. */
2678 if (it
->current_x
> 0
2679 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2680 && (/* And glyph doesn't fit on the line. */
2681 new_x
> it
->last_visible_x
2682 /* Or it fits exactly and we're on a window
2684 || (new_x
== it
->last_visible_x
2685 && FRAME_WINDOW_P (it
->f
))))
2687 if (it
->current
.dpvec_index
>= 0
2688 || it
->current
.overlay_string_index
>= 0)
2690 set_iterator_to_next (it
, 1);
2691 move_it_in_display_line_to (it
, -1, -1, 0);
2694 it
->continuation_lines_width
+= it
->current_x
;
2697 /* We're starting a new display line, not affected by the
2698 height of the continued line, so clear the appropriate
2699 fields in the iterator structure. */
2700 it
->max_ascent
= it
->max_descent
= 0;
2701 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2703 it
->current_y
= first_y
;
2705 it
->current_x
= it
->hpos
= 0;
2711 /* Return 1 if POS is a position in ellipses displayed for invisible
2712 text. W is the window we display, for text property lookup. */
2715 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2717 Lisp_Object prop
, window
;
2719 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2721 /* If POS specifies a position in a display vector, this might
2722 be for an ellipsis displayed for invisible text. We won't
2723 get the iterator set up for delivering that ellipsis unless
2724 we make sure that it gets aware of the invisible text. */
2725 if (pos
->dpvec_index
>= 0
2726 && pos
->overlay_string_index
< 0
2727 && CHARPOS (pos
->string_pos
) < 0
2729 && (XSETWINDOW (window
, w
),
2730 prop
= Fget_char_property (make_number (charpos
),
2731 Qinvisible
, window
),
2732 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2734 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2736 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2743 /* Initialize IT for stepping through current_buffer in window W,
2744 starting at position POS that includes overlay string and display
2745 vector/ control character translation position information. Value
2746 is zero if there are overlay strings with newlines at POS. */
2749 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2751 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2752 int i
, overlay_strings_with_newlines
= 0;
2754 /* If POS specifies a position in a display vector, this might
2755 be for an ellipsis displayed for invisible text. We won't
2756 get the iterator set up for delivering that ellipsis unless
2757 we make sure that it gets aware of the invisible text. */
2758 if (in_ellipses_for_invisible_text_p (pos
, w
))
2764 /* Keep in mind: the call to reseat in init_iterator skips invisible
2765 text, so we might end up at a position different from POS. This
2766 is only a problem when POS is a row start after a newline and an
2767 overlay starts there with an after-string, and the overlay has an
2768 invisible property. Since we don't skip invisible text in
2769 display_line and elsewhere immediately after consuming the
2770 newline before the row start, such a POS will not be in a string,
2771 but the call to init_iterator below will move us to the
2773 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2775 /* This only scans the current chunk -- it should scan all chunks.
2776 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2777 to 16 in 22.1 to make this a lesser problem. */
2778 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2780 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2781 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2783 while (s
< e
&& *s
!= '\n')
2788 overlay_strings_with_newlines
= 1;
2793 /* If position is within an overlay string, set up IT to the right
2795 if (pos
->overlay_string_index
>= 0)
2799 /* If the first overlay string happens to have a `display'
2800 property for an image, the iterator will be set up for that
2801 image, and we have to undo that setup first before we can
2802 correct the overlay string index. */
2803 if (it
->method
== GET_FROM_IMAGE
)
2806 /* We already have the first chunk of overlay strings in
2807 IT->overlay_strings. Load more until the one for
2808 pos->overlay_string_index is in IT->overlay_strings. */
2809 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2811 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2812 it
->current
.overlay_string_index
= 0;
2815 load_overlay_strings (it
, 0);
2816 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2820 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2821 relative_index
= (it
->current
.overlay_string_index
2822 % OVERLAY_STRING_CHUNK_SIZE
);
2823 it
->string
= it
->overlay_strings
[relative_index
];
2824 xassert (STRINGP (it
->string
));
2825 it
->current
.string_pos
= pos
->string_pos
;
2826 it
->method
= GET_FROM_STRING
;
2829 if (CHARPOS (pos
->string_pos
) >= 0)
2831 /* Recorded position is not in an overlay string, but in another
2832 string. This can only be a string from a `display' property.
2833 IT should already be filled with that string. */
2834 it
->current
.string_pos
= pos
->string_pos
;
2835 xassert (STRINGP (it
->string
));
2838 /* Restore position in display vector translations, control
2839 character translations or ellipses. */
2840 if (pos
->dpvec_index
>= 0)
2842 if (it
->dpvec
== NULL
)
2843 get_next_display_element (it
);
2844 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
2845 it
->current
.dpvec_index
= pos
->dpvec_index
;
2849 return !overlay_strings_with_newlines
;
2853 /* Initialize IT for stepping through current_buffer in window W
2854 starting at ROW->start. */
2857 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2859 init_from_display_pos (it
, w
, &row
->start
);
2860 it
->start
= row
->start
;
2861 it
->continuation_lines_width
= row
->continuation_lines_width
;
2866 /* Initialize IT for stepping through current_buffer in window W
2867 starting in the line following ROW, i.e. starting at ROW->end.
2868 Value is zero if there are overlay strings with newlines at ROW's
2872 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
2876 if (init_from_display_pos (it
, w
, &row
->end
))
2878 if (row
->continued_p
)
2879 it
->continuation_lines_width
2880 = row
->continuation_lines_width
+ row
->pixel_width
;
2891 /***********************************************************************
2893 ***********************************************************************/
2895 /* Called when IT reaches IT->stop_charpos. Handle text property and
2896 overlay changes. Set IT->stop_charpos to the next position where
2900 handle_stop (struct it
*it
)
2902 enum prop_handled handled
;
2903 int handle_overlay_change_p
;
2907 it
->current
.dpvec_index
= -1;
2908 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
2909 it
->ignore_overlay_strings_at_pos_p
= 0;
2912 /* Use face of preceding text for ellipsis (if invisible) */
2913 if (it
->selective_display_ellipsis_p
)
2914 it
->saved_face_id
= it
->face_id
;
2918 handled
= HANDLED_NORMALLY
;
2920 /* Call text property handlers. */
2921 for (p
= it_props
; p
->handler
; ++p
)
2923 handled
= p
->handler (it
);
2925 if (handled
== HANDLED_RECOMPUTE_PROPS
)
2927 else if (handled
== HANDLED_RETURN
)
2929 /* We still want to show before and after strings from
2930 overlays even if the actual buffer text is replaced. */
2931 if (!handle_overlay_change_p
2933 || !get_overlay_strings_1 (it
, 0, 0))
2936 setup_for_ellipsis (it
, 0);
2937 /* When handling a display spec, we might load an
2938 empty string. In that case, discard it here. We
2939 used to discard it in handle_single_display_spec,
2940 but that causes get_overlay_strings_1, above, to
2941 ignore overlay strings that we must check. */
2942 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2946 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
2950 it
->ignore_overlay_strings_at_pos_p
= 1;
2951 it
->string_from_display_prop_p
= 0;
2952 it
->from_disp_prop_p
= 0;
2953 handle_overlay_change_p
= 0;
2955 handled
= HANDLED_RECOMPUTE_PROPS
;
2958 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
2959 handle_overlay_change_p
= 0;
2962 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
2964 /* Don't check for overlay strings below when set to deliver
2965 characters from a display vector. */
2966 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
2967 handle_overlay_change_p
= 0;
2969 /* Handle overlay changes.
2970 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
2971 if it finds overlays. */
2972 if (handle_overlay_change_p
)
2973 handled
= handle_overlay_change (it
);
2978 setup_for_ellipsis (it
, 0);
2982 while (handled
== HANDLED_RECOMPUTE_PROPS
);
2984 /* Determine where to stop next. */
2985 if (handled
== HANDLED_NORMALLY
)
2986 compute_stop_pos (it
);
2990 /* Compute IT->stop_charpos from text property and overlay change
2991 information for IT's current position. */
2994 compute_stop_pos (struct it
*it
)
2996 register INTERVAL iv
, next_iv
;
2997 Lisp_Object object
, limit
, position
;
2998 EMACS_INT charpos
, bytepos
;
3000 /* If nowhere else, stop at the end. */
3001 it
->stop_charpos
= it
->end_charpos
;
3003 if (STRINGP (it
->string
))
3005 /* Strings are usually short, so don't limit the search for
3007 object
= it
->string
;
3009 charpos
= IT_STRING_CHARPOS (*it
);
3010 bytepos
= IT_STRING_BYTEPOS (*it
);
3016 /* If next overlay change is in front of the current stop pos
3017 (which is IT->end_charpos), stop there. Note: value of
3018 next_overlay_change is point-max if no overlay change
3020 charpos
= IT_CHARPOS (*it
);
3021 bytepos
= IT_BYTEPOS (*it
);
3022 pos
= next_overlay_change (charpos
);
3023 if (pos
< it
->stop_charpos
)
3024 it
->stop_charpos
= pos
;
3026 /* If showing the region, we have to stop at the region
3027 start or end because the face might change there. */
3028 if (it
->region_beg_charpos
> 0)
3030 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3031 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3032 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3033 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3036 /* Set up variables for computing the stop position from text
3037 property changes. */
3038 XSETBUFFER (object
, current_buffer
);
3039 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3042 /* Get the interval containing IT's position. Value is a null
3043 interval if there isn't such an interval. */
3044 position
= make_number (charpos
);
3045 iv
= validate_interval_range (object
, &position
, &position
, 0);
3046 if (!NULL_INTERVAL_P (iv
))
3048 Lisp_Object values_here
[LAST_PROP_IDX
];
3051 /* Get properties here. */
3052 for (p
= it_props
; p
->handler
; ++p
)
3053 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3055 /* Look for an interval following iv that has different
3057 for (next_iv
= next_interval (iv
);
3058 (!NULL_INTERVAL_P (next_iv
)
3060 || XFASTINT (limit
) > next_iv
->position
));
3061 next_iv
= next_interval (next_iv
))
3063 for (p
= it_props
; p
->handler
; ++p
)
3065 Lisp_Object new_value
;
3067 new_value
= textget (next_iv
->plist
, *p
->name
);
3068 if (!EQ (values_here
[p
->idx
], new_value
))
3076 if (!NULL_INTERVAL_P (next_iv
))
3078 if (INTEGERP (limit
)
3079 && next_iv
->position
>= XFASTINT (limit
))
3080 /* No text property change up to limit. */
3081 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3083 /* Text properties change in next_iv. */
3084 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3088 if (it
->cmp_it
.id
< 0)
3090 EMACS_INT stoppos
= it
->end_charpos
;
3092 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3094 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3095 stoppos
, it
->string
);
3098 xassert (STRINGP (it
->string
)
3099 || (it
->stop_charpos
>= BEGV
3100 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3104 /* Return the position of the next overlay change after POS in
3105 current_buffer. Value is point-max if no overlay change
3106 follows. This is like `next-overlay-change' but doesn't use
3110 next_overlay_change (EMACS_INT pos
)
3112 ptrdiff_t i
, noverlays
;
3114 Lisp_Object
*overlays
;
3116 /* Get all overlays at the given position. */
3117 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3119 /* If any of these overlays ends before endpos,
3120 use its ending point instead. */
3121 for (i
= 0; i
< noverlays
; ++i
)
3126 oend
= OVERLAY_END (overlays
[i
]);
3127 oendpos
= OVERLAY_POSITION (oend
);
3128 endpos
= min (endpos
, oendpos
);
3134 /* How many characters forward to search for a display property or
3135 display string. Enough for a screenful of 100 lines x 50
3136 characters in a line. */
3137 #define MAX_DISP_SCAN 5000
3139 /* Return the character position of a display string at or after
3140 position specified by POSITION. If no display string exists at or
3141 after POSITION, return ZV. A display string is either an overlay
3142 with `display' property whose value is a string, or a `display'
3143 text property whose value is a string. STRING is data about the
3144 string to iterate; if STRING->lstring is nil, we are iterating a
3145 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3148 compute_display_string_pos (struct text_pos
*position
,
3149 struct bidi_string_data
*string
,
3150 int frame_window_p
, int *disp_prop_p
)
3152 /* OBJECT = nil means current buffer. */
3153 Lisp_Object object
=
3154 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3155 Lisp_Object pos
, spec
, limpos
;
3156 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3157 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3158 EMACS_INT begb
= string_p
? 0 : BEGV
;
3159 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3161 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3162 struct text_pos tpos
;
3167 /* We don't support display properties whose values are strings
3168 that have display string properties. */
3169 || string
->from_disp_str
3170 /* C strings cannot have display properties. */
3171 || (string
->s
&& !STRINGP (object
)))
3177 /* If the character at CHARPOS is where the display string begins,
3179 pos
= make_number (charpos
);
3180 if (STRINGP (object
))
3181 bufpos
= string
->bufpos
;
3185 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3187 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3190 && handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3196 /* Look forward for the first character with a `display' property
3197 that will replace the underlying text when displayed. */
3198 limpos
= make_number (lim
);
3200 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3201 CHARPOS (tpos
) = XFASTINT (pos
);
3202 if (CHARPOS (tpos
) >= lim
)
3207 if (STRINGP (object
))
3208 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3210 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3211 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3212 if (!STRINGP (object
))
3213 bufpos
= CHARPOS (tpos
);
3214 } while (NILP (spec
)
3215 || !handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3218 return CHARPOS (tpos
);
3221 /* Return the character position of the end of the display string that
3222 started at CHARPOS. A display string is either an overlay with
3223 `display' property whose value is a string or a `display' text
3224 property whose value is a string. */
3226 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3228 /* OBJECT = nil means current buffer. */
3229 Lisp_Object object
=
3230 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3231 Lisp_Object pos
= make_number (charpos
);
3233 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3235 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3238 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3241 /* Look forward for the first character where the `display' property
3243 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3245 return XFASTINT (pos
);
3250 /***********************************************************************
3252 ***********************************************************************/
3254 /* Handle changes in the `fontified' property of the current buffer by
3255 calling hook functions from Qfontification_functions to fontify
3258 static enum prop_handled
3259 handle_fontified_prop (struct it
*it
)
3261 Lisp_Object prop
, pos
;
3262 enum prop_handled handled
= HANDLED_NORMALLY
;
3264 if (!NILP (Vmemory_full
))
3267 /* Get the value of the `fontified' property at IT's current buffer
3268 position. (The `fontified' property doesn't have a special
3269 meaning in strings.) If the value is nil, call functions from
3270 Qfontification_functions. */
3271 if (!STRINGP (it
->string
)
3273 && !NILP (Vfontification_functions
)
3274 && !NILP (Vrun_hooks
)
3275 && (pos
= make_number (IT_CHARPOS (*it
)),
3276 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3277 /* Ignore the special cased nil value always present at EOB since
3278 no amount of fontifying will be able to change it. */
3279 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3281 int count
= SPECPDL_INDEX ();
3283 struct buffer
*obuf
= current_buffer
;
3284 int begv
= BEGV
, zv
= ZV
;
3285 int old_clip_changed
= current_buffer
->clip_changed
;
3287 val
= Vfontification_functions
;
3288 specbind (Qfontification_functions
, Qnil
);
3290 xassert (it
->end_charpos
== ZV
);
3292 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3293 safe_call1 (val
, pos
);
3296 Lisp_Object fns
, fn
;
3297 struct gcpro gcpro1
, gcpro2
;
3302 for (; CONSP (val
); val
= XCDR (val
))
3308 /* A value of t indicates this hook has a local
3309 binding; it means to run the global binding too.
3310 In a global value, t should not occur. If it
3311 does, we must ignore it to avoid an endless
3313 for (fns
= Fdefault_value (Qfontification_functions
);
3319 safe_call1 (fn
, pos
);
3323 safe_call1 (fn
, pos
);
3329 unbind_to (count
, Qnil
);
3331 /* Fontification functions routinely call `save-restriction'.
3332 Normally, this tags clip_changed, which can confuse redisplay
3333 (see discussion in Bug#6671). Since we don't perform any
3334 special handling of fontification changes in the case where
3335 `save-restriction' isn't called, there's no point doing so in
3336 this case either. So, if the buffer's restrictions are
3337 actually left unchanged, reset clip_changed. */
3338 if (obuf
== current_buffer
)
3340 if (begv
== BEGV
&& zv
== ZV
)
3341 current_buffer
->clip_changed
= old_clip_changed
;
3343 /* There isn't much we can reasonably do to protect against
3344 misbehaving fontification, but here's a fig leaf. */
3345 else if (!NILP (BVAR (obuf
, name
)))
3346 set_buffer_internal_1 (obuf
);
3348 /* The fontification code may have added/removed text.
3349 It could do even a lot worse, but let's at least protect against
3350 the most obvious case where only the text past `pos' gets changed',
3351 as is/was done in grep.el where some escapes sequences are turned
3352 into face properties (bug#7876). */
3353 it
->end_charpos
= ZV
;
3355 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3356 something. This avoids an endless loop if they failed to
3357 fontify the text for which reason ever. */
3358 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3359 handled
= HANDLED_RECOMPUTE_PROPS
;
3367 /***********************************************************************
3369 ***********************************************************************/
3371 /* Set up iterator IT from face properties at its current position.
3372 Called from handle_stop. */
3374 static enum prop_handled
3375 handle_face_prop (struct it
*it
)
3378 EMACS_INT next_stop
;
3380 if (!STRINGP (it
->string
))
3383 = face_at_buffer_position (it
->w
,
3385 it
->region_beg_charpos
,
3386 it
->region_end_charpos
,
3389 + TEXT_PROP_DISTANCE_LIMIT
),
3390 0, it
->base_face_id
);
3392 /* Is this a start of a run of characters with box face?
3393 Caveat: this can be called for a freshly initialized
3394 iterator; face_id is -1 in this case. We know that the new
3395 face will not change until limit, i.e. if the new face has a
3396 box, all characters up to limit will have one. But, as
3397 usual, we don't know whether limit is really the end. */
3398 if (new_face_id
!= it
->face_id
)
3400 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3402 /* If new face has a box but old face has not, this is
3403 the start of a run of characters with box, i.e. it has
3404 a shadow on the left side. The value of face_id of the
3405 iterator will be -1 if this is the initial call that gets
3406 the face. In this case, we have to look in front of IT's
3407 position and see whether there is a face != new_face_id. */
3408 it
->start_of_box_run_p
3409 = (new_face
->box
!= FACE_NO_BOX
3410 && (it
->face_id
>= 0
3411 || IT_CHARPOS (*it
) == BEG
3412 || new_face_id
!= face_before_it_pos (it
)));
3413 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3421 Lisp_Object from_overlay
3422 = (it
->current
.overlay_string_index
>= 0
3423 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3426 /* See if we got to this string directly or indirectly from
3427 an overlay property. That includes the before-string or
3428 after-string of an overlay, strings in display properties
3429 provided by an overlay, their text properties, etc.
3431 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3432 if (! NILP (from_overlay
))
3433 for (i
= it
->sp
- 1; i
>= 0; i
--)
3435 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3437 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3438 else if (! NILP (it
->stack
[i
].from_overlay
))
3439 from_overlay
= it
->stack
[i
].from_overlay
;
3441 if (!NILP (from_overlay
))
3445 if (! NILP (from_overlay
))
3447 bufpos
= IT_CHARPOS (*it
);
3448 /* For a string from an overlay, the base face depends
3449 only on text properties and ignores overlays. */
3451 = face_for_overlay_string (it
->w
,
3453 it
->region_beg_charpos
,
3454 it
->region_end_charpos
,
3457 + TEXT_PROP_DISTANCE_LIMIT
),
3465 /* For strings from a `display' property, use the face at
3466 IT's current buffer position as the base face to merge
3467 with, so that overlay strings appear in the same face as
3468 surrounding text, unless they specify their own
3470 base_face_id
= underlying_face_id (it
);
3473 new_face_id
= face_at_string_position (it
->w
,
3475 IT_STRING_CHARPOS (*it
),
3477 it
->region_beg_charpos
,
3478 it
->region_end_charpos
,
3482 /* Is this a start of a run of characters with box? Caveat:
3483 this can be called for a freshly allocated iterator; face_id
3484 is -1 is this case. We know that the new face will not
3485 change until the next check pos, i.e. if the new face has a
3486 box, all characters up to that position will have a
3487 box. But, as usual, we don't know whether that position
3488 is really the end. */
3489 if (new_face_id
!= it
->face_id
)
3491 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3492 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3494 /* If new face has a box but old face hasn't, this is the
3495 start of a run of characters with box, i.e. it has a
3496 shadow on the left side. */
3497 it
->start_of_box_run_p
3498 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3499 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3503 it
->face_id
= new_face_id
;
3504 return HANDLED_NORMALLY
;
3508 /* Return the ID of the face ``underlying'' IT's current position,
3509 which is in a string. If the iterator is associated with a
3510 buffer, return the face at IT's current buffer position.
3511 Otherwise, use the iterator's base_face_id. */
3514 underlying_face_id (struct it
*it
)
3516 int face_id
= it
->base_face_id
, i
;
3518 xassert (STRINGP (it
->string
));
3520 for (i
= it
->sp
- 1; i
>= 0; --i
)
3521 if (NILP (it
->stack
[i
].string
))
3522 face_id
= it
->stack
[i
].face_id
;
3528 /* Compute the face one character before or after the current position
3529 of IT, in the visual order. BEFORE_P non-zero means get the face
3530 in front (to the left in L2R paragraphs, to the right in R2L
3531 paragraphs) of IT's screen position. Value is the ID of the face. */
3534 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3537 EMACS_INT next_check_charpos
;
3539 void *it_copy_data
= NULL
;
3541 xassert (it
->s
== NULL
);
3543 if (STRINGP (it
->string
))
3545 EMACS_INT bufpos
, charpos
;
3548 /* No face change past the end of the string (for the case
3549 we are padding with spaces). No face change before the
3551 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3552 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3557 /* Set charpos to the position before or after IT's current
3558 position, in the logical order, which in the non-bidi
3559 case is the same as the visual order. */
3561 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3562 else if (it
->what
== IT_COMPOSITION
)
3563 /* For composition, we must check the character after the
3565 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3567 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3573 /* With bidi iteration, the character before the current
3574 in the visual order cannot be found by simple
3575 iteration, because "reverse" reordering is not
3576 supported. Instead, we need to use the move_it_*
3577 family of functions. */
3578 /* Ignore face changes before the first visible
3579 character on this display line. */
3580 if (it
->current_x
<= it
->first_visible_x
)
3582 SAVE_IT (it_copy
, *it
, it_copy_data
);
3583 /* Implementation note: Since move_it_in_display_line
3584 works in the iterator geometry, and thinks the first
3585 character is always the leftmost, even in R2L lines,
3586 we don't need to distinguish between the R2L and L2R
3588 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3589 it_copy
.current_x
- 1, MOVE_TO_X
);
3590 charpos
= IT_STRING_CHARPOS (it_copy
);
3591 RESTORE_IT (it
, it
, it_copy_data
);
3595 /* Set charpos to the string position of the character
3596 that comes after IT's current position in the visual
3598 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3602 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3604 charpos
= it_copy
.bidi_it
.charpos
;
3607 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3609 if (it
->current
.overlay_string_index
>= 0)
3610 bufpos
= IT_CHARPOS (*it
);
3614 base_face_id
= underlying_face_id (it
);
3616 /* Get the face for ASCII, or unibyte. */
3617 face_id
= face_at_string_position (it
->w
,
3621 it
->region_beg_charpos
,
3622 it
->region_end_charpos
,
3623 &next_check_charpos
,
3626 /* Correct the face for charsets different from ASCII. Do it
3627 for the multibyte case only. The face returned above is
3628 suitable for unibyte text if IT->string is unibyte. */
3629 if (STRING_MULTIBYTE (it
->string
))
3631 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3632 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3634 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3636 c
= string_char_and_length (p
, &len
);
3637 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3642 struct text_pos pos
;
3644 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3645 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3648 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3649 pos
= it
->current
.pos
;
3654 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3657 if (it
->what
== IT_COMPOSITION
)
3659 /* For composition, we must check the position after
3661 pos
.charpos
+= it
->cmp_it
.nchars
;
3662 pos
.bytepos
+= it
->len
;
3665 INC_TEXT_POS (pos
, it
->multibyte_p
);
3672 /* With bidi iteration, the character before the current
3673 in the visual order cannot be found by simple
3674 iteration, because "reverse" reordering is not
3675 supported. Instead, we need to use the move_it_*
3676 family of functions. */
3677 /* Ignore face changes before the first visible
3678 character on this display line. */
3679 if (it
->current_x
<= it
->first_visible_x
)
3681 SAVE_IT (it_copy
, *it
, it_copy_data
);
3682 /* Implementation note: Since move_it_in_display_line
3683 works in the iterator geometry, and thinks the first
3684 character is always the leftmost, even in R2L lines,
3685 we don't need to distinguish between the R2L and L2R
3687 move_it_in_display_line (&it_copy
, ZV
,
3688 it_copy
.current_x
- 1, MOVE_TO_X
);
3689 pos
= it_copy
.current
.pos
;
3690 RESTORE_IT (it
, it
, it_copy_data
);
3694 /* Set charpos to the buffer position of the character
3695 that comes after IT's current position in the visual
3697 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3701 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3704 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3707 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3709 /* Determine face for CHARSET_ASCII, or unibyte. */
3710 face_id
= face_at_buffer_position (it
->w
,
3712 it
->region_beg_charpos
,
3713 it
->region_end_charpos
,
3714 &next_check_charpos
,
3717 /* Correct the face for charsets different from ASCII. Do it
3718 for the multibyte case only. The face returned above is
3719 suitable for unibyte text if current_buffer is unibyte. */
3720 if (it
->multibyte_p
)
3722 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3723 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3724 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3733 /***********************************************************************
3735 ***********************************************************************/
3737 /* Set up iterator IT from invisible properties at its current
3738 position. Called from handle_stop. */
3740 static enum prop_handled
3741 handle_invisible_prop (struct it
*it
)
3743 enum prop_handled handled
= HANDLED_NORMALLY
;
3745 if (STRINGP (it
->string
))
3747 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3749 /* Get the value of the invisible text property at the
3750 current position. Value will be nil if there is no such
3752 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3753 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3756 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3760 handled
= HANDLED_RECOMPUTE_PROPS
;
3762 /* Get the position at which the next change of the
3763 invisible text property can be found in IT->string.
3764 Value will be nil if the property value is the same for
3765 all the rest of IT->string. */
3766 XSETINT (limit
, SCHARS (it
->string
));
3767 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3770 /* Text at current position is invisible. The next
3771 change in the property is at position end_charpos.
3772 Move IT's current position to that position. */
3773 if (INTEGERP (end_charpos
)
3774 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3776 struct text_pos old
;
3779 old
= it
->current
.string_pos
;
3780 oldpos
= CHARPOS (old
);
3783 if (it
->bidi_it
.first_elt
3784 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3785 bidi_paragraph_init (it
->paragraph_embedding
,
3787 /* Bidi-iterate out of the invisible text. */
3790 bidi_move_to_visually_next (&it
->bidi_it
);
3792 while (oldpos
<= it
->bidi_it
.charpos
3793 && it
->bidi_it
.charpos
< endpos
);
3795 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3796 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3797 if (IT_CHARPOS (*it
) >= endpos
)
3798 it
->prev_stop
= endpos
;
3802 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
3803 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
3808 /* The rest of the string is invisible. If this is an
3809 overlay string, proceed with the next overlay string
3810 or whatever comes and return a character from there. */
3811 if (it
->current
.overlay_string_index
>= 0)
3813 next_overlay_string (it
);
3814 /* Don't check for overlay strings when we just
3815 finished processing them. */
3816 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
3820 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
3821 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
3829 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
3830 Lisp_Object pos
, prop
, overlay
;
3832 /* First of all, is there invisible text at this position? */
3833 tem
= start_charpos
= IT_CHARPOS (*it
);
3834 pos
= make_number (tem
);
3835 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
3837 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3839 /* If we are on invisible text, skip over it. */
3840 if (invis_p
&& start_charpos
< it
->end_charpos
)
3842 /* Record whether we have to display an ellipsis for the
3844 int display_ellipsis_p
= invis_p
== 2;
3846 handled
= HANDLED_RECOMPUTE_PROPS
;
3848 /* Loop skipping over invisible text. The loop is left at
3849 ZV or with IT on the first char being visible again. */
3852 /* Try to skip some invisible text. Return value is the
3853 position reached which can be equal to where we start
3854 if there is nothing invisible there. This skips both
3855 over invisible text properties and overlays with
3856 invisible property. */
3857 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
3859 /* If we skipped nothing at all we weren't at invisible
3860 text in the first place. If everything to the end of
3861 the buffer was skipped, end the loop. */
3862 if (newpos
== tem
|| newpos
>= ZV
)
3866 /* We skipped some characters but not necessarily
3867 all there are. Check if we ended up on visible
3868 text. Fget_char_property returns the property of
3869 the char before the given position, i.e. if we
3870 get invis_p = 0, this means that the char at
3871 newpos is visible. */
3872 pos
= make_number (newpos
);
3873 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
3874 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
3877 /* If we ended up on invisible text, proceed to
3878 skip starting with next_stop. */
3882 /* If there are adjacent invisible texts, don't lose the
3883 second one's ellipsis. */
3885 display_ellipsis_p
= 1;
3889 /* The position newpos is now either ZV or on visible text. */
3890 if (it
->bidi_p
&& newpos
< ZV
)
3892 /* With bidi iteration, the region of invisible text
3893 could start and/or end in the middle of a non-base
3894 embedding level. Therefore, we need to skip
3895 invisible text using the bidi iterator, starting at
3896 IT's current position, until we find ourselves
3897 outside the invisible text. Skipping invisible text
3898 _after_ bidi iteration avoids affecting the visual
3899 order of the displayed text when invisible properties
3900 are added or removed. */
3901 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
3903 /* If we were `reseat'ed to a new paragraph,
3904 determine the paragraph base direction. We need
3905 to do it now because next_element_from_buffer may
3906 not have a chance to do it, if we are going to
3907 skip any text at the beginning, which resets the
3909 bidi_paragraph_init (it
->paragraph_embedding
,
3914 bidi_move_to_visually_next (&it
->bidi_it
);
3916 while (it
->stop_charpos
<= it
->bidi_it
.charpos
3917 && it
->bidi_it
.charpos
< newpos
);
3918 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3919 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3920 /* If we overstepped NEWPOS, record its position in the
3921 iterator, so that we skip invisible text if later the
3922 bidi iteration lands us in the invisible region
3924 if (IT_CHARPOS (*it
) >= newpos
)
3925 it
->prev_stop
= newpos
;
3929 IT_CHARPOS (*it
) = newpos
;
3930 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
3933 /* If there are before-strings at the start of invisible
3934 text, and the text is invisible because of a text
3935 property, arrange to show before-strings because 20.x did
3936 it that way. (If the text is invisible because of an
3937 overlay property instead of a text property, this is
3938 already handled in the overlay code.) */
3940 && get_overlay_strings (it
, it
->stop_charpos
))
3942 handled
= HANDLED_RECOMPUTE_PROPS
;
3943 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
3945 else if (display_ellipsis_p
)
3947 /* Make sure that the glyphs of the ellipsis will get
3948 correct `charpos' values. If we would not update
3949 it->position here, the glyphs would belong to the
3950 last visible character _before_ the invisible
3951 text, which confuses `set_cursor_from_row'.
3953 We use the last invisible position instead of the
3954 first because this way the cursor is always drawn on
3955 the first "." of the ellipsis, whenever PT is inside
3956 the invisible text. Otherwise the cursor would be
3957 placed _after_ the ellipsis when the point is after the
3958 first invisible character. */
3959 if (!STRINGP (it
->object
))
3961 it
->position
.charpos
= newpos
- 1;
3962 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
3965 /* Let the ellipsis display before
3966 considering any properties of the following char.
3967 Fixes jasonr@gnu.org 01 Oct 07 bug. */
3968 handled
= HANDLED_RETURN
;
3977 /* Make iterator IT return `...' next.
3978 Replaces LEN characters from buffer. */
3981 setup_for_ellipsis (struct it
*it
, int len
)
3983 /* Use the display table definition for `...'. Invalid glyphs
3984 will be handled by the method returning elements from dpvec. */
3985 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
3987 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
3988 it
->dpvec
= v
->contents
;
3989 it
->dpend
= v
->contents
+ v
->header
.size
;
3993 /* Default `...'. */
3994 it
->dpvec
= default_invis_vector
;
3995 it
->dpend
= default_invis_vector
+ 3;
3998 it
->dpvec_char_len
= len
;
3999 it
->current
.dpvec_index
= 0;
4000 it
->dpvec_face_id
= -1;
4002 /* Remember the current face id in case glyphs specify faces.
4003 IT's face is restored in set_iterator_to_next.
4004 saved_face_id was set to preceding char's face in handle_stop. */
4005 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4006 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4008 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4014 /***********************************************************************
4016 ***********************************************************************/
4018 /* Set up iterator IT from `display' property at its current position.
4019 Called from handle_stop.
4020 We return HANDLED_RETURN if some part of the display property
4021 overrides the display of the buffer text itself.
4022 Otherwise we return HANDLED_NORMALLY. */
4024 static enum prop_handled
4025 handle_display_prop (struct it
*it
)
4027 Lisp_Object propval
, object
, overlay
;
4028 struct text_pos
*position
;
4030 /* Nonzero if some property replaces the display of the text itself. */
4031 int display_replaced_p
= 0;
4033 if (STRINGP (it
->string
))
4035 object
= it
->string
;
4036 position
= &it
->current
.string_pos
;
4037 bufpos
= CHARPOS (it
->current
.pos
);
4041 XSETWINDOW (object
, it
->w
);
4042 position
= &it
->current
.pos
;
4043 bufpos
= CHARPOS (*position
);
4046 /* Reset those iterator values set from display property values. */
4047 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4048 it
->space_width
= Qnil
;
4049 it
->font_height
= Qnil
;
4052 /* We don't support recursive `display' properties, i.e. string
4053 values that have a string `display' property, that have a string
4054 `display' property etc. */
4055 if (!it
->string_from_display_prop_p
)
4056 it
->area
= TEXT_AREA
;
4058 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4059 Qdisplay
, object
, &overlay
);
4061 return HANDLED_NORMALLY
;
4062 /* Now OVERLAY is the overlay that gave us this property, or nil
4063 if it was a text property. */
4065 if (!STRINGP (it
->string
))
4066 object
= it
->w
->buffer
;
4068 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4070 FRAME_WINDOW_P (it
->f
));
4072 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4075 /* Subroutine of handle_display_prop. Returns non-zero if the display
4076 specification in SPEC is a replacing specification, i.e. it would
4077 replace the text covered by `display' property with something else,
4078 such as an image or a display string.
4080 See handle_single_display_spec for documentation of arguments.
4081 frame_window_p is non-zero if the window being redisplayed is on a
4082 GUI frame; this argument is used only if IT is NULL, see below.
4084 IT can be NULL, if this is called by the bidi reordering code
4085 through compute_display_string_pos, which see. In that case, this
4086 function only examines SPEC, but does not otherwise "handle" it, in
4087 the sense that it doesn't set up members of IT from the display
4090 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4091 Lisp_Object overlay
, struct text_pos
*position
,
4092 EMACS_INT bufpos
, int frame_window_p
)
4094 int replacing_p
= 0;
4097 /* Simple specerties. */
4098 && !EQ (XCAR (spec
), Qimage
)
4099 && !EQ (XCAR (spec
), Qspace
)
4100 && !EQ (XCAR (spec
), Qwhen
)
4101 && !EQ (XCAR (spec
), Qslice
)
4102 && !EQ (XCAR (spec
), Qspace_width
)
4103 && !EQ (XCAR (spec
), Qheight
)
4104 && !EQ (XCAR (spec
), Qraise
)
4105 /* Marginal area specifications. */
4106 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4107 && !EQ (XCAR (spec
), Qleft_fringe
)
4108 && !EQ (XCAR (spec
), Qright_fringe
)
4109 && !NILP (XCAR (spec
)))
4111 for (; CONSP (spec
); spec
= XCDR (spec
))
4113 if (handle_single_display_spec (it
, XCAR (spec
), object
, overlay
,
4114 position
, bufpos
, replacing_p
,
4118 /* If some text in a string is replaced, `position' no
4119 longer points to the position of `object'. */
4120 if (!it
|| STRINGP (object
))
4125 else if (VECTORP (spec
))
4128 for (i
= 0; i
< ASIZE (spec
); ++i
)
4129 if (handle_single_display_spec (it
, AREF (spec
, i
), object
, overlay
,
4130 position
, bufpos
, replacing_p
,
4134 /* If some text in a string is replaced, `position' no
4135 longer points to the position of `object'. */
4136 if (!it
|| STRINGP (object
))
4142 if (handle_single_display_spec (it
, spec
, object
, overlay
,
4143 position
, bufpos
, 0, frame_window_p
))
4150 /* Value is the position of the end of the `display' property starting
4151 at START_POS in OBJECT. */
4153 static struct text_pos
4154 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4157 struct text_pos end_pos
;
4159 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4160 Qdisplay
, object
, Qnil
);
4161 CHARPOS (end_pos
) = XFASTINT (end
);
4162 if (STRINGP (object
))
4163 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4165 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4171 /* Set up IT from a single `display' property specification SPEC. OBJECT
4172 is the object in which the `display' property was found. *POSITION
4173 is the position in OBJECT at which the `display' property was found.
4174 BUFPOS is the buffer position of OBJECT (different from POSITION if
4175 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4176 previously saw a display specification which already replaced text
4177 display with something else, for example an image; we ignore such
4178 properties after the first one has been processed.
4180 OVERLAY is the overlay this `display' property came from,
4181 or nil if it was a text property.
4183 If SPEC is a `space' or `image' specification, and in some other
4184 cases too, set *POSITION to the position where the `display'
4187 If IT is NULL, only examine the property specification in SPEC, but
4188 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4189 is intended to be displayed in a window on a GUI frame.
4191 Value is non-zero if something was found which replaces the display
4192 of buffer or string text. */
4195 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4196 Lisp_Object overlay
, struct text_pos
*position
,
4197 EMACS_INT bufpos
, int display_replaced_p
,
4201 Lisp_Object location
, value
;
4202 struct text_pos start_pos
= *position
;
4205 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4206 If the result is non-nil, use VALUE instead of SPEC. */
4208 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4217 if (!NILP (form
) && !EQ (form
, Qt
))
4219 int count
= SPECPDL_INDEX ();
4220 struct gcpro gcpro1
;
4222 /* Bind `object' to the object having the `display' property, a
4223 buffer or string. Bind `position' to the position in the
4224 object where the property was found, and `buffer-position'
4225 to the current position in the buffer. */
4228 XSETBUFFER (object
, current_buffer
);
4229 specbind (Qobject
, object
);
4230 specbind (Qposition
, make_number (CHARPOS (*position
)));
4231 specbind (Qbuffer_position
, make_number (bufpos
));
4233 form
= safe_eval (form
);
4235 unbind_to (count
, Qnil
);
4241 /* Handle `(height HEIGHT)' specifications. */
4243 && EQ (XCAR (spec
), Qheight
)
4244 && CONSP (XCDR (spec
)))
4248 if (!FRAME_WINDOW_P (it
->f
))
4251 it
->font_height
= XCAR (XCDR (spec
));
4252 if (!NILP (it
->font_height
))
4254 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4255 int new_height
= -1;
4257 if (CONSP (it
->font_height
)
4258 && (EQ (XCAR (it
->font_height
), Qplus
)
4259 || EQ (XCAR (it
->font_height
), Qminus
))
4260 && CONSP (XCDR (it
->font_height
))
4261 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4263 /* `(+ N)' or `(- N)' where N is an integer. */
4264 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4265 if (EQ (XCAR (it
->font_height
), Qplus
))
4267 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4269 else if (FUNCTIONP (it
->font_height
))
4271 /* Call function with current height as argument.
4272 Value is the new height. */
4274 height
= safe_call1 (it
->font_height
,
4275 face
->lface
[LFACE_HEIGHT_INDEX
]);
4276 if (NUMBERP (height
))
4277 new_height
= XFLOATINT (height
);
4279 else if (NUMBERP (it
->font_height
))
4281 /* Value is a multiple of the canonical char height. */
4284 f
= FACE_FROM_ID (it
->f
,
4285 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4286 new_height
= (XFLOATINT (it
->font_height
)
4287 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4291 /* Evaluate IT->font_height with `height' bound to the
4292 current specified height to get the new height. */
4293 int count
= SPECPDL_INDEX ();
4295 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4296 value
= safe_eval (it
->font_height
);
4297 unbind_to (count
, Qnil
);
4299 if (NUMBERP (value
))
4300 new_height
= XFLOATINT (value
);
4304 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4311 /* Handle `(space-width WIDTH)'. */
4313 && EQ (XCAR (spec
), Qspace_width
)
4314 && CONSP (XCDR (spec
)))
4318 if (!FRAME_WINDOW_P (it
->f
))
4321 value
= XCAR (XCDR (spec
));
4322 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4323 it
->space_width
= value
;
4329 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4331 && EQ (XCAR (spec
), Qslice
))
4337 if (!FRAME_WINDOW_P (it
->f
))
4340 if (tem
= XCDR (spec
), CONSP (tem
))
4342 it
->slice
.x
= XCAR (tem
);
4343 if (tem
= XCDR (tem
), CONSP (tem
))
4345 it
->slice
.y
= XCAR (tem
);
4346 if (tem
= XCDR (tem
), CONSP (tem
))
4348 it
->slice
.width
= XCAR (tem
);
4349 if (tem
= XCDR (tem
), CONSP (tem
))
4350 it
->slice
.height
= XCAR (tem
);
4359 /* Handle `(raise FACTOR)'. */
4361 && EQ (XCAR (spec
), Qraise
)
4362 && CONSP (XCDR (spec
)))
4366 if (!FRAME_WINDOW_P (it
->f
))
4369 #ifdef HAVE_WINDOW_SYSTEM
4370 value
= XCAR (XCDR (spec
));
4371 if (NUMBERP (value
))
4373 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4374 it
->voffset
= - (XFLOATINT (value
)
4375 * (FONT_HEIGHT (face
->font
)));
4377 #endif /* HAVE_WINDOW_SYSTEM */
4383 /* Don't handle the other kinds of display specifications
4384 inside a string that we got from a `display' property. */
4385 if (it
&& it
->string_from_display_prop_p
)
4388 /* Characters having this form of property are not displayed, so
4389 we have to find the end of the property. */
4392 start_pos
= *position
;
4393 *position
= display_prop_end (it
, object
, start_pos
);
4397 /* Stop the scan at that end position--we assume that all
4398 text properties change there. */
4400 it
->stop_charpos
= position
->charpos
;
4402 /* Handle `(left-fringe BITMAP [FACE])'
4403 and `(right-fringe BITMAP [FACE])'. */
4405 && (EQ (XCAR (spec
), Qleft_fringe
)
4406 || EQ (XCAR (spec
), Qright_fringe
))
4407 && CONSP (XCDR (spec
)))
4413 if (!FRAME_WINDOW_P (it
->f
))
4414 /* If we return here, POSITION has been advanced
4415 across the text with this property. */
4418 else if (!frame_window_p
)
4421 #ifdef HAVE_WINDOW_SYSTEM
4422 value
= XCAR (XCDR (spec
));
4423 if (!SYMBOLP (value
)
4424 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4425 /* If we return here, POSITION has been advanced
4426 across the text with this property. */
4431 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4433 if (CONSP (XCDR (XCDR (spec
))))
4435 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4436 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4442 /* Save current settings of IT so that we can restore them
4443 when we are finished with the glyph property value. */
4444 push_it (it
, position
);
4446 it
->area
= TEXT_AREA
;
4447 it
->what
= IT_IMAGE
;
4448 it
->image_id
= -1; /* no image */
4449 it
->position
= start_pos
;
4450 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4451 it
->method
= GET_FROM_IMAGE
;
4452 it
->from_overlay
= Qnil
;
4453 it
->face_id
= face_id
;
4454 it
->from_disp_prop_p
= 1;
4456 /* Say that we haven't consumed the characters with
4457 `display' property yet. The call to pop_it in
4458 set_iterator_to_next will clean this up. */
4459 *position
= start_pos
;
4461 if (EQ (XCAR (spec
), Qleft_fringe
))
4463 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4464 it
->left_user_fringe_face_id
= face_id
;
4468 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4469 it
->right_user_fringe_face_id
= face_id
;
4472 #endif /* HAVE_WINDOW_SYSTEM */
4476 /* Prepare to handle `((margin left-margin) ...)',
4477 `((margin right-margin) ...)' and `((margin nil) ...)'
4478 prefixes for display specifications. */
4479 location
= Qunbound
;
4480 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4484 value
= XCDR (spec
);
4486 value
= XCAR (value
);
4489 if (EQ (XCAR (tem
), Qmargin
)
4490 && (tem
= XCDR (tem
),
4491 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4493 || EQ (tem
, Qleft_margin
)
4494 || EQ (tem
, Qright_margin
))))
4498 if (EQ (location
, Qunbound
))
4504 /* After this point, VALUE is the property after any
4505 margin prefix has been stripped. It must be a string,
4506 an image specification, or `(space ...)'.
4508 LOCATION specifies where to display: `left-margin',
4509 `right-margin' or nil. */
4511 valid_p
= (STRINGP (value
)
4512 #ifdef HAVE_WINDOW_SYSTEM
4513 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4514 && valid_image_p (value
))
4515 #endif /* not HAVE_WINDOW_SYSTEM */
4516 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4518 if (valid_p
&& !display_replaced_p
)
4523 /* Save current settings of IT so that we can restore them
4524 when we are finished with the glyph property value. */
4525 push_it (it
, position
);
4526 it
->from_overlay
= overlay
;
4527 it
->from_disp_prop_p
= 1;
4529 if (NILP (location
))
4530 it
->area
= TEXT_AREA
;
4531 else if (EQ (location
, Qleft_margin
))
4532 it
->area
= LEFT_MARGIN_AREA
;
4534 it
->area
= RIGHT_MARGIN_AREA
;
4536 if (STRINGP (value
))
4539 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4540 it
->current
.overlay_string_index
= -1;
4541 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4542 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4543 it
->method
= GET_FROM_STRING
;
4544 it
->stop_charpos
= 0;
4546 it
->base_level_stop
= 0;
4547 it
->string_from_display_prop_p
= 1;
4548 /* Say that we haven't consumed the characters with
4549 `display' property yet. The call to pop_it in
4550 set_iterator_to_next will clean this up. */
4551 if (BUFFERP (object
))
4552 *position
= start_pos
;
4554 /* Force paragraph direction to be that of the parent
4555 object. If the parent object's paragraph direction is
4556 not yet determined, default to L2R. */
4557 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4558 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4560 it
->paragraph_embedding
= L2R
;
4562 /* Set up the bidi iterator for this display string. */
4565 it
->bidi_it
.string
.lstring
= it
->string
;
4566 it
->bidi_it
.string
.s
= NULL
;
4567 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4568 it
->bidi_it
.string
.bufpos
= bufpos
;
4569 it
->bidi_it
.string
.from_disp_str
= 1;
4570 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4571 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4574 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4576 it
->method
= GET_FROM_STRETCH
;
4578 *position
= it
->position
= start_pos
;
4580 #ifdef HAVE_WINDOW_SYSTEM
4583 it
->what
= IT_IMAGE
;
4584 it
->image_id
= lookup_image (it
->f
, value
);
4585 it
->position
= start_pos
;
4586 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4587 it
->method
= GET_FROM_IMAGE
;
4589 /* Say that we haven't consumed the characters with
4590 `display' property yet. The call to pop_it in
4591 set_iterator_to_next will clean this up. */
4592 *position
= start_pos
;
4594 #endif /* HAVE_WINDOW_SYSTEM */
4599 /* Invalid property or property not supported. Restore
4600 POSITION to what it was before. */
4601 *position
= start_pos
;
4605 /* Check if PROP is a display property value whose text should be
4606 treated as intangible. OVERLAY is the overlay from which PROP
4607 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4608 specify the buffer position covered by PROP. */
4611 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4612 EMACS_INT charpos
, EMACS_INT bytepos
)
4614 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4615 struct text_pos position
;
4617 SET_TEXT_POS (position
, charpos
, bytepos
);
4618 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4619 &position
, charpos
, frame_window_p
);
4623 /* Return 1 if PROP is a display sub-property value containing STRING.
4625 Implementation note: this and the following function are really
4626 special cases of handle_display_spec and
4627 handle_single_display_spec, and should ideally use the same code.
4628 Until they do, these two pairs must be consistent and must be
4629 modified in sync. */
4632 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4634 if (EQ (string
, prop
))
4637 /* Skip over `when FORM'. */
4638 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4643 /* Actually, the condition following `when' should be eval'ed,
4644 like handle_single_display_spec does, and we should return
4645 zero if it evaluates to nil. However, this function is
4646 called only when the buffer was already displayed and some
4647 glyph in the glyph matrix was found to come from a display
4648 string. Therefore, the condition was already evaluated, and
4649 the result was non-nil, otherwise the display string wouldn't
4650 have been displayed and we would have never been called for
4651 this property. Thus, we can skip the evaluation and assume
4652 its result is non-nil. */
4657 /* Skip over `margin LOCATION'. */
4658 if (EQ (XCAR (prop
), Qmargin
))
4669 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4673 /* Return 1 if STRING appears in the `display' property PROP. */
4676 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4679 && !EQ (XCAR (prop
), Qwhen
)
4680 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4682 /* A list of sub-properties. */
4683 while (CONSP (prop
))
4685 if (single_display_spec_string_p (XCAR (prop
), string
))
4690 else if (VECTORP (prop
))
4692 /* A vector of sub-properties. */
4694 for (i
= 0; i
< ASIZE (prop
); ++i
)
4695 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4699 return single_display_spec_string_p (prop
, string
);
4704 /* Look for STRING in overlays and text properties in the current
4705 buffer, between character positions FROM and TO (excluding TO).
4706 BACK_P non-zero means look back (in this case, TO is supposed to be
4708 Value is the first character position where STRING was found, or
4709 zero if it wasn't found before hitting TO.
4711 This function may only use code that doesn't eval because it is
4712 called asynchronously from note_mouse_highlight. */
4715 string_buffer_position_lim (Lisp_Object string
,
4716 EMACS_INT from
, EMACS_INT to
, int back_p
)
4718 Lisp_Object limit
, prop
, pos
;
4721 pos
= make_number (from
);
4723 if (!back_p
) /* looking forward */
4725 limit
= make_number (min (to
, ZV
));
4726 while (!found
&& !EQ (pos
, limit
))
4728 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4729 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4732 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4736 else /* looking back */
4738 limit
= make_number (max (to
, BEGV
));
4739 while (!found
&& !EQ (pos
, limit
))
4741 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4742 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4745 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4750 return found
? XINT (pos
) : 0;
4753 /* Determine which buffer position in current buffer STRING comes from.
4754 AROUND_CHARPOS is an approximate position where it could come from.
4755 Value is the buffer position or 0 if it couldn't be determined.
4757 This function is necessary because we don't record buffer positions
4758 in glyphs generated from strings (to keep struct glyph small).
4759 This function may only use code that doesn't eval because it is
4760 called asynchronously from note_mouse_highlight. */
4763 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
4765 const int MAX_DISTANCE
= 1000;
4766 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
4767 around_charpos
+ MAX_DISTANCE
,
4771 found
= string_buffer_position_lim (string
, around_charpos
,
4772 around_charpos
- MAX_DISTANCE
, 1);
4778 /***********************************************************************
4779 `composition' property
4780 ***********************************************************************/
4782 /* Set up iterator IT from `composition' property at its current
4783 position. Called from handle_stop. */
4785 static enum prop_handled
4786 handle_composition_prop (struct it
*it
)
4788 Lisp_Object prop
, string
;
4789 EMACS_INT pos
, pos_byte
, start
, end
;
4791 if (STRINGP (it
->string
))
4795 pos
= IT_STRING_CHARPOS (*it
);
4796 pos_byte
= IT_STRING_BYTEPOS (*it
);
4797 string
= it
->string
;
4798 s
= SDATA (string
) + pos_byte
;
4799 it
->c
= STRING_CHAR (s
);
4803 pos
= IT_CHARPOS (*it
);
4804 pos_byte
= IT_BYTEPOS (*it
);
4806 it
->c
= FETCH_CHAR (pos_byte
);
4809 /* If there's a valid composition and point is not inside of the
4810 composition (in the case that the composition is from the current
4811 buffer), draw a glyph composed from the composition components. */
4812 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
4813 && COMPOSITION_VALID_P (start
, end
, prop
)
4814 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
4817 /* As we can't handle this situation (perhaps font-lock added
4818 a new composition), we just return here hoping that next
4819 redisplay will detect this composition much earlier. */
4820 return HANDLED_NORMALLY
;
4823 if (STRINGP (it
->string
))
4824 pos_byte
= string_char_to_byte (it
->string
, start
);
4826 pos_byte
= CHAR_TO_BYTE (start
);
4828 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
4831 if (it
->cmp_it
.id
>= 0)
4834 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
4835 it
->cmp_it
.nglyphs
= -1;
4839 return HANDLED_NORMALLY
;
4844 /***********************************************************************
4846 ***********************************************************************/
4848 /* The following structure is used to record overlay strings for
4849 later sorting in load_overlay_strings. */
4851 struct overlay_entry
4853 Lisp_Object overlay
;
4860 /* Set up iterator IT from overlay strings at its current position.
4861 Called from handle_stop. */
4863 static enum prop_handled
4864 handle_overlay_change (struct it
*it
)
4866 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
4867 return HANDLED_RECOMPUTE_PROPS
;
4869 return HANDLED_NORMALLY
;
4873 /* Set up the next overlay string for delivery by IT, if there is an
4874 overlay string to deliver. Called by set_iterator_to_next when the
4875 end of the current overlay string is reached. If there are more
4876 overlay strings to display, IT->string and
4877 IT->current.overlay_string_index are set appropriately here.
4878 Otherwise IT->string is set to nil. */
4881 next_overlay_string (struct it
*it
)
4883 ++it
->current
.overlay_string_index
;
4884 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
4886 /* No more overlay strings. Restore IT's settings to what
4887 they were before overlay strings were processed, and
4888 continue to deliver from current_buffer. */
4890 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
4893 || (NILP (it
->string
)
4894 && it
->method
== GET_FROM_BUFFER
4895 && it
->stop_charpos
>= BEGV
4896 && it
->stop_charpos
<= it
->end_charpos
));
4897 it
->current
.overlay_string_index
= -1;
4898 it
->n_overlay_strings
= 0;
4899 it
->overlay_strings_charpos
= -1;
4901 /* If we're at the end of the buffer, record that we have
4902 processed the overlay strings there already, so that
4903 next_element_from_buffer doesn't try it again. */
4904 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
4905 it
->overlay_strings_at_end_processed_p
= 1;
4909 /* There are more overlay strings to process. If
4910 IT->current.overlay_string_index has advanced to a position
4911 where we must load IT->overlay_strings with more strings, do
4912 it. We must load at the IT->overlay_strings_charpos where
4913 IT->n_overlay_strings was originally computed; when invisible
4914 text is present, this might not be IT_CHARPOS (Bug#7016). */
4915 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
4917 if (it
->current
.overlay_string_index
&& i
== 0)
4918 load_overlay_strings (it
, it
->overlay_strings_charpos
);
4920 /* Initialize IT to deliver display elements from the overlay
4922 it
->string
= it
->overlay_strings
[i
];
4923 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4924 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
4925 it
->method
= GET_FROM_STRING
;
4926 it
->stop_charpos
= 0;
4927 if (it
->cmp_it
.stop_pos
>= 0)
4928 it
->cmp_it
.stop_pos
= 0;
4930 it
->base_level_stop
= 0;
4932 /* Set up the bidi iterator for this overlay string. */
4935 it
->bidi_it
.string
.lstring
= it
->string
;
4936 it
->bidi_it
.string
.s
= NULL
;
4937 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
4938 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
4939 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
4940 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4941 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4949 /* Compare two overlay_entry structures E1 and E2. Used as a
4950 comparison function for qsort in load_overlay_strings. Overlay
4951 strings for the same position are sorted so that
4953 1. All after-strings come in front of before-strings, except
4954 when they come from the same overlay.
4956 2. Within after-strings, strings are sorted so that overlay strings
4957 from overlays with higher priorities come first.
4959 2. Within before-strings, strings are sorted so that overlay
4960 strings from overlays with higher priorities come last.
4962 Value is analogous to strcmp. */
4966 compare_overlay_entries (const void *e1
, const void *e2
)
4968 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
4969 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
4972 if (entry1
->after_string_p
!= entry2
->after_string_p
)
4974 /* Let after-strings appear in front of before-strings if
4975 they come from different overlays. */
4976 if (EQ (entry1
->overlay
, entry2
->overlay
))
4977 result
= entry1
->after_string_p
? 1 : -1;
4979 result
= entry1
->after_string_p
? -1 : 1;
4981 else if (entry1
->after_string_p
)
4982 /* After-strings sorted in order of decreasing priority. */
4983 result
= entry2
->priority
- entry1
->priority
;
4985 /* Before-strings sorted in order of increasing priority. */
4986 result
= entry1
->priority
- entry2
->priority
;
4992 /* Load the vector IT->overlay_strings with overlay strings from IT's
4993 current buffer position, or from CHARPOS if that is > 0. Set
4994 IT->n_overlays to the total number of overlay strings found.
4996 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
4997 a time. On entry into load_overlay_strings,
4998 IT->current.overlay_string_index gives the number of overlay
4999 strings that have already been loaded by previous calls to this
5002 IT->add_overlay_start contains an additional overlay start
5003 position to consider for taking overlay strings from, if non-zero.
5004 This position comes into play when the overlay has an `invisible'
5005 property, and both before and after-strings. When we've skipped to
5006 the end of the overlay, because of its `invisible' property, we
5007 nevertheless want its before-string to appear.
5008 IT->add_overlay_start will contain the overlay start position
5011 Overlay strings are sorted so that after-string strings come in
5012 front of before-string strings. Within before and after-strings,
5013 strings are sorted by overlay priority. See also function
5014 compare_overlay_entries. */
5017 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5019 Lisp_Object overlay
, window
, str
, invisible
;
5020 struct Lisp_Overlay
*ov
;
5021 EMACS_INT start
, end
;
5023 int n
= 0, i
, j
, invis_p
;
5024 struct overlay_entry
*entries
5025 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5028 charpos
= IT_CHARPOS (*it
);
5030 /* Append the overlay string STRING of overlay OVERLAY to vector
5031 `entries' which has size `size' and currently contains `n'
5032 elements. AFTER_P non-zero means STRING is an after-string of
5034 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5037 Lisp_Object priority; \
5041 int new_size = 2 * size; \
5042 struct overlay_entry *old = entries; \
5044 (struct overlay_entry *) alloca (new_size \
5045 * sizeof *entries); \
5046 memcpy (entries, old, size * sizeof *entries); \
5050 entries[n].string = (STRING); \
5051 entries[n].overlay = (OVERLAY); \
5052 priority = Foverlay_get ((OVERLAY), Qpriority); \
5053 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5054 entries[n].after_string_p = (AFTER_P); \
5059 /* Process overlay before the overlay center. */
5060 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5062 XSETMISC (overlay
, ov
);
5063 xassert (OVERLAYP (overlay
));
5064 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5065 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5070 /* Skip this overlay if it doesn't start or end at IT's current
5072 if (end
!= charpos
&& start
!= charpos
)
5075 /* Skip this overlay if it doesn't apply to IT->w. */
5076 window
= Foverlay_get (overlay
, Qwindow
);
5077 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5080 /* If the text ``under'' the overlay is invisible, both before-
5081 and after-strings from this overlay are visible; start and
5082 end position are indistinguishable. */
5083 invisible
= Foverlay_get (overlay
, Qinvisible
);
5084 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5086 /* If overlay has a non-empty before-string, record it. */
5087 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5088 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5090 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5092 /* If overlay has a non-empty after-string, record it. */
5093 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5094 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5096 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5099 /* Process overlays after the overlay center. */
5100 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5102 XSETMISC (overlay
, ov
);
5103 xassert (OVERLAYP (overlay
));
5104 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5105 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5107 if (start
> charpos
)
5110 /* Skip this overlay if it doesn't start or end at IT's current
5112 if (end
!= charpos
&& start
!= charpos
)
5115 /* Skip this overlay if it doesn't apply to IT->w. */
5116 window
= Foverlay_get (overlay
, Qwindow
);
5117 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5120 /* If the text ``under'' the overlay is invisible, it has a zero
5121 dimension, and both before- and after-strings apply. */
5122 invisible
= Foverlay_get (overlay
, Qinvisible
);
5123 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5125 /* If overlay has a non-empty before-string, record it. */
5126 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5127 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5129 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5131 /* If overlay has a non-empty after-string, record it. */
5132 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5133 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5135 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5138 #undef RECORD_OVERLAY_STRING
5142 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5144 /* Record number of overlay strings, and where we computed it. */
5145 it
->n_overlay_strings
= n
;
5146 it
->overlay_strings_charpos
= charpos
;
5148 /* IT->current.overlay_string_index is the number of overlay strings
5149 that have already been consumed by IT. Copy some of the
5150 remaining overlay strings to IT->overlay_strings. */
5152 j
= it
->current
.overlay_string_index
;
5153 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5155 it
->overlay_strings
[i
] = entries
[j
].string
;
5156 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5163 /* Get the first chunk of overlay strings at IT's current buffer
5164 position, or at CHARPOS if that is > 0. Value is non-zero if at
5165 least one overlay string was found. */
5168 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5170 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5171 process. This fills IT->overlay_strings with strings, and sets
5172 IT->n_overlay_strings to the total number of strings to process.
5173 IT->pos.overlay_string_index has to be set temporarily to zero
5174 because load_overlay_strings needs this; it must be set to -1
5175 when no overlay strings are found because a zero value would
5176 indicate a position in the first overlay string. */
5177 it
->current
.overlay_string_index
= 0;
5178 load_overlay_strings (it
, charpos
);
5180 /* If we found overlay strings, set up IT to deliver display
5181 elements from the first one. Otherwise set up IT to deliver
5182 from current_buffer. */
5183 if (it
->n_overlay_strings
)
5185 /* Make sure we know settings in current_buffer, so that we can
5186 restore meaningful values when we're done with the overlay
5189 compute_stop_pos (it
);
5190 xassert (it
->face_id
>= 0);
5192 /* Save IT's settings. They are restored after all overlay
5193 strings have been processed. */
5194 xassert (!compute_stop_p
|| it
->sp
== 0);
5196 /* When called from handle_stop, there might be an empty display
5197 string loaded. In that case, don't bother saving it. */
5198 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5201 /* Set up IT to deliver display elements from the first overlay
5203 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5204 it
->string
= it
->overlay_strings
[0];
5205 it
->from_overlay
= Qnil
;
5206 it
->stop_charpos
= 0;
5207 xassert (STRINGP (it
->string
));
5208 it
->end_charpos
= SCHARS (it
->string
);
5210 it
->base_level_stop
= 0;
5211 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5212 it
->method
= GET_FROM_STRING
;
5213 it
->from_disp_prop_p
= 0;
5215 /* Force paragraph direction to be that of the parent
5217 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5218 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5220 it
->paragraph_embedding
= L2R
;
5222 /* Set up the bidi iterator for this overlay string. */
5225 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5227 it
->bidi_it
.string
.lstring
= it
->string
;
5228 it
->bidi_it
.string
.s
= NULL
;
5229 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5230 it
->bidi_it
.string
.bufpos
= pos
;
5231 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5232 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5233 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5238 it
->current
.overlay_string_index
= -1;
5243 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5246 it
->method
= GET_FROM_BUFFER
;
5248 (void) get_overlay_strings_1 (it
, charpos
, 1);
5252 /* Value is non-zero if we found at least one overlay string. */
5253 return STRINGP (it
->string
);
5258 /***********************************************************************
5259 Saving and restoring state
5260 ***********************************************************************/
5262 /* Save current settings of IT on IT->stack. Called, for example,
5263 before setting up IT for an overlay string, to be able to restore
5264 IT's settings to what they were after the overlay string has been
5265 processed. If POSITION is non-NULL, it is the position to save on
5266 the stack instead of IT->position. */
5269 push_it (struct it
*it
, struct text_pos
*position
)
5271 struct iterator_stack_entry
*p
;
5273 xassert (it
->sp
< IT_STACK_SIZE
);
5274 p
= it
->stack
+ it
->sp
;
5276 p
->stop_charpos
= it
->stop_charpos
;
5277 p
->prev_stop
= it
->prev_stop
;
5278 p
->base_level_stop
= it
->base_level_stop
;
5279 p
->cmp_it
= it
->cmp_it
;
5280 xassert (it
->face_id
>= 0);
5281 p
->face_id
= it
->face_id
;
5282 p
->string
= it
->string
;
5283 p
->method
= it
->method
;
5284 p
->from_overlay
= it
->from_overlay
;
5287 case GET_FROM_IMAGE
:
5288 p
->u
.image
.object
= it
->object
;
5289 p
->u
.image
.image_id
= it
->image_id
;
5290 p
->u
.image
.slice
= it
->slice
;
5292 case GET_FROM_STRETCH
:
5293 p
->u
.stretch
.object
= it
->object
;
5296 p
->position
= position
? *position
: it
->position
;
5297 p
->current
= it
->current
;
5298 p
->end_charpos
= it
->end_charpos
;
5299 p
->string_nchars
= it
->string_nchars
;
5301 p
->multibyte_p
= it
->multibyte_p
;
5302 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5303 p
->space_width
= it
->space_width
;
5304 p
->font_height
= it
->font_height
;
5305 p
->voffset
= it
->voffset
;
5306 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5307 p
->display_ellipsis_p
= 0;
5308 p
->line_wrap
= it
->line_wrap
;
5309 p
->bidi_p
= it
->bidi_p
;
5310 p
->paragraph_embedding
= it
->paragraph_embedding
;
5311 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5314 /* Save the state of the bidi iterator as well. */
5316 bidi_push_it (&it
->bidi_it
);
5320 iterate_out_of_display_property (struct it
*it
)
5322 int buffer_p
= BUFFERP (it
->object
);
5323 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5324 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5326 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5328 /* Maybe initialize paragraph direction. If we are at the beginning
5329 of a new paragraph, next_element_from_buffer may not have a
5330 chance to do that. */
5331 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5332 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5333 /* prev_stop can be zero, so check against BEGV as well. */
5334 while (it
->bidi_it
.charpos
>= bob
5335 && it
->prev_stop
<= it
->bidi_it
.charpos
5336 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5337 && it
->bidi_it
.charpos
< eob
)
5338 bidi_move_to_visually_next (&it
->bidi_it
);
5339 /* Record the stop_pos we just crossed, for when we cross it
5341 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5342 it
->prev_stop
= CHARPOS (it
->position
);
5343 /* If we ended up not where pop_it put us, resync IT's
5344 positional members with the bidi iterator. */
5345 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5346 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5348 it
->current
.pos
= it
->position
;
5350 it
->current
.string_pos
= it
->position
;
5353 /* Restore IT's settings from IT->stack. Called, for example, when no
5354 more overlay strings must be processed, and we return to delivering
5355 display elements from a buffer, or when the end of a string from a
5356 `display' property is reached and we return to delivering display
5357 elements from an overlay string, or from a buffer. */
5360 pop_it (struct it
*it
)
5362 struct iterator_stack_entry
*p
;
5363 int from_display_prop
= it
->from_disp_prop_p
;
5365 xassert (it
->sp
> 0);
5367 p
= it
->stack
+ it
->sp
;
5368 it
->stop_charpos
= p
->stop_charpos
;
5369 it
->prev_stop
= p
->prev_stop
;
5370 it
->base_level_stop
= p
->base_level_stop
;
5371 it
->cmp_it
= p
->cmp_it
;
5372 it
->face_id
= p
->face_id
;
5373 it
->current
= p
->current
;
5374 it
->position
= p
->position
;
5375 it
->string
= p
->string
;
5376 it
->from_overlay
= p
->from_overlay
;
5377 if (NILP (it
->string
))
5378 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5379 it
->method
= p
->method
;
5382 case GET_FROM_IMAGE
:
5383 it
->image_id
= p
->u
.image
.image_id
;
5384 it
->object
= p
->u
.image
.object
;
5385 it
->slice
= p
->u
.image
.slice
;
5387 case GET_FROM_STRETCH
:
5388 it
->object
= p
->u
.stretch
.object
;
5390 case GET_FROM_BUFFER
:
5391 it
->object
= it
->w
->buffer
;
5393 case GET_FROM_STRING
:
5394 it
->object
= it
->string
;
5396 case GET_FROM_DISPLAY_VECTOR
:
5398 it
->method
= GET_FROM_C_STRING
;
5399 else if (STRINGP (it
->string
))
5400 it
->method
= GET_FROM_STRING
;
5403 it
->method
= GET_FROM_BUFFER
;
5404 it
->object
= it
->w
->buffer
;
5407 it
->end_charpos
= p
->end_charpos
;
5408 it
->string_nchars
= p
->string_nchars
;
5410 it
->multibyte_p
= p
->multibyte_p
;
5411 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5412 it
->space_width
= p
->space_width
;
5413 it
->font_height
= p
->font_height
;
5414 it
->voffset
= p
->voffset
;
5415 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5416 it
->line_wrap
= p
->line_wrap
;
5417 it
->bidi_p
= p
->bidi_p
;
5418 it
->paragraph_embedding
= p
->paragraph_embedding
;
5419 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5422 bidi_pop_it (&it
->bidi_it
);
5423 /* Bidi-iterate until we get out of the portion of text, if any,
5424 covered by a `display' text property or by an overlay with
5425 `display' property. (We cannot just jump there, because the
5426 internal coherency of the bidi iterator state can not be
5427 preserved across such jumps.) We also must determine the
5428 paragraph base direction if the overlay we just processed is
5429 at the beginning of a new paragraph. */
5430 if (from_display_prop
5431 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5432 iterate_out_of_display_property (it
);
5434 xassert ((BUFFERP (it
->object
)
5435 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5436 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5437 || (STRINGP (it
->object
)
5438 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5439 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
));
5445 /***********************************************************************
5447 ***********************************************************************/
5449 /* Set IT's current position to the previous line start. */
5452 back_to_previous_line_start (struct it
*it
)
5454 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5455 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5459 /* Move IT to the next line start.
5461 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5462 we skipped over part of the text (as opposed to moving the iterator
5463 continuously over the text). Otherwise, don't change the value
5466 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5467 iterator on the newline, if it was found.
5469 Newlines may come from buffer text, overlay strings, or strings
5470 displayed via the `display' property. That's the reason we can't
5471 simply use find_next_newline_no_quit.
5473 Note that this function may not skip over invisible text that is so
5474 because of text properties and immediately follows a newline. If
5475 it would, function reseat_at_next_visible_line_start, when called
5476 from set_iterator_to_next, would effectively make invisible
5477 characters following a newline part of the wrong glyph row, which
5478 leads to wrong cursor motion. */
5481 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5482 struct bidi_it
*bidi_it_prev
)
5484 EMACS_INT old_selective
;
5485 int newline_found_p
, n
;
5486 const int MAX_NEWLINE_DISTANCE
= 500;
5488 /* If already on a newline, just consume it to avoid unintended
5489 skipping over invisible text below. */
5490 if (it
->what
== IT_CHARACTER
5492 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5494 if (it
->bidi_p
&& bidi_it_prev
)
5495 *bidi_it_prev
= it
->bidi_it
;
5496 set_iterator_to_next (it
, 0);
5501 /* Don't handle selective display in the following. It's (a)
5502 unnecessary because it's done by the caller, and (b) leads to an
5503 infinite recursion because next_element_from_ellipsis indirectly
5504 calls this function. */
5505 old_selective
= it
->selective
;
5508 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5509 from buffer text. */
5510 for (n
= newline_found_p
= 0;
5511 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5512 n
+= STRINGP (it
->string
) ? 0 : 1)
5514 if (!get_next_display_element (it
))
5516 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5517 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5518 *bidi_it_prev
= it
->bidi_it
;
5519 set_iterator_to_next (it
, 0);
5522 /* If we didn't find a newline near enough, see if we can use a
5524 if (!newline_found_p
)
5526 EMACS_INT start
= IT_CHARPOS (*it
);
5527 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5530 xassert (!STRINGP (it
->string
));
5532 /* If there isn't any `display' property in sight, and no
5533 overlays, we can just use the position of the newline in
5535 if (it
->stop_charpos
>= limit
5536 || ((pos
= Fnext_single_property_change (make_number (start
),
5538 make_number (limit
)),
5540 && next_overlay_change (start
) == ZV
))
5544 IT_CHARPOS (*it
) = limit
;
5545 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5549 struct bidi_it bprev
;
5551 /* Help bidi.c avoid expensive searches for display
5552 properties and overlays, by telling it that there are
5553 none up to `limit'. */
5554 if (it
->bidi_it
.disp_pos
< limit
)
5556 it
->bidi_it
.disp_pos
= limit
;
5557 it
->bidi_it
.disp_prop_p
= 0;
5560 bprev
= it
->bidi_it
;
5561 bidi_move_to_visually_next (&it
->bidi_it
);
5562 } while (it
->bidi_it
.charpos
!= limit
);
5563 IT_CHARPOS (*it
) = limit
;
5564 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5566 *bidi_it_prev
= bprev
;
5568 *skipped_p
= newline_found_p
= 1;
5572 while (get_next_display_element (it
)
5573 && !newline_found_p
)
5575 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5576 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5577 *bidi_it_prev
= it
->bidi_it
;
5578 set_iterator_to_next (it
, 0);
5583 it
->selective
= old_selective
;
5584 return newline_found_p
;
5588 /* Set IT's current position to the previous visible line start. Skip
5589 invisible text that is so either due to text properties or due to
5590 selective display. Caution: this does not change IT->current_x and
5594 back_to_previous_visible_line_start (struct it
*it
)
5596 while (IT_CHARPOS (*it
) > BEGV
)
5598 back_to_previous_line_start (it
);
5600 if (IT_CHARPOS (*it
) <= BEGV
)
5603 /* If selective > 0, then lines indented more than its value are
5605 if (it
->selective
> 0
5606 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5610 /* Check the newline before point for invisibility. */
5613 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5614 Qinvisible
, it
->window
);
5615 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5619 if (IT_CHARPOS (*it
) <= BEGV
)
5624 void *it2data
= NULL
;
5627 Lisp_Object val
, overlay
;
5629 SAVE_IT (it2
, *it
, it2data
);
5631 /* If newline is part of a composition, continue from start of composition */
5632 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5633 && beg
< IT_CHARPOS (*it
))
5636 /* If newline is replaced by a display property, find start of overlay
5637 or interval and continue search from that point. */
5638 pos
= --IT_CHARPOS (it2
);
5641 bidi_unshelve_cache (NULL
, 0);
5642 it2
.string_from_display_prop_p
= 0;
5643 it2
.from_disp_prop_p
= 0;
5644 if (handle_display_prop (&it2
) == HANDLED_RETURN
5645 && !NILP (val
= get_char_property_and_overlay
5646 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5647 && (OVERLAYP (overlay
)
5648 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5649 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5651 RESTORE_IT (it
, it
, it2data
);
5655 /* Newline is not replaced by anything -- so we are done. */
5656 RESTORE_IT (it
, it
, it2data
);
5662 IT_CHARPOS (*it
) = beg
;
5663 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5667 it
->continuation_lines_width
= 0;
5669 xassert (IT_CHARPOS (*it
) >= BEGV
);
5670 xassert (IT_CHARPOS (*it
) == BEGV
5671 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5676 /* Reseat iterator IT at the previous visible line start. Skip
5677 invisible text that is so either due to text properties or due to
5678 selective display. At the end, update IT's overlay information,
5679 face information etc. */
5682 reseat_at_previous_visible_line_start (struct it
*it
)
5684 back_to_previous_visible_line_start (it
);
5685 reseat (it
, it
->current
.pos
, 1);
5690 /* Reseat iterator IT on the next visible line start in the current
5691 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5692 preceding the line start. Skip over invisible text that is so
5693 because of selective display. Compute faces, overlays etc at the
5694 new position. Note that this function does not skip over text that
5695 is invisible because of text properties. */
5698 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5700 int newline_found_p
, skipped_p
= 0;
5701 struct bidi_it bidi_it_prev
;
5703 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5705 /* Skip over lines that are invisible because they are indented
5706 more than the value of IT->selective. */
5707 if (it
->selective
> 0)
5708 while (IT_CHARPOS (*it
) < ZV
5709 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5712 xassert (IT_BYTEPOS (*it
) == BEGV
5713 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5715 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5718 /* Position on the newline if that's what's requested. */
5719 if (on_newline_p
&& newline_found_p
)
5721 if (STRINGP (it
->string
))
5723 if (IT_STRING_CHARPOS (*it
) > 0)
5727 --IT_STRING_CHARPOS (*it
);
5728 --IT_STRING_BYTEPOS (*it
);
5732 /* We need to restore the bidi iterator to the state
5733 it had on the newline, and resync the IT's
5734 position with that. */
5735 it
->bidi_it
= bidi_it_prev
;
5736 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5737 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5741 else if (IT_CHARPOS (*it
) > BEGV
)
5750 /* We need to restore the bidi iterator to the state it
5751 had on the newline and resync IT with that. */
5752 it
->bidi_it
= bidi_it_prev
;
5753 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5754 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5756 reseat (it
, it
->current
.pos
, 0);
5760 reseat (it
, it
->current
.pos
, 0);
5767 /***********************************************************************
5768 Changing an iterator's position
5769 ***********************************************************************/
5771 /* Change IT's current position to POS in current_buffer. If FORCE_P
5772 is non-zero, always check for text properties at the new position.
5773 Otherwise, text properties are only looked up if POS >=
5774 IT->check_charpos of a property. */
5777 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
5779 EMACS_INT original_pos
= IT_CHARPOS (*it
);
5781 reseat_1 (it
, pos
, 0);
5783 /* Determine where to check text properties. Avoid doing it
5784 where possible because text property lookup is very expensive. */
5786 || CHARPOS (pos
) > it
->stop_charpos
5787 || CHARPOS (pos
) < original_pos
)
5791 /* For bidi iteration, we need to prime prev_stop and
5792 base_level_stop with our best estimations. */
5793 /* Implementation note: Of course, POS is not necessarily a
5794 stop position, so assigning prev_pos to it is a lie; we
5795 should have called compute_stop_backwards. However, if
5796 the current buffer does not include any R2L characters,
5797 that call would be a waste of cycles, because the
5798 iterator will never move back, and thus never cross this
5799 "fake" stop position. So we delay that backward search
5800 until the time we really need it, in next_element_from_buffer. */
5801 if (CHARPOS (pos
) != it
->prev_stop
)
5802 it
->prev_stop
= CHARPOS (pos
);
5803 if (CHARPOS (pos
) < it
->base_level_stop
)
5804 it
->base_level_stop
= 0; /* meaning it's unknown */
5810 it
->prev_stop
= it
->base_level_stop
= 0;
5819 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
5820 IT->stop_pos to POS, also. */
5823 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
5825 /* Don't call this function when scanning a C string. */
5826 xassert (it
->s
== NULL
);
5828 /* POS must be a reasonable value. */
5829 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
5831 it
->current
.pos
= it
->position
= pos
;
5832 it
->end_charpos
= ZV
;
5834 it
->current
.dpvec_index
= -1;
5835 it
->current
.overlay_string_index
= -1;
5836 IT_STRING_CHARPOS (*it
) = -1;
5837 IT_STRING_BYTEPOS (*it
) = -1;
5839 it
->method
= GET_FROM_BUFFER
;
5840 it
->object
= it
->w
->buffer
;
5841 it
->area
= TEXT_AREA
;
5842 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
5844 it
->string_from_display_prop_p
= 0;
5845 it
->from_disp_prop_p
= 0;
5846 it
->face_before_selective_p
= 0;
5849 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5851 bidi_unshelve_cache (NULL
, 0);
5852 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5853 it
->bidi_it
.string
.s
= NULL
;
5854 it
->bidi_it
.string
.lstring
= Qnil
;
5855 it
->bidi_it
.string
.bufpos
= 0;
5856 it
->bidi_it
.string
.unibyte
= 0;
5861 it
->stop_charpos
= CHARPOS (pos
);
5862 it
->base_level_stop
= CHARPOS (pos
);
5867 /* Set up IT for displaying a string, starting at CHARPOS in window W.
5868 If S is non-null, it is a C string to iterate over. Otherwise,
5869 STRING gives a Lisp string to iterate over.
5871 If PRECISION > 0, don't return more then PRECISION number of
5872 characters from the string.
5874 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
5875 characters have been returned. FIELD_WIDTH < 0 means an infinite
5878 MULTIBYTE = 0 means disable processing of multibyte characters,
5879 MULTIBYTE > 0 means enable it,
5880 MULTIBYTE < 0 means use IT->multibyte_p.
5882 IT must be initialized via a prior call to init_iterator before
5883 calling this function. */
5886 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
5887 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
5890 /* No region in strings. */
5891 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
5893 /* No text property checks performed by default, but see below. */
5894 it
->stop_charpos
= -1;
5896 /* Set iterator position and end position. */
5897 memset (&it
->current
, 0, sizeof it
->current
);
5898 it
->current
.overlay_string_index
= -1;
5899 it
->current
.dpvec_index
= -1;
5900 xassert (charpos
>= 0);
5902 /* If STRING is specified, use its multibyteness, otherwise use the
5903 setting of MULTIBYTE, if specified. */
5905 it
->multibyte_p
= multibyte
> 0;
5907 /* Bidirectional reordering of strings is controlled by the default
5908 value of bidi-display-reordering. */
5909 it
->bidi_p
= !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
5913 xassert (STRINGP (string
));
5914 it
->string
= string
;
5916 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
5917 it
->method
= GET_FROM_STRING
;
5918 it
->current
.string_pos
= string_pos (charpos
, string
);
5922 it
->bidi_it
.string
.lstring
= string
;
5923 it
->bidi_it
.string
.s
= NULL
;
5924 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5925 it
->bidi_it
.string
.bufpos
= 0;
5926 it
->bidi_it
.string
.from_disp_str
= 0;
5927 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5928 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
5929 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5934 it
->s
= (const unsigned char *) s
;
5937 /* Note that we use IT->current.pos, not it->current.string_pos,
5938 for displaying C strings. */
5939 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
5940 if (it
->multibyte_p
)
5942 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
5943 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
5947 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
5948 it
->end_charpos
= it
->string_nchars
= strlen (s
);
5953 it
->bidi_it
.string
.lstring
= Qnil
;
5954 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
5955 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5956 it
->bidi_it
.string
.bufpos
= 0;
5957 it
->bidi_it
.string
.from_disp_str
= 0;
5958 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5959 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
5962 it
->method
= GET_FROM_C_STRING
;
5965 /* PRECISION > 0 means don't return more than PRECISION characters
5967 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
5969 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
5971 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5974 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
5975 characters have been returned. FIELD_WIDTH == 0 means don't pad,
5976 FIELD_WIDTH < 0 means infinite field width. This is useful for
5977 padding with `-' at the end of a mode line. */
5978 if (field_width
< 0)
5979 field_width
= INFINITY
;
5980 /* Implementation note: We deliberately don't enlarge
5981 it->bidi_it.string.schars here to fit it->end_charpos, because
5982 the bidi iterator cannot produce characters out of thin air. */
5983 if (field_width
> it
->end_charpos
- charpos
)
5984 it
->end_charpos
= charpos
+ field_width
;
5986 /* Use the standard display table for displaying strings. */
5987 if (DISP_TABLE_P (Vstandard_display_table
))
5988 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
5990 it
->stop_charpos
= charpos
;
5991 it
->prev_stop
= charpos
;
5992 it
->base_level_stop
= 0;
5995 it
->bidi_it
.first_elt
= 1;
5996 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
5997 it
->bidi_it
.disp_pos
= -1;
5999 if (s
== NULL
&& it
->multibyte_p
)
6001 EMACS_INT endpos
= SCHARS (it
->string
);
6002 if (endpos
> it
->end_charpos
)
6003 endpos
= it
->end_charpos
;
6004 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6012 /***********************************************************************
6014 ***********************************************************************/
6016 /* Map enum it_method value to corresponding next_element_from_* function. */
6018 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6020 next_element_from_buffer
,
6021 next_element_from_display_vector
,
6022 next_element_from_string
,
6023 next_element_from_c_string
,
6024 next_element_from_image
,
6025 next_element_from_stretch
6028 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6031 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6032 (possibly with the following characters). */
6034 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6035 ((IT)->cmp_it.id >= 0 \
6036 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6037 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6038 END_CHARPOS, (IT)->w, \
6039 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6043 /* Lookup the char-table Vglyphless_char_display for character C (-1
6044 if we want information for no-font case), and return the display
6045 method symbol. By side-effect, update it->what and
6046 it->glyphless_method. This function is called from
6047 get_next_display_element for each character element, and from
6048 x_produce_glyphs when no suitable font was found. */
6051 lookup_glyphless_char_display (int c
, struct it
*it
)
6053 Lisp_Object glyphless_method
= Qnil
;
6055 if (CHAR_TABLE_P (Vglyphless_char_display
)
6056 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6060 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6061 if (CONSP (glyphless_method
))
6062 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6063 ? XCAR (glyphless_method
)
6064 : XCDR (glyphless_method
);
6067 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6071 if (NILP (glyphless_method
))
6074 /* The default is to display the character by a proper font. */
6076 /* The default for the no-font case is to display an empty box. */
6077 glyphless_method
= Qempty_box
;
6079 if (EQ (glyphless_method
, Qzero_width
))
6082 return glyphless_method
;
6083 /* This method can't be used for the no-font case. */
6084 glyphless_method
= Qempty_box
;
6086 if (EQ (glyphless_method
, Qthin_space
))
6087 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6088 else if (EQ (glyphless_method
, Qempty_box
))
6089 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6090 else if (EQ (glyphless_method
, Qhex_code
))
6091 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6092 else if (STRINGP (glyphless_method
))
6093 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6096 /* Invalid value. We use the default method. */
6097 glyphless_method
= Qnil
;
6100 it
->what
= IT_GLYPHLESS
;
6101 return glyphless_method
;
6104 /* Load IT's display element fields with information about the next
6105 display element from the current position of IT. Value is zero if
6106 end of buffer (or C string) is reached. */
6108 static struct frame
*last_escape_glyph_frame
= NULL
;
6109 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6110 static int last_escape_glyph_merged_face_id
= 0;
6112 struct frame
*last_glyphless_glyph_frame
= NULL
;
6113 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6114 int last_glyphless_glyph_merged_face_id
= 0;
6117 get_next_display_element (struct it
*it
)
6119 /* Non-zero means that we found a display element. Zero means that
6120 we hit the end of what we iterate over. Performance note: the
6121 function pointer `method' used here turns out to be faster than
6122 using a sequence of if-statements. */
6126 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6128 if (it
->what
== IT_CHARACTER
)
6130 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6131 and only if (a) the resolved directionality of that character
6133 /* FIXME: Do we need an exception for characters from display
6135 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6136 it
->c
= bidi_mirror_char (it
->c
);
6137 /* Map via display table or translate control characters.
6138 IT->c, IT->len etc. have been set to the next character by
6139 the function call above. If we have a display table, and it
6140 contains an entry for IT->c, translate it. Don't do this if
6141 IT->c itself comes from a display table, otherwise we could
6142 end up in an infinite recursion. (An alternative could be to
6143 count the recursion depth of this function and signal an
6144 error when a certain maximum depth is reached.) Is it worth
6146 if (success_p
&& it
->dpvec
== NULL
)
6149 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6150 enum { char_is_other
= 0, char_is_nbsp
, char_is_soft_hyphen
}
6151 nbsp_or_shy
= char_is_other
;
6152 int c
= it
->c
; /* This is the character to display. */
6154 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6156 xassert (SINGLE_BYTE_CHAR_P (c
));
6157 if (unibyte_display_via_language_environment
)
6159 c
= DECODE_CHAR (unibyte
, c
);
6161 c
= BYTE8_TO_CHAR (it
->c
);
6164 c
= BYTE8_TO_CHAR (it
->c
);
6168 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6171 struct Lisp_Vector
*v
= XVECTOR (dv
);
6173 /* Return the first character from the display table
6174 entry, if not empty. If empty, don't display the
6175 current character. */
6178 it
->dpvec_char_len
= it
->len
;
6179 it
->dpvec
= v
->contents
;
6180 it
->dpend
= v
->contents
+ v
->header
.size
;
6181 it
->current
.dpvec_index
= 0;
6182 it
->dpvec_face_id
= -1;
6183 it
->saved_face_id
= it
->face_id
;
6184 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6189 set_iterator_to_next (it
, 0);
6194 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6196 if (it
->what
== IT_GLYPHLESS
)
6198 /* Don't display this character. */
6199 set_iterator_to_next (it
, 0);
6203 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6204 nbsp_or_shy
= (c
== 0xA0 ? char_is_nbsp
6205 : c
== 0xAD ? char_is_soft_hyphen
6208 /* Translate control characters into `\003' or `^C' form.
6209 Control characters coming from a display table entry are
6210 currently not translated because we use IT->dpvec to hold
6211 the translation. This could easily be changed but I
6212 don't believe that it is worth doing.
6214 NBSP and SOFT-HYPEN are property translated too.
6216 Non-printable characters and raw-byte characters are also
6217 translated to octal form. */
6218 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6219 ? (it
->area
!= TEXT_AREA
6220 /* In mode line, treat \n, \t like other crl chars. */
6223 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6224 || (c
!= '\n' && c
!= '\t'))
6227 || ! CHAR_PRINTABLE_P (c
))))
6229 /* C is a control character, NBSP, SOFT-HYPEN, raw-byte,
6230 or a non-printable character which must be displayed
6231 either as '\003' or as `^C' where the '\\' and '^'
6232 can be defined in the display table. Fill
6233 IT->ctl_chars with glyphs for what we have to
6234 display. Then, set IT->dpvec to these glyphs. */
6238 EMACS_INT lface_id
= 0;
6241 /* Handle control characters with ^. */
6243 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6247 g
= '^'; /* default glyph for Control */
6248 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6250 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6251 && GLYPH_CODE_CHAR_VALID_P (gc
))
6253 g
= GLYPH_CODE_CHAR (gc
);
6254 lface_id
= GLYPH_CODE_FACE (gc
);
6258 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6260 else if (it
->f
== last_escape_glyph_frame
6261 && it
->face_id
== last_escape_glyph_face_id
)
6263 face_id
= last_escape_glyph_merged_face_id
;
6267 /* Merge the escape-glyph face into the current face. */
6268 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6270 last_escape_glyph_frame
= it
->f
;
6271 last_escape_glyph_face_id
= it
->face_id
;
6272 last_escape_glyph_merged_face_id
= face_id
;
6275 XSETINT (it
->ctl_chars
[0], g
);
6276 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6278 goto display_control
;
6281 /* Handle non-break space in the mode where it only gets
6284 if (EQ (Vnobreak_char_display
, Qt
)
6285 && nbsp_or_shy
== char_is_nbsp
)
6287 /* Merge the no-break-space face into the current face. */
6288 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6292 XSETINT (it
->ctl_chars
[0], ' ');
6294 goto display_control
;
6297 /* Handle sequences that start with the "escape glyph". */
6299 /* the default escape glyph is \. */
6300 escape_glyph
= '\\';
6303 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6304 && GLYPH_CODE_CHAR_VALID_P (gc
))
6306 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6307 lface_id
= GLYPH_CODE_FACE (gc
);
6311 /* The display table specified a face.
6312 Merge it into face_id and also into escape_glyph. */
6313 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6316 else if (it
->f
== last_escape_glyph_frame
6317 && it
->face_id
== last_escape_glyph_face_id
)
6319 face_id
= last_escape_glyph_merged_face_id
;
6323 /* Merge the escape-glyph face into the current face. */
6324 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6326 last_escape_glyph_frame
= it
->f
;
6327 last_escape_glyph_face_id
= it
->face_id
;
6328 last_escape_glyph_merged_face_id
= face_id
;
6331 /* Handle soft hyphens in the mode where they only get
6334 if (EQ (Vnobreak_char_display
, Qt
)
6335 && nbsp_or_shy
== char_is_soft_hyphen
)
6337 XSETINT (it
->ctl_chars
[0], '-');
6339 goto display_control
;
6342 /* Handle non-break space and soft hyphen
6343 with the escape glyph. */
6347 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6348 c
= (nbsp_or_shy
== char_is_nbsp
? ' ' : '-');
6349 XSETINT (it
->ctl_chars
[1], c
);
6351 goto display_control
;
6358 if (CHAR_BYTE8_P (c
))
6359 /* Display \200 instead of \17777600. */
6360 c
= CHAR_TO_BYTE8 (c
);
6361 len
= sprintf (str
, "%03o", c
);
6363 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6364 for (i
= 0; i
< len
; i
++)
6365 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6370 /* Set up IT->dpvec and return first character from it. */
6371 it
->dpvec_char_len
= it
->len
;
6372 it
->dpvec
= it
->ctl_chars
;
6373 it
->dpend
= it
->dpvec
+ ctl_len
;
6374 it
->current
.dpvec_index
= 0;
6375 it
->dpvec_face_id
= face_id
;
6376 it
->saved_face_id
= it
->face_id
;
6377 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6381 it
->char_to_display
= c
;
6385 it
->char_to_display
= it
->c
;
6389 /* Adjust face id for a multibyte character. There are no multibyte
6390 character in unibyte text. */
6391 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6394 && FRAME_WINDOW_P (it
->f
))
6396 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6398 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6400 /* Automatic composition with glyph-string. */
6401 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6403 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6407 EMACS_INT pos
= (it
->s
? -1
6408 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6409 : IT_CHARPOS (*it
));
6412 if (it
->what
== IT_CHARACTER
)
6413 c
= it
->char_to_display
;
6416 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6420 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6421 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6424 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6429 /* Is this character the last one of a run of characters with
6430 box? If yes, set IT->end_of_box_run_p to 1. */
6434 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6436 int face_id
= underlying_face_id (it
);
6437 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6441 if (face
->box
== FACE_NO_BOX
)
6443 /* If the box comes from face properties in a
6444 display string, check faces in that string. */
6445 int string_face_id
= face_after_it_pos (it
);
6446 it
->end_of_box_run_p
6447 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6450 /* Otherwise, the box comes from the underlying face.
6451 If this is the last string character displayed, check
6452 the next buffer location. */
6453 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6454 && (it
->current
.overlay_string_index
6455 == it
->n_overlay_strings
- 1))
6459 struct text_pos pos
= it
->current
.pos
;
6460 INC_TEXT_POS (pos
, it
->multibyte_p
);
6462 next_face_id
= face_at_buffer_position
6463 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6464 it
->region_end_charpos
, &ignore
,
6465 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6467 it
->end_of_box_run_p
6468 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6475 int face_id
= face_after_it_pos (it
);
6476 it
->end_of_box_run_p
6477 = (face_id
!= it
->face_id
6478 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6482 /* Value is 0 if end of buffer or string reached. */
6487 /* Move IT to the next display element.
6489 RESEAT_P non-zero means if called on a newline in buffer text,
6490 skip to the next visible line start.
6492 Functions get_next_display_element and set_iterator_to_next are
6493 separate because I find this arrangement easier to handle than a
6494 get_next_display_element function that also increments IT's
6495 position. The way it is we can first look at an iterator's current
6496 display element, decide whether it fits on a line, and if it does,
6497 increment the iterator position. The other way around we probably
6498 would either need a flag indicating whether the iterator has to be
6499 incremented the next time, or we would have to implement a
6500 decrement position function which would not be easy to write. */
6503 set_iterator_to_next (struct it
*it
, int reseat_p
)
6505 /* Reset flags indicating start and end of a sequence of characters
6506 with box. Reset them at the start of this function because
6507 moving the iterator to a new position might set them. */
6508 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6512 case GET_FROM_BUFFER
:
6513 /* The current display element of IT is a character from
6514 current_buffer. Advance in the buffer, and maybe skip over
6515 invisible lines that are so because of selective display. */
6516 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6517 reseat_at_next_visible_line_start (it
, 0);
6518 else if (it
->cmp_it
.id
>= 0)
6520 /* We are currently getting glyphs from a composition. */
6525 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6526 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6527 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6529 it
->cmp_it
.from
= it
->cmp_it
.to
;
6534 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6536 it
->end_charpos
, Qnil
);
6539 else if (! it
->cmp_it
.reversed_p
)
6541 /* Composition created while scanning forward. */
6542 /* Update IT's char/byte positions to point to the first
6543 character of the next grapheme cluster, or to the
6544 character visually after the current composition. */
6545 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6546 bidi_move_to_visually_next (&it
->bidi_it
);
6547 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6548 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6550 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6552 /* Proceed to the next grapheme cluster. */
6553 it
->cmp_it
.from
= it
->cmp_it
.to
;
6557 /* No more grapheme clusters in this composition.
6558 Find the next stop position. */
6559 EMACS_INT stop
= it
->end_charpos
;
6560 if (it
->bidi_it
.scan_dir
< 0)
6561 /* Now we are scanning backward and don't know
6564 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6565 IT_BYTEPOS (*it
), stop
, Qnil
);
6570 /* Composition created while scanning backward. */
6571 /* Update IT's char/byte positions to point to the last
6572 character of the previous grapheme cluster, or the
6573 character visually after the current composition. */
6574 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6575 bidi_move_to_visually_next (&it
->bidi_it
);
6576 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6577 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6578 if (it
->cmp_it
.from
> 0)
6580 /* Proceed to the previous grapheme cluster. */
6581 it
->cmp_it
.to
= it
->cmp_it
.from
;
6585 /* No more grapheme clusters in this composition.
6586 Find the next stop position. */
6587 EMACS_INT stop
= it
->end_charpos
;
6588 if (it
->bidi_it
.scan_dir
< 0)
6589 /* Now we are scanning backward and don't know
6592 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6593 IT_BYTEPOS (*it
), stop
, Qnil
);
6599 xassert (it
->len
!= 0);
6603 IT_BYTEPOS (*it
) += it
->len
;
6604 IT_CHARPOS (*it
) += 1;
6608 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6609 /* If this is a new paragraph, determine its base
6610 direction (a.k.a. its base embedding level). */
6611 if (it
->bidi_it
.new_paragraph
)
6612 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6613 bidi_move_to_visually_next (&it
->bidi_it
);
6614 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6615 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6616 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6618 /* As the scan direction was changed, we must
6619 re-compute the stop position for composition. */
6620 EMACS_INT stop
= it
->end_charpos
;
6621 if (it
->bidi_it
.scan_dir
< 0)
6623 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6624 IT_BYTEPOS (*it
), stop
, Qnil
);
6627 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6631 case GET_FROM_C_STRING
:
6632 /* Current display element of IT is from a C string. */
6634 /* If the string position is beyond string's end, it means
6635 next_element_from_c_string is padding the string with
6636 blanks, in which case we bypass the bidi iterator,
6637 because it cannot deal with such virtual characters. */
6638 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6640 IT_BYTEPOS (*it
) += it
->len
;
6641 IT_CHARPOS (*it
) += 1;
6645 bidi_move_to_visually_next (&it
->bidi_it
);
6646 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6647 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6651 case GET_FROM_DISPLAY_VECTOR
:
6652 /* Current display element of IT is from a display table entry.
6653 Advance in the display table definition. Reset it to null if
6654 end reached, and continue with characters from buffers/
6656 ++it
->current
.dpvec_index
;
6658 /* Restore face of the iterator to what they were before the
6659 display vector entry (these entries may contain faces). */
6660 it
->face_id
= it
->saved_face_id
;
6662 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6664 int recheck_faces
= it
->ellipsis_p
;
6667 it
->method
= GET_FROM_C_STRING
;
6668 else if (STRINGP (it
->string
))
6669 it
->method
= GET_FROM_STRING
;
6672 it
->method
= GET_FROM_BUFFER
;
6673 it
->object
= it
->w
->buffer
;
6677 it
->current
.dpvec_index
= -1;
6679 /* Skip over characters which were displayed via IT->dpvec. */
6680 if (it
->dpvec_char_len
< 0)
6681 reseat_at_next_visible_line_start (it
, 1);
6682 else if (it
->dpvec_char_len
> 0)
6684 if (it
->method
== GET_FROM_STRING
6685 && it
->n_overlay_strings
> 0)
6686 it
->ignore_overlay_strings_at_pos_p
= 1;
6687 it
->len
= it
->dpvec_char_len
;
6688 set_iterator_to_next (it
, reseat_p
);
6691 /* Maybe recheck faces after display vector */
6693 it
->stop_charpos
= IT_CHARPOS (*it
);
6697 case GET_FROM_STRING
:
6698 /* Current display element is a character from a Lisp string. */
6699 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6700 if (it
->cmp_it
.id
>= 0)
6706 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6707 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6708 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6709 it
->cmp_it
.from
= it
->cmp_it
.to
;
6713 composition_compute_stop_pos (&it
->cmp_it
,
6714 IT_STRING_CHARPOS (*it
),
6715 IT_STRING_BYTEPOS (*it
),
6716 it
->end_charpos
, it
->string
);
6719 else if (! it
->cmp_it
.reversed_p
)
6721 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6722 bidi_move_to_visually_next (&it
->bidi_it
);
6723 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6724 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6726 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6727 it
->cmp_it
.from
= it
->cmp_it
.to
;
6730 EMACS_INT stop
= it
->end_charpos
;
6731 if (it
->bidi_it
.scan_dir
< 0)
6733 composition_compute_stop_pos (&it
->cmp_it
,
6734 IT_STRING_CHARPOS (*it
),
6735 IT_STRING_BYTEPOS (*it
), stop
,
6741 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6742 bidi_move_to_visually_next (&it
->bidi_it
);
6743 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6744 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6745 if (it
->cmp_it
.from
> 0)
6746 it
->cmp_it
.to
= it
->cmp_it
.from
;
6749 EMACS_INT stop
= it
->end_charpos
;
6750 if (it
->bidi_it
.scan_dir
< 0)
6752 composition_compute_stop_pos (&it
->cmp_it
,
6753 IT_STRING_CHARPOS (*it
),
6754 IT_STRING_BYTEPOS (*it
), stop
,
6762 /* If the string position is beyond string's end, it
6763 means next_element_from_string is padding the string
6764 with blanks, in which case we bypass the bidi
6765 iterator, because it cannot deal with such virtual
6767 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6769 IT_STRING_BYTEPOS (*it
) += it
->len
;
6770 IT_STRING_CHARPOS (*it
) += 1;
6774 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6776 bidi_move_to_visually_next (&it
->bidi_it
);
6777 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6778 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6779 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6781 EMACS_INT stop
= it
->end_charpos
;
6783 if (it
->bidi_it
.scan_dir
< 0)
6785 composition_compute_stop_pos (&it
->cmp_it
,
6786 IT_STRING_CHARPOS (*it
),
6787 IT_STRING_BYTEPOS (*it
), stop
,
6793 consider_string_end
:
6795 if (it
->current
.overlay_string_index
>= 0)
6797 /* IT->string is an overlay string. Advance to the
6798 next, if there is one. */
6799 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
6802 next_overlay_string (it
);
6804 setup_for_ellipsis (it
, 0);
6809 /* IT->string is not an overlay string. If we reached
6810 its end, and there is something on IT->stack, proceed
6811 with what is on the stack. This can be either another
6812 string, this time an overlay string, or a buffer. */
6813 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
6817 if (it
->method
== GET_FROM_STRING
)
6818 goto consider_string_end
;
6823 case GET_FROM_IMAGE
:
6824 case GET_FROM_STRETCH
:
6825 /* The position etc with which we have to proceed are on
6826 the stack. The position may be at the end of a string,
6827 if the `display' property takes up the whole string. */
6828 xassert (it
->sp
> 0);
6830 if (it
->method
== GET_FROM_STRING
)
6831 goto consider_string_end
;
6835 /* There are no other methods defined, so this should be a bug. */
6839 xassert (it
->method
!= GET_FROM_STRING
6840 || (STRINGP (it
->string
)
6841 && IT_STRING_CHARPOS (*it
) >= 0));
6844 /* Load IT's display element fields with information about the next
6845 display element which comes from a display table entry or from the
6846 result of translating a control character to one of the forms `^C'
6849 IT->dpvec holds the glyphs to return as characters.
6850 IT->saved_face_id holds the face id before the display vector--it
6851 is restored into IT->face_id in set_iterator_to_next. */
6854 next_element_from_display_vector (struct it
*it
)
6859 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
6861 it
->face_id
= it
->saved_face_id
;
6863 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
6864 That seemed totally bogus - so I changed it... */
6865 gc
= it
->dpvec
[it
->current
.dpvec_index
];
6867 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
6869 it
->c
= GLYPH_CODE_CHAR (gc
);
6870 it
->len
= CHAR_BYTES (it
->c
);
6872 /* The entry may contain a face id to use. Such a face id is
6873 the id of a Lisp face, not a realized face. A face id of
6874 zero means no face is specified. */
6875 if (it
->dpvec_face_id
>= 0)
6876 it
->face_id
= it
->dpvec_face_id
;
6879 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
6881 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6886 /* Display table entry is invalid. Return a space. */
6887 it
->c
= ' ', it
->len
= 1;
6889 /* Don't change position and object of the iterator here. They are
6890 still the values of the character that had this display table
6891 entry or was translated, and that's what we want. */
6892 it
->what
= IT_CHARACTER
;
6896 /* Get the first element of string/buffer in the visual order, after
6897 being reseated to a new position in a string or a buffer. */
6899 get_visually_first_element (struct it
*it
)
6901 int string_p
= STRINGP (it
->string
) || it
->s
;
6902 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
6903 EMACS_INT bob
= (string_p
? 0 : BEGV
);
6905 if (STRINGP (it
->string
))
6907 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
6908 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
6912 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
6913 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
6916 if (it
->bidi_it
.charpos
== eob
)
6918 /* Nothing to do, but reset the FIRST_ELT flag, like
6919 bidi_paragraph_init does, because we are not going to
6921 it
->bidi_it
.first_elt
= 0;
6923 else if (it
->bidi_it
.charpos
== bob
6925 /* FIXME: Should support all Unicode line separators. */
6926 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
6927 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
6929 /* If we are at the beginning of a line/string, we can produce
6930 the next element right away. */
6931 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6932 bidi_move_to_visually_next (&it
->bidi_it
);
6936 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
6938 /* We need to prime the bidi iterator starting at the line's or
6939 string's beginning, before we will be able to produce the
6942 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
6945 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
6947 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
6949 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6952 /* Now return to buffer/string position where we were asked
6953 to get the next display element, and produce that. */
6954 bidi_move_to_visually_next (&it
->bidi_it
);
6956 while (it
->bidi_it
.bytepos
!= orig_bytepos
6957 && it
->bidi_it
.charpos
< eob
);
6960 /* Adjust IT's position information to where we ended up. */
6961 if (STRINGP (it
->string
))
6963 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6964 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6968 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6969 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6972 if (STRINGP (it
->string
) || !it
->s
)
6974 EMACS_INT stop
, charpos
, bytepos
;
6976 if (STRINGP (it
->string
))
6979 stop
= SCHARS (it
->string
);
6980 if (stop
> it
->end_charpos
)
6981 stop
= it
->end_charpos
;
6982 charpos
= IT_STRING_CHARPOS (*it
);
6983 bytepos
= IT_STRING_BYTEPOS (*it
);
6987 stop
= it
->end_charpos
;
6988 charpos
= IT_CHARPOS (*it
);
6989 bytepos
= IT_BYTEPOS (*it
);
6991 if (it
->bidi_it
.scan_dir
< 0)
6993 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
6998 /* Load IT with the next display element from Lisp string IT->string.
6999 IT->current.string_pos is the current position within the string.
7000 If IT->current.overlay_string_index >= 0, the Lisp string is an
7004 next_element_from_string (struct it
*it
)
7006 struct text_pos position
;
7008 xassert (STRINGP (it
->string
));
7009 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7010 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7011 position
= it
->current
.string_pos
;
7013 /* With bidi reordering, the character to display might not be the
7014 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7015 that we were reseat()ed to a new string, whose paragraph
7016 direction is not known. */
7017 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7019 get_visually_first_element (it
);
7020 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7023 /* Time to check for invisible text? */
7024 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7026 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7029 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7030 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7032 /* With bidi non-linear iteration, we could find
7033 ourselves far beyond the last computed stop_charpos,
7034 with several other stop positions in between that we
7035 missed. Scan them all now, in buffer's logical
7036 order, until we find and handle the last stop_charpos
7037 that precedes our current position. */
7038 handle_stop_backwards (it
, it
->stop_charpos
);
7039 return GET_NEXT_DISPLAY_ELEMENT (it
);
7045 /* Take note of the stop position we just moved
7046 across, for when we will move back across it. */
7047 it
->prev_stop
= it
->stop_charpos
;
7048 /* If we are at base paragraph embedding level, take
7049 note of the last stop position seen at this
7051 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7052 it
->base_level_stop
= it
->stop_charpos
;
7056 /* Since a handler may have changed IT->method, we must
7058 return GET_NEXT_DISPLAY_ELEMENT (it
);
7062 /* If we are before prev_stop, we may have overstepped
7063 on our way backwards a stop_pos, and if so, we need
7064 to handle that stop_pos. */
7065 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7066 /* We can sometimes back up for reasons that have nothing
7067 to do with bidi reordering. E.g., compositions. The
7068 code below is only needed when we are above the base
7069 embedding level, so test for that explicitly. */
7070 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7072 /* If we lost track of base_level_stop, we have no better
7073 place for handle_stop_backwards to start from than string
7074 beginning. This happens, e.g., when we were reseated to
7075 the previous screenful of text by vertical-motion. */
7076 if (it
->base_level_stop
<= 0
7077 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7078 it
->base_level_stop
= 0;
7079 handle_stop_backwards (it
, it
->base_level_stop
);
7080 return GET_NEXT_DISPLAY_ELEMENT (it
);
7084 if (it
->current
.overlay_string_index
>= 0)
7086 /* Get the next character from an overlay string. In overlay
7087 strings, There is no field width or padding with spaces to
7089 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7094 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7095 IT_STRING_BYTEPOS (*it
),
7096 it
->bidi_it
.scan_dir
< 0
7098 : SCHARS (it
->string
))
7099 && next_element_from_composition (it
))
7103 else if (STRING_MULTIBYTE (it
->string
))
7105 const unsigned char *s
= (SDATA (it
->string
)
7106 + IT_STRING_BYTEPOS (*it
));
7107 it
->c
= string_char_and_length (s
, &it
->len
);
7111 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7117 /* Get the next character from a Lisp string that is not an
7118 overlay string. Such strings come from the mode line, for
7119 example. We may have to pad with spaces, or truncate the
7120 string. See also next_element_from_c_string. */
7121 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7126 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7128 /* Pad with spaces. */
7129 it
->c
= ' ', it
->len
= 1;
7130 CHARPOS (position
) = BYTEPOS (position
) = -1;
7132 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7133 IT_STRING_BYTEPOS (*it
),
7134 it
->bidi_it
.scan_dir
< 0
7136 : it
->string_nchars
)
7137 && next_element_from_composition (it
))
7141 else if (STRING_MULTIBYTE (it
->string
))
7143 const unsigned char *s
= (SDATA (it
->string
)
7144 + IT_STRING_BYTEPOS (*it
));
7145 it
->c
= string_char_and_length (s
, &it
->len
);
7149 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7154 /* Record what we have and where it came from. */
7155 it
->what
= IT_CHARACTER
;
7156 it
->object
= it
->string
;
7157 it
->position
= position
;
7162 /* Load IT with next display element from C string IT->s.
7163 IT->string_nchars is the maximum number of characters to return
7164 from the string. IT->end_charpos may be greater than
7165 IT->string_nchars when this function is called, in which case we
7166 may have to return padding spaces. Value is zero if end of string
7167 reached, including padding spaces. */
7170 next_element_from_c_string (struct it
*it
)
7175 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7176 it
->what
= IT_CHARACTER
;
7177 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7180 /* With bidi reordering, the character to display might not be the
7181 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7182 we were reseated to a new string, whose paragraph direction is
7184 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7185 get_visually_first_element (it
);
7187 /* IT's position can be greater than IT->string_nchars in case a
7188 field width or precision has been specified when the iterator was
7190 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7192 /* End of the game. */
7196 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7198 /* Pad with spaces. */
7199 it
->c
= ' ', it
->len
= 1;
7200 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7202 else if (it
->multibyte_p
)
7203 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7205 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7211 /* Set up IT to return characters from an ellipsis, if appropriate.
7212 The definition of the ellipsis glyphs may come from a display table
7213 entry. This function fills IT with the first glyph from the
7214 ellipsis if an ellipsis is to be displayed. */
7217 next_element_from_ellipsis (struct it
*it
)
7219 if (it
->selective_display_ellipsis_p
)
7220 setup_for_ellipsis (it
, it
->len
);
7223 /* The face at the current position may be different from the
7224 face we find after the invisible text. Remember what it
7225 was in IT->saved_face_id, and signal that it's there by
7226 setting face_before_selective_p. */
7227 it
->saved_face_id
= it
->face_id
;
7228 it
->method
= GET_FROM_BUFFER
;
7229 it
->object
= it
->w
->buffer
;
7230 reseat_at_next_visible_line_start (it
, 1);
7231 it
->face_before_selective_p
= 1;
7234 return GET_NEXT_DISPLAY_ELEMENT (it
);
7238 /* Deliver an image display element. The iterator IT is already
7239 filled with image information (done in handle_display_prop). Value
7244 next_element_from_image (struct it
*it
)
7246 it
->what
= IT_IMAGE
;
7247 it
->ignore_overlay_strings_at_pos_p
= 0;
7252 /* Fill iterator IT with next display element from a stretch glyph
7253 property. IT->object is the value of the text property. Value is
7257 next_element_from_stretch (struct it
*it
)
7259 it
->what
= IT_STRETCH
;
7263 /* Scan backwards from IT's current position until we find a stop
7264 position, or until BEGV. This is called when we find ourself
7265 before both the last known prev_stop and base_level_stop while
7266 reordering bidirectional text. */
7269 compute_stop_pos_backwards (struct it
*it
)
7271 const int SCAN_BACK_LIMIT
= 1000;
7272 struct text_pos pos
;
7273 struct display_pos save_current
= it
->current
;
7274 struct text_pos save_position
= it
->position
;
7275 EMACS_INT charpos
= IT_CHARPOS (*it
);
7276 EMACS_INT where_we_are
= charpos
;
7277 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7278 EMACS_INT save_end_pos
= it
->end_charpos
;
7280 xassert (NILP (it
->string
) && !it
->s
);
7281 xassert (it
->bidi_p
);
7285 it
->end_charpos
= min (charpos
+ 1, ZV
);
7286 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7287 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7288 reseat_1 (it
, pos
, 0);
7289 compute_stop_pos (it
);
7290 /* We must advance forward, right? */
7291 if (it
->stop_charpos
<= charpos
)
7294 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7296 if (it
->stop_charpos
<= where_we_are
)
7297 it
->prev_stop
= it
->stop_charpos
;
7299 it
->prev_stop
= BEGV
;
7301 it
->current
= save_current
;
7302 it
->position
= save_position
;
7303 it
->stop_charpos
= save_stop_pos
;
7304 it
->end_charpos
= save_end_pos
;
7307 /* Scan forward from CHARPOS in the current buffer/string, until we
7308 find a stop position > current IT's position. Then handle the stop
7309 position before that. This is called when we bump into a stop
7310 position while reordering bidirectional text. CHARPOS should be
7311 the last previously processed stop_pos (or BEGV/0, if none were
7312 processed yet) whose position is less that IT's current
7316 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7318 int bufp
= !STRINGP (it
->string
);
7319 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7320 struct display_pos save_current
= it
->current
;
7321 struct text_pos save_position
= it
->position
;
7322 struct text_pos pos1
;
7323 EMACS_INT next_stop
;
7325 /* Scan in strict logical order. */
7326 xassert (it
->bidi_p
);
7330 it
->prev_stop
= charpos
;
7333 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7334 reseat_1 (it
, pos1
, 0);
7337 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7338 compute_stop_pos (it
);
7339 /* We must advance forward, right? */
7340 if (it
->stop_charpos
<= it
->prev_stop
)
7342 charpos
= it
->stop_charpos
;
7344 while (charpos
<= where_we_are
);
7347 it
->current
= save_current
;
7348 it
->position
= save_position
;
7349 next_stop
= it
->stop_charpos
;
7350 it
->stop_charpos
= it
->prev_stop
;
7352 it
->stop_charpos
= next_stop
;
7355 /* Load IT with the next display element from current_buffer. Value
7356 is zero if end of buffer reached. IT->stop_charpos is the next
7357 position at which to stop and check for text properties or buffer
7361 next_element_from_buffer (struct it
*it
)
7365 xassert (IT_CHARPOS (*it
) >= BEGV
);
7366 xassert (NILP (it
->string
) && !it
->s
);
7367 xassert (!it
->bidi_p
7368 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7369 && it
->bidi_it
.string
.s
== NULL
));
7371 /* With bidi reordering, the character to display might not be the
7372 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7373 we were reseat()ed to a new buffer position, which is potentially
7374 a different paragraph. */
7375 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7377 get_visually_first_element (it
);
7378 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7381 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7383 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7385 int overlay_strings_follow_p
;
7387 /* End of the game, except when overlay strings follow that
7388 haven't been returned yet. */
7389 if (it
->overlay_strings_at_end_processed_p
)
7390 overlay_strings_follow_p
= 0;
7393 it
->overlay_strings_at_end_processed_p
= 1;
7394 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7397 if (overlay_strings_follow_p
)
7398 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7402 it
->position
= it
->current
.pos
;
7406 else if (!(!it
->bidi_p
7407 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7408 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7410 /* With bidi non-linear iteration, we could find ourselves
7411 far beyond the last computed stop_charpos, with several
7412 other stop positions in between that we missed. Scan
7413 them all now, in buffer's logical order, until we find
7414 and handle the last stop_charpos that precedes our
7415 current position. */
7416 handle_stop_backwards (it
, it
->stop_charpos
);
7417 return GET_NEXT_DISPLAY_ELEMENT (it
);
7423 /* Take note of the stop position we just moved across,
7424 for when we will move back across it. */
7425 it
->prev_stop
= it
->stop_charpos
;
7426 /* If we are at base paragraph embedding level, take
7427 note of the last stop position seen at this
7429 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7430 it
->base_level_stop
= it
->stop_charpos
;
7433 return GET_NEXT_DISPLAY_ELEMENT (it
);
7437 /* If we are before prev_stop, we may have overstepped on
7438 our way backwards a stop_pos, and if so, we need to
7439 handle that stop_pos. */
7440 && IT_CHARPOS (*it
) < it
->prev_stop
7441 /* We can sometimes back up for reasons that have nothing
7442 to do with bidi reordering. E.g., compositions. The
7443 code below is only needed when we are above the base
7444 embedding level, so test for that explicitly. */
7445 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7447 if (it
->base_level_stop
<= 0
7448 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7450 /* If we lost track of base_level_stop, we need to find
7451 prev_stop by looking backwards. This happens, e.g., when
7452 we were reseated to the previous screenful of text by
7454 it
->base_level_stop
= BEGV
;
7455 compute_stop_pos_backwards (it
);
7456 handle_stop_backwards (it
, it
->prev_stop
);
7459 handle_stop_backwards (it
, it
->base_level_stop
);
7460 return GET_NEXT_DISPLAY_ELEMENT (it
);
7464 /* No face changes, overlays etc. in sight, so just return a
7465 character from current_buffer. */
7469 /* Maybe run the redisplay end trigger hook. Performance note:
7470 This doesn't seem to cost measurable time. */
7471 if (it
->redisplay_end_trigger_charpos
7473 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7474 run_redisplay_end_trigger_hook (it
);
7476 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7477 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7479 && next_element_from_composition (it
))
7484 /* Get the next character, maybe multibyte. */
7485 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7486 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7487 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7489 it
->c
= *p
, it
->len
= 1;
7491 /* Record what we have and where it came from. */
7492 it
->what
= IT_CHARACTER
;
7493 it
->object
= it
->w
->buffer
;
7494 it
->position
= it
->current
.pos
;
7496 /* Normally we return the character found above, except when we
7497 really want to return an ellipsis for selective display. */
7502 /* A value of selective > 0 means hide lines indented more
7503 than that number of columns. */
7504 if (it
->selective
> 0
7505 && IT_CHARPOS (*it
) + 1 < ZV
7506 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7507 IT_BYTEPOS (*it
) + 1,
7510 success_p
= next_element_from_ellipsis (it
);
7511 it
->dpvec_char_len
= -1;
7514 else if (it
->c
== '\r' && it
->selective
== -1)
7516 /* A value of selective == -1 means that everything from the
7517 CR to the end of the line is invisible, with maybe an
7518 ellipsis displayed for it. */
7519 success_p
= next_element_from_ellipsis (it
);
7520 it
->dpvec_char_len
= -1;
7525 /* Value is zero if end of buffer reached. */
7526 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7531 /* Run the redisplay end trigger hook for IT. */
7534 run_redisplay_end_trigger_hook (struct it
*it
)
7536 Lisp_Object args
[3];
7538 /* IT->glyph_row should be non-null, i.e. we should be actually
7539 displaying something, or otherwise we should not run the hook. */
7540 xassert (it
->glyph_row
);
7542 /* Set up hook arguments. */
7543 args
[0] = Qredisplay_end_trigger_functions
;
7544 args
[1] = it
->window
;
7545 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7546 it
->redisplay_end_trigger_charpos
= 0;
7548 /* Since we are *trying* to run these functions, don't try to run
7549 them again, even if they get an error. */
7550 it
->w
->redisplay_end_trigger
= Qnil
;
7551 Frun_hook_with_args (3, args
);
7553 /* Notice if it changed the face of the character we are on. */
7554 handle_face_prop (it
);
7558 /* Deliver a composition display element. Unlike the other
7559 next_element_from_XXX, this function is not registered in the array
7560 get_next_element[]. It is called from next_element_from_buffer and
7561 next_element_from_string when necessary. */
7564 next_element_from_composition (struct it
*it
)
7566 it
->what
= IT_COMPOSITION
;
7567 it
->len
= it
->cmp_it
.nbytes
;
7568 if (STRINGP (it
->string
))
7572 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7573 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7576 it
->position
= it
->current
.string_pos
;
7577 it
->object
= it
->string
;
7578 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7579 IT_STRING_BYTEPOS (*it
), it
->string
);
7585 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7586 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7589 if (it
->bidi_it
.new_paragraph
)
7590 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7591 /* Resync the bidi iterator with IT's new position.
7592 FIXME: this doesn't support bidirectional text. */
7593 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7594 bidi_move_to_visually_next (&it
->bidi_it
);
7598 it
->position
= it
->current
.pos
;
7599 it
->object
= it
->w
->buffer
;
7600 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7601 IT_BYTEPOS (*it
), Qnil
);
7608 /***********************************************************************
7609 Moving an iterator without producing glyphs
7610 ***********************************************************************/
7612 /* Check if iterator is at a position corresponding to a valid buffer
7613 position after some move_it_ call. */
7615 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7616 ((it)->method == GET_FROM_STRING \
7617 ? IT_STRING_CHARPOS (*it) == 0 \
7621 /* Move iterator IT to a specified buffer or X position within one
7622 line on the display without producing glyphs.
7624 OP should be a bit mask including some or all of these bits:
7625 MOVE_TO_X: Stop upon reaching x-position TO_X.
7626 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7627 Regardless of OP's value, stop upon reaching the end of the display line.
7629 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7630 This means, in particular, that TO_X includes window's horizontal
7633 The return value has several possible values that
7634 say what condition caused the scan to stop:
7636 MOVE_POS_MATCH_OR_ZV
7637 - when TO_POS or ZV was reached.
7640 -when TO_X was reached before TO_POS or ZV were reached.
7643 - when we reached the end of the display area and the line must
7647 - when we reached the end of the display area and the line is
7651 - when we stopped at a line end, i.e. a newline or a CR and selective
7654 static enum move_it_result
7655 move_it_in_display_line_to (struct it
*it
,
7656 EMACS_INT to_charpos
, int to_x
,
7657 enum move_operation_enum op
)
7659 enum move_it_result result
= MOVE_UNDEFINED
;
7660 struct glyph_row
*saved_glyph_row
;
7661 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7662 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7663 void *ppos_data
= NULL
;
7665 enum it_method prev_method
= it
->method
;
7666 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7667 int saw_smaller_pos
= prev_pos
< to_charpos
;
7669 /* Don't produce glyphs in produce_glyphs. */
7670 saved_glyph_row
= it
->glyph_row
;
7671 it
->glyph_row
= NULL
;
7673 /* Use wrap_it to save a copy of IT wherever a word wrap could
7674 occur. Use atpos_it to save a copy of IT at the desired buffer
7675 position, if found, so that we can scan ahead and check if the
7676 word later overshoots the window edge. Use atx_it similarly, for
7682 /* Use ppos_it under bidi reordering to save a copy of IT for the
7683 position > CHARPOS that is the closest to CHARPOS. We restore
7684 that position in IT when we have scanned the entire display line
7685 without finding a match for CHARPOS and all the character
7686 positions are greater than CHARPOS. */
7689 SAVE_IT (ppos_it
, *it
, ppos_data
);
7690 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7691 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7692 SAVE_IT (ppos_it
, *it
, ppos_data
);
7695 #define BUFFER_POS_REACHED_P() \
7696 ((op & MOVE_TO_POS) != 0 \
7697 && BUFFERP (it->object) \
7698 && (IT_CHARPOS (*it) == to_charpos \
7699 || (!it->bidi_p && IT_CHARPOS (*it) > to_charpos)) \
7700 && (it->method == GET_FROM_BUFFER \
7701 || (it->method == GET_FROM_DISPLAY_VECTOR \
7702 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7704 /* If there's a line-/wrap-prefix, handle it. */
7705 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7706 && it
->current_y
< it
->last_visible_y
)
7707 handle_line_prefix (it
);
7709 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7710 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7714 int x
, i
, ascent
= 0, descent
= 0;
7716 /* Utility macro to reset an iterator with x, ascent, and descent. */
7717 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7718 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7719 (IT)->max_descent = descent)
7721 /* Stop if we move beyond TO_CHARPOS (after an image or a
7722 display string or stretch glyph). */
7723 if ((op
& MOVE_TO_POS
) != 0
7724 && BUFFERP (it
->object
)
7725 && it
->method
== GET_FROM_BUFFER
7726 && ((!it
->bidi_p
&& IT_CHARPOS (*it
) > to_charpos
)
7728 && (prev_method
== GET_FROM_IMAGE
7729 || prev_method
== GET_FROM_STRETCH
7730 || prev_method
== GET_FROM_STRING
)
7731 /* Passed TO_CHARPOS from left to right. */
7732 && ((prev_pos
< to_charpos
7733 && IT_CHARPOS (*it
) > to_charpos
)
7734 /* Passed TO_CHARPOS from right to left. */
7735 || (prev_pos
> to_charpos
7736 && IT_CHARPOS (*it
) < to_charpos
)))))
7738 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7740 result
= MOVE_POS_MATCH_OR_ZV
;
7743 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7744 /* If wrap_it is valid, the current position might be in a
7745 word that is wrapped. So, save the iterator in
7746 atpos_it and continue to see if wrapping happens. */
7747 SAVE_IT (atpos_it
, *it
, atpos_data
);
7750 /* Stop when ZV reached.
7751 We used to stop here when TO_CHARPOS reached as well, but that is
7752 too soon if this glyph does not fit on this line. So we handle it
7753 explicitly below. */
7754 if (!get_next_display_element (it
))
7756 result
= MOVE_POS_MATCH_OR_ZV
;
7760 if (it
->line_wrap
== TRUNCATE
)
7762 if (BUFFER_POS_REACHED_P ())
7764 result
= MOVE_POS_MATCH_OR_ZV
;
7770 if (it
->line_wrap
== WORD_WRAP
)
7772 if (IT_DISPLAYING_WHITESPACE (it
))
7776 /* We have reached a glyph that follows one or more
7777 whitespace characters. If the position is
7778 already found, we are done. */
7779 if (atpos_it
.sp
>= 0)
7781 RESTORE_IT (it
, &atpos_it
, atpos_data
);
7782 result
= MOVE_POS_MATCH_OR_ZV
;
7787 RESTORE_IT (it
, &atx_it
, atx_data
);
7788 result
= MOVE_X_REACHED
;
7791 /* Otherwise, we can wrap here. */
7792 SAVE_IT (wrap_it
, *it
, wrap_data
);
7798 /* Remember the line height for the current line, in case
7799 the next element doesn't fit on the line. */
7800 ascent
= it
->max_ascent
;
7801 descent
= it
->max_descent
;
7803 /* The call to produce_glyphs will get the metrics of the
7804 display element IT is loaded with. Record the x-position
7805 before this display element, in case it doesn't fit on the
7809 PRODUCE_GLYPHS (it
);
7811 if (it
->area
!= TEXT_AREA
)
7813 prev_method
= it
->method
;
7814 if (it
->method
== GET_FROM_BUFFER
)
7815 prev_pos
= IT_CHARPOS (*it
);
7816 set_iterator_to_next (it
, 1);
7817 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7818 SET_TEXT_POS (this_line_min_pos
,
7819 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7821 && (op
& MOVE_TO_POS
)
7822 && IT_CHARPOS (*it
) > to_charpos
7823 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
7824 SAVE_IT (ppos_it
, *it
, ppos_data
);
7828 /* The number of glyphs we get back in IT->nglyphs will normally
7829 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
7830 character on a terminal frame, or (iii) a line end. For the
7831 second case, IT->nglyphs - 1 padding glyphs will be present.
7832 (On X frames, there is only one glyph produced for a
7833 composite character.)
7835 The behavior implemented below means, for continuation lines,
7836 that as many spaces of a TAB as fit on the current line are
7837 displayed there. For terminal frames, as many glyphs of a
7838 multi-glyph character are displayed in the current line, too.
7839 This is what the old redisplay code did, and we keep it that
7840 way. Under X, the whole shape of a complex character must
7841 fit on the line or it will be completely displayed in the
7844 Note that both for tabs and padding glyphs, all glyphs have
7848 /* More than one glyph or glyph doesn't fit on line. All
7849 glyphs have the same width. */
7850 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
7852 int x_before_this_char
= x
;
7853 int hpos_before_this_char
= it
->hpos
;
7855 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
7857 new_x
= x
+ single_glyph_width
;
7859 /* We want to leave anything reaching TO_X to the caller. */
7860 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
7862 if (BUFFER_POS_REACHED_P ())
7864 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7865 goto buffer_pos_reached
;
7866 if (atpos_it
.sp
< 0)
7868 SAVE_IT (atpos_it
, *it
, atpos_data
);
7869 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7874 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7877 result
= MOVE_X_REACHED
;
7882 SAVE_IT (atx_it
, *it
, atx_data
);
7883 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
7888 if (/* Lines are continued. */
7889 it
->line_wrap
!= TRUNCATE
7890 && (/* And glyph doesn't fit on the line. */
7891 new_x
> it
->last_visible_x
7892 /* Or it fits exactly and we're on a window
7894 || (new_x
== it
->last_visible_x
7895 && FRAME_WINDOW_P (it
->f
))))
7897 if (/* IT->hpos == 0 means the very first glyph
7898 doesn't fit on the line, e.g. a wide image. */
7900 || (new_x
== it
->last_visible_x
7901 && FRAME_WINDOW_P (it
->f
)))
7904 it
->current_x
= new_x
;
7906 /* The character's last glyph just barely fits
7908 if (i
== it
->nglyphs
- 1)
7910 /* If this is the destination position,
7911 return a position *before* it in this row,
7912 now that we know it fits in this row. */
7913 if (BUFFER_POS_REACHED_P ())
7915 if (it
->line_wrap
!= WORD_WRAP
7918 it
->hpos
= hpos_before_this_char
;
7919 it
->current_x
= x_before_this_char
;
7920 result
= MOVE_POS_MATCH_OR_ZV
;
7923 if (it
->line_wrap
== WORD_WRAP
7926 SAVE_IT (atpos_it
, *it
, atpos_data
);
7927 atpos_it
.current_x
= x_before_this_char
;
7928 atpos_it
.hpos
= hpos_before_this_char
;
7932 prev_method
= it
->method
;
7933 if (it
->method
== GET_FROM_BUFFER
)
7934 prev_pos
= IT_CHARPOS (*it
);
7935 set_iterator_to_next (it
, 1);
7936 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7937 SET_TEXT_POS (this_line_min_pos
,
7938 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7939 /* On graphical terminals, newlines may
7940 "overflow" into the fringe if
7941 overflow-newline-into-fringe is non-nil.
7942 On text-only terminals, newlines may
7943 overflow into the last glyph on the
7945 if (!FRAME_WINDOW_P (it
->f
)
7946 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
7948 if (!get_next_display_element (it
))
7950 result
= MOVE_POS_MATCH_OR_ZV
;
7953 if (BUFFER_POS_REACHED_P ())
7955 if (ITERATOR_AT_END_OF_LINE_P (it
))
7956 result
= MOVE_POS_MATCH_OR_ZV
;
7958 result
= MOVE_LINE_CONTINUED
;
7961 if (ITERATOR_AT_END_OF_LINE_P (it
))
7963 result
= MOVE_NEWLINE_OR_CR
;
7970 IT_RESET_X_ASCENT_DESCENT (it
);
7972 if (wrap_it
.sp
>= 0)
7974 RESTORE_IT (it
, &wrap_it
, wrap_data
);
7979 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
7981 result
= MOVE_LINE_CONTINUED
;
7985 if (BUFFER_POS_REACHED_P ())
7987 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7988 goto buffer_pos_reached
;
7989 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
7991 SAVE_IT (atpos_it
, *it
, atpos_data
);
7992 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
7996 if (new_x
> it
->first_visible_x
)
7998 /* Glyph is visible. Increment number of glyphs that
7999 would be displayed. */
8004 if (result
!= MOVE_UNDEFINED
)
8007 else if (BUFFER_POS_REACHED_P ())
8010 IT_RESET_X_ASCENT_DESCENT (it
);
8011 result
= MOVE_POS_MATCH_OR_ZV
;
8014 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8016 /* Stop when TO_X specified and reached. This check is
8017 necessary here because of lines consisting of a line end,
8018 only. The line end will not produce any glyphs and we
8019 would never get MOVE_X_REACHED. */
8020 xassert (it
->nglyphs
== 0);
8021 result
= MOVE_X_REACHED
;
8025 /* Is this a line end? If yes, we're done. */
8026 if (ITERATOR_AT_END_OF_LINE_P (it
))
8028 /* If we are past TO_CHARPOS, but never saw any character
8029 positions smaller than TO_CHARPOS, return
8030 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8032 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8034 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8036 if (IT_CHARPOS (ppos_it
) < ZV
)
8038 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8039 result
= MOVE_POS_MATCH_OR_ZV
;
8042 goto buffer_pos_reached
;
8044 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8045 && IT_CHARPOS (*it
) > to_charpos
)
8046 goto buffer_pos_reached
;
8048 result
= MOVE_NEWLINE_OR_CR
;
8051 result
= MOVE_NEWLINE_OR_CR
;
8055 prev_method
= it
->method
;
8056 if (it
->method
== GET_FROM_BUFFER
)
8057 prev_pos
= IT_CHARPOS (*it
);
8058 /* The current display element has been consumed. Advance
8060 set_iterator_to_next (it
, 1);
8061 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8062 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8063 if (IT_CHARPOS (*it
) < to_charpos
)
8064 saw_smaller_pos
= 1;
8066 && (op
& MOVE_TO_POS
)
8067 && IT_CHARPOS (*it
) >= to_charpos
8068 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8069 SAVE_IT (ppos_it
, *it
, ppos_data
);
8071 /* Stop if lines are truncated and IT's current x-position is
8072 past the right edge of the window now. */
8073 if (it
->line_wrap
== TRUNCATE
8074 && it
->current_x
>= it
->last_visible_x
)
8076 if (!FRAME_WINDOW_P (it
->f
)
8077 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8081 if ((at_eob_p
= !get_next_display_element (it
))
8082 || BUFFER_POS_REACHED_P ()
8083 /* If we are past TO_CHARPOS, but never saw any
8084 character positions smaller than TO_CHARPOS,
8085 return MOVE_POS_MATCH_OR_ZV, like the
8086 unidirectional display did. */
8087 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8089 && IT_CHARPOS (*it
) > to_charpos
))
8091 if (!at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8092 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8093 result
= MOVE_POS_MATCH_OR_ZV
;
8096 if (ITERATOR_AT_END_OF_LINE_P (it
))
8098 result
= MOVE_NEWLINE_OR_CR
;
8102 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8104 && IT_CHARPOS (*it
) > to_charpos
)
8106 if (IT_CHARPOS (ppos_it
) < ZV
)
8107 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8108 result
= MOVE_POS_MATCH_OR_ZV
;
8111 result
= MOVE_LINE_TRUNCATED
;
8114 #undef IT_RESET_X_ASCENT_DESCENT
8117 #undef BUFFER_POS_REACHED_P
8119 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8120 restore the saved iterator. */
8121 if (atpos_it
.sp
>= 0)
8122 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8123 else if (atx_it
.sp
>= 0)
8124 RESTORE_IT (it
, &atx_it
, atx_data
);
8129 bidi_unshelve_cache (atpos_data
, 1);
8131 bidi_unshelve_cache (atx_data
, 1);
8133 bidi_unshelve_cache (wrap_data
, 1);
8135 bidi_unshelve_cache (ppos_data
, 1);
8137 /* Restore the iterator settings altered at the beginning of this
8139 it
->glyph_row
= saved_glyph_row
;
8143 /* For external use. */
8145 move_it_in_display_line (struct it
*it
,
8146 EMACS_INT to_charpos
, int to_x
,
8147 enum move_operation_enum op
)
8149 if (it
->line_wrap
== WORD_WRAP
8150 && (op
& MOVE_TO_X
))
8153 void *save_data
= NULL
;
8156 SAVE_IT (save_it
, *it
, save_data
);
8157 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8158 /* When word-wrap is on, TO_X may lie past the end
8159 of a wrapped line. Then it->current is the
8160 character on the next line, so backtrack to the
8161 space before the wrap point. */
8162 if (skip
== MOVE_LINE_CONTINUED
)
8164 int prev_x
= max (it
->current_x
- 1, 0);
8165 RESTORE_IT (it
, &save_it
, save_data
);
8166 move_it_in_display_line_to
8167 (it
, -1, prev_x
, MOVE_TO_X
);
8170 bidi_unshelve_cache (save_data
, 1);
8173 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8177 /* Move IT forward until it satisfies one or more of the criteria in
8178 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8180 OP is a bit-mask that specifies where to stop, and in particular,
8181 which of those four position arguments makes a difference. See the
8182 description of enum move_operation_enum.
8184 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8185 screen line, this function will set IT to the next position that is
8186 displayed to the right of TO_CHARPOS on the screen. */
8189 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8191 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8192 int line_height
, line_start_x
= 0, reached
= 0;
8193 void *backup_data
= NULL
;
8197 if (op
& MOVE_TO_VPOS
)
8199 /* If no TO_CHARPOS and no TO_X specified, stop at the
8200 start of the line TO_VPOS. */
8201 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8203 if (it
->vpos
== to_vpos
)
8209 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8213 /* TO_VPOS >= 0 means stop at TO_X in the line at
8214 TO_VPOS, or at TO_POS, whichever comes first. */
8215 if (it
->vpos
== to_vpos
)
8221 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8223 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8228 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8230 /* We have reached TO_X but not in the line we want. */
8231 skip
= move_it_in_display_line_to (it
, to_charpos
,
8233 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8241 else if (op
& MOVE_TO_Y
)
8243 struct it it_backup
;
8245 if (it
->line_wrap
== WORD_WRAP
)
8246 SAVE_IT (it_backup
, *it
, backup_data
);
8248 /* TO_Y specified means stop at TO_X in the line containing
8249 TO_Y---or at TO_CHARPOS if this is reached first. The
8250 problem is that we can't really tell whether the line
8251 contains TO_Y before we have completely scanned it, and
8252 this may skip past TO_X. What we do is to first scan to
8255 If TO_X is not specified, use a TO_X of zero. The reason
8256 is to make the outcome of this function more predictable.
8257 If we didn't use TO_X == 0, we would stop at the end of
8258 the line which is probably not what a caller would expect
8260 skip
= move_it_in_display_line_to
8261 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8262 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8264 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8265 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8267 else if (skip
== MOVE_X_REACHED
)
8269 /* If TO_X was reached, we want to know whether TO_Y is
8270 in the line. We know this is the case if the already
8271 scanned glyphs make the line tall enough. Otherwise,
8272 we must check by scanning the rest of the line. */
8273 line_height
= it
->max_ascent
+ it
->max_descent
;
8274 if (to_y
>= it
->current_y
8275 && to_y
< it
->current_y
+ line_height
)
8280 SAVE_IT (it_backup
, *it
, backup_data
);
8281 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8282 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8284 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8285 line_height
= it
->max_ascent
+ it
->max_descent
;
8286 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8288 if (to_y
>= it
->current_y
8289 && to_y
< it
->current_y
+ line_height
)
8291 /* If TO_Y is in this line and TO_X was reached
8292 above, we scanned too far. We have to restore
8293 IT's settings to the ones before skipping. */
8294 RESTORE_IT (it
, &it_backup
, backup_data
);
8300 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8306 /* Check whether TO_Y is in this line. */
8307 line_height
= it
->max_ascent
+ it
->max_descent
;
8308 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8310 if (to_y
>= it
->current_y
8311 && to_y
< it
->current_y
+ line_height
)
8313 /* When word-wrap is on, TO_X may lie past the end
8314 of a wrapped line. Then it->current is the
8315 character on the next line, so backtrack to the
8316 space before the wrap point. */
8317 if (skip
== MOVE_LINE_CONTINUED
8318 && it
->line_wrap
== WORD_WRAP
)
8320 int prev_x
= max (it
->current_x
- 1, 0);
8321 RESTORE_IT (it
, &it_backup
, backup_data
);
8322 skip
= move_it_in_display_line_to
8323 (it
, -1, prev_x
, MOVE_TO_X
);
8332 else if (BUFFERP (it
->object
)
8333 && (it
->method
== GET_FROM_BUFFER
8334 || it
->method
== GET_FROM_STRETCH
)
8335 && IT_CHARPOS (*it
) >= to_charpos
)
8336 skip
= MOVE_POS_MATCH_OR_ZV
;
8338 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8342 case MOVE_POS_MATCH_OR_ZV
:
8346 case MOVE_NEWLINE_OR_CR
:
8347 set_iterator_to_next (it
, 1);
8348 it
->continuation_lines_width
= 0;
8351 case MOVE_LINE_TRUNCATED
:
8352 it
->continuation_lines_width
= 0;
8353 reseat_at_next_visible_line_start (it
, 0);
8354 if ((op
& MOVE_TO_POS
) != 0
8355 && IT_CHARPOS (*it
) > to_charpos
)
8362 case MOVE_LINE_CONTINUED
:
8363 /* For continued lines ending in a tab, some of the glyphs
8364 associated with the tab are displayed on the current
8365 line. Since it->current_x does not include these glyphs,
8366 we use it->last_visible_x instead. */
8369 it
->continuation_lines_width
+= it
->last_visible_x
;
8370 /* When moving by vpos, ensure that the iterator really
8371 advances to the next line (bug#847, bug#969). Fixme:
8372 do we need to do this in other circumstances? */
8373 if (it
->current_x
!= it
->last_visible_x
8374 && (op
& MOVE_TO_VPOS
)
8375 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8377 line_start_x
= it
->current_x
+ it
->pixel_width
8378 - it
->last_visible_x
;
8379 set_iterator_to_next (it
, 0);
8383 it
->continuation_lines_width
+= it
->current_x
;
8390 /* Reset/increment for the next run. */
8391 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8392 it
->current_x
= line_start_x
;
8395 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8397 last_height
= it
->max_ascent
+ it
->max_descent
;
8398 last_max_ascent
= it
->max_ascent
;
8399 it
->max_ascent
= it
->max_descent
= 0;
8404 /* On text terminals, we may stop at the end of a line in the middle
8405 of a multi-character glyph. If the glyph itself is continued,
8406 i.e. it is actually displayed on the next line, don't treat this
8407 stopping point as valid; move to the next line instead (unless
8408 that brings us offscreen). */
8409 if (!FRAME_WINDOW_P (it
->f
)
8411 && IT_CHARPOS (*it
) == to_charpos
8412 && it
->what
== IT_CHARACTER
8414 && it
->line_wrap
== WINDOW_WRAP
8415 && it
->current_x
== it
->last_visible_x
- 1
8418 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8420 it
->continuation_lines_width
+= it
->current_x
;
8421 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8422 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8424 last_height
= it
->max_ascent
+ it
->max_descent
;
8425 last_max_ascent
= it
->max_ascent
;
8429 bidi_unshelve_cache (backup_data
, 1);
8431 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8435 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8437 If DY > 0, move IT backward at least that many pixels. DY = 0
8438 means move IT backward to the preceding line start or BEGV. This
8439 function may move over more than DY pixels if IT->current_y - DY
8440 ends up in the middle of a line; in this case IT->current_y will be
8441 set to the top of the line moved to. */
8444 move_it_vertically_backward (struct it
*it
, int dy
)
8448 void *it2data
= NULL
, *it3data
= NULL
;
8449 EMACS_INT start_pos
;
8454 start_pos
= IT_CHARPOS (*it
);
8456 /* Estimate how many newlines we must move back. */
8457 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8459 /* Set the iterator's position that many lines back. */
8460 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8461 back_to_previous_visible_line_start (it
);
8463 /* Reseat the iterator here. When moving backward, we don't want
8464 reseat to skip forward over invisible text, set up the iterator
8465 to deliver from overlay strings at the new position etc. So,
8466 use reseat_1 here. */
8467 reseat_1 (it
, it
->current
.pos
, 1);
8469 /* We are now surely at a line start. */
8470 it
->current_x
= it
->hpos
= 0;
8471 it
->continuation_lines_width
= 0;
8473 /* Move forward and see what y-distance we moved. First move to the
8474 start of the next line so that we get its height. We need this
8475 height to be able to tell whether we reached the specified
8477 SAVE_IT (it2
, *it
, it2data
);
8478 it2
.max_ascent
= it2
.max_descent
= 0;
8481 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8482 MOVE_TO_POS
| MOVE_TO_VPOS
);
8484 while (!IT_POS_VALID_AFTER_MOVE_P (&it2
));
8485 xassert (IT_CHARPOS (*it
) >= BEGV
);
8486 SAVE_IT (it3
, it2
, it3data
);
8488 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8489 xassert (IT_CHARPOS (*it
) >= BEGV
);
8490 /* H is the actual vertical distance from the position in *IT
8491 and the starting position. */
8492 h
= it2
.current_y
- it
->current_y
;
8493 /* NLINES is the distance in number of lines. */
8494 nlines
= it2
.vpos
- it
->vpos
;
8496 /* Correct IT's y and vpos position
8497 so that they are relative to the starting point. */
8503 /* DY == 0 means move to the start of the screen line. The
8504 value of nlines is > 0 if continuation lines were involved. */
8505 RESTORE_IT (it
, it
, it2data
);
8507 move_it_by_lines (it
, nlines
);
8508 bidi_unshelve_cache (it3data
, 1);
8512 /* The y-position we try to reach, relative to *IT.
8513 Note that H has been subtracted in front of the if-statement. */
8514 int target_y
= it
->current_y
+ h
- dy
;
8515 int y0
= it3
.current_y
;
8519 RESTORE_IT (&it3
, &it3
, it3data
);
8520 y1
= line_bottom_y (&it3
);
8521 line_height
= y1
- y0
;
8522 RESTORE_IT (it
, it
, it2data
);
8523 /* If we did not reach target_y, try to move further backward if
8524 we can. If we moved too far backward, try to move forward. */
8525 if (target_y
< it
->current_y
8526 /* This is heuristic. In a window that's 3 lines high, with
8527 a line height of 13 pixels each, recentering with point
8528 on the bottom line will try to move -39/2 = 19 pixels
8529 backward. Try to avoid moving into the first line. */
8530 && (it
->current_y
- target_y
8531 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8532 && IT_CHARPOS (*it
) > BEGV
)
8534 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8535 target_y
- it
->current_y
));
8536 dy
= it
->current_y
- target_y
;
8537 goto move_further_back
;
8539 else if (target_y
>= it
->current_y
+ line_height
8540 && IT_CHARPOS (*it
) < ZV
)
8542 /* Should move forward by at least one line, maybe more.
8544 Note: Calling move_it_by_lines can be expensive on
8545 terminal frames, where compute_motion is used (via
8546 vmotion) to do the job, when there are very long lines
8547 and truncate-lines is nil. That's the reason for
8548 treating terminal frames specially here. */
8550 if (!FRAME_WINDOW_P (it
->f
))
8551 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8556 move_it_by_lines (it
, 1);
8558 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8565 /* Move IT by a specified amount of pixel lines DY. DY negative means
8566 move backwards. DY = 0 means move to start of screen line. At the
8567 end, IT will be on the start of a screen line. */
8570 move_it_vertically (struct it
*it
, int dy
)
8573 move_it_vertically_backward (it
, -dy
);
8576 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8577 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8578 MOVE_TO_POS
| MOVE_TO_Y
);
8579 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8581 /* If buffer ends in ZV without a newline, move to the start of
8582 the line to satisfy the post-condition. */
8583 if (IT_CHARPOS (*it
) == ZV
8585 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8586 move_it_by_lines (it
, 0);
8591 /* Move iterator IT past the end of the text line it is in. */
8594 move_it_past_eol (struct it
*it
)
8596 enum move_it_result rc
;
8598 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8599 if (rc
== MOVE_NEWLINE_OR_CR
)
8600 set_iterator_to_next (it
, 0);
8604 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8605 negative means move up. DVPOS == 0 means move to the start of the
8608 Optimization idea: If we would know that IT->f doesn't use
8609 a face with proportional font, we could be faster for
8610 truncate-lines nil. */
8613 move_it_by_lines (struct it
*it
, int dvpos
)
8616 /* The commented-out optimization uses vmotion on terminals. This
8617 gives bad results, because elements like it->what, on which
8618 callers such as pos_visible_p rely, aren't updated. */
8619 /* struct position pos;
8620 if (!FRAME_WINDOW_P (it->f))
8622 struct text_pos textpos;
8624 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8625 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8626 reseat (it, textpos, 1);
8627 it->vpos += pos.vpos;
8628 it->current_y += pos.vpos;
8634 /* DVPOS == 0 means move to the start of the screen line. */
8635 move_it_vertically_backward (it
, 0);
8636 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8637 /* Let next call to line_bottom_y calculate real line height */
8642 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8643 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8644 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8649 void *it2data
= NULL
;
8650 EMACS_INT start_charpos
, i
;
8652 /* Start at the beginning of the screen line containing IT's
8653 position. This may actually move vertically backwards,
8654 in case of overlays, so adjust dvpos accordingly. */
8656 move_it_vertically_backward (it
, 0);
8659 /* Go back -DVPOS visible lines and reseat the iterator there. */
8660 start_charpos
= IT_CHARPOS (*it
);
8661 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8662 back_to_previous_visible_line_start (it
);
8663 reseat (it
, it
->current
.pos
, 1);
8665 /* Move further back if we end up in a string or an image. */
8666 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8668 /* First try to move to start of display line. */
8670 move_it_vertically_backward (it
, 0);
8672 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8674 /* If start of line is still in string or image,
8675 move further back. */
8676 back_to_previous_visible_line_start (it
);
8677 reseat (it
, it
->current
.pos
, 1);
8681 it
->current_x
= it
->hpos
= 0;
8683 /* Above call may have moved too far if continuation lines
8684 are involved. Scan forward and see if it did. */
8685 SAVE_IT (it2
, *it
, it2data
);
8686 it2
.vpos
= it2
.current_y
= 0;
8687 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8688 it
->vpos
-= it2
.vpos
;
8689 it
->current_y
-= it2
.current_y
;
8690 it
->current_x
= it
->hpos
= 0;
8692 /* If we moved too far back, move IT some lines forward. */
8693 if (it2
.vpos
> -dvpos
)
8695 int delta
= it2
.vpos
+ dvpos
;
8697 RESTORE_IT (&it2
, &it2
, it2data
);
8698 SAVE_IT (it2
, *it
, it2data
);
8699 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8700 /* Move back again if we got too far ahead. */
8701 if (IT_CHARPOS (*it
) >= start_charpos
)
8702 RESTORE_IT (it
, &it2
, it2data
);
8704 bidi_unshelve_cache (it2data
, 1);
8707 RESTORE_IT (it
, it
, it2data
);
8711 /* Return 1 if IT points into the middle of a display vector. */
8714 in_display_vector_p (struct it
*it
)
8716 return (it
->method
== GET_FROM_DISPLAY_VECTOR
8717 && it
->current
.dpvec_index
> 0
8718 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
8722 /***********************************************************************
8724 ***********************************************************************/
8727 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
8731 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
8733 Lisp_Object args
[3];
8734 Lisp_Object msg
, fmt
;
8737 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
8740 /* Do nothing if called asynchronously. Inserting text into
8741 a buffer may call after-change-functions and alike and
8742 that would means running Lisp asynchronously. */
8743 if (handling_signal
)
8747 GCPRO4 (fmt
, msg
, arg1
, arg2
);
8749 args
[0] = fmt
= build_string (format
);
8752 msg
= Fformat (3, args
);
8754 len
= SBYTES (msg
) + 1;
8755 SAFE_ALLOCA (buffer
, char *, len
);
8756 memcpy (buffer
, SDATA (msg
), len
);
8758 message_dolog (buffer
, len
- 1, 1, 0);
8765 /* Output a newline in the *Messages* buffer if "needs" one. */
8768 message_log_maybe_newline (void)
8770 if (message_log_need_newline
)
8771 message_dolog ("", 0, 1, 0);
8775 /* Add a string M of length NBYTES to the message log, optionally
8776 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
8777 nonzero, means interpret the contents of M as multibyte. This
8778 function calls low-level routines in order to bypass text property
8779 hooks, etc. which might not be safe to run.
8781 This may GC (insert may run before/after change hooks),
8782 so the buffer M must NOT point to a Lisp string. */
8785 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
8787 const unsigned char *msg
= (const unsigned char *) m
;
8789 if (!NILP (Vmemory_full
))
8792 if (!NILP (Vmessage_log_max
))
8794 struct buffer
*oldbuf
;
8795 Lisp_Object oldpoint
, oldbegv
, oldzv
;
8796 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
8797 EMACS_INT point_at_end
= 0;
8798 EMACS_INT zv_at_end
= 0;
8799 Lisp_Object old_deactivate_mark
, tem
;
8800 struct gcpro gcpro1
;
8802 old_deactivate_mark
= Vdeactivate_mark
;
8803 oldbuf
= current_buffer
;
8804 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
8805 BVAR (current_buffer
, undo_list
) = Qt
;
8807 oldpoint
= message_dolog_marker1
;
8808 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
8809 oldbegv
= message_dolog_marker2
;
8810 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
8811 oldzv
= message_dolog_marker3
;
8812 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
8813 GCPRO1 (old_deactivate_mark
);
8821 BEGV_BYTE
= BEG_BYTE
;
8824 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8826 /* Insert the string--maybe converting multibyte to single byte
8827 or vice versa, so that all the text fits the buffer. */
8829 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8835 /* Convert a multibyte string to single-byte
8836 for the *Message* buffer. */
8837 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
8839 c
= string_char_and_length (msg
+ i
, &char_bytes
);
8840 work
[0] = (ASCII_CHAR_P (c
)
8842 : multibyte_char_to_unibyte (c
));
8843 insert_1_both (work
, 1, 1, 1, 0, 0);
8846 else if (! multibyte
8847 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
8851 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
8852 /* Convert a single-byte string to multibyte
8853 for the *Message* buffer. */
8854 for (i
= 0; i
< nbytes
; i
++)
8857 MAKE_CHAR_MULTIBYTE (c
);
8858 char_bytes
= CHAR_STRING (c
, str
);
8859 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
8863 insert_1 (m
, nbytes
, 1, 0, 0);
8867 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
8869 insert_1 ("\n", 1, 1, 0, 0);
8871 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8873 this_bol_byte
= PT_BYTE
;
8875 /* See if this line duplicates the previous one.
8876 If so, combine duplicates. */
8879 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
8881 prev_bol_byte
= PT_BYTE
;
8883 dups
= message_log_check_duplicate (prev_bol_byte
,
8887 del_range_both (prev_bol
, prev_bol_byte
,
8888 this_bol
, this_bol_byte
, 0);
8891 char dupstr
[sizeof " [ times]"
8892 + INT_STRLEN_BOUND (printmax_t
)];
8895 /* If you change this format, don't forget to also
8896 change message_log_check_duplicate. */
8897 sprintf (dupstr
, " [%"pMd
" times]", dups
);
8898 duplen
= strlen (dupstr
);
8899 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
8900 insert_1 (dupstr
, duplen
, 1, 0, 1);
8905 /* If we have more than the desired maximum number of lines
8906 in the *Messages* buffer now, delete the oldest ones.
8907 This is safe because we don't have undo in this buffer. */
8909 if (NATNUMP (Vmessage_log_max
))
8911 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
8912 -XFASTINT (Vmessage_log_max
) - 1, 0);
8913 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
8916 BEGV
= XMARKER (oldbegv
)->charpos
;
8917 BEGV_BYTE
= marker_byte_position (oldbegv
);
8926 ZV
= XMARKER (oldzv
)->charpos
;
8927 ZV_BYTE
= marker_byte_position (oldzv
);
8931 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
8933 /* We can't do Fgoto_char (oldpoint) because it will run some
8935 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
8936 XMARKER (oldpoint
)->bytepos
);
8939 unchain_marker (XMARKER (oldpoint
));
8940 unchain_marker (XMARKER (oldbegv
));
8941 unchain_marker (XMARKER (oldzv
));
8943 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
8944 set_buffer_internal (oldbuf
);
8946 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
8947 message_log_need_newline
= !nlflag
;
8948 Vdeactivate_mark
= old_deactivate_mark
;
8953 /* We are at the end of the buffer after just having inserted a newline.
8954 (Note: We depend on the fact we won't be crossing the gap.)
8955 Check to see if the most recent message looks a lot like the previous one.
8956 Return 0 if different, 1 if the new one should just replace it, or a
8957 value N > 1 if we should also append " [N times]". */
8960 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
8963 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
8965 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
8966 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
8968 for (i
= 0; i
< len
; i
++)
8970 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
8978 if (*p1
++ == ' ' && *p1
++ == '[')
8981 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
8982 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
8989 /* Display an echo area message M with a specified length of NBYTES
8990 bytes. The string may include null characters. If M is 0, clear
8991 out any existing message, and let the mini-buffer text show
8994 This may GC, so the buffer M must NOT point to a Lisp string. */
8997 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
8999 /* First flush out any partial line written with print. */
9000 message_log_maybe_newline ();
9002 message_dolog (m
, nbytes
, 1, multibyte
);
9003 message2_nolog (m
, nbytes
, multibyte
);
9007 /* The non-logging counterpart of message2. */
9010 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9012 struct frame
*sf
= SELECTED_FRAME ();
9013 message_enable_multibyte
= multibyte
;
9015 if (FRAME_INITIAL_P (sf
))
9017 if (noninteractive_need_newline
)
9018 putc ('\n', stderr
);
9019 noninteractive_need_newline
= 0;
9021 fwrite (m
, nbytes
, 1, stderr
);
9022 if (cursor_in_echo_area
== 0)
9023 fprintf (stderr
, "\n");
9026 /* A null message buffer means that the frame hasn't really been
9027 initialized yet. Error messages get reported properly by
9028 cmd_error, so this must be just an informative message; toss it. */
9029 else if (INTERACTIVE
9030 && sf
->glyphs_initialized_p
9031 && FRAME_MESSAGE_BUF (sf
))
9033 Lisp_Object mini_window
;
9036 /* Get the frame containing the mini-buffer
9037 that the selected frame is using. */
9038 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9039 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9041 FRAME_SAMPLE_VISIBILITY (f
);
9042 if (FRAME_VISIBLE_P (sf
)
9043 && ! FRAME_VISIBLE_P (f
))
9044 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9048 set_message (m
, Qnil
, nbytes
, multibyte
);
9049 if (minibuffer_auto_raise
)
9050 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9053 clear_message (1, 1);
9055 do_pending_window_change (0);
9056 echo_area_display (1);
9057 do_pending_window_change (0);
9058 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9059 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9064 /* Display an echo area message M with a specified length of NBYTES
9065 bytes. The string may include null characters. If M is not a
9066 string, clear out any existing message, and let the mini-buffer
9069 This function cancels echoing. */
9072 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9074 struct gcpro gcpro1
;
9077 clear_message (1,1);
9080 /* First flush out any partial line written with print. */
9081 message_log_maybe_newline ();
9087 SAFE_ALLOCA (buffer
, char *, nbytes
);
9088 memcpy (buffer
, SDATA (m
), nbytes
);
9089 message_dolog (buffer
, nbytes
, 1, multibyte
);
9092 message3_nolog (m
, nbytes
, multibyte
);
9098 /* The non-logging version of message3.
9099 This does not cancel echoing, because it is used for echoing.
9100 Perhaps we need to make a separate function for echoing
9101 and make this cancel echoing. */
9104 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9106 struct frame
*sf
= SELECTED_FRAME ();
9107 message_enable_multibyte
= multibyte
;
9109 if (FRAME_INITIAL_P (sf
))
9111 if (noninteractive_need_newline
)
9112 putc ('\n', stderr
);
9113 noninteractive_need_newline
= 0;
9115 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9116 if (cursor_in_echo_area
== 0)
9117 fprintf (stderr
, "\n");
9120 /* A null message buffer means that the frame hasn't really been
9121 initialized yet. Error messages get reported properly by
9122 cmd_error, so this must be just an informative message; toss it. */
9123 else if (INTERACTIVE
9124 && sf
->glyphs_initialized_p
9125 && FRAME_MESSAGE_BUF (sf
))
9127 Lisp_Object mini_window
;
9131 /* Get the frame containing the mini-buffer
9132 that the selected frame is using. */
9133 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9134 frame
= XWINDOW (mini_window
)->frame
;
9137 FRAME_SAMPLE_VISIBILITY (f
);
9138 if (FRAME_VISIBLE_P (sf
)
9139 && !FRAME_VISIBLE_P (f
))
9140 Fmake_frame_visible (frame
);
9142 if (STRINGP (m
) && SCHARS (m
) > 0)
9144 set_message (NULL
, m
, nbytes
, multibyte
);
9145 if (minibuffer_auto_raise
)
9146 Fraise_frame (frame
);
9147 /* Assume we are not echoing.
9148 (If we are, echo_now will override this.) */
9149 echo_message_buffer
= Qnil
;
9152 clear_message (1, 1);
9154 do_pending_window_change (0);
9155 echo_area_display (1);
9156 do_pending_window_change (0);
9157 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9158 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9163 /* Display a null-terminated echo area message M. If M is 0, clear
9164 out any existing message, and let the mini-buffer text show through.
9166 The buffer M must continue to exist until after the echo area gets
9167 cleared or some other message gets displayed there. Do not pass
9168 text that is stored in a Lisp string. Do not pass text in a buffer
9169 that was alloca'd. */
9172 message1 (const char *m
)
9174 message2 (m
, (m
? strlen (m
) : 0), 0);
9178 /* The non-logging counterpart of message1. */
9181 message1_nolog (const char *m
)
9183 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9186 /* Display a message M which contains a single %s
9187 which gets replaced with STRING. */
9190 message_with_string (const char *m
, Lisp_Object string
, int log
)
9192 CHECK_STRING (string
);
9198 if (noninteractive_need_newline
)
9199 putc ('\n', stderr
);
9200 noninteractive_need_newline
= 0;
9201 fprintf (stderr
, m
, SDATA (string
));
9202 if (!cursor_in_echo_area
)
9203 fprintf (stderr
, "\n");
9207 else if (INTERACTIVE
)
9209 /* The frame whose minibuffer we're going to display the message on.
9210 It may be larger than the selected frame, so we need
9211 to use its buffer, not the selected frame's buffer. */
9212 Lisp_Object mini_window
;
9213 struct frame
*f
, *sf
= SELECTED_FRAME ();
9215 /* Get the frame containing the minibuffer
9216 that the selected frame is using. */
9217 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9218 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9220 /* A null message buffer means that the frame hasn't really been
9221 initialized yet. Error messages get reported properly by
9222 cmd_error, so this must be just an informative message; toss it. */
9223 if (FRAME_MESSAGE_BUF (f
))
9225 Lisp_Object args
[2], msg
;
9226 struct gcpro gcpro1
, gcpro2
;
9228 args
[0] = build_string (m
);
9229 args
[1] = msg
= string
;
9230 GCPRO2 (args
[0], msg
);
9233 msg
= Fformat (2, args
);
9236 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9238 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9242 /* Print should start at the beginning of the message
9243 buffer next time. */
9244 message_buf_print
= 0;
9250 /* Dump an informative message to the minibuf. If M is 0, clear out
9251 any existing message, and let the mini-buffer text show through. */
9254 vmessage (const char *m
, va_list ap
)
9260 if (noninteractive_need_newline
)
9261 putc ('\n', stderr
);
9262 noninteractive_need_newline
= 0;
9263 vfprintf (stderr
, m
, ap
);
9264 if (cursor_in_echo_area
== 0)
9265 fprintf (stderr
, "\n");
9269 else if (INTERACTIVE
)
9271 /* The frame whose mini-buffer we're going to display the message
9272 on. It may be larger than the selected frame, so we need to
9273 use its buffer, not the selected frame's buffer. */
9274 Lisp_Object mini_window
;
9275 struct frame
*f
, *sf
= SELECTED_FRAME ();
9277 /* Get the frame containing the mini-buffer
9278 that the selected frame is using. */
9279 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9280 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9282 /* A null message buffer means that the frame hasn't really been
9283 initialized yet. Error messages get reported properly by
9284 cmd_error, so this must be just an informative message; toss
9286 if (FRAME_MESSAGE_BUF (f
))
9292 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9293 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9295 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9300 /* Print should start at the beginning of the message
9301 buffer next time. */
9302 message_buf_print
= 0;
9308 message (const char *m
, ...)
9318 /* The non-logging version of message. */
9321 message_nolog (const char *m
, ...)
9323 Lisp_Object old_log_max
;
9326 old_log_max
= Vmessage_log_max
;
9327 Vmessage_log_max
= Qnil
;
9329 Vmessage_log_max
= old_log_max
;
9335 /* Display the current message in the current mini-buffer. This is
9336 only called from error handlers in process.c, and is not time
9340 update_echo_area (void)
9342 if (!NILP (echo_area_buffer
[0]))
9345 string
= Fcurrent_message ();
9346 message3 (string
, SBYTES (string
),
9347 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9352 /* Make sure echo area buffers in `echo_buffers' are live.
9353 If they aren't, make new ones. */
9356 ensure_echo_area_buffers (void)
9360 for (i
= 0; i
< 2; ++i
)
9361 if (!BUFFERP (echo_buffer
[i
])
9362 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9365 Lisp_Object old_buffer
;
9368 old_buffer
= echo_buffer
[i
];
9369 sprintf (name
, " *Echo Area %d*", i
);
9370 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9371 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9372 /* to force word wrap in echo area -
9373 it was decided to postpone this*/
9374 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9376 for (j
= 0; j
< 2; ++j
)
9377 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9378 echo_area_buffer
[j
] = echo_buffer
[i
];
9383 /* Call FN with args A1..A4 with either the current or last displayed
9384 echo_area_buffer as current buffer.
9386 WHICH zero means use the current message buffer
9387 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9388 from echo_buffer[] and clear it.
9390 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9391 suitable buffer from echo_buffer[] and clear it.
9393 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9394 that the current message becomes the last displayed one, make
9395 choose a suitable buffer for echo_area_buffer[0], and clear it.
9397 Value is what FN returns. */
9400 with_echo_area_buffer (struct window
*w
, int which
,
9401 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9402 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9405 int this_one
, the_other
, clear_buffer_p
, rc
;
9406 int count
= SPECPDL_INDEX ();
9408 /* If buffers aren't live, make new ones. */
9409 ensure_echo_area_buffers ();
9414 this_one
= 0, the_other
= 1;
9416 this_one
= 1, the_other
= 0;
9419 this_one
= 0, the_other
= 1;
9422 /* We need a fresh one in case the current echo buffer equals
9423 the one containing the last displayed echo area message. */
9424 if (!NILP (echo_area_buffer
[this_one
])
9425 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9426 echo_area_buffer
[this_one
] = Qnil
;
9429 /* Choose a suitable buffer from echo_buffer[] is we don't
9431 if (NILP (echo_area_buffer
[this_one
]))
9433 echo_area_buffer
[this_one
]
9434 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9435 ? echo_buffer
[the_other
]
9436 : echo_buffer
[this_one
]);
9440 buffer
= echo_area_buffer
[this_one
];
9442 /* Don't get confused by reusing the buffer used for echoing
9443 for a different purpose. */
9444 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9447 record_unwind_protect (unwind_with_echo_area_buffer
,
9448 with_echo_area_buffer_unwind_data (w
));
9450 /* Make the echo area buffer current. Note that for display
9451 purposes, it is not necessary that the displayed window's buffer
9452 == current_buffer, except for text property lookup. So, let's
9453 only set that buffer temporarily here without doing a full
9454 Fset_window_buffer. We must also change w->pointm, though,
9455 because otherwise an assertions in unshow_buffer fails, and Emacs
9457 set_buffer_internal_1 (XBUFFER (buffer
));
9461 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9464 BVAR (current_buffer
, undo_list
) = Qt
;
9465 BVAR (current_buffer
, read_only
) = Qnil
;
9466 specbind (Qinhibit_read_only
, Qt
);
9467 specbind (Qinhibit_modification_hooks
, Qt
);
9469 if (clear_buffer_p
&& Z
> BEG
)
9472 xassert (BEGV
>= BEG
);
9473 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9475 rc
= fn (a1
, a2
, a3
, a4
);
9477 xassert (BEGV
>= BEG
);
9478 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9480 unbind_to (count
, Qnil
);
9485 /* Save state that should be preserved around the call to the function
9486 FN called in with_echo_area_buffer. */
9489 with_echo_area_buffer_unwind_data (struct window
*w
)
9492 Lisp_Object vector
, tmp
;
9494 /* Reduce consing by keeping one vector in
9495 Vwith_echo_area_save_vector. */
9496 vector
= Vwith_echo_area_save_vector
;
9497 Vwith_echo_area_save_vector
= Qnil
;
9500 vector
= Fmake_vector (make_number (7), Qnil
);
9502 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9503 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9504 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9508 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9509 ASET (vector
, i
, w
->buffer
); ++i
;
9510 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9511 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9516 for (; i
< end
; ++i
)
9517 ASET (vector
, i
, Qnil
);
9520 xassert (i
== ASIZE (vector
));
9525 /* Restore global state from VECTOR which was created by
9526 with_echo_area_buffer_unwind_data. */
9529 unwind_with_echo_area_buffer (Lisp_Object vector
)
9531 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9532 Vdeactivate_mark
= AREF (vector
, 1);
9533 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9535 if (WINDOWP (AREF (vector
, 3)))
9538 Lisp_Object buffer
, charpos
, bytepos
;
9540 w
= XWINDOW (AREF (vector
, 3));
9541 buffer
= AREF (vector
, 4);
9542 charpos
= AREF (vector
, 5);
9543 bytepos
= AREF (vector
, 6);
9546 set_marker_both (w
->pointm
, buffer
,
9547 XFASTINT (charpos
), XFASTINT (bytepos
));
9550 Vwith_echo_area_save_vector
= vector
;
9555 /* Set up the echo area for use by print functions. MULTIBYTE_P
9556 non-zero means we will print multibyte. */
9559 setup_echo_area_for_printing (int multibyte_p
)
9561 /* If we can't find an echo area any more, exit. */
9562 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9565 ensure_echo_area_buffers ();
9567 if (!message_buf_print
)
9569 /* A message has been output since the last time we printed.
9570 Choose a fresh echo area buffer. */
9571 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9572 echo_area_buffer
[0] = echo_buffer
[1];
9574 echo_area_buffer
[0] = echo_buffer
[0];
9576 /* Switch to that buffer and clear it. */
9577 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9578 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9582 int count
= SPECPDL_INDEX ();
9583 specbind (Qinhibit_read_only
, Qt
);
9584 /* Note that undo recording is always disabled. */
9586 unbind_to (count
, Qnil
);
9588 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9590 /* Set up the buffer for the multibyteness we need. */
9592 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9593 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9595 /* Raise the frame containing the echo area. */
9596 if (minibuffer_auto_raise
)
9598 struct frame
*sf
= SELECTED_FRAME ();
9599 Lisp_Object mini_window
;
9600 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9601 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9604 message_log_maybe_newline ();
9605 message_buf_print
= 1;
9609 if (NILP (echo_area_buffer
[0]))
9611 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9612 echo_area_buffer
[0] = echo_buffer
[1];
9614 echo_area_buffer
[0] = echo_buffer
[0];
9617 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9619 /* Someone switched buffers between print requests. */
9620 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9621 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9627 /* Display an echo area message in window W. Value is non-zero if W's
9628 height is changed. If display_last_displayed_message_p is
9629 non-zero, display the message that was last displayed, otherwise
9630 display the current message. */
9633 display_echo_area (struct window
*w
)
9635 int i
, no_message_p
, window_height_changed_p
, count
;
9637 /* Temporarily disable garbage collections while displaying the echo
9638 area. This is done because a GC can print a message itself.
9639 That message would modify the echo area buffer's contents while a
9640 redisplay of the buffer is going on, and seriously confuse
9642 count
= inhibit_garbage_collection ();
9644 /* If there is no message, we must call display_echo_area_1
9645 nevertheless because it resizes the window. But we will have to
9646 reset the echo_area_buffer in question to nil at the end because
9647 with_echo_area_buffer will sets it to an empty buffer. */
9648 i
= display_last_displayed_message_p
? 1 : 0;
9649 no_message_p
= NILP (echo_area_buffer
[i
]);
9651 window_height_changed_p
9652 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9653 display_echo_area_1
,
9654 (intptr_t) w
, Qnil
, 0, 0);
9657 echo_area_buffer
[i
] = Qnil
;
9659 unbind_to (count
, Qnil
);
9660 return window_height_changed_p
;
9664 /* Helper for display_echo_area. Display the current buffer which
9665 contains the current echo area message in window W, a mini-window,
9666 a pointer to which is passed in A1. A2..A4 are currently not used.
9667 Change the height of W so that all of the message is displayed.
9668 Value is non-zero if height of W was changed. */
9671 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9674 struct window
*w
= (struct window
*) i1
;
9676 struct text_pos start
;
9677 int window_height_changed_p
= 0;
9679 /* Do this before displaying, so that we have a large enough glyph
9680 matrix for the display. If we can't get enough space for the
9681 whole text, display the last N lines. That works by setting w->start. */
9682 window_height_changed_p
= resize_mini_window (w
, 0);
9684 /* Use the starting position chosen by resize_mini_window. */
9685 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9688 clear_glyph_matrix (w
->desired_matrix
);
9689 XSETWINDOW (window
, w
);
9690 try_window (window
, start
, 0);
9692 return window_height_changed_p
;
9696 /* Resize the echo area window to exactly the size needed for the
9697 currently displayed message, if there is one. If a mini-buffer
9698 is active, don't shrink it. */
9701 resize_echo_area_exactly (void)
9703 if (BUFFERP (echo_area_buffer
[0])
9704 && WINDOWP (echo_area_window
))
9706 struct window
*w
= XWINDOW (echo_area_window
);
9708 Lisp_Object resize_exactly
;
9710 if (minibuf_level
== 0)
9711 resize_exactly
= Qt
;
9713 resize_exactly
= Qnil
;
9715 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
9716 (intptr_t) w
, resize_exactly
,
9720 ++windows_or_buffers_changed
;
9721 ++update_mode_lines
;
9722 redisplay_internal ();
9728 /* Callback function for with_echo_area_buffer, when used from
9729 resize_echo_area_exactly. A1 contains a pointer to the window to
9730 resize, EXACTLY non-nil means resize the mini-window exactly to the
9731 size of the text displayed. A3 and A4 are not used. Value is what
9732 resize_mini_window returns. */
9735 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
9738 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
9742 /* Resize mini-window W to fit the size of its contents. EXACT_P
9743 means size the window exactly to the size needed. Otherwise, it's
9744 only enlarged until W's buffer is empty.
9746 Set W->start to the right place to begin display. If the whole
9747 contents fit, start at the beginning. Otherwise, start so as
9748 to make the end of the contents appear. This is particularly
9749 important for y-or-n-p, but seems desirable generally.
9751 Value is non-zero if the window height has been changed. */
9754 resize_mini_window (struct window
*w
, int exact_p
)
9756 struct frame
*f
= XFRAME (w
->frame
);
9757 int window_height_changed_p
= 0;
9759 xassert (MINI_WINDOW_P (w
));
9761 /* By default, start display at the beginning. */
9762 set_marker_both (w
->start
, w
->buffer
,
9763 BUF_BEGV (XBUFFER (w
->buffer
)),
9764 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
9766 /* Don't resize windows while redisplaying a window; it would
9767 confuse redisplay functions when the size of the window they are
9768 displaying changes from under them. Such a resizing can happen,
9769 for instance, when which-func prints a long message while
9770 we are running fontification-functions. We're running these
9771 functions with safe_call which binds inhibit-redisplay to t. */
9772 if (!NILP (Vinhibit_redisplay
))
9775 /* Nil means don't try to resize. */
9776 if (NILP (Vresize_mini_windows
)
9777 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
9780 if (!FRAME_MINIBUF_ONLY_P (f
))
9783 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
9784 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
9785 int height
, max_height
;
9786 int unit
= FRAME_LINE_HEIGHT (f
);
9787 struct text_pos start
;
9788 struct buffer
*old_current_buffer
= NULL
;
9790 if (current_buffer
!= XBUFFER (w
->buffer
))
9792 old_current_buffer
= current_buffer
;
9793 set_buffer_internal (XBUFFER (w
->buffer
));
9796 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9798 /* Compute the max. number of lines specified by the user. */
9799 if (FLOATP (Vmax_mini_window_height
))
9800 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
9801 else if (INTEGERP (Vmax_mini_window_height
))
9802 max_height
= XINT (Vmax_mini_window_height
);
9804 max_height
= total_height
/ 4;
9806 /* Correct that max. height if it's bogus. */
9807 max_height
= max (1, max_height
);
9808 max_height
= min (total_height
, max_height
);
9810 /* Find out the height of the text in the window. */
9811 if (it
.line_wrap
== TRUNCATE
)
9816 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
9817 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
9818 height
= it
.current_y
+ last_height
;
9820 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9821 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
9822 height
= (height
+ unit
- 1) / unit
;
9825 /* Compute a suitable window start. */
9826 if (height
> max_height
)
9828 height
= max_height
;
9829 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
9830 move_it_vertically_backward (&it
, (height
- 1) * unit
);
9831 start
= it
.current
.pos
;
9834 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
9835 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
9837 if (EQ (Vresize_mini_windows
, Qgrow_only
))
9839 /* Let it grow only, until we display an empty message, in which
9840 case the window shrinks again. */
9841 if (height
> WINDOW_TOTAL_LINES (w
))
9843 int old_height
= WINDOW_TOTAL_LINES (w
);
9844 freeze_window_starts (f
, 1);
9845 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9846 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9848 else if (height
< WINDOW_TOTAL_LINES (w
)
9849 && (exact_p
|| BEGV
== ZV
))
9851 int old_height
= WINDOW_TOTAL_LINES (w
);
9852 freeze_window_starts (f
, 0);
9853 shrink_mini_window (w
);
9854 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9859 /* Always resize to exact size needed. */
9860 if (height
> WINDOW_TOTAL_LINES (w
))
9862 int old_height
= WINDOW_TOTAL_LINES (w
);
9863 freeze_window_starts (f
, 1);
9864 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9865 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9867 else if (height
< WINDOW_TOTAL_LINES (w
))
9869 int old_height
= WINDOW_TOTAL_LINES (w
);
9870 freeze_window_starts (f
, 0);
9871 shrink_mini_window (w
);
9875 freeze_window_starts (f
, 1);
9876 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
9879 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
9883 if (old_current_buffer
)
9884 set_buffer_internal (old_current_buffer
);
9887 return window_height_changed_p
;
9891 /* Value is the current message, a string, or nil if there is no
9895 current_message (void)
9899 if (!BUFFERP (echo_area_buffer
[0]))
9903 with_echo_area_buffer (0, 0, current_message_1
,
9904 (intptr_t) &msg
, Qnil
, 0, 0);
9906 echo_area_buffer
[0] = Qnil
;
9914 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9917 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
9920 *msg
= make_buffer_string (BEG
, Z
, 1);
9927 /* Push the current message on Vmessage_stack for later restauration
9928 by restore_message. Value is non-zero if the current message isn't
9929 empty. This is a relatively infrequent operation, so it's not
9930 worth optimizing. */
9936 msg
= current_message ();
9937 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
9938 return STRINGP (msg
);
9942 /* Restore message display from the top of Vmessage_stack. */
9945 restore_message (void)
9949 xassert (CONSP (Vmessage_stack
));
9950 msg
= XCAR (Vmessage_stack
);
9952 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9954 message3_nolog (msg
, 0, 0);
9958 /* Handler for record_unwind_protect calling pop_message. */
9961 pop_message_unwind (Lisp_Object dummy
)
9967 /* Pop the top-most entry off Vmessage_stack. */
9972 xassert (CONSP (Vmessage_stack
));
9973 Vmessage_stack
= XCDR (Vmessage_stack
);
9977 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
9978 exits. If the stack is not empty, we have a missing pop_message
9982 check_message_stack (void)
9984 if (!NILP (Vmessage_stack
))
9989 /* Truncate to NCHARS what will be displayed in the echo area the next
9990 time we display it---but don't redisplay it now. */
9993 truncate_echo_area (EMACS_INT nchars
)
9996 echo_area_buffer
[0] = Qnil
;
9997 /* A null message buffer means that the frame hasn't really been
9998 initialized yet. Error messages get reported properly by
9999 cmd_error, so this must be just an informative message; toss it. */
10000 else if (!noninteractive
10002 && !NILP (echo_area_buffer
[0]))
10004 struct frame
*sf
= SELECTED_FRAME ();
10005 if (FRAME_MESSAGE_BUF (sf
))
10006 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10011 /* Helper function for truncate_echo_area. Truncate the current
10012 message to at most NCHARS characters. */
10015 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10017 if (BEG
+ nchars
< Z
)
10018 del_range (BEG
+ nchars
, Z
);
10020 echo_area_buffer
[0] = Qnil
;
10025 /* Set the current message to a substring of S or STRING.
10027 If STRING is a Lisp string, set the message to the first NBYTES
10028 bytes from STRING. NBYTES zero means use the whole string. If
10029 STRING is multibyte, the message will be displayed multibyte.
10031 If S is not null, set the message to the first LEN bytes of S. LEN
10032 zero means use the whole string. MULTIBYTE_P non-zero means S is
10033 multibyte. Display the message multibyte in that case.
10035 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10036 to t before calling set_message_1 (which calls insert).
10040 set_message (const char *s
, Lisp_Object string
,
10041 EMACS_INT nbytes
, int multibyte_p
)
10043 message_enable_multibyte
10044 = ((s
&& multibyte_p
)
10045 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10047 with_echo_area_buffer (0, -1, set_message_1
,
10048 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10049 message_buf_print
= 0;
10050 help_echo_showing_p
= 0;
10054 /* Helper function for set_message. Arguments have the same meaning
10055 as there, with A1 corresponding to S and A2 corresponding to STRING
10056 This function is called with the echo area buffer being
10060 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10063 const char *s
= (const char *) i1
;
10064 const unsigned char *msg
= (const unsigned char *) s
;
10065 Lisp_Object string
= a2
;
10067 /* Change multibyteness of the echo buffer appropriately. */
10068 if (message_enable_multibyte
10069 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10070 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10072 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10073 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10074 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10076 /* Insert new message at BEG. */
10077 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10079 if (STRINGP (string
))
10084 nbytes
= SBYTES (string
);
10085 nchars
= string_byte_to_char (string
, nbytes
);
10087 /* This function takes care of single/multibyte conversion. We
10088 just have to ensure that the echo area buffer has the right
10089 setting of enable_multibyte_characters. */
10090 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10095 nbytes
= strlen (s
);
10097 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10099 /* Convert from multi-byte to single-byte. */
10104 /* Convert a multibyte string to single-byte. */
10105 for (i
= 0; i
< nbytes
; i
+= n
)
10107 c
= string_char_and_length (msg
+ i
, &n
);
10108 work
[0] = (ASCII_CHAR_P (c
)
10110 : multibyte_char_to_unibyte (c
));
10111 insert_1_both (work
, 1, 1, 1, 0, 0);
10114 else if (!multibyte_p
10115 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10117 /* Convert from single-byte to multi-byte. */
10120 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10122 /* Convert a single-byte string to multibyte. */
10123 for (i
= 0; i
< nbytes
; i
++)
10126 MAKE_CHAR_MULTIBYTE (c
);
10127 n
= CHAR_STRING (c
, str
);
10128 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10132 insert_1 (s
, nbytes
, 1, 0, 0);
10139 /* Clear messages. CURRENT_P non-zero means clear the current
10140 message. LAST_DISPLAYED_P non-zero means clear the message
10144 clear_message (int current_p
, int last_displayed_p
)
10148 echo_area_buffer
[0] = Qnil
;
10149 message_cleared_p
= 1;
10152 if (last_displayed_p
)
10153 echo_area_buffer
[1] = Qnil
;
10155 message_buf_print
= 0;
10158 /* Clear garbaged frames.
10160 This function is used where the old redisplay called
10161 redraw_garbaged_frames which in turn called redraw_frame which in
10162 turn called clear_frame. The call to clear_frame was a source of
10163 flickering. I believe a clear_frame is not necessary. It should
10164 suffice in the new redisplay to invalidate all current matrices,
10165 and ensure a complete redisplay of all windows. */
10168 clear_garbaged_frames (void)
10170 if (frame_garbaged
)
10172 Lisp_Object tail
, frame
;
10173 int changed_count
= 0;
10175 FOR_EACH_FRAME (tail
, frame
)
10177 struct frame
*f
= XFRAME (frame
);
10179 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10183 Fredraw_frame (frame
);
10184 f
->force_flush_display_p
= 1;
10186 clear_current_matrices (f
);
10193 frame_garbaged
= 0;
10195 ++windows_or_buffers_changed
;
10200 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10201 is non-zero update selected_frame. Value is non-zero if the
10202 mini-windows height has been changed. */
10205 echo_area_display (int update_frame_p
)
10207 Lisp_Object mini_window
;
10210 int window_height_changed_p
= 0;
10211 struct frame
*sf
= SELECTED_FRAME ();
10213 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10214 w
= XWINDOW (mini_window
);
10215 f
= XFRAME (WINDOW_FRAME (w
));
10217 /* Don't display if frame is invisible or not yet initialized. */
10218 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10221 #ifdef HAVE_WINDOW_SYSTEM
10222 /* When Emacs starts, selected_frame may be the initial terminal
10223 frame. If we let this through, a message would be displayed on
10225 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10227 #endif /* HAVE_WINDOW_SYSTEM */
10229 /* Redraw garbaged frames. */
10230 if (frame_garbaged
)
10231 clear_garbaged_frames ();
10233 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10235 echo_area_window
= mini_window
;
10236 window_height_changed_p
= display_echo_area (w
);
10237 w
->must_be_updated_p
= 1;
10239 /* Update the display, unless called from redisplay_internal.
10240 Also don't update the screen during redisplay itself. The
10241 update will happen at the end of redisplay, and an update
10242 here could cause confusion. */
10243 if (update_frame_p
&& !redisplaying_p
)
10247 /* If the display update has been interrupted by pending
10248 input, update mode lines in the frame. Due to the
10249 pending input, it might have been that redisplay hasn't
10250 been called, so that mode lines above the echo area are
10251 garbaged. This looks odd, so we prevent it here. */
10252 if (!display_completed
)
10253 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10255 if (window_height_changed_p
10256 /* Don't do this if Emacs is shutting down. Redisplay
10257 needs to run hooks. */
10258 && !NILP (Vrun_hooks
))
10260 /* Must update other windows. Likewise as in other
10261 cases, don't let this update be interrupted by
10263 int count
= SPECPDL_INDEX ();
10264 specbind (Qredisplay_dont_pause
, Qt
);
10265 windows_or_buffers_changed
= 1;
10266 redisplay_internal ();
10267 unbind_to (count
, Qnil
);
10269 else if (FRAME_WINDOW_P (f
) && n
== 0)
10271 /* Window configuration is the same as before.
10272 Can do with a display update of the echo area,
10273 unless we displayed some mode lines. */
10274 update_single_window (w
, 1);
10275 FRAME_RIF (f
)->flush_display (f
);
10278 update_frame (f
, 1, 1);
10280 /* If cursor is in the echo area, make sure that the next
10281 redisplay displays the minibuffer, so that the cursor will
10282 be replaced with what the minibuffer wants. */
10283 if (cursor_in_echo_area
)
10284 ++windows_or_buffers_changed
;
10287 else if (!EQ (mini_window
, selected_window
))
10288 windows_or_buffers_changed
++;
10290 /* Last displayed message is now the current message. */
10291 echo_area_buffer
[1] = echo_area_buffer
[0];
10292 /* Inform read_char that we're not echoing. */
10293 echo_message_buffer
= Qnil
;
10295 /* Prevent redisplay optimization in redisplay_internal by resetting
10296 this_line_start_pos. This is done because the mini-buffer now
10297 displays the message instead of its buffer text. */
10298 if (EQ (mini_window
, selected_window
))
10299 CHARPOS (this_line_start_pos
) = 0;
10301 return window_height_changed_p
;
10306 /***********************************************************************
10307 Mode Lines and Frame Titles
10308 ***********************************************************************/
10310 /* A buffer for constructing non-propertized mode-line strings and
10311 frame titles in it; allocated from the heap in init_xdisp and
10312 resized as needed in store_mode_line_noprop_char. */
10314 static char *mode_line_noprop_buf
;
10316 /* The buffer's end, and a current output position in it. */
10318 static char *mode_line_noprop_buf_end
;
10319 static char *mode_line_noprop_ptr
;
10321 #define MODE_LINE_NOPROP_LEN(start) \
10322 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10325 MODE_LINE_DISPLAY
= 0,
10329 } mode_line_target
;
10331 /* Alist that caches the results of :propertize.
10332 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10333 static Lisp_Object mode_line_proptrans_alist
;
10335 /* List of strings making up the mode-line. */
10336 static Lisp_Object mode_line_string_list
;
10338 /* Base face property when building propertized mode line string. */
10339 static Lisp_Object mode_line_string_face
;
10340 static Lisp_Object mode_line_string_face_prop
;
10343 /* Unwind data for mode line strings */
10345 static Lisp_Object Vmode_line_unwind_vector
;
10348 format_mode_line_unwind_data (struct buffer
*obuf
,
10350 int save_proptrans
)
10352 Lisp_Object vector
, tmp
;
10354 /* Reduce consing by keeping one vector in
10355 Vwith_echo_area_save_vector. */
10356 vector
= Vmode_line_unwind_vector
;
10357 Vmode_line_unwind_vector
= Qnil
;
10360 vector
= Fmake_vector (make_number (8), Qnil
);
10362 ASET (vector
, 0, make_number (mode_line_target
));
10363 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10364 ASET (vector
, 2, mode_line_string_list
);
10365 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10366 ASET (vector
, 4, mode_line_string_face
);
10367 ASET (vector
, 5, mode_line_string_face_prop
);
10370 XSETBUFFER (tmp
, obuf
);
10373 ASET (vector
, 6, tmp
);
10374 ASET (vector
, 7, owin
);
10380 unwind_format_mode_line (Lisp_Object vector
)
10382 mode_line_target
= XINT (AREF (vector
, 0));
10383 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10384 mode_line_string_list
= AREF (vector
, 2);
10385 if (! EQ (AREF (vector
, 3), Qt
))
10386 mode_line_proptrans_alist
= AREF (vector
, 3);
10387 mode_line_string_face
= AREF (vector
, 4);
10388 mode_line_string_face_prop
= AREF (vector
, 5);
10390 if (!NILP (AREF (vector
, 7)))
10391 /* Select window before buffer, since it may change the buffer. */
10392 Fselect_window (AREF (vector
, 7), Qt
);
10394 if (!NILP (AREF (vector
, 6)))
10396 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10397 ASET (vector
, 6, Qnil
);
10400 Vmode_line_unwind_vector
= vector
;
10405 /* Store a single character C for the frame title in mode_line_noprop_buf.
10406 Re-allocate mode_line_noprop_buf if necessary. */
10409 store_mode_line_noprop_char (char c
)
10411 /* If output position has reached the end of the allocated buffer,
10412 increase the buffer's size. */
10413 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10415 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10416 ptrdiff_t size
= len
;
10417 mode_line_noprop_buf
=
10418 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10419 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10420 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10423 *mode_line_noprop_ptr
++ = c
;
10427 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10428 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10429 characters that yield more columns than PRECISION; PRECISION <= 0
10430 means copy the whole string. Pad with spaces until FIELD_WIDTH
10431 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10432 pad. Called from display_mode_element when it is used to build a
10436 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10438 const unsigned char *str
= (const unsigned char *) string
;
10440 EMACS_INT dummy
, nbytes
;
10442 /* Copy at most PRECISION chars from STR. */
10443 nbytes
= strlen (string
);
10444 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10446 store_mode_line_noprop_char (*str
++);
10448 /* Fill up with spaces until FIELD_WIDTH reached. */
10449 while (field_width
> 0
10450 && n
< field_width
)
10452 store_mode_line_noprop_char (' ');
10459 /***********************************************************************
10461 ***********************************************************************/
10463 #ifdef HAVE_WINDOW_SYSTEM
10465 /* Set the title of FRAME, if it has changed. The title format is
10466 Vicon_title_format if FRAME is iconified, otherwise it is
10467 frame_title_format. */
10470 x_consider_frame_title (Lisp_Object frame
)
10472 struct frame
*f
= XFRAME (frame
);
10474 if (FRAME_WINDOW_P (f
)
10475 || FRAME_MINIBUF_ONLY_P (f
)
10476 || f
->explicit_name
)
10478 /* Do we have more than one visible frame on this X display? */
10481 ptrdiff_t title_start
;
10485 int count
= SPECPDL_INDEX ();
10487 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10489 Lisp_Object other_frame
= XCAR (tail
);
10490 struct frame
*tf
= XFRAME (other_frame
);
10493 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10494 && !FRAME_MINIBUF_ONLY_P (tf
)
10495 && !EQ (other_frame
, tip_frame
)
10496 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10500 /* Set global variable indicating that multiple frames exist. */
10501 multiple_frames
= CONSP (tail
);
10503 /* Switch to the buffer of selected window of the frame. Set up
10504 mode_line_target so that display_mode_element will output into
10505 mode_line_noprop_buf; then display the title. */
10506 record_unwind_protect (unwind_format_mode_line
,
10507 format_mode_line_unwind_data
10508 (current_buffer
, selected_window
, 0));
10510 Fselect_window (f
->selected_window
, Qt
);
10511 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10512 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10514 mode_line_target
= MODE_LINE_TITLE
;
10515 title_start
= MODE_LINE_NOPROP_LEN (0);
10516 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10517 NULL
, DEFAULT_FACE_ID
);
10518 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10519 len
= MODE_LINE_NOPROP_LEN (title_start
);
10520 title
= mode_line_noprop_buf
+ title_start
;
10521 unbind_to (count
, Qnil
);
10523 /* Set the title only if it's changed. This avoids consing in
10524 the common case where it hasn't. (If it turns out that we've
10525 already wasted too much time by walking through the list with
10526 display_mode_element, then we might need to optimize at a
10527 higher level than this.) */
10528 if (! STRINGP (f
->name
)
10529 || SBYTES (f
->name
) != len
10530 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10531 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10535 #endif /* not HAVE_WINDOW_SYSTEM */
10540 /***********************************************************************
10542 ***********************************************************************/
10545 /* Prepare for redisplay by updating menu-bar item lists when
10546 appropriate. This can call eval. */
10549 prepare_menu_bars (void)
10552 struct gcpro gcpro1
, gcpro2
;
10554 Lisp_Object tooltip_frame
;
10556 #ifdef HAVE_WINDOW_SYSTEM
10557 tooltip_frame
= tip_frame
;
10559 tooltip_frame
= Qnil
;
10562 /* Update all frame titles based on their buffer names, etc. We do
10563 this before the menu bars so that the buffer-menu will show the
10564 up-to-date frame titles. */
10565 #ifdef HAVE_WINDOW_SYSTEM
10566 if (windows_or_buffers_changed
|| update_mode_lines
)
10568 Lisp_Object tail
, frame
;
10570 FOR_EACH_FRAME (tail
, frame
)
10572 f
= XFRAME (frame
);
10573 if (!EQ (frame
, tooltip_frame
)
10574 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10575 x_consider_frame_title (frame
);
10578 #endif /* HAVE_WINDOW_SYSTEM */
10580 /* Update the menu bar item lists, if appropriate. This has to be
10581 done before any actual redisplay or generation of display lines. */
10582 all_windows
= (update_mode_lines
10583 || buffer_shared
> 1
10584 || windows_or_buffers_changed
);
10587 Lisp_Object tail
, frame
;
10588 int count
= SPECPDL_INDEX ();
10589 /* 1 means that update_menu_bar has run its hooks
10590 so any further calls to update_menu_bar shouldn't do so again. */
10591 int menu_bar_hooks_run
= 0;
10593 record_unwind_save_match_data ();
10595 FOR_EACH_FRAME (tail
, frame
)
10597 f
= XFRAME (frame
);
10599 /* Ignore tooltip frame. */
10600 if (EQ (frame
, tooltip_frame
))
10603 /* If a window on this frame changed size, report that to
10604 the user and clear the size-change flag. */
10605 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10607 Lisp_Object functions
;
10609 /* Clear flag first in case we get an error below. */
10610 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10611 functions
= Vwindow_size_change_functions
;
10612 GCPRO2 (tail
, functions
);
10614 while (CONSP (functions
))
10616 if (!EQ (XCAR (functions
), Qt
))
10617 call1 (XCAR (functions
), frame
);
10618 functions
= XCDR (functions
);
10624 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10625 #ifdef HAVE_WINDOW_SYSTEM
10626 update_tool_bar (f
, 0);
10629 if (windows_or_buffers_changed
10631 ns_set_doc_edited (f
, Fbuffer_modified_p
10632 (XWINDOW (f
->selected_window
)->buffer
));
10637 unbind_to (count
, Qnil
);
10641 struct frame
*sf
= SELECTED_FRAME ();
10642 update_menu_bar (sf
, 1, 0);
10643 #ifdef HAVE_WINDOW_SYSTEM
10644 update_tool_bar (sf
, 1);
10650 /* Update the menu bar item list for frame F. This has to be done
10651 before we start to fill in any display lines, because it can call
10654 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10656 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10657 already ran the menu bar hooks for this redisplay, so there
10658 is no need to run them again. The return value is the
10659 updated value of this flag, to pass to the next call. */
10662 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10664 Lisp_Object window
;
10665 register struct window
*w
;
10667 /* If called recursively during a menu update, do nothing. This can
10668 happen when, for instance, an activate-menubar-hook causes a
10670 if (inhibit_menubar_update
)
10673 window
= FRAME_SELECTED_WINDOW (f
);
10674 w
= XWINDOW (window
);
10676 if (FRAME_WINDOW_P (f
)
10678 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10679 || defined (HAVE_NS) || defined (USE_GTK)
10680 FRAME_EXTERNAL_MENU_BAR (f
)
10682 FRAME_MENU_BAR_LINES (f
) > 0
10684 : FRAME_MENU_BAR_LINES (f
) > 0)
10686 /* If the user has switched buffers or windows, we need to
10687 recompute to reflect the new bindings. But we'll
10688 recompute when update_mode_lines is set too; that means
10689 that people can use force-mode-line-update to request
10690 that the menu bar be recomputed. The adverse effect on
10691 the rest of the redisplay algorithm is about the same as
10692 windows_or_buffers_changed anyway. */
10693 if (windows_or_buffers_changed
10694 /* This used to test w->update_mode_line, but we believe
10695 there is no need to recompute the menu in that case. */
10696 || update_mode_lines
10697 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10698 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10699 != !NILP (w
->last_had_star
))
10700 || ((!NILP (Vtransient_mark_mode
)
10701 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10702 != !NILP (w
->region_showing
)))
10704 struct buffer
*prev
= current_buffer
;
10705 int count
= SPECPDL_INDEX ();
10707 specbind (Qinhibit_menubar_update
, Qt
);
10709 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10710 if (save_match_data
)
10711 record_unwind_save_match_data ();
10712 if (NILP (Voverriding_local_map_menu_flag
))
10714 specbind (Qoverriding_terminal_local_map
, Qnil
);
10715 specbind (Qoverriding_local_map
, Qnil
);
10720 /* Run the Lucid hook. */
10721 safe_run_hooks (Qactivate_menubar_hook
);
10723 /* If it has changed current-menubar from previous value,
10724 really recompute the menu-bar from the value. */
10725 if (! NILP (Vlucid_menu_bar_dirty_flag
))
10726 call0 (Qrecompute_lucid_menubar
);
10728 safe_run_hooks (Qmenu_bar_update_hook
);
10733 XSETFRAME (Vmenu_updating_frame
, f
);
10734 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
10736 /* Redisplay the menu bar in case we changed it. */
10737 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10738 || defined (HAVE_NS) || defined (USE_GTK)
10739 if (FRAME_WINDOW_P (f
))
10741 #if defined (HAVE_NS)
10742 /* All frames on Mac OS share the same menubar. So only
10743 the selected frame should be allowed to set it. */
10744 if (f
== SELECTED_FRAME ())
10746 set_frame_menubar (f
, 0, 0);
10749 /* On a terminal screen, the menu bar is an ordinary screen
10750 line, and this makes it get updated. */
10751 w
->update_mode_line
= Qt
;
10752 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10753 /* In the non-toolkit version, the menu bar is an ordinary screen
10754 line, and this makes it get updated. */
10755 w
->update_mode_line
= Qt
;
10756 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
10758 unbind_to (count
, Qnil
);
10759 set_buffer_internal_1 (prev
);
10768 /***********************************************************************
10770 ***********************************************************************/
10772 #ifdef HAVE_WINDOW_SYSTEM
10775 Nominal cursor position -- where to draw output.
10776 HPOS and VPOS are window relative glyph matrix coordinates.
10777 X and Y are window relative pixel coordinates. */
10779 struct cursor_pos output_cursor
;
10783 Set the global variable output_cursor to CURSOR. All cursor
10784 positions are relative to updated_window. */
10787 set_output_cursor (struct cursor_pos
*cursor
)
10789 output_cursor
.hpos
= cursor
->hpos
;
10790 output_cursor
.vpos
= cursor
->vpos
;
10791 output_cursor
.x
= cursor
->x
;
10792 output_cursor
.y
= cursor
->y
;
10797 Set a nominal cursor position.
10799 HPOS and VPOS are column/row positions in a window glyph matrix. X
10800 and Y are window text area relative pixel positions.
10802 If this is done during an update, updated_window will contain the
10803 window that is being updated and the position is the future output
10804 cursor position for that window. If updated_window is null, use
10805 selected_window and display the cursor at the given position. */
10808 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
10812 /* If updated_window is not set, work on selected_window. */
10813 if (updated_window
)
10814 w
= updated_window
;
10816 w
= XWINDOW (selected_window
);
10818 /* Set the output cursor. */
10819 output_cursor
.hpos
= hpos
;
10820 output_cursor
.vpos
= vpos
;
10821 output_cursor
.x
= x
;
10822 output_cursor
.y
= y
;
10824 /* If not called as part of an update, really display the cursor.
10825 This will also set the cursor position of W. */
10826 if (updated_window
== NULL
)
10829 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
10830 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
10831 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
10836 #endif /* HAVE_WINDOW_SYSTEM */
10839 /***********************************************************************
10841 ***********************************************************************/
10843 #ifdef HAVE_WINDOW_SYSTEM
10845 /* Where the mouse was last time we reported a mouse event. */
10847 FRAME_PTR last_mouse_frame
;
10849 /* Tool-bar item index of the item on which a mouse button was pressed
10852 int last_tool_bar_item
;
10856 update_tool_bar_unwind (Lisp_Object frame
)
10858 selected_frame
= frame
;
10862 /* Update the tool-bar item list for frame F. This has to be done
10863 before we start to fill in any display lines. Called from
10864 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
10865 and restore it here. */
10868 update_tool_bar (struct frame
*f
, int save_match_data
)
10870 #if defined (USE_GTK) || defined (HAVE_NS)
10871 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
10873 int do_update
= WINDOWP (f
->tool_bar_window
)
10874 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
10879 Lisp_Object window
;
10882 window
= FRAME_SELECTED_WINDOW (f
);
10883 w
= XWINDOW (window
);
10885 /* If the user has switched buffers or windows, we need to
10886 recompute to reflect the new bindings. But we'll
10887 recompute when update_mode_lines is set too; that means
10888 that people can use force-mode-line-update to request
10889 that the menu bar be recomputed. The adverse effect on
10890 the rest of the redisplay algorithm is about the same as
10891 windows_or_buffers_changed anyway. */
10892 if (windows_or_buffers_changed
10893 || !NILP (w
->update_mode_line
)
10894 || update_mode_lines
10895 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10896 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10897 != !NILP (w
->last_had_star
))
10898 || ((!NILP (Vtransient_mark_mode
)
10899 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10900 != !NILP (w
->region_showing
)))
10902 struct buffer
*prev
= current_buffer
;
10903 int count
= SPECPDL_INDEX ();
10904 Lisp_Object frame
, new_tool_bar
;
10905 int new_n_tool_bar
;
10906 struct gcpro gcpro1
;
10908 /* Set current_buffer to the buffer of the selected
10909 window of the frame, so that we get the right local
10911 set_buffer_internal_1 (XBUFFER (w
->buffer
));
10913 /* Save match data, if we must. */
10914 if (save_match_data
)
10915 record_unwind_save_match_data ();
10917 /* Make sure that we don't accidentally use bogus keymaps. */
10918 if (NILP (Voverriding_local_map_menu_flag
))
10920 specbind (Qoverriding_terminal_local_map
, Qnil
);
10921 specbind (Qoverriding_local_map
, Qnil
);
10924 GCPRO1 (new_tool_bar
);
10926 /* We must temporarily set the selected frame to this frame
10927 before calling tool_bar_items, because the calculation of
10928 the tool-bar keymap uses the selected frame (see
10929 `tool-bar-make-keymap' in tool-bar.el). */
10930 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
10931 XSETFRAME (frame
, f
);
10932 selected_frame
= frame
;
10934 /* Build desired tool-bar items from keymaps. */
10935 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
10938 /* Redisplay the tool-bar if we changed it. */
10939 if (new_n_tool_bar
!= f
->n_tool_bar_items
10940 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
10942 /* Redisplay that happens asynchronously due to an expose event
10943 may access f->tool_bar_items. Make sure we update both
10944 variables within BLOCK_INPUT so no such event interrupts. */
10946 f
->tool_bar_items
= new_tool_bar
;
10947 f
->n_tool_bar_items
= new_n_tool_bar
;
10948 w
->update_mode_line
= Qt
;
10954 unbind_to (count
, Qnil
);
10955 set_buffer_internal_1 (prev
);
10961 /* Set F->desired_tool_bar_string to a Lisp string representing frame
10962 F's desired tool-bar contents. F->tool_bar_items must have
10963 been set up previously by calling prepare_menu_bars. */
10966 build_desired_tool_bar_string (struct frame
*f
)
10968 int i
, size
, size_needed
;
10969 struct gcpro gcpro1
, gcpro2
, gcpro3
;
10970 Lisp_Object image
, plist
, props
;
10972 image
= plist
= props
= Qnil
;
10973 GCPRO3 (image
, plist
, props
);
10975 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
10976 Otherwise, make a new string. */
10978 /* The size of the string we might be able to reuse. */
10979 size
= (STRINGP (f
->desired_tool_bar_string
)
10980 ? SCHARS (f
->desired_tool_bar_string
)
10983 /* We need one space in the string for each image. */
10984 size_needed
= f
->n_tool_bar_items
;
10986 /* Reuse f->desired_tool_bar_string, if possible. */
10987 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
10988 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
10989 make_number (' '));
10992 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
10993 Fremove_text_properties (make_number (0), make_number (size
),
10994 props
, f
->desired_tool_bar_string
);
10997 /* Put a `display' property on the string for the images to display,
10998 put a `menu_item' property on tool-bar items with a value that
10999 is the index of the item in F's tool-bar item vector. */
11000 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11002 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11004 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11005 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11006 int hmargin
, vmargin
, relief
, idx
, end
;
11008 /* If image is a vector, choose the image according to the
11010 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11011 if (VECTORP (image
))
11015 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11016 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11019 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11020 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11022 xassert (ASIZE (image
) >= idx
);
11023 image
= AREF (image
, idx
);
11028 /* Ignore invalid image specifications. */
11029 if (!valid_image_p (image
))
11032 /* Display the tool-bar button pressed, or depressed. */
11033 plist
= Fcopy_sequence (XCDR (image
));
11035 /* Compute margin and relief to draw. */
11036 relief
= (tool_bar_button_relief
>= 0
11037 ? tool_bar_button_relief
11038 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11039 hmargin
= vmargin
= relief
;
11041 if (INTEGERP (Vtool_bar_button_margin
)
11042 && XINT (Vtool_bar_button_margin
) > 0)
11044 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11045 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11047 else if (CONSP (Vtool_bar_button_margin
))
11049 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11050 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11051 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11053 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11054 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11055 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11058 if (auto_raise_tool_bar_buttons_p
)
11060 /* Add a `:relief' property to the image spec if the item is
11064 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11071 /* If image is selected, display it pressed, i.e. with a
11072 negative relief. If it's not selected, display it with a
11074 plist
= Fplist_put (plist
, QCrelief
,
11076 ? make_number (-relief
)
11077 : make_number (relief
)));
11082 /* Put a margin around the image. */
11083 if (hmargin
|| vmargin
)
11085 if (hmargin
== vmargin
)
11086 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11088 plist
= Fplist_put (plist
, QCmargin
,
11089 Fcons (make_number (hmargin
),
11090 make_number (vmargin
)));
11093 /* If button is not enabled, and we don't have special images
11094 for the disabled state, make the image appear disabled by
11095 applying an appropriate algorithm to it. */
11096 if (!enabled_p
&& idx
< 0)
11097 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11099 /* Put a `display' text property on the string for the image to
11100 display. Put a `menu-item' property on the string that gives
11101 the start of this item's properties in the tool-bar items
11103 image
= Fcons (Qimage
, plist
);
11104 props
= list4 (Qdisplay
, image
,
11105 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11107 /* Let the last image hide all remaining spaces in the tool bar
11108 string. The string can be longer than needed when we reuse a
11109 previous string. */
11110 if (i
+ 1 == f
->n_tool_bar_items
)
11111 end
= SCHARS (f
->desired_tool_bar_string
);
11114 Fadd_text_properties (make_number (i
), make_number (end
),
11115 props
, f
->desired_tool_bar_string
);
11123 /* Display one line of the tool-bar of frame IT->f.
11125 HEIGHT specifies the desired height of the tool-bar line.
11126 If the actual height of the glyph row is less than HEIGHT, the
11127 row's height is increased to HEIGHT, and the icons are centered
11128 vertically in the new height.
11130 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11131 count a final empty row in case the tool-bar width exactly matches
11136 display_tool_bar_line (struct it
*it
, int height
)
11138 struct glyph_row
*row
= it
->glyph_row
;
11139 int max_x
= it
->last_visible_x
;
11140 struct glyph
*last
;
11142 prepare_desired_row (row
);
11143 row
->y
= it
->current_y
;
11145 /* Note that this isn't made use of if the face hasn't a box,
11146 so there's no need to check the face here. */
11147 it
->start_of_box_run_p
= 1;
11149 while (it
->current_x
< max_x
)
11151 int x
, n_glyphs_before
, i
, nglyphs
;
11152 struct it it_before
;
11154 /* Get the next display element. */
11155 if (!get_next_display_element (it
))
11157 /* Don't count empty row if we are counting needed tool-bar lines. */
11158 if (height
< 0 && !it
->hpos
)
11163 /* Produce glyphs. */
11164 n_glyphs_before
= row
->used
[TEXT_AREA
];
11167 PRODUCE_GLYPHS (it
);
11169 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11171 x
= it_before
.current_x
;
11172 while (i
< nglyphs
)
11174 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11176 if (x
+ glyph
->pixel_width
> max_x
)
11178 /* Glyph doesn't fit on line. Backtrack. */
11179 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11181 /* If this is the only glyph on this line, it will never fit on the
11182 tool-bar, so skip it. But ensure there is at least one glyph,
11183 so we don't accidentally disable the tool-bar. */
11184 if (n_glyphs_before
== 0
11185 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11191 x
+= glyph
->pixel_width
;
11195 /* Stop at line end. */
11196 if (ITERATOR_AT_END_OF_LINE_P (it
))
11199 set_iterator_to_next (it
, 1);
11204 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11206 /* Use default face for the border below the tool bar.
11208 FIXME: When auto-resize-tool-bars is grow-only, there is
11209 no additional border below the possibly empty tool-bar lines.
11210 So to make the extra empty lines look "normal", we have to
11211 use the tool-bar face for the border too. */
11212 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11213 it
->face_id
= DEFAULT_FACE_ID
;
11215 extend_face_to_end_of_line (it
);
11216 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11217 last
->right_box_line_p
= 1;
11218 if (last
== row
->glyphs
[TEXT_AREA
])
11219 last
->left_box_line_p
= 1;
11221 /* Make line the desired height and center it vertically. */
11222 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11224 /* Don't add more than one line height. */
11225 height
%= FRAME_LINE_HEIGHT (it
->f
);
11226 it
->max_ascent
+= height
/ 2;
11227 it
->max_descent
+= (height
+ 1) / 2;
11230 compute_line_metrics (it
);
11232 /* If line is empty, make it occupy the rest of the tool-bar. */
11233 if (!row
->displays_text_p
)
11235 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11236 row
->visible_height
= row
->height
;
11237 row
->ascent
= row
->phys_ascent
= 0;
11238 row
->extra_line_spacing
= 0;
11241 row
->full_width_p
= 1;
11242 row
->continued_p
= 0;
11243 row
->truncated_on_left_p
= 0;
11244 row
->truncated_on_right_p
= 0;
11246 it
->current_x
= it
->hpos
= 0;
11247 it
->current_y
+= row
->height
;
11253 /* Max tool-bar height. */
11255 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11256 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11258 /* Value is the number of screen lines needed to make all tool-bar
11259 items of frame F visible. The number of actual rows needed is
11260 returned in *N_ROWS if non-NULL. */
11263 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11265 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11267 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11268 the desired matrix, so use (unused) mode-line row as temporary row to
11269 avoid destroying the first tool-bar row. */
11270 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11272 /* Initialize an iterator for iteration over
11273 F->desired_tool_bar_string in the tool-bar window of frame F. */
11274 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11275 it
.first_visible_x
= 0;
11276 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11277 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11278 it
.paragraph_embedding
= L2R
;
11280 while (!ITERATOR_AT_END_P (&it
))
11282 clear_glyph_row (temp_row
);
11283 it
.glyph_row
= temp_row
;
11284 display_tool_bar_line (&it
, -1);
11286 clear_glyph_row (temp_row
);
11288 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11290 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11292 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11296 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11298 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11299 (Lisp_Object frame
)
11306 frame
= selected_frame
;
11308 CHECK_FRAME (frame
);
11309 f
= XFRAME (frame
);
11311 if (WINDOWP (f
->tool_bar_window
)
11312 && (w
= XWINDOW (f
->tool_bar_window
),
11313 WINDOW_TOTAL_LINES (w
) > 0))
11315 update_tool_bar (f
, 1);
11316 if (f
->n_tool_bar_items
)
11318 build_desired_tool_bar_string (f
);
11319 nlines
= tool_bar_lines_needed (f
, NULL
);
11323 return make_number (nlines
);
11327 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11328 height should be changed. */
11331 redisplay_tool_bar (struct frame
*f
)
11335 struct glyph_row
*row
;
11337 #if defined (USE_GTK) || defined (HAVE_NS)
11338 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11339 update_frame_tool_bar (f
);
11343 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11344 do anything. This means you must start with tool-bar-lines
11345 non-zero to get the auto-sizing effect. Or in other words, you
11346 can turn off tool-bars by specifying tool-bar-lines zero. */
11347 if (!WINDOWP (f
->tool_bar_window
)
11348 || (w
= XWINDOW (f
->tool_bar_window
),
11349 WINDOW_TOTAL_LINES (w
) == 0))
11352 /* Set up an iterator for the tool-bar window. */
11353 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11354 it
.first_visible_x
= 0;
11355 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11356 row
= it
.glyph_row
;
11358 /* Build a string that represents the contents of the tool-bar. */
11359 build_desired_tool_bar_string (f
);
11360 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11361 /* FIXME: This should be controlled by a user option. But it
11362 doesn't make sense to have an R2L tool bar if the menu bar cannot
11363 be drawn also R2L, and making the menu bar R2L is tricky due
11364 toolkit-specific code that implements it. If an R2L tool bar is
11365 ever supported, display_tool_bar_line should also be augmented to
11366 call unproduce_glyphs like display_line and display_string
11368 it
.paragraph_embedding
= L2R
;
11370 if (f
->n_tool_bar_rows
== 0)
11374 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11375 nlines
!= WINDOW_TOTAL_LINES (w
)))
11378 int old_height
= WINDOW_TOTAL_LINES (w
);
11380 XSETFRAME (frame
, f
);
11381 Fmodify_frame_parameters (frame
,
11382 Fcons (Fcons (Qtool_bar_lines
,
11383 make_number (nlines
)),
11385 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11387 clear_glyph_matrix (w
->desired_matrix
);
11388 fonts_changed_p
= 1;
11394 /* Display as many lines as needed to display all tool-bar items. */
11396 if (f
->n_tool_bar_rows
> 0)
11398 int border
, rows
, height
, extra
;
11400 if (INTEGERP (Vtool_bar_border
))
11401 border
= XINT (Vtool_bar_border
);
11402 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11403 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11404 else if (EQ (Vtool_bar_border
, Qborder_width
))
11405 border
= f
->border_width
;
11411 rows
= f
->n_tool_bar_rows
;
11412 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11413 extra
= it
.last_visible_y
- border
- height
* rows
;
11415 while (it
.current_y
< it
.last_visible_y
)
11418 if (extra
> 0 && rows
-- > 0)
11420 h
= (extra
+ rows
- 1) / rows
;
11423 display_tool_bar_line (&it
, height
+ h
);
11428 while (it
.current_y
< it
.last_visible_y
)
11429 display_tool_bar_line (&it
, 0);
11432 /* It doesn't make much sense to try scrolling in the tool-bar
11433 window, so don't do it. */
11434 w
->desired_matrix
->no_scrolling_p
= 1;
11435 w
->must_be_updated_p
= 1;
11437 if (!NILP (Vauto_resize_tool_bars
))
11439 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11440 int change_height_p
= 0;
11442 /* If we couldn't display everything, change the tool-bar's
11443 height if there is room for more. */
11444 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11445 && it
.current_y
< max_tool_bar_height
)
11446 change_height_p
= 1;
11448 row
= it
.glyph_row
- 1;
11450 /* If there are blank lines at the end, except for a partially
11451 visible blank line at the end that is smaller than
11452 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11453 if (!row
->displays_text_p
11454 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11455 change_height_p
= 1;
11457 /* If row displays tool-bar items, but is partially visible,
11458 change the tool-bar's height. */
11459 if (row
->displays_text_p
11460 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11461 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11462 change_height_p
= 1;
11464 /* Resize windows as needed by changing the `tool-bar-lines'
11465 frame parameter. */
11466 if (change_height_p
)
11469 int old_height
= WINDOW_TOTAL_LINES (w
);
11471 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11473 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11474 && !f
->minimize_tool_bar_window_p
)
11475 ? (nlines
> old_height
)
11476 : (nlines
!= old_height
));
11477 f
->minimize_tool_bar_window_p
= 0;
11479 if (change_height_p
)
11481 XSETFRAME (frame
, f
);
11482 Fmodify_frame_parameters (frame
,
11483 Fcons (Fcons (Qtool_bar_lines
,
11484 make_number (nlines
)),
11486 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11488 clear_glyph_matrix (w
->desired_matrix
);
11489 f
->n_tool_bar_rows
= nrows
;
11490 fonts_changed_p
= 1;
11497 f
->minimize_tool_bar_window_p
= 0;
11502 /* Get information about the tool-bar item which is displayed in GLYPH
11503 on frame F. Return in *PROP_IDX the index where tool-bar item
11504 properties start in F->tool_bar_items. Value is zero if
11505 GLYPH doesn't display a tool-bar item. */
11508 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11514 /* This function can be called asynchronously, which means we must
11515 exclude any possibility that Fget_text_property signals an
11517 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11518 charpos
= max (0, charpos
);
11520 /* Get the text property `menu-item' at pos. The value of that
11521 property is the start index of this item's properties in
11522 F->tool_bar_items. */
11523 prop
= Fget_text_property (make_number (charpos
),
11524 Qmenu_item
, f
->current_tool_bar_string
);
11525 if (INTEGERP (prop
))
11527 *prop_idx
= XINT (prop
);
11537 /* Get information about the tool-bar item at position X/Y on frame F.
11538 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11539 the current matrix of the tool-bar window of F, or NULL if not
11540 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11541 item in F->tool_bar_items. Value is
11543 -1 if X/Y is not on a tool-bar item
11544 0 if X/Y is on the same item that was highlighted before.
11548 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11549 int *hpos
, int *vpos
, int *prop_idx
)
11551 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11552 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11555 /* Find the glyph under X/Y. */
11556 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11557 if (*glyph
== NULL
)
11560 /* Get the start of this tool-bar item's properties in
11561 f->tool_bar_items. */
11562 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11565 /* Is mouse on the highlighted item? */
11566 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11567 && *vpos
>= hlinfo
->mouse_face_beg_row
11568 && *vpos
<= hlinfo
->mouse_face_end_row
11569 && (*vpos
> hlinfo
->mouse_face_beg_row
11570 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11571 && (*vpos
< hlinfo
->mouse_face_end_row
11572 || *hpos
< hlinfo
->mouse_face_end_col
11573 || hlinfo
->mouse_face_past_end
))
11581 Handle mouse button event on the tool-bar of frame F, at
11582 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11583 0 for button release. MODIFIERS is event modifiers for button
11587 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11588 unsigned int modifiers
)
11590 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11591 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11592 int hpos
, vpos
, prop_idx
;
11593 struct glyph
*glyph
;
11594 Lisp_Object enabled_p
;
11596 /* If not on the highlighted tool-bar item, return. */
11597 frame_to_window_pixel_xy (w
, &x
, &y
);
11598 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11601 /* If item is disabled, do nothing. */
11602 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11603 if (NILP (enabled_p
))
11608 /* Show item in pressed state. */
11609 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11610 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11611 last_tool_bar_item
= prop_idx
;
11615 Lisp_Object key
, frame
;
11616 struct input_event event
;
11617 EVENT_INIT (event
);
11619 /* Show item in released state. */
11620 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11621 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11623 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11625 XSETFRAME (frame
, f
);
11626 event
.kind
= TOOL_BAR_EVENT
;
11627 event
.frame_or_window
= frame
;
11629 kbd_buffer_store_event (&event
);
11631 event
.kind
= TOOL_BAR_EVENT
;
11632 event
.frame_or_window
= frame
;
11634 event
.modifiers
= modifiers
;
11635 kbd_buffer_store_event (&event
);
11636 last_tool_bar_item
= -1;
11641 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11642 tool-bar window-relative coordinates X/Y. Called from
11643 note_mouse_highlight. */
11646 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11648 Lisp_Object window
= f
->tool_bar_window
;
11649 struct window
*w
= XWINDOW (window
);
11650 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11651 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11653 struct glyph
*glyph
;
11654 struct glyph_row
*row
;
11656 Lisp_Object enabled_p
;
11658 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11659 int mouse_down_p
, rc
;
11661 /* Function note_mouse_highlight is called with negative X/Y
11662 values when mouse moves outside of the frame. */
11663 if (x
<= 0 || y
<= 0)
11665 clear_mouse_face (hlinfo
);
11669 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11672 /* Not on tool-bar item. */
11673 clear_mouse_face (hlinfo
);
11677 /* On same tool-bar item as before. */
11678 goto set_help_echo
;
11680 clear_mouse_face (hlinfo
);
11682 /* Mouse is down, but on different tool-bar item? */
11683 mouse_down_p
= (dpyinfo
->grabbed
11684 && f
== last_mouse_frame
11685 && FRAME_LIVE_P (f
));
11687 && last_tool_bar_item
!= prop_idx
)
11690 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11691 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11693 /* If tool-bar item is not enabled, don't highlight it. */
11694 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11695 if (!NILP (enabled_p
))
11697 /* Compute the x-position of the glyph. In front and past the
11698 image is a space. We include this in the highlighted area. */
11699 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11700 for (i
= x
= 0; i
< hpos
; ++i
)
11701 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11703 /* Record this as the current active region. */
11704 hlinfo
->mouse_face_beg_col
= hpos
;
11705 hlinfo
->mouse_face_beg_row
= vpos
;
11706 hlinfo
->mouse_face_beg_x
= x
;
11707 hlinfo
->mouse_face_beg_y
= row
->y
;
11708 hlinfo
->mouse_face_past_end
= 0;
11710 hlinfo
->mouse_face_end_col
= hpos
+ 1;
11711 hlinfo
->mouse_face_end_row
= vpos
;
11712 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
11713 hlinfo
->mouse_face_end_y
= row
->y
;
11714 hlinfo
->mouse_face_window
= window
;
11715 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
11717 /* Display it as active. */
11718 show_mouse_face (hlinfo
, draw
);
11719 hlinfo
->mouse_face_image_state
= draw
;
11724 /* Set help_echo_string to a help string to display for this tool-bar item.
11725 XTread_socket does the rest. */
11726 help_echo_object
= help_echo_window
= Qnil
;
11727 help_echo_pos
= -1;
11728 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
11729 if (NILP (help_echo_string
))
11730 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
11733 #endif /* HAVE_WINDOW_SYSTEM */
11737 /************************************************************************
11738 Horizontal scrolling
11739 ************************************************************************/
11741 static int hscroll_window_tree (Lisp_Object
);
11742 static int hscroll_windows (Lisp_Object
);
11744 /* For all leaf windows in the window tree rooted at WINDOW, set their
11745 hscroll value so that PT is (i) visible in the window, and (ii) so
11746 that it is not within a certain margin at the window's left and
11747 right border. Value is non-zero if any window's hscroll has been
11751 hscroll_window_tree (Lisp_Object window
)
11753 int hscrolled_p
= 0;
11754 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
11755 int hscroll_step_abs
= 0;
11756 double hscroll_step_rel
= 0;
11758 if (hscroll_relative_p
)
11760 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
11761 if (hscroll_step_rel
< 0)
11763 hscroll_relative_p
= 0;
11764 hscroll_step_abs
= 0;
11767 else if (INTEGERP (Vhscroll_step
))
11769 hscroll_step_abs
= XINT (Vhscroll_step
);
11770 if (hscroll_step_abs
< 0)
11771 hscroll_step_abs
= 0;
11774 hscroll_step_abs
= 0;
11776 while (WINDOWP (window
))
11778 struct window
*w
= XWINDOW (window
);
11780 if (WINDOWP (w
->hchild
))
11781 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
11782 else if (WINDOWP (w
->vchild
))
11783 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
11784 else if (w
->cursor
.vpos
>= 0)
11787 int text_area_width
;
11788 struct glyph_row
*current_cursor_row
11789 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
11790 struct glyph_row
*desired_cursor_row
11791 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
11792 struct glyph_row
*cursor_row
11793 = (desired_cursor_row
->enabled_p
11794 ? desired_cursor_row
11795 : current_cursor_row
);
11797 text_area_width
= window_box_width (w
, TEXT_AREA
);
11799 /* Scroll when cursor is inside this scroll margin. */
11800 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
11802 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
11803 && ((XFASTINT (w
->hscroll
)
11804 && w
->cursor
.x
<= h_margin
)
11805 || (cursor_row
->enabled_p
11806 && cursor_row
->truncated_on_right_p
11807 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
11811 struct buffer
*saved_current_buffer
;
11815 /* Find point in a display of infinite width. */
11816 saved_current_buffer
= current_buffer
;
11817 current_buffer
= XBUFFER (w
->buffer
);
11819 if (w
== XWINDOW (selected_window
))
11823 pt
= marker_position (w
->pointm
);
11824 pt
= max (BEGV
, pt
);
11828 /* Move iterator to pt starting at cursor_row->start in
11829 a line with infinite width. */
11830 init_to_row_start (&it
, w
, cursor_row
);
11831 it
.last_visible_x
= INFINITY
;
11832 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
11833 current_buffer
= saved_current_buffer
;
11835 /* Position cursor in window. */
11836 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
11837 hscroll
= max (0, (it
.current_x
11838 - (ITERATOR_AT_END_OF_LINE_P (&it
)
11839 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
11840 : (text_area_width
/ 2))))
11841 / FRAME_COLUMN_WIDTH (it
.f
);
11842 else if (w
->cursor
.x
>= text_area_width
- h_margin
)
11844 if (hscroll_relative_p
)
11845 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
11848 wanted_x
= text_area_width
11849 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11852 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11856 if (hscroll_relative_p
)
11857 wanted_x
= text_area_width
* hscroll_step_rel
11860 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
11863 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
11865 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
11867 /* Don't call Fset_window_hscroll if value hasn't
11868 changed because it will prevent redisplay
11870 if (XFASTINT (w
->hscroll
) != hscroll
)
11872 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
11873 w
->hscroll
= make_number (hscroll
);
11882 /* Value is non-zero if hscroll of any leaf window has been changed. */
11883 return hscrolled_p
;
11887 /* Set hscroll so that cursor is visible and not inside horizontal
11888 scroll margins for all windows in the tree rooted at WINDOW. See
11889 also hscroll_window_tree above. Value is non-zero if any window's
11890 hscroll has been changed. If it has, desired matrices on the frame
11891 of WINDOW are cleared. */
11894 hscroll_windows (Lisp_Object window
)
11896 int hscrolled_p
= hscroll_window_tree (window
);
11898 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
11899 return hscrolled_p
;
11904 /************************************************************************
11906 ************************************************************************/
11908 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
11909 to a non-zero value. This is sometimes handy to have in a debugger
11914 /* First and last unchanged row for try_window_id. */
11916 static int debug_first_unchanged_at_end_vpos
;
11917 static int debug_last_unchanged_at_beg_vpos
;
11919 /* Delta vpos and y. */
11921 static int debug_dvpos
, debug_dy
;
11923 /* Delta in characters and bytes for try_window_id. */
11925 static EMACS_INT debug_delta
, debug_delta_bytes
;
11927 /* Values of window_end_pos and window_end_vpos at the end of
11930 static EMACS_INT debug_end_vpos
;
11932 /* Append a string to W->desired_matrix->method. FMT is a printf
11933 format string. If trace_redisplay_p is non-zero also printf the
11934 resulting string to stderr. */
11936 static void debug_method_add (struct window
*, char const *, ...)
11937 ATTRIBUTE_FORMAT_PRINTF (2, 3);
11940 debug_method_add (struct window
*w
, char const *fmt
, ...)
11943 char *method
= w
->desired_matrix
->method
;
11944 int len
= strlen (method
);
11945 int size
= sizeof w
->desired_matrix
->method
;
11946 int remaining
= size
- len
- 1;
11949 va_start (ap
, fmt
);
11950 vsprintf (buffer
, fmt
, ap
);
11952 if (len
&& remaining
)
11955 --remaining
, ++len
;
11958 strncpy (method
+ len
, buffer
, remaining
);
11960 if (trace_redisplay_p
)
11961 fprintf (stderr
, "%p (%s): %s\n",
11963 ((BUFFERP (w
->buffer
)
11964 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
11965 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
11970 #endif /* GLYPH_DEBUG */
11973 /* Value is non-zero if all changes in window W, which displays
11974 current_buffer, are in the text between START and END. START is a
11975 buffer position, END is given as a distance from Z. Used in
11976 redisplay_internal for display optimization. */
11979 text_outside_line_unchanged_p (struct window
*w
,
11980 EMACS_INT start
, EMACS_INT end
)
11982 int unchanged_p
= 1;
11984 /* If text or overlays have changed, see where. */
11985 if (XFASTINT (w
->last_modified
) < MODIFF
11986 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
11988 /* Gap in the line? */
11989 if (GPT
< start
|| Z
- GPT
< end
)
11992 /* Changes start in front of the line, or end after it? */
11994 && (BEG_UNCHANGED
< start
- 1
11995 || END_UNCHANGED
< end
))
11998 /* If selective display, can't optimize if changes start at the
11999 beginning of the line. */
12001 && INTEGERP (BVAR (current_buffer
, selective_display
))
12002 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12003 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12006 /* If there are overlays at the start or end of the line, these
12007 may have overlay strings with newlines in them. A change at
12008 START, for instance, may actually concern the display of such
12009 overlay strings as well, and they are displayed on different
12010 lines. So, quickly rule out this case. (For the future, it
12011 might be desirable to implement something more telling than
12012 just BEG/END_UNCHANGED.) */
12015 if (BEG
+ BEG_UNCHANGED
== start
12016 && overlay_touches_p (start
))
12018 if (END_UNCHANGED
== end
12019 && overlay_touches_p (Z
- end
))
12023 /* Under bidi reordering, adding or deleting a character in the
12024 beginning of a paragraph, before the first strong directional
12025 character, can change the base direction of the paragraph (unless
12026 the buffer specifies a fixed paragraph direction), which will
12027 require to redisplay the whole paragraph. It might be worthwhile
12028 to find the paragraph limits and widen the range of redisplayed
12029 lines to that, but for now just give up this optimization. */
12030 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12031 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12035 return unchanged_p
;
12039 /* Do a frame update, taking possible shortcuts into account. This is
12040 the main external entry point for redisplay.
12042 If the last redisplay displayed an echo area message and that message
12043 is no longer requested, we clear the echo area or bring back the
12044 mini-buffer if that is in use. */
12049 redisplay_internal ();
12054 overlay_arrow_string_or_property (Lisp_Object var
)
12058 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12061 return Voverlay_arrow_string
;
12064 /* Return 1 if there are any overlay-arrows in current_buffer. */
12066 overlay_arrow_in_current_buffer_p (void)
12070 for (vlist
= Voverlay_arrow_variable_list
;
12072 vlist
= XCDR (vlist
))
12074 Lisp_Object var
= XCAR (vlist
);
12077 if (!SYMBOLP (var
))
12079 val
= find_symbol_value (var
);
12081 && current_buffer
== XMARKER (val
)->buffer
)
12088 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12092 overlay_arrows_changed_p (void)
12096 for (vlist
= Voverlay_arrow_variable_list
;
12098 vlist
= XCDR (vlist
))
12100 Lisp_Object var
= XCAR (vlist
);
12101 Lisp_Object val
, pstr
;
12103 if (!SYMBOLP (var
))
12105 val
= find_symbol_value (var
);
12106 if (!MARKERP (val
))
12108 if (! EQ (COERCE_MARKER (val
),
12109 Fget (var
, Qlast_arrow_position
))
12110 || ! (pstr
= overlay_arrow_string_or_property (var
),
12111 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12117 /* Mark overlay arrows to be updated on next redisplay. */
12120 update_overlay_arrows (int up_to_date
)
12124 for (vlist
= Voverlay_arrow_variable_list
;
12126 vlist
= XCDR (vlist
))
12128 Lisp_Object var
= XCAR (vlist
);
12130 if (!SYMBOLP (var
))
12133 if (up_to_date
> 0)
12135 Lisp_Object val
= find_symbol_value (var
);
12136 Fput (var
, Qlast_arrow_position
,
12137 COERCE_MARKER (val
));
12138 Fput (var
, Qlast_arrow_string
,
12139 overlay_arrow_string_or_property (var
));
12141 else if (up_to_date
< 0
12142 || !NILP (Fget (var
, Qlast_arrow_position
)))
12144 Fput (var
, Qlast_arrow_position
, Qt
);
12145 Fput (var
, Qlast_arrow_string
, Qt
);
12151 /* Return overlay arrow string to display at row.
12152 Return integer (bitmap number) for arrow bitmap in left fringe.
12153 Return nil if no overlay arrow. */
12156 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12160 for (vlist
= Voverlay_arrow_variable_list
;
12162 vlist
= XCDR (vlist
))
12164 Lisp_Object var
= XCAR (vlist
);
12167 if (!SYMBOLP (var
))
12170 val
= find_symbol_value (var
);
12173 && current_buffer
== XMARKER (val
)->buffer
12174 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12176 if (FRAME_WINDOW_P (it
->f
)
12177 /* FIXME: if ROW->reversed_p is set, this should test
12178 the right fringe, not the left one. */
12179 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12181 #ifdef HAVE_WINDOW_SYSTEM
12182 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12185 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12186 return make_number (fringe_bitmap
);
12189 return make_number (-1); /* Use default arrow bitmap */
12191 return overlay_arrow_string_or_property (var
);
12198 /* Return 1 if point moved out of or into a composition. Otherwise
12199 return 0. PREV_BUF and PREV_PT are the last point buffer and
12200 position. BUF and PT are the current point buffer and position. */
12203 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12204 struct buffer
*buf
, EMACS_INT pt
)
12206 EMACS_INT start
, end
;
12208 Lisp_Object buffer
;
12210 XSETBUFFER (buffer
, buf
);
12211 /* Check a composition at the last point if point moved within the
12213 if (prev_buf
== buf
)
12216 /* Point didn't move. */
12219 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12220 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12221 && COMPOSITION_VALID_P (start
, end
, prop
)
12222 && start
< prev_pt
&& end
> prev_pt
)
12223 /* The last point was within the composition. Return 1 iff
12224 point moved out of the composition. */
12225 return (pt
<= start
|| pt
>= end
);
12228 /* Check a composition at the current point. */
12229 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12230 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12231 && COMPOSITION_VALID_P (start
, end
, prop
)
12232 && start
< pt
&& end
> pt
);
12236 /* Reconsider the setting of B->clip_changed which is displayed
12240 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12242 if (b
->clip_changed
12243 && !NILP (w
->window_end_valid
)
12244 && w
->current_matrix
->buffer
== b
12245 && w
->current_matrix
->zv
== BUF_ZV (b
)
12246 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12247 b
->clip_changed
= 0;
12249 /* If display wasn't paused, and W is not a tool bar window, see if
12250 point has been moved into or out of a composition. In that case,
12251 we set b->clip_changed to 1 to force updating the screen. If
12252 b->clip_changed has already been set to 1, we can skip this
12254 if (!b
->clip_changed
12255 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12259 if (w
== XWINDOW (selected_window
))
12262 pt
= marker_position (w
->pointm
);
12264 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12265 || pt
!= XINT (w
->last_point
))
12266 && check_point_in_composition (w
->current_matrix
->buffer
,
12267 XINT (w
->last_point
),
12268 XBUFFER (w
->buffer
), pt
))
12269 b
->clip_changed
= 1;
12274 /* Select FRAME to forward the values of frame-local variables into C
12275 variables so that the redisplay routines can access those values
12279 select_frame_for_redisplay (Lisp_Object frame
)
12281 Lisp_Object tail
, tem
;
12282 Lisp_Object old
= selected_frame
;
12283 struct Lisp_Symbol
*sym
;
12285 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12287 selected_frame
= frame
;
12290 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12291 if (CONSP (XCAR (tail
))
12292 && (tem
= XCAR (XCAR (tail
)),
12294 && (sym
= indirect_variable (XSYMBOL (tem
)),
12295 sym
->redirect
== SYMBOL_LOCALIZED
)
12296 && sym
->val
.blv
->frame_local
)
12297 /* Use find_symbol_value rather than Fsymbol_value
12298 to avoid an error if it is void. */
12299 find_symbol_value (tem
);
12300 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12304 #define STOP_POLLING \
12305 do { if (! polling_stopped_here) stop_polling (); \
12306 polling_stopped_here = 1; } while (0)
12308 #define RESUME_POLLING \
12309 do { if (polling_stopped_here) start_polling (); \
12310 polling_stopped_here = 0; } while (0)
12313 /* Perhaps in the future avoid recentering windows if it
12314 is not necessary; currently that causes some problems. */
12317 redisplay_internal (void)
12319 struct window
*w
= XWINDOW (selected_window
);
12323 int must_finish
= 0;
12324 struct text_pos tlbufpos
, tlendpos
;
12325 int number_of_visible_frames
;
12328 int polling_stopped_here
= 0;
12329 Lisp_Object old_frame
= selected_frame
;
12331 /* Non-zero means redisplay has to consider all windows on all
12332 frames. Zero means, only selected_window is considered. */
12333 int consider_all_windows_p
;
12335 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12337 /* No redisplay if running in batch mode or frame is not yet fully
12338 initialized, or redisplay is explicitly turned off by setting
12339 Vinhibit_redisplay. */
12340 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12341 || !NILP (Vinhibit_redisplay
))
12344 /* Don't examine these until after testing Vinhibit_redisplay.
12345 When Emacs is shutting down, perhaps because its connection to
12346 X has dropped, we should not look at them at all. */
12347 fr
= XFRAME (w
->frame
);
12348 sf
= SELECTED_FRAME ();
12350 if (!fr
->glyphs_initialized_p
)
12353 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12354 if (popup_activated ())
12358 /* I don't think this happens but let's be paranoid. */
12359 if (redisplaying_p
)
12362 /* Record a function that resets redisplaying_p to its old value
12363 when we leave this function. */
12364 count
= SPECPDL_INDEX ();
12365 record_unwind_protect (unwind_redisplay
,
12366 Fcons (make_number (redisplaying_p
), selected_frame
));
12368 specbind (Qinhibit_free_realized_faces
, Qnil
);
12371 Lisp_Object tail
, frame
;
12373 FOR_EACH_FRAME (tail
, frame
)
12375 struct frame
*f
= XFRAME (frame
);
12376 f
->already_hscrolled_p
= 0;
12381 /* Remember the currently selected window. */
12384 if (!EQ (old_frame
, selected_frame
)
12385 && FRAME_LIVE_P (XFRAME (old_frame
)))
12386 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12387 selected_frame and selected_window to be temporarily out-of-sync so
12388 when we come back here via `goto retry', we need to resync because we
12389 may need to run Elisp code (via prepare_menu_bars). */
12390 select_frame_for_redisplay (old_frame
);
12393 reconsider_clip_changes (w
, current_buffer
);
12394 last_escape_glyph_frame
= NULL
;
12395 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12396 last_glyphless_glyph_frame
= NULL
;
12397 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12399 /* If new fonts have been loaded that make a glyph matrix adjustment
12400 necessary, do it. */
12401 if (fonts_changed_p
)
12403 adjust_glyphs (NULL
);
12404 ++windows_or_buffers_changed
;
12405 fonts_changed_p
= 0;
12408 /* If face_change_count is non-zero, init_iterator will free all
12409 realized faces, which includes the faces referenced from current
12410 matrices. So, we can't reuse current matrices in this case. */
12411 if (face_change_count
)
12412 ++windows_or_buffers_changed
;
12414 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12415 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12417 /* Since frames on a single ASCII terminal share the same
12418 display area, displaying a different frame means redisplay
12419 the whole thing. */
12420 windows_or_buffers_changed
++;
12421 SET_FRAME_GARBAGED (sf
);
12423 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12425 FRAME_TTY (sf
)->previous_frame
= sf
;
12428 /* Set the visible flags for all frames. Do this before checking
12429 for resized or garbaged frames; they want to know if their frames
12430 are visible. See the comment in frame.h for
12431 FRAME_SAMPLE_VISIBILITY. */
12433 Lisp_Object tail
, frame
;
12435 number_of_visible_frames
= 0;
12437 FOR_EACH_FRAME (tail
, frame
)
12439 struct frame
*f
= XFRAME (frame
);
12441 FRAME_SAMPLE_VISIBILITY (f
);
12442 if (FRAME_VISIBLE_P (f
))
12443 ++number_of_visible_frames
;
12444 clear_desired_matrices (f
);
12448 /* Notice any pending interrupt request to change frame size. */
12449 do_pending_window_change (1);
12451 /* do_pending_window_change could change the selected_window due to
12452 frame resizing which makes the selected window too small. */
12453 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12456 reconsider_clip_changes (w
, current_buffer
);
12459 /* Clear frames marked as garbaged. */
12460 if (frame_garbaged
)
12461 clear_garbaged_frames ();
12463 /* Build menubar and tool-bar items. */
12464 if (NILP (Vmemory_full
))
12465 prepare_menu_bars ();
12467 if (windows_or_buffers_changed
)
12468 update_mode_lines
++;
12470 /* Detect case that we need to write or remove a star in the mode line. */
12471 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12473 w
->update_mode_line
= Qt
;
12474 if (buffer_shared
> 1)
12475 update_mode_lines
++;
12478 /* Avoid invocation of point motion hooks by `current_column' below. */
12479 count1
= SPECPDL_INDEX ();
12480 specbind (Qinhibit_point_motion_hooks
, Qt
);
12482 /* If %c is in the mode line, update it if needed. */
12483 if (!NILP (w
->column_number_displayed
)
12484 /* This alternative quickly identifies a common case
12485 where no change is needed. */
12486 && !(PT
== XFASTINT (w
->last_point
)
12487 && XFASTINT (w
->last_modified
) >= MODIFF
12488 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12489 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12490 w
->update_mode_line
= Qt
;
12492 unbind_to (count1
, Qnil
);
12494 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12496 /* The variable buffer_shared is set in redisplay_window and
12497 indicates that we redisplay a buffer in different windows. See
12499 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12500 || cursor_type_changed
);
12502 /* If specs for an arrow have changed, do thorough redisplay
12503 to ensure we remove any arrow that should no longer exist. */
12504 if (overlay_arrows_changed_p ())
12505 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12507 /* Normally the message* functions will have already displayed and
12508 updated the echo area, but the frame may have been trashed, or
12509 the update may have been preempted, so display the echo area
12510 again here. Checking message_cleared_p captures the case that
12511 the echo area should be cleared. */
12512 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12513 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12514 || (message_cleared_p
12515 && minibuf_level
== 0
12516 /* If the mini-window is currently selected, this means the
12517 echo-area doesn't show through. */
12518 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12520 int window_height_changed_p
= echo_area_display (0);
12523 /* If we don't display the current message, don't clear the
12524 message_cleared_p flag, because, if we did, we wouldn't clear
12525 the echo area in the next redisplay which doesn't preserve
12527 if (!display_last_displayed_message_p
)
12528 message_cleared_p
= 0;
12530 if (fonts_changed_p
)
12532 else if (window_height_changed_p
)
12534 consider_all_windows_p
= 1;
12535 ++update_mode_lines
;
12536 ++windows_or_buffers_changed
;
12538 /* If window configuration was changed, frames may have been
12539 marked garbaged. Clear them or we will experience
12540 surprises wrt scrolling. */
12541 if (frame_garbaged
)
12542 clear_garbaged_frames ();
12545 else if (EQ (selected_window
, minibuf_window
)
12546 && (current_buffer
->clip_changed
12547 || XFASTINT (w
->last_modified
) < MODIFF
12548 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12549 && resize_mini_window (w
, 0))
12551 /* Resized active mini-window to fit the size of what it is
12552 showing if its contents might have changed. */
12554 /* FIXME: this causes all frames to be updated, which seems unnecessary
12555 since only the current frame needs to be considered. This function needs
12556 to be rewritten with two variables, consider_all_windows and
12557 consider_all_frames. */
12558 consider_all_windows_p
= 1;
12559 ++windows_or_buffers_changed
;
12560 ++update_mode_lines
;
12562 /* If window configuration was changed, frames may have been
12563 marked garbaged. Clear them or we will experience
12564 surprises wrt scrolling. */
12565 if (frame_garbaged
)
12566 clear_garbaged_frames ();
12570 /* If showing the region, and mark has changed, we must redisplay
12571 the whole window. The assignment to this_line_start_pos prevents
12572 the optimization directly below this if-statement. */
12573 if (((!NILP (Vtransient_mark_mode
)
12574 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12575 != !NILP (w
->region_showing
))
12576 || (!NILP (w
->region_showing
)
12577 && !EQ (w
->region_showing
,
12578 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12579 CHARPOS (this_line_start_pos
) = 0;
12581 /* Optimize the case that only the line containing the cursor in the
12582 selected window has changed. Variables starting with this_ are
12583 set in display_line and record information about the line
12584 containing the cursor. */
12585 tlbufpos
= this_line_start_pos
;
12586 tlendpos
= this_line_end_pos
;
12587 if (!consider_all_windows_p
12588 && CHARPOS (tlbufpos
) > 0
12589 && NILP (w
->update_mode_line
)
12590 && !current_buffer
->clip_changed
12591 && !current_buffer
->prevent_redisplay_optimizations_p
12592 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12593 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12594 /* Make sure recorded data applies to current buffer, etc. */
12595 && this_line_buffer
== current_buffer
12596 && current_buffer
== XBUFFER (w
->buffer
)
12597 && NILP (w
->force_start
)
12598 && NILP (w
->optional_new_start
)
12599 /* Point must be on the line that we have info recorded about. */
12600 && PT
>= CHARPOS (tlbufpos
)
12601 && PT
<= Z
- CHARPOS (tlendpos
)
12602 /* All text outside that line, including its final newline,
12603 must be unchanged. */
12604 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12605 CHARPOS (tlendpos
)))
12607 if (CHARPOS (tlbufpos
) > BEGV
12608 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12609 && (CHARPOS (tlbufpos
) == ZV
12610 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12611 /* Former continuation line has disappeared by becoming empty. */
12613 else if (XFASTINT (w
->last_modified
) < MODIFF
12614 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12615 || MINI_WINDOW_P (w
))
12617 /* We have to handle the case of continuation around a
12618 wide-column character (see the comment in indent.c around
12621 For instance, in the following case:
12623 -------- Insert --------
12624 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12625 J_I_ ==> J_I_ `^^' are cursors.
12629 As we have to redraw the line above, we cannot use this
12633 int line_height_before
= this_line_pixel_height
;
12635 /* Note that start_display will handle the case that the
12636 line starting at tlbufpos is a continuation line. */
12637 start_display (&it
, w
, tlbufpos
);
12639 /* Implementation note: It this still necessary? */
12640 if (it
.current_x
!= this_line_start_x
)
12643 TRACE ((stderr
, "trying display optimization 1\n"));
12644 w
->cursor
.vpos
= -1;
12645 overlay_arrow_seen
= 0;
12646 it
.vpos
= this_line_vpos
;
12647 it
.current_y
= this_line_y
;
12648 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12649 display_line (&it
);
12651 /* If line contains point, is not continued,
12652 and ends at same distance from eob as before, we win. */
12653 if (w
->cursor
.vpos
>= 0
12654 /* Line is not continued, otherwise this_line_start_pos
12655 would have been set to 0 in display_line. */
12656 && CHARPOS (this_line_start_pos
)
12657 /* Line ends as before. */
12658 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12659 /* Line has same height as before. Otherwise other lines
12660 would have to be shifted up or down. */
12661 && this_line_pixel_height
== line_height_before
)
12663 /* If this is not the window's last line, we must adjust
12664 the charstarts of the lines below. */
12665 if (it
.current_y
< it
.last_visible_y
)
12667 struct glyph_row
*row
12668 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12669 EMACS_INT delta
, delta_bytes
;
12671 /* We used to distinguish between two cases here,
12672 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12673 when the line ends in a newline or the end of the
12674 buffer's accessible portion. But both cases did
12675 the same, so they were collapsed. */
12677 - CHARPOS (tlendpos
)
12678 - MATRIX_ROW_START_CHARPOS (row
));
12679 delta_bytes
= (Z_BYTE
12680 - BYTEPOS (tlendpos
)
12681 - MATRIX_ROW_START_BYTEPOS (row
));
12683 increment_matrix_positions (w
->current_matrix
,
12684 this_line_vpos
+ 1,
12685 w
->current_matrix
->nrows
,
12686 delta
, delta_bytes
);
12689 /* If this row displays text now but previously didn't,
12690 or vice versa, w->window_end_vpos may have to be
12692 if ((it
.glyph_row
- 1)->displays_text_p
)
12694 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
12695 XSETINT (w
->window_end_vpos
, this_line_vpos
);
12697 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
12698 && this_line_vpos
> 0)
12699 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
12700 w
->window_end_valid
= Qnil
;
12702 /* Update hint: No need to try to scroll in update_window. */
12703 w
->desired_matrix
->no_scrolling_p
= 1;
12706 *w
->desired_matrix
->method
= 0;
12707 debug_method_add (w
, "optimization 1");
12709 #ifdef HAVE_WINDOW_SYSTEM
12710 update_window_fringes (w
, 0);
12717 else if (/* Cursor position hasn't changed. */
12718 PT
== XFASTINT (w
->last_point
)
12719 /* Make sure the cursor was last displayed
12720 in this window. Otherwise we have to reposition it. */
12721 && 0 <= w
->cursor
.vpos
12722 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
12726 do_pending_window_change (1);
12727 /* If selected_window changed, redisplay again. */
12728 if (WINDOWP (selected_window
)
12729 && (w
= XWINDOW (selected_window
)) != sw
)
12732 /* We used to always goto end_of_redisplay here, but this
12733 isn't enough if we have a blinking cursor. */
12734 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
12735 goto end_of_redisplay
;
12739 /* If highlighting the region, or if the cursor is in the echo area,
12740 then we can't just move the cursor. */
12741 else if (! (!NILP (Vtransient_mark_mode
)
12742 && !NILP (BVAR (current_buffer
, mark_active
)))
12743 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
12744 || highlight_nonselected_windows
)
12745 && NILP (w
->region_showing
)
12746 && NILP (Vshow_trailing_whitespace
)
12747 && !cursor_in_echo_area
)
12750 struct glyph_row
*row
;
12752 /* Skip from tlbufpos to PT and see where it is. Note that
12753 PT may be in invisible text. If so, we will end at the
12754 next visible position. */
12755 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
12756 NULL
, DEFAULT_FACE_ID
);
12757 it
.current_x
= this_line_start_x
;
12758 it
.current_y
= this_line_y
;
12759 it
.vpos
= this_line_vpos
;
12761 /* The call to move_it_to stops in front of PT, but
12762 moves over before-strings. */
12763 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
12765 if (it
.vpos
== this_line_vpos
12766 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
12769 xassert (this_line_vpos
== it
.vpos
);
12770 xassert (this_line_y
== it
.current_y
);
12771 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
12773 *w
->desired_matrix
->method
= 0;
12774 debug_method_add (w
, "optimization 3");
12783 /* Text changed drastically or point moved off of line. */
12784 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
12787 CHARPOS (this_line_start_pos
) = 0;
12788 consider_all_windows_p
|= buffer_shared
> 1;
12789 ++clear_face_cache_count
;
12790 #ifdef HAVE_WINDOW_SYSTEM
12791 ++clear_image_cache_count
;
12794 /* Build desired matrices, and update the display. If
12795 consider_all_windows_p is non-zero, do it for all windows on all
12796 frames. Otherwise do it for selected_window, only. */
12798 if (consider_all_windows_p
)
12800 Lisp_Object tail
, frame
;
12802 FOR_EACH_FRAME (tail
, frame
)
12803 XFRAME (frame
)->updated_p
= 0;
12805 /* Recompute # windows showing selected buffer. This will be
12806 incremented each time such a window is displayed. */
12809 FOR_EACH_FRAME (tail
, frame
)
12811 struct frame
*f
= XFRAME (frame
);
12813 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
12815 if (! EQ (frame
, selected_frame
))
12816 /* Select the frame, for the sake of frame-local
12818 select_frame_for_redisplay (frame
);
12820 /* Mark all the scroll bars to be removed; we'll redeem
12821 the ones we want when we redisplay their windows. */
12822 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
12823 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
12825 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12826 redisplay_windows (FRAME_ROOT_WINDOW (f
));
12828 /* The X error handler may have deleted that frame. */
12829 if (!FRAME_LIVE_P (f
))
12832 /* Any scroll bars which redisplay_windows should have
12833 nuked should now go away. */
12834 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
12835 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
12837 /* If fonts changed, display again. */
12838 /* ??? rms: I suspect it is a mistake to jump all the way
12839 back to retry here. It should just retry this frame. */
12840 if (fonts_changed_p
)
12843 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
12845 /* See if we have to hscroll. */
12846 if (!f
->already_hscrolled_p
)
12848 f
->already_hscrolled_p
= 1;
12849 if (hscroll_windows (f
->root_window
))
12853 /* Prevent various kinds of signals during display
12854 update. stdio is not robust about handling
12855 signals, which can cause an apparent I/O
12857 if (interrupt_input
)
12858 unrequest_sigio ();
12861 /* Update the display. */
12862 set_window_update_flags (XWINDOW (f
->root_window
), 1);
12863 pending
|= update_frame (f
, 0, 0);
12869 if (!EQ (old_frame
, selected_frame
)
12870 && FRAME_LIVE_P (XFRAME (old_frame
)))
12871 /* We played a bit fast-and-loose above and allowed selected_frame
12872 and selected_window to be temporarily out-of-sync but let's make
12873 sure this stays contained. */
12874 select_frame_for_redisplay (old_frame
);
12875 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
12879 /* Do the mark_window_display_accurate after all windows have
12880 been redisplayed because this call resets flags in buffers
12881 which are needed for proper redisplay. */
12882 FOR_EACH_FRAME (tail
, frame
)
12884 struct frame
*f
= XFRAME (frame
);
12887 mark_window_display_accurate (f
->root_window
, 1);
12888 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
12889 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
12894 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12896 Lisp_Object mini_window
;
12897 struct frame
*mini_frame
;
12899 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
12900 /* Use list_of_error, not Qerror, so that
12901 we catch only errors and don't run the debugger. */
12902 internal_condition_case_1 (redisplay_window_1
, selected_window
,
12904 redisplay_window_error
);
12906 /* Compare desired and current matrices, perform output. */
12909 /* If fonts changed, display again. */
12910 if (fonts_changed_p
)
12913 /* Prevent various kinds of signals during display update.
12914 stdio is not robust about handling signals,
12915 which can cause an apparent I/O error. */
12916 if (interrupt_input
)
12917 unrequest_sigio ();
12920 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
12922 if (hscroll_windows (selected_window
))
12925 XWINDOW (selected_window
)->must_be_updated_p
= 1;
12926 pending
= update_frame (sf
, 0, 0);
12929 /* We may have called echo_area_display at the top of this
12930 function. If the echo area is on another frame, that may
12931 have put text on a frame other than the selected one, so the
12932 above call to update_frame would not have caught it. Catch
12934 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
12935 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
12937 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
12939 XWINDOW (mini_window
)->must_be_updated_p
= 1;
12940 pending
|= update_frame (mini_frame
, 0, 0);
12941 if (!pending
&& hscroll_windows (mini_window
))
12946 /* If display was paused because of pending input, make sure we do a
12947 thorough update the next time. */
12950 /* Prevent the optimization at the beginning of
12951 redisplay_internal that tries a single-line update of the
12952 line containing the cursor in the selected window. */
12953 CHARPOS (this_line_start_pos
) = 0;
12955 /* Let the overlay arrow be updated the next time. */
12956 update_overlay_arrows (0);
12958 /* If we pause after scrolling, some rows in the current
12959 matrices of some windows are not valid. */
12960 if (!WINDOW_FULL_WIDTH_P (w
)
12961 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
12962 update_mode_lines
= 1;
12966 if (!consider_all_windows_p
)
12968 /* This has already been done above if
12969 consider_all_windows_p is set. */
12970 mark_window_display_accurate_1 (w
, 1);
12972 /* Say overlay arrows are up to date. */
12973 update_overlay_arrows (1);
12975 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
12976 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
12979 update_mode_lines
= 0;
12980 windows_or_buffers_changed
= 0;
12981 cursor_type_changed
= 0;
12984 /* Start SIGIO interrupts coming again. Having them off during the
12985 code above makes it less likely one will discard output, but not
12986 impossible, since there might be stuff in the system buffer here.
12987 But it is much hairier to try to do anything about that. */
12988 if (interrupt_input
)
12992 /* If a frame has become visible which was not before, redisplay
12993 again, so that we display it. Expose events for such a frame
12994 (which it gets when becoming visible) don't call the parts of
12995 redisplay constructing glyphs, so simply exposing a frame won't
12996 display anything in this case. So, we have to display these
12997 frames here explicitly. */
13000 Lisp_Object tail
, frame
;
13003 FOR_EACH_FRAME (tail
, frame
)
13005 int this_is_visible
= 0;
13007 if (XFRAME (frame
)->visible
)
13008 this_is_visible
= 1;
13009 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13010 if (XFRAME (frame
)->visible
)
13011 this_is_visible
= 1;
13013 if (this_is_visible
)
13017 if (new_count
!= number_of_visible_frames
)
13018 windows_or_buffers_changed
++;
13021 /* Change frame size now if a change is pending. */
13022 do_pending_window_change (1);
13024 /* If we just did a pending size change, or have additional
13025 visible frames, or selected_window changed, redisplay again. */
13026 if ((windows_or_buffers_changed
&& !pending
)
13027 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13030 /* Clear the face and image caches.
13032 We used to do this only if consider_all_windows_p. But the cache
13033 needs to be cleared if a timer creates images in the current
13034 buffer (e.g. the test case in Bug#6230). */
13036 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13038 clear_face_cache (0);
13039 clear_face_cache_count
= 0;
13042 #ifdef HAVE_WINDOW_SYSTEM
13043 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13045 clear_image_caches (Qnil
);
13046 clear_image_cache_count
= 0;
13048 #endif /* HAVE_WINDOW_SYSTEM */
13051 unbind_to (count
, Qnil
);
13056 /* Redisplay, but leave alone any recent echo area message unless
13057 another message has been requested in its place.
13059 This is useful in situations where you need to redisplay but no
13060 user action has occurred, making it inappropriate for the message
13061 area to be cleared. See tracking_off and
13062 wait_reading_process_output for examples of these situations.
13064 FROM_WHERE is an integer saying from where this function was
13065 called. This is useful for debugging. */
13068 redisplay_preserve_echo_area (int from_where
)
13070 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13072 if (!NILP (echo_area_buffer
[1]))
13074 /* We have a previously displayed message, but no current
13075 message. Redisplay the previous message. */
13076 display_last_displayed_message_p
= 1;
13077 redisplay_internal ();
13078 display_last_displayed_message_p
= 0;
13081 redisplay_internal ();
13083 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13084 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13085 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13089 /* Function registered with record_unwind_protect in
13090 redisplay_internal. Reset redisplaying_p to the value it had
13091 before redisplay_internal was called, and clear
13092 prevent_freeing_realized_faces_p. It also selects the previously
13093 selected frame, unless it has been deleted (by an X connection
13094 failure during redisplay, for example). */
13097 unwind_redisplay (Lisp_Object val
)
13099 Lisp_Object old_redisplaying_p
, old_frame
;
13101 old_redisplaying_p
= XCAR (val
);
13102 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13103 old_frame
= XCDR (val
);
13104 if (! EQ (old_frame
, selected_frame
)
13105 && FRAME_LIVE_P (XFRAME (old_frame
)))
13106 select_frame_for_redisplay (old_frame
);
13111 /* Mark the display of window W as accurate or inaccurate. If
13112 ACCURATE_P is non-zero mark display of W as accurate. If
13113 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13114 redisplay_internal is called. */
13117 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13119 if (BUFFERP (w
->buffer
))
13121 struct buffer
*b
= XBUFFER (w
->buffer
);
13124 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13125 w
->last_overlay_modified
13126 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13128 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13132 b
->clip_changed
= 0;
13133 b
->prevent_redisplay_optimizations_p
= 0;
13135 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13136 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13137 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13138 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13140 w
->current_matrix
->buffer
= b
;
13141 w
->current_matrix
->begv
= BUF_BEGV (b
);
13142 w
->current_matrix
->zv
= BUF_ZV (b
);
13144 w
->last_cursor
= w
->cursor
;
13145 w
->last_cursor_off_p
= w
->cursor_off_p
;
13147 if (w
== XWINDOW (selected_window
))
13148 w
->last_point
= make_number (BUF_PT (b
));
13150 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13156 w
->window_end_valid
= w
->buffer
;
13157 w
->update_mode_line
= Qnil
;
13162 /* Mark the display of windows in the window tree rooted at WINDOW as
13163 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13164 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13165 be redisplayed the next time redisplay_internal is called. */
13168 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13172 for (; !NILP (window
); window
= w
->next
)
13174 w
= XWINDOW (window
);
13175 mark_window_display_accurate_1 (w
, accurate_p
);
13177 if (!NILP (w
->vchild
))
13178 mark_window_display_accurate (w
->vchild
, accurate_p
);
13179 if (!NILP (w
->hchild
))
13180 mark_window_display_accurate (w
->hchild
, accurate_p
);
13185 update_overlay_arrows (1);
13189 /* Force a thorough redisplay the next time by setting
13190 last_arrow_position and last_arrow_string to t, which is
13191 unequal to any useful value of Voverlay_arrow_... */
13192 update_overlay_arrows (-1);
13197 /* Return value in display table DP (Lisp_Char_Table *) for character
13198 C. Since a display table doesn't have any parent, we don't have to
13199 follow parent. Do not call this function directly but use the
13200 macro DISP_CHAR_VECTOR. */
13203 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13207 if (ASCII_CHAR_P (c
))
13210 if (SUB_CHAR_TABLE_P (val
))
13211 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13217 XSETCHAR_TABLE (table
, dp
);
13218 val
= char_table_ref (table
, c
);
13227 /***********************************************************************
13229 ***********************************************************************/
13231 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13234 redisplay_windows (Lisp_Object window
)
13236 while (!NILP (window
))
13238 struct window
*w
= XWINDOW (window
);
13240 if (!NILP (w
->hchild
))
13241 redisplay_windows (w
->hchild
);
13242 else if (!NILP (w
->vchild
))
13243 redisplay_windows (w
->vchild
);
13244 else if (!NILP (w
->buffer
))
13246 displayed_buffer
= XBUFFER (w
->buffer
);
13247 /* Use list_of_error, not Qerror, so that
13248 we catch only errors and don't run the debugger. */
13249 internal_condition_case_1 (redisplay_window_0
, window
,
13251 redisplay_window_error
);
13259 redisplay_window_error (Lisp_Object ignore
)
13261 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13266 redisplay_window_0 (Lisp_Object window
)
13268 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13269 redisplay_window (window
, 0);
13274 redisplay_window_1 (Lisp_Object window
)
13276 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13277 redisplay_window (window
, 1);
13282 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13283 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13284 which positions recorded in ROW differ from current buffer
13287 Return 0 if cursor is not on this row, 1 otherwise. */
13290 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13291 struct glyph_matrix
*matrix
,
13292 EMACS_INT delta
, EMACS_INT delta_bytes
,
13295 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13296 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13297 struct glyph
*cursor
= NULL
;
13298 /* The last known character position in row. */
13299 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13301 EMACS_INT pt_old
= PT
- delta
;
13302 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13303 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13304 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13305 /* A glyph beyond the edge of TEXT_AREA which we should never
13307 struct glyph
*glyphs_end
= end
;
13308 /* Non-zero means we've found a match for cursor position, but that
13309 glyph has the avoid_cursor_p flag set. */
13310 int match_with_avoid_cursor
= 0;
13311 /* Non-zero means we've seen at least one glyph that came from a
13313 int string_seen
= 0;
13314 /* Largest and smalles buffer positions seen so far during scan of
13316 EMACS_INT bpos_max
= pos_before
;
13317 EMACS_INT bpos_min
= pos_after
;
13318 /* Last buffer position covered by an overlay string with an integer
13319 `cursor' property. */
13320 EMACS_INT bpos_covered
= 0;
13321 /* Non-zero means the display string on which to display the cursor
13322 comes from a text property, not from an overlay. */
13323 int string_from_text_prop
= 0;
13325 /* Skip over glyphs not having an object at the start and the end of
13326 the row. These are special glyphs like truncation marks on
13327 terminal frames. */
13328 if (row
->displays_text_p
)
13330 if (!row
->reversed_p
)
13333 && INTEGERP (glyph
->object
)
13334 && glyph
->charpos
< 0)
13336 x
+= glyph
->pixel_width
;
13340 && INTEGERP ((end
- 1)->object
)
13341 /* CHARPOS is zero for blanks and stretch glyphs
13342 inserted by extend_face_to_end_of_line. */
13343 && (end
- 1)->charpos
<= 0)
13345 glyph_before
= glyph
- 1;
13352 /* If the glyph row is reversed, we need to process it from back
13353 to front, so swap the edge pointers. */
13354 glyphs_end
= end
= glyph
- 1;
13355 glyph
+= row
->used
[TEXT_AREA
] - 1;
13357 while (glyph
> end
+ 1
13358 && INTEGERP (glyph
->object
)
13359 && glyph
->charpos
< 0)
13362 x
-= glyph
->pixel_width
;
13364 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13366 /* By default, in reversed rows we put the cursor on the
13367 rightmost (first in the reading order) glyph. */
13368 for (g
= end
+ 1; g
< glyph
; g
++)
13369 x
+= g
->pixel_width
;
13371 && INTEGERP ((end
+ 1)->object
)
13372 && (end
+ 1)->charpos
<= 0)
13374 glyph_before
= glyph
+ 1;
13378 else if (row
->reversed_p
)
13380 /* In R2L rows that don't display text, put the cursor on the
13381 rightmost glyph. Case in point: an empty last line that is
13382 part of an R2L paragraph. */
13384 /* Avoid placing the cursor on the last glyph of the row, where
13385 on terminal frames we hold the vertical border between
13386 adjacent windows. */
13387 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13388 && !WINDOW_RIGHTMOST_P (w
)
13389 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13391 x
= -1; /* will be computed below, at label compute_x */
13394 /* Step 1: Try to find the glyph whose character position
13395 corresponds to point. If that's not possible, find 2 glyphs
13396 whose character positions are the closest to point, one before
13397 point, the other after it. */
13398 if (!row
->reversed_p
)
13399 while (/* not marched to end of glyph row */
13401 /* glyph was not inserted by redisplay for internal purposes */
13402 && !INTEGERP (glyph
->object
))
13404 if (BUFFERP (glyph
->object
))
13406 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13408 if (glyph
->charpos
> bpos_max
)
13409 bpos_max
= glyph
->charpos
;
13410 if (glyph
->charpos
< bpos_min
)
13411 bpos_min
= glyph
->charpos
;
13412 if (!glyph
->avoid_cursor_p
)
13414 /* If we hit point, we've found the glyph on which to
13415 display the cursor. */
13418 match_with_avoid_cursor
= 0;
13421 /* See if we've found a better approximation to
13422 POS_BEFORE or to POS_AFTER. Note that we want the
13423 first (leftmost) glyph of all those that are the
13424 closest from below, and the last (rightmost) of all
13425 those from above. */
13426 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13428 pos_before
= glyph
->charpos
;
13429 glyph_before
= glyph
;
13431 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13433 pos_after
= glyph
->charpos
;
13434 glyph_after
= glyph
;
13437 else if (dpos
== 0)
13438 match_with_avoid_cursor
= 1;
13440 else if (STRINGP (glyph
->object
))
13442 Lisp_Object chprop
;
13443 EMACS_INT glyph_pos
= glyph
->charpos
;
13445 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13447 if (INTEGERP (chprop
))
13449 bpos_covered
= bpos_max
+ XINT (chprop
);
13450 /* If the `cursor' property covers buffer positions up
13451 to and including point, we should display cursor on
13452 this glyph. Note that overlays and text properties
13453 with string values stop bidi reordering, so every
13454 buffer position to the left of the string is always
13455 smaller than any position to the right of the
13456 string. Therefore, if a `cursor' property on one
13457 of the string's characters has an integer value, we
13458 will break out of the loop below _before_ we get to
13459 the position match above. IOW, integer values of
13460 the `cursor' property override the "exact match for
13461 point" strategy of positioning the cursor. */
13462 /* Implementation note: bpos_max == pt_old when, e.g.,
13463 we are in an empty line, where bpos_max is set to
13464 MATRIX_ROW_START_CHARPOS, see above. */
13465 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13474 x
+= glyph
->pixel_width
;
13477 else if (glyph
> end
) /* row is reversed */
13478 while (!INTEGERP (glyph
->object
))
13480 if (BUFFERP (glyph
->object
))
13482 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13484 if (glyph
->charpos
> bpos_max
)
13485 bpos_max
= glyph
->charpos
;
13486 if (glyph
->charpos
< bpos_min
)
13487 bpos_min
= glyph
->charpos
;
13488 if (!glyph
->avoid_cursor_p
)
13492 match_with_avoid_cursor
= 0;
13495 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13497 pos_before
= glyph
->charpos
;
13498 glyph_before
= glyph
;
13500 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13502 pos_after
= glyph
->charpos
;
13503 glyph_after
= glyph
;
13506 else if (dpos
== 0)
13507 match_with_avoid_cursor
= 1;
13509 else if (STRINGP (glyph
->object
))
13511 Lisp_Object chprop
;
13512 EMACS_INT glyph_pos
= glyph
->charpos
;
13514 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13516 if (INTEGERP (chprop
))
13518 bpos_covered
= bpos_max
+ XINT (chprop
);
13519 /* If the `cursor' property covers buffer positions up
13520 to and including point, we should display cursor on
13522 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13531 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13533 x
--; /* can't use any pixel_width */
13536 x
-= glyph
->pixel_width
;
13539 /* Step 2: If we didn't find an exact match for point, we need to
13540 look for a proper place to put the cursor among glyphs between
13541 GLYPH_BEFORE and GLYPH_AFTER. */
13542 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13543 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13544 && bpos_covered
< pt_old
)
13546 /* An empty line has a single glyph whose OBJECT is zero and
13547 whose CHARPOS is the position of a newline on that line.
13548 Note that on a TTY, there are more glyphs after that, which
13549 were produced by extend_face_to_end_of_line, but their
13550 CHARPOS is zero or negative. */
13552 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13553 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13555 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13557 EMACS_INT ellipsis_pos
;
13559 /* Scan back over the ellipsis glyphs. */
13560 if (!row
->reversed_p
)
13562 ellipsis_pos
= (glyph
- 1)->charpos
;
13563 while (glyph
> row
->glyphs
[TEXT_AREA
]
13564 && (glyph
- 1)->charpos
== ellipsis_pos
)
13565 glyph
--, x
-= glyph
->pixel_width
;
13566 /* That loop always goes one position too far, including
13567 the glyph before the ellipsis. So scan forward over
13569 x
+= glyph
->pixel_width
;
13572 else /* row is reversed */
13574 ellipsis_pos
= (glyph
+ 1)->charpos
;
13575 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13576 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13577 glyph
++, x
+= glyph
->pixel_width
;
13578 x
-= glyph
->pixel_width
;
13582 else if (match_with_avoid_cursor
13583 /* A truncated row may not include PT among its
13584 character positions. Setting the cursor inside the
13585 scroll margin will trigger recalculation of hscroll
13586 in hscroll_window_tree. */
13587 || (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
13588 || (row
->truncated_on_right_p
&& pt_old
> bpos_max
)
13589 /* Zero-width characters produce no glyphs. */
13592 && (row
->reversed_p
13593 ? glyph_after
> glyphs_end
13594 : glyph_after
< glyphs_end
)))
13596 cursor
= glyph_after
;
13599 else if (string_seen
)
13601 int incr
= row
->reversed_p
? -1 : +1;
13603 /* Need to find the glyph that came out of a string which is
13604 present at point. That glyph is somewhere between
13605 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13606 positioned between POS_BEFORE and POS_AFTER in the
13608 struct glyph
*start
, *stop
;
13609 EMACS_INT pos
= pos_before
;
13613 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13614 correspond to POS_BEFORE and POS_AFTER, respectively. We
13615 need START and STOP in the order that corresponds to the
13616 row's direction as given by its reversed_p flag. If the
13617 directionality of characters between POS_BEFORE and
13618 POS_AFTER is the opposite of the row's base direction,
13619 these characters will have been reordered for display,
13620 and we need to reverse START and STOP. */
13621 if (!row
->reversed_p
)
13623 start
= min (glyph_before
, glyph_after
);
13624 stop
= max (glyph_before
, glyph_after
);
13628 start
= max (glyph_before
, glyph_after
);
13629 stop
= min (glyph_before
, glyph_after
);
13631 for (glyph
= start
+ incr
;
13632 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13635 /* Any glyphs that come from the buffer are here because
13636 of bidi reordering. Skip them, and only pay
13637 attention to glyphs that came from some string. */
13638 if (STRINGP (glyph
->object
))
13642 /* If the display property covers the newline, we
13643 need to search for it one position farther. */
13644 EMACS_INT lim
= pos_after
13645 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13647 string_from_text_prop
= 0;
13648 str
= glyph
->object
;
13649 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13650 if (tem
== 0 /* from overlay */
13653 /* If the string from which this glyph came is
13654 found in the buffer at point, then we've
13655 found the glyph we've been looking for. If
13656 it comes from an overlay (tem == 0), and it
13657 has the `cursor' property on one of its
13658 glyphs, record that glyph as a candidate for
13659 displaying the cursor. (As in the
13660 unidirectional version, we will display the
13661 cursor on the last candidate we find.) */
13662 if (tem
== 0 || tem
== pt_old
)
13664 /* The glyphs from this string could have
13665 been reordered. Find the one with the
13666 smallest string position. Or there could
13667 be a character in the string with the
13668 `cursor' property, which means display
13669 cursor on that character's glyph. */
13670 EMACS_INT strpos
= glyph
->charpos
;
13675 string_from_text_prop
= 1;
13678 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13679 && EQ (glyph
->object
, str
);
13683 EMACS_INT gpos
= glyph
->charpos
;
13685 cprop
= Fget_char_property (make_number (gpos
),
13693 if (tem
&& glyph
->charpos
< strpos
)
13695 strpos
= glyph
->charpos
;
13704 pos
= tem
+ 1; /* don't find previous instances */
13706 /* This string is not what we want; skip all of the
13707 glyphs that came from it. */
13708 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13709 && EQ (glyph
->object
, str
))
13716 /* If we reached the end of the line, and END was from a string,
13717 the cursor is not on this line. */
13719 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
13720 && STRINGP (end
->object
)
13721 && row
->continued_p
)
13727 if (cursor
!= NULL
)
13733 /* Need to compute x that corresponds to GLYPH. */
13734 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
13736 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
13738 x
+= g
->pixel_width
;
13742 /* ROW could be part of a continued line, which, under bidi
13743 reordering, might have other rows whose start and end charpos
13744 occlude point. Only set w->cursor if we found a better
13745 approximation to the cursor position than we have from previously
13746 examined candidate rows belonging to the same continued line. */
13747 if (/* we already have a candidate row */
13748 w
->cursor
.vpos
>= 0
13749 /* that candidate is not the row we are processing */
13750 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
13751 /* Make sure cursor.vpos specifies a row whose start and end
13752 charpos occlude point, and it is valid candidate for being a
13753 cursor-row. This is because some callers of this function
13754 leave cursor.vpos at the row where the cursor was displayed
13755 during the last redisplay cycle. */
13756 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
13757 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13758 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
13761 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
13763 /* Don't consider glyphs that are outside TEXT_AREA. */
13764 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
13766 /* Keep the candidate whose buffer position is the closest to
13767 point or has the `cursor' property. */
13768 if (/* previous candidate is a glyph in TEXT_AREA of that row */
13769 w
->cursor
.hpos
>= 0
13770 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
13771 && ((BUFFERP (g1
->object
)
13772 && (g1
->charpos
== pt_old
/* an exact match always wins */
13773 || (BUFFERP (glyph
->object
)
13774 && eabs (g1
->charpos
- pt_old
)
13775 < eabs (glyph
->charpos
- pt_old
))))
13776 /* previous candidate is a glyph from a string that has
13777 a non-nil `cursor' property */
13778 || (STRINGP (g1
->object
)
13779 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
13780 Qcursor
, g1
->object
))
13781 /* pevious candidate is from the same display
13782 string as this one, and the display string
13783 came from a text property */
13784 || (EQ (g1
->object
, glyph
->object
)
13785 && string_from_text_prop
)
13786 /* this candidate is from newline and its
13787 position is not an exact match */
13788 || (INTEGERP (glyph
->object
)
13789 && glyph
->charpos
!= pt_old
)))))
13791 /* If this candidate gives an exact match, use that. */
13792 if (!(BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13793 /* Otherwise, keep the candidate that comes from a row
13794 spanning less buffer positions. This may win when one or
13795 both candidate positions are on glyphs that came from
13796 display strings, for which we cannot compare buffer
13798 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13799 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
13800 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
13803 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
13805 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
13806 w
->cursor
.y
= row
->y
+ dy
;
13808 if (w
== XWINDOW (selected_window
))
13810 if (!row
->continued_p
13811 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
13814 this_line_buffer
= XBUFFER (w
->buffer
);
13816 CHARPOS (this_line_start_pos
)
13817 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
13818 BYTEPOS (this_line_start_pos
)
13819 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
13821 CHARPOS (this_line_end_pos
)
13822 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
13823 BYTEPOS (this_line_end_pos
)
13824 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
13826 this_line_y
= w
->cursor
.y
;
13827 this_line_pixel_height
= row
->height
;
13828 this_line_vpos
= w
->cursor
.vpos
;
13829 this_line_start_x
= row
->x
;
13832 CHARPOS (this_line_start_pos
) = 0;
13839 /* Run window scroll functions, if any, for WINDOW with new window
13840 start STARTP. Sets the window start of WINDOW to that position.
13842 We assume that the window's buffer is really current. */
13844 static inline struct text_pos
13845 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
13847 struct window
*w
= XWINDOW (window
);
13848 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
13850 if (current_buffer
!= XBUFFER (w
->buffer
))
13853 if (!NILP (Vwindow_scroll_functions
))
13855 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
13856 make_number (CHARPOS (startp
)));
13857 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13858 /* In case the hook functions switch buffers. */
13859 if (current_buffer
!= XBUFFER (w
->buffer
))
13860 set_buffer_internal_1 (XBUFFER (w
->buffer
));
13867 /* Make sure the line containing the cursor is fully visible.
13868 A value of 1 means there is nothing to be done.
13869 (Either the line is fully visible, or it cannot be made so,
13870 or we cannot tell.)
13872 If FORCE_P is non-zero, return 0 even if partial visible cursor row
13873 is higher than window.
13875 A value of 0 means the caller should do scrolling
13876 as if point had gone off the screen. */
13879 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
13881 struct glyph_matrix
*matrix
;
13882 struct glyph_row
*row
;
13885 if (!make_cursor_line_fully_visible_p
)
13888 /* It's not always possible to find the cursor, e.g, when a window
13889 is full of overlay strings. Don't do anything in that case. */
13890 if (w
->cursor
.vpos
< 0)
13893 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
13894 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
13896 /* If the cursor row is not partially visible, there's nothing to do. */
13897 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
13900 /* If the row the cursor is in is taller than the window's height,
13901 it's not clear what to do, so do nothing. */
13902 window_height
= window_box_height (w
);
13903 if (row
->height
>= window_height
)
13905 if (!force_p
|| MINI_WINDOW_P (w
)
13906 || w
->vscroll
|| w
->cursor
.vpos
== 0)
13913 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
13914 non-zero means only WINDOW is redisplayed in redisplay_internal.
13915 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
13916 in redisplay_window to bring a partially visible line into view in
13917 the case that only the cursor has moved.
13919 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
13920 last screen line's vertical height extends past the end of the screen.
13924 1 if scrolling succeeded
13926 0 if scrolling didn't find point.
13928 -1 if new fonts have been loaded so that we must interrupt
13929 redisplay, adjust glyph matrices, and try again. */
13935 SCROLLING_NEED_LARGER_MATRICES
13938 /* If scroll-conservatively is more than this, never recenter.
13940 If you change this, don't forget to update the doc string of
13941 `scroll-conservatively' and the Emacs manual. */
13942 #define SCROLL_LIMIT 100
13945 try_scrolling (Lisp_Object window
, int just_this_one_p
,
13946 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
13947 int temp_scroll_step
, int last_line_misfit
)
13949 struct window
*w
= XWINDOW (window
);
13950 struct frame
*f
= XFRAME (w
->frame
);
13951 struct text_pos pos
, startp
;
13953 int this_scroll_margin
, scroll_max
, rc
, height
;
13954 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
13955 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
13956 Lisp_Object aggressive
;
13957 /* We will never try scrolling more than this number of lines. */
13958 int scroll_limit
= SCROLL_LIMIT
;
13961 debug_method_add (w
, "try_scrolling");
13964 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
13966 /* Compute scroll margin height in pixels. We scroll when point is
13967 within this distance from the top or bottom of the window. */
13968 if (scroll_margin
> 0)
13969 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
13970 * FRAME_LINE_HEIGHT (f
);
13972 this_scroll_margin
= 0;
13974 /* Force arg_scroll_conservatively to have a reasonable value, to
13975 avoid scrolling too far away with slow move_it_* functions. Note
13976 that the user can supply scroll-conservatively equal to
13977 `most-positive-fixnum', which can be larger than INT_MAX. */
13978 if (arg_scroll_conservatively
> scroll_limit
)
13980 arg_scroll_conservatively
= scroll_limit
+ 1;
13981 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
13983 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
13984 /* Compute how much we should try to scroll maximally to bring
13985 point into view. */
13986 scroll_max
= (max (scroll_step
,
13987 max (arg_scroll_conservatively
, temp_scroll_step
))
13988 * FRAME_LINE_HEIGHT (f
));
13989 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
13990 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
13991 /* We're trying to scroll because of aggressive scrolling but no
13992 scroll_step is set. Choose an arbitrary one. */
13993 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
13999 /* Decide whether to scroll down. */
14000 if (PT
> CHARPOS (startp
))
14002 int scroll_margin_y
;
14004 /* Compute the pixel ypos of the scroll margin, then move it to
14005 either that ypos or PT, whichever comes first. */
14006 start_display (&it
, w
, startp
);
14007 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14008 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14009 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14010 (MOVE_TO_POS
| MOVE_TO_Y
));
14012 if (PT
> CHARPOS (it
.current
.pos
))
14014 int y0
= line_bottom_y (&it
);
14015 /* Compute how many pixels below window bottom to stop searching
14016 for PT. This avoids costly search for PT that is far away if
14017 the user limited scrolling by a small number of lines, but
14018 always finds PT if scroll_conservatively is set to a large
14019 number, such as most-positive-fixnum. */
14020 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14021 int y_to_move
= it
.last_visible_y
+ slack
;
14023 /* Compute the distance from the scroll margin to PT or to
14024 the scroll limit, whichever comes first. This should
14025 include the height of the cursor line, to make that line
14027 move_it_to (&it
, PT
, -1, y_to_move
,
14028 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14029 dy
= line_bottom_y (&it
) - y0
;
14031 if (dy
> scroll_max
)
14032 return SCROLLING_FAILED
;
14040 /* Point is in or below the bottom scroll margin, so move the
14041 window start down. If scrolling conservatively, move it just
14042 enough down to make point visible. If scroll_step is set,
14043 move it down by scroll_step. */
14044 if (arg_scroll_conservatively
)
14046 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14047 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14048 else if (scroll_step
|| temp_scroll_step
)
14049 amount_to_scroll
= scroll_max
;
14052 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14053 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14054 if (NUMBERP (aggressive
))
14056 double float_amount
= XFLOATINT (aggressive
) * height
;
14057 amount_to_scroll
= float_amount
;
14058 if (amount_to_scroll
== 0 && float_amount
> 0)
14059 amount_to_scroll
= 1;
14060 /* Don't let point enter the scroll margin near top of
14062 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14063 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14067 if (amount_to_scroll
<= 0)
14068 return SCROLLING_FAILED
;
14070 start_display (&it
, w
, startp
);
14071 if (arg_scroll_conservatively
<= scroll_limit
)
14072 move_it_vertically (&it
, amount_to_scroll
);
14075 /* Extra precision for users who set scroll-conservatively
14076 to a large number: make sure the amount we scroll
14077 the window start is never less than amount_to_scroll,
14078 which was computed as distance from window bottom to
14079 point. This matters when lines at window top and lines
14080 below window bottom have different height. */
14082 void *it1data
= NULL
;
14083 /* We use a temporary it1 because line_bottom_y can modify
14084 its argument, if it moves one line down; see there. */
14087 SAVE_IT (it1
, it
, it1data
);
14088 start_y
= line_bottom_y (&it1
);
14090 RESTORE_IT (&it
, &it
, it1data
);
14091 move_it_by_lines (&it
, 1);
14092 SAVE_IT (it1
, it
, it1data
);
14093 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14096 /* If STARTP is unchanged, move it down another screen line. */
14097 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14098 move_it_by_lines (&it
, 1);
14099 startp
= it
.current
.pos
;
14103 struct text_pos scroll_margin_pos
= startp
;
14105 /* See if point is inside the scroll margin at the top of the
14107 if (this_scroll_margin
)
14109 start_display (&it
, w
, startp
);
14110 move_it_vertically (&it
, this_scroll_margin
);
14111 scroll_margin_pos
= it
.current
.pos
;
14114 if (PT
< CHARPOS (scroll_margin_pos
))
14116 /* Point is in the scroll margin at the top of the window or
14117 above what is displayed in the window. */
14120 /* Compute the vertical distance from PT to the scroll
14121 margin position. Move as far as scroll_max allows, or
14122 one screenful, or 10 screen lines, whichever is largest.
14123 Give up if distance is greater than scroll_max. */
14124 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14125 start_display (&it
, w
, pos
);
14127 y_to_move
= max (it
.last_visible_y
,
14128 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14129 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14131 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14132 dy
= it
.current_y
- y0
;
14133 if (dy
> scroll_max
)
14134 return SCROLLING_FAILED
;
14136 /* Compute new window start. */
14137 start_display (&it
, w
, startp
);
14139 if (arg_scroll_conservatively
)
14140 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14141 max (scroll_step
, temp_scroll_step
));
14142 else if (scroll_step
|| temp_scroll_step
)
14143 amount_to_scroll
= scroll_max
;
14146 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14147 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14148 if (NUMBERP (aggressive
))
14150 double float_amount
= XFLOATINT (aggressive
) * height
;
14151 amount_to_scroll
= float_amount
;
14152 if (amount_to_scroll
== 0 && float_amount
> 0)
14153 amount_to_scroll
= 1;
14154 amount_to_scroll
-=
14155 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14156 /* Don't let point enter the scroll margin near
14157 bottom of the window. */
14158 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14159 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14163 if (amount_to_scroll
<= 0)
14164 return SCROLLING_FAILED
;
14166 move_it_vertically_backward (&it
, amount_to_scroll
);
14167 startp
= it
.current
.pos
;
14171 /* Run window scroll functions. */
14172 startp
= run_window_scroll_functions (window
, startp
);
14174 /* Display the window. Give up if new fonts are loaded, or if point
14176 if (!try_window (window
, startp
, 0))
14177 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14178 else if (w
->cursor
.vpos
< 0)
14180 clear_glyph_matrix (w
->desired_matrix
);
14181 rc
= SCROLLING_FAILED
;
14185 /* Maybe forget recorded base line for line number display. */
14186 if (!just_this_one_p
14187 || current_buffer
->clip_changed
14188 || BEG_UNCHANGED
< CHARPOS (startp
))
14189 w
->base_line_number
= Qnil
;
14191 /* If cursor ends up on a partially visible line,
14192 treat that as being off the bottom of the screen. */
14193 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14194 /* It's possible that the cursor is on the first line of the
14195 buffer, which is partially obscured due to a vscroll
14196 (Bug#7537). In that case, avoid looping forever . */
14197 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14199 clear_glyph_matrix (w
->desired_matrix
);
14200 ++extra_scroll_margin_lines
;
14203 rc
= SCROLLING_SUCCESS
;
14210 /* Compute a suitable window start for window W if display of W starts
14211 on a continuation line. Value is non-zero if a new window start
14214 The new window start will be computed, based on W's width, starting
14215 from the start of the continued line. It is the start of the
14216 screen line with the minimum distance from the old start W->start. */
14219 compute_window_start_on_continuation_line (struct window
*w
)
14221 struct text_pos pos
, start_pos
;
14222 int window_start_changed_p
= 0;
14224 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14226 /* If window start is on a continuation line... Window start may be
14227 < BEGV in case there's invisible text at the start of the
14228 buffer (M-x rmail, for example). */
14229 if (CHARPOS (start_pos
) > BEGV
14230 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14233 struct glyph_row
*row
;
14235 /* Handle the case that the window start is out of range. */
14236 if (CHARPOS (start_pos
) < BEGV
)
14237 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14238 else if (CHARPOS (start_pos
) > ZV
)
14239 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14241 /* Find the start of the continued line. This should be fast
14242 because scan_buffer is fast (newline cache). */
14243 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14244 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14245 row
, DEFAULT_FACE_ID
);
14246 reseat_at_previous_visible_line_start (&it
);
14248 /* If the line start is "too far" away from the window start,
14249 say it takes too much time to compute a new window start. */
14250 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14251 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14253 int min_distance
, distance
;
14255 /* Move forward by display lines to find the new window
14256 start. If window width was enlarged, the new start can
14257 be expected to be > the old start. If window width was
14258 decreased, the new window start will be < the old start.
14259 So, we're looking for the display line start with the
14260 minimum distance from the old window start. */
14261 pos
= it
.current
.pos
;
14262 min_distance
= INFINITY
;
14263 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14264 distance
< min_distance
)
14266 min_distance
= distance
;
14267 pos
= it
.current
.pos
;
14268 move_it_by_lines (&it
, 1);
14271 /* Set the window start there. */
14272 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14273 window_start_changed_p
= 1;
14277 return window_start_changed_p
;
14281 /* Try cursor movement in case text has not changed in window WINDOW,
14282 with window start STARTP. Value is
14284 CURSOR_MOVEMENT_SUCCESS if successful
14286 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14288 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14289 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14290 we want to scroll as if scroll-step were set to 1. See the code.
14292 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14293 which case we have to abort this redisplay, and adjust matrices
14298 CURSOR_MOVEMENT_SUCCESS
,
14299 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14300 CURSOR_MOVEMENT_MUST_SCROLL
,
14301 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14305 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14307 struct window
*w
= XWINDOW (window
);
14308 struct frame
*f
= XFRAME (w
->frame
);
14309 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14312 if (inhibit_try_cursor_movement
)
14316 /* Handle case where text has not changed, only point, and it has
14317 not moved off the frame. */
14318 if (/* Point may be in this window. */
14319 PT
>= CHARPOS (startp
)
14320 /* Selective display hasn't changed. */
14321 && !current_buffer
->clip_changed
14322 /* Function force-mode-line-update is used to force a thorough
14323 redisplay. It sets either windows_or_buffers_changed or
14324 update_mode_lines. So don't take a shortcut here for these
14326 && !update_mode_lines
14327 && !windows_or_buffers_changed
14328 && !cursor_type_changed
14329 /* Can't use this case if highlighting a region. When a
14330 region exists, cursor movement has to do more than just
14332 && !(!NILP (Vtransient_mark_mode
)
14333 && !NILP (BVAR (current_buffer
, mark_active
)))
14334 && NILP (w
->region_showing
)
14335 && NILP (Vshow_trailing_whitespace
)
14336 /* Right after splitting windows, last_point may be nil. */
14337 && INTEGERP (w
->last_point
)
14338 /* This code is not used for mini-buffer for the sake of the case
14339 of redisplaying to replace an echo area message; since in
14340 that case the mini-buffer contents per se are usually
14341 unchanged. This code is of no real use in the mini-buffer
14342 since the handling of this_line_start_pos, etc., in redisplay
14343 handles the same cases. */
14344 && !EQ (window
, minibuf_window
)
14345 /* When splitting windows or for new windows, it happens that
14346 redisplay is called with a nil window_end_vpos or one being
14347 larger than the window. This should really be fixed in
14348 window.c. I don't have this on my list, now, so we do
14349 approximately the same as the old redisplay code. --gerd. */
14350 && INTEGERP (w
->window_end_vpos
)
14351 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14352 && (FRAME_WINDOW_P (f
)
14353 || !overlay_arrow_in_current_buffer_p ()))
14355 int this_scroll_margin
, top_scroll_margin
;
14356 struct glyph_row
*row
= NULL
;
14359 debug_method_add (w
, "cursor movement");
14362 /* Scroll if point within this distance from the top or bottom
14363 of the window. This is a pixel value. */
14364 if (scroll_margin
> 0)
14366 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14367 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14370 this_scroll_margin
= 0;
14372 top_scroll_margin
= this_scroll_margin
;
14373 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14374 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14376 /* Start with the row the cursor was displayed during the last
14377 not paused redisplay. Give up if that row is not valid. */
14378 if (w
->last_cursor
.vpos
< 0
14379 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14380 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14383 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14384 if (row
->mode_line_p
)
14386 if (!row
->enabled_p
)
14387 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14390 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14392 int scroll_p
= 0, must_scroll
= 0;
14393 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14395 if (PT
> XFASTINT (w
->last_point
))
14397 /* Point has moved forward. */
14398 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14399 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14401 xassert (row
->enabled_p
);
14405 /* If the end position of a row equals the start
14406 position of the next row, and PT is at that position,
14407 we would rather display cursor in the next line. */
14408 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14409 && MATRIX_ROW_END_CHARPOS (row
) == PT
14410 && row
< w
->current_matrix
->rows
14411 + w
->current_matrix
->nrows
- 1
14412 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14413 && !cursor_row_p (row
))
14416 /* If within the scroll margin, scroll. Note that
14417 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14418 the next line would be drawn, and that
14419 this_scroll_margin can be zero. */
14420 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14421 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14422 /* Line is completely visible last line in window
14423 and PT is to be set in the next line. */
14424 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14425 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14426 && !row
->ends_at_zv_p
14427 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14430 else if (PT
< XFASTINT (w
->last_point
))
14432 /* Cursor has to be moved backward. Note that PT >=
14433 CHARPOS (startp) because of the outer if-statement. */
14434 while (!row
->mode_line_p
14435 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14436 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14437 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14438 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14439 row
> w
->current_matrix
->rows
14440 && (row
-1)->ends_in_newline_from_string_p
))))
14441 && (row
->y
> top_scroll_margin
14442 || CHARPOS (startp
) == BEGV
))
14444 xassert (row
->enabled_p
);
14448 /* Consider the following case: Window starts at BEGV,
14449 there is invisible, intangible text at BEGV, so that
14450 display starts at some point START > BEGV. It can
14451 happen that we are called with PT somewhere between
14452 BEGV and START. Try to handle that case. */
14453 if (row
< w
->current_matrix
->rows
14454 || row
->mode_line_p
)
14456 row
= w
->current_matrix
->rows
;
14457 if (row
->mode_line_p
)
14461 /* Due to newlines in overlay strings, we may have to
14462 skip forward over overlay strings. */
14463 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14464 && MATRIX_ROW_END_CHARPOS (row
) == PT
14465 && !cursor_row_p (row
))
14468 /* If within the scroll margin, scroll. */
14469 if (row
->y
< top_scroll_margin
14470 && CHARPOS (startp
) != BEGV
)
14475 /* Cursor did not move. So don't scroll even if cursor line
14476 is partially visible, as it was so before. */
14477 rc
= CURSOR_MOVEMENT_SUCCESS
;
14480 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14481 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14483 /* if PT is not in the glyph row, give up. */
14484 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14487 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14488 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14490 /* If rows are bidi-reordered and point moved, back up
14491 until we find a row that does not belong to a
14492 continuation line. This is because we must consider
14493 all rows of a continued line as candidates for the
14494 new cursor positioning, since row start and end
14495 positions change non-linearly with vertical position
14497 /* FIXME: Revisit this when glyph ``spilling'' in
14498 continuation lines' rows is implemented for
14499 bidi-reordered rows. */
14500 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14502 xassert (row
->enabled_p
);
14504 /* If we hit the beginning of the displayed portion
14505 without finding the first row of a continued
14507 if (row
<= w
->current_matrix
->rows
)
14509 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14517 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14518 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14519 && make_cursor_line_fully_visible_p
)
14521 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14522 && !row
->ends_at_zv_p
14523 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14524 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14525 else if (row
->height
> window_box_height (w
))
14527 /* If we end up in a partially visible line, let's
14528 make it fully visible, except when it's taller
14529 than the window, in which case we can't do much
14532 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14536 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14537 if (!cursor_row_fully_visible_p (w
, 0, 1))
14538 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14540 rc
= CURSOR_MOVEMENT_SUCCESS
;
14544 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14545 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14546 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14548 /* With bidi-reordered rows, there could be more than
14549 one candidate row whose start and end positions
14550 occlude point. We need to let set_cursor_from_row
14551 find the best candidate. */
14552 /* FIXME: Revisit this when glyph ``spilling'' in
14553 continuation lines' rows is implemented for
14554 bidi-reordered rows. */
14559 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14560 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14561 && cursor_row_p (row
))
14562 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14564 /* As soon as we've found the first suitable row
14565 whose ends_at_zv_p flag is set, we are done. */
14567 && MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
)
14569 rc
= CURSOR_MOVEMENT_SUCCESS
;
14574 while ((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14575 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14576 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14577 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14578 /* If we didn't find any candidate rows, or exited the
14579 loop before all the candidates were examined, signal
14580 to the caller that this method failed. */
14581 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14582 && (!rv
|| MATRIX_ROW_CONTINUATION_LINE_P (row
)))
14583 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14585 rc
= CURSOR_MOVEMENT_SUCCESS
;
14591 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14593 rc
= CURSOR_MOVEMENT_SUCCESS
;
14598 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14599 && MATRIX_ROW_START_CHARPOS (row
) == PT
14600 && cursor_row_p (row
));
14608 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14612 set_vertical_scroll_bar (struct window
*w
)
14614 EMACS_INT start
, end
, whole
;
14616 /* Calculate the start and end positions for the current window.
14617 At some point, it would be nice to choose between scrollbars
14618 which reflect the whole buffer size, with special markers
14619 indicating narrowing, and scrollbars which reflect only the
14622 Note that mini-buffers sometimes aren't displaying any text. */
14623 if (!MINI_WINDOW_P (w
)
14624 || (w
== XWINDOW (minibuf_window
)
14625 && NILP (echo_area_buffer
[0])))
14627 struct buffer
*buf
= XBUFFER (w
->buffer
);
14628 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14629 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14630 /* I don't think this is guaranteed to be right. For the
14631 moment, we'll pretend it is. */
14632 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
14636 if (whole
< (end
- start
))
14637 whole
= end
- start
;
14640 start
= end
= whole
= 0;
14642 /* Indicate what this scroll bar ought to be displaying now. */
14643 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14644 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
14645 (w
, end
- start
, whole
, start
);
14649 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
14650 selected_window is redisplayed.
14652 We can return without actually redisplaying the window if
14653 fonts_changed_p is nonzero. In that case, redisplay_internal will
14657 redisplay_window (Lisp_Object window
, int just_this_one_p
)
14659 struct window
*w
= XWINDOW (window
);
14660 struct frame
*f
= XFRAME (w
->frame
);
14661 struct buffer
*buffer
= XBUFFER (w
->buffer
);
14662 struct buffer
*old
= current_buffer
;
14663 struct text_pos lpoint
, opoint
, startp
;
14664 int update_mode_line
;
14667 /* Record it now because it's overwritten. */
14668 int current_matrix_up_to_date_p
= 0;
14669 int used_current_matrix_p
= 0;
14670 /* This is less strict than current_matrix_up_to_date_p.
14671 It indictes that the buffer contents and narrowing are unchanged. */
14672 int buffer_unchanged_p
= 0;
14673 int temp_scroll_step
= 0;
14674 int count
= SPECPDL_INDEX ();
14676 int centering_position
= -1;
14677 int last_line_misfit
= 0;
14678 EMACS_INT beg_unchanged
, end_unchanged
;
14680 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14683 /* W must be a leaf window here. */
14684 xassert (!NILP (w
->buffer
));
14686 *w
->desired_matrix
->method
= 0;
14690 reconsider_clip_changes (w
, buffer
);
14692 /* Has the mode line to be updated? */
14693 update_mode_line
= (!NILP (w
->update_mode_line
)
14694 || update_mode_lines
14695 || buffer
->clip_changed
14696 || buffer
->prevent_redisplay_optimizations_p
);
14698 if (MINI_WINDOW_P (w
))
14700 if (w
== XWINDOW (echo_area_window
)
14701 && !NILP (echo_area_buffer
[0]))
14703 if (update_mode_line
)
14704 /* We may have to update a tty frame's menu bar or a
14705 tool-bar. Example `M-x C-h C-h C-g'. */
14706 goto finish_menu_bars
;
14708 /* We've already displayed the echo area glyphs in this window. */
14709 goto finish_scroll_bars
;
14711 else if ((w
!= XWINDOW (minibuf_window
)
14712 || minibuf_level
== 0)
14713 /* When buffer is nonempty, redisplay window normally. */
14714 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
14715 /* Quail displays non-mini buffers in minibuffer window.
14716 In that case, redisplay the window normally. */
14717 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
14719 /* W is a mini-buffer window, but it's not active, so clear
14721 int yb
= window_text_bottom_y (w
);
14722 struct glyph_row
*row
;
14725 for (y
= 0, row
= w
->desired_matrix
->rows
;
14727 y
+= row
->height
, ++row
)
14728 blank_row (w
, row
, y
);
14729 goto finish_scroll_bars
;
14732 clear_glyph_matrix (w
->desired_matrix
);
14735 /* Otherwise set up data on this window; select its buffer and point
14737 /* Really select the buffer, for the sake of buffer-local
14739 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14741 current_matrix_up_to_date_p
14742 = (!NILP (w
->window_end_valid
)
14743 && !current_buffer
->clip_changed
14744 && !current_buffer
->prevent_redisplay_optimizations_p
14745 && XFASTINT (w
->last_modified
) >= MODIFF
14746 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14748 /* Run the window-bottom-change-functions
14749 if it is possible that the text on the screen has changed
14750 (either due to modification of the text, or any other reason). */
14751 if (!current_matrix_up_to_date_p
14752 && !NILP (Vwindow_text_change_functions
))
14754 safe_run_hooks (Qwindow_text_change_functions
);
14758 beg_unchanged
= BEG_UNCHANGED
;
14759 end_unchanged
= END_UNCHANGED
;
14761 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
14763 specbind (Qinhibit_point_motion_hooks
, Qt
);
14766 = (!NILP (w
->window_end_valid
)
14767 && !current_buffer
->clip_changed
14768 && XFASTINT (w
->last_modified
) >= MODIFF
14769 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
14771 /* When windows_or_buffers_changed is non-zero, we can't rely on
14772 the window end being valid, so set it to nil there. */
14773 if (windows_or_buffers_changed
)
14775 /* If window starts on a continuation line, maybe adjust the
14776 window start in case the window's width changed. */
14777 if (XMARKER (w
->start
)->buffer
== current_buffer
)
14778 compute_window_start_on_continuation_line (w
);
14780 w
->window_end_valid
= Qnil
;
14783 /* Some sanity checks. */
14784 CHECK_WINDOW_END (w
);
14785 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
14787 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
14790 /* If %c is in mode line, update it if needed. */
14791 if (!NILP (w
->column_number_displayed
)
14792 /* This alternative quickly identifies a common case
14793 where no change is needed. */
14794 && !(PT
== XFASTINT (w
->last_point
)
14795 && XFASTINT (w
->last_modified
) >= MODIFF
14796 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
14797 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
14798 update_mode_line
= 1;
14800 /* Count number of windows showing the selected buffer. An indirect
14801 buffer counts as its base buffer. */
14802 if (!just_this_one_p
)
14804 struct buffer
*current_base
, *window_base
;
14805 current_base
= current_buffer
;
14806 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
14807 if (current_base
->base_buffer
)
14808 current_base
= current_base
->base_buffer
;
14809 if (window_base
->base_buffer
)
14810 window_base
= window_base
->base_buffer
;
14811 if (current_base
== window_base
)
14815 /* Point refers normally to the selected window. For any other
14816 window, set up appropriate value. */
14817 if (!EQ (window
, selected_window
))
14819 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
14820 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
14824 new_pt_byte
= BEGV_BYTE
;
14825 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
14827 else if (new_pt
> (ZV
- 1))
14830 new_pt_byte
= ZV_BYTE
;
14831 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
14834 /* We don't use SET_PT so that the point-motion hooks don't run. */
14835 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
14838 /* If any of the character widths specified in the display table
14839 have changed, invalidate the width run cache. It's true that
14840 this may be a bit late to catch such changes, but the rest of
14841 redisplay goes (non-fatally) haywire when the display table is
14842 changed, so why should we worry about doing any better? */
14843 if (current_buffer
->width_run_cache
)
14845 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
14847 if (! disptab_matches_widthtab (disptab
,
14848 XVECTOR (BVAR (current_buffer
, width_table
))))
14850 invalidate_region_cache (current_buffer
,
14851 current_buffer
->width_run_cache
,
14853 recompute_width_table (current_buffer
, disptab
);
14857 /* If window-start is screwed up, choose a new one. */
14858 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
14861 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14863 /* If someone specified a new starting point but did not insist,
14864 check whether it can be used. */
14865 if (!NILP (w
->optional_new_start
)
14866 && CHARPOS (startp
) >= BEGV
14867 && CHARPOS (startp
) <= ZV
)
14869 w
->optional_new_start
= Qnil
;
14870 start_display (&it
, w
, startp
);
14871 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
14872 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14873 if (IT_CHARPOS (it
) == PT
)
14874 w
->force_start
= Qt
;
14875 /* IT may overshoot PT if text at PT is invisible. */
14876 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
14877 w
->force_start
= Qt
;
14882 /* Handle case where place to start displaying has been specified,
14883 unless the specified location is outside the accessible range. */
14884 if (!NILP (w
->force_start
)
14885 || w
->frozen_window_start_p
)
14887 /* We set this later on if we have to adjust point. */
14890 w
->force_start
= Qnil
;
14892 w
->window_end_valid
= Qnil
;
14894 /* Forget any recorded base line for line number display. */
14895 if (!buffer_unchanged_p
)
14896 w
->base_line_number
= Qnil
;
14898 /* Redisplay the mode line. Select the buffer properly for that.
14899 Also, run the hook window-scroll-functions
14900 because we have scrolled. */
14901 /* Note, we do this after clearing force_start because
14902 if there's an error, it is better to forget about force_start
14903 than to get into an infinite loop calling the hook functions
14904 and having them get more errors. */
14905 if (!update_mode_line
14906 || ! NILP (Vwindow_scroll_functions
))
14908 update_mode_line
= 1;
14909 w
->update_mode_line
= Qt
;
14910 startp
= run_window_scroll_functions (window
, startp
);
14913 w
->last_modified
= make_number (0);
14914 w
->last_overlay_modified
= make_number (0);
14915 if (CHARPOS (startp
) < BEGV
)
14916 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
14917 else if (CHARPOS (startp
) > ZV
)
14918 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
14920 /* Redisplay, then check if cursor has been set during the
14921 redisplay. Give up if new fonts were loaded. */
14922 /* We used to issue a CHECK_MARGINS argument to try_window here,
14923 but this causes scrolling to fail when point begins inside
14924 the scroll margin (bug#148) -- cyd */
14925 if (!try_window (window
, startp
, 0))
14927 w
->force_start
= Qt
;
14928 clear_glyph_matrix (w
->desired_matrix
);
14929 goto need_larger_matrices
;
14932 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
14934 /* If point does not appear, try to move point so it does
14935 appear. The desired matrix has been built above, so we
14936 can use it here. */
14937 new_vpos
= window_box_height (w
) / 2;
14940 if (!cursor_row_fully_visible_p (w
, 0, 0))
14942 /* Point does appear, but on a line partly visible at end of window.
14943 Move it back to a fully-visible line. */
14944 new_vpos
= window_box_height (w
);
14947 /* If we need to move point for either of the above reasons,
14948 now actually do it. */
14951 struct glyph_row
*row
;
14953 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
14954 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
14957 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
14958 MATRIX_ROW_START_BYTEPOS (row
));
14960 if (w
!= XWINDOW (selected_window
))
14961 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
14962 else if (current_buffer
== old
)
14963 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
14965 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
14967 /* If we are highlighting the region, then we just changed
14968 the region, so redisplay to show it. */
14969 if (!NILP (Vtransient_mark_mode
)
14970 && !NILP (BVAR (current_buffer
, mark_active
)))
14972 clear_glyph_matrix (w
->desired_matrix
);
14973 if (!try_window (window
, startp
, 0))
14974 goto need_larger_matrices
;
14979 debug_method_add (w
, "forced window start");
14984 /* Handle case where text has not changed, only point, and it has
14985 not moved off the frame, and we are not retrying after hscroll.
14986 (current_matrix_up_to_date_p is nonzero when retrying.) */
14987 if (current_matrix_up_to_date_p
14988 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
14989 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
14993 case CURSOR_MOVEMENT_SUCCESS
:
14994 used_current_matrix_p
= 1;
14997 case CURSOR_MOVEMENT_MUST_SCROLL
:
14998 goto try_to_scroll
;
15004 /* If current starting point was originally the beginning of a line
15005 but no longer is, find a new starting point. */
15006 else if (!NILP (w
->start_at_line_beg
)
15007 && !(CHARPOS (startp
) <= BEGV
15008 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15011 debug_method_add (w
, "recenter 1");
15016 /* Try scrolling with try_window_id. Value is > 0 if update has
15017 been done, it is -1 if we know that the same window start will
15018 not work. It is 0 if unsuccessful for some other reason. */
15019 else if ((tem
= try_window_id (w
)) != 0)
15022 debug_method_add (w
, "try_window_id %d", tem
);
15025 if (fonts_changed_p
)
15026 goto need_larger_matrices
;
15030 /* Otherwise try_window_id has returned -1 which means that we
15031 don't want the alternative below this comment to execute. */
15033 else if (CHARPOS (startp
) >= BEGV
15034 && CHARPOS (startp
) <= ZV
15035 && PT
>= CHARPOS (startp
)
15036 && (CHARPOS (startp
) < ZV
15037 /* Avoid starting at end of buffer. */
15038 || CHARPOS (startp
) == BEGV
15039 || (XFASTINT (w
->last_modified
) >= MODIFF
15040 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15043 /* If first window line is a continuation line, and window start
15044 is inside the modified region, but the first change is before
15045 current window start, we must select a new window start.
15047 However, if this is the result of a down-mouse event (e.g. by
15048 extending the mouse-drag-overlay), we don't want to select a
15049 new window start, since that would change the position under
15050 the mouse, resulting in an unwanted mouse-movement rather
15051 than a simple mouse-click. */
15052 if (NILP (w
->start_at_line_beg
)
15053 && NILP (do_mouse_tracking
)
15054 && CHARPOS (startp
) > BEGV
15055 && CHARPOS (startp
) > BEG
+ beg_unchanged
15056 && CHARPOS (startp
) <= Z
- end_unchanged
15057 /* Even if w->start_at_line_beg is nil, a new window may
15058 start at a line_beg, since that's how set_buffer_window
15059 sets it. So, we need to check the return value of
15060 compute_window_start_on_continuation_line. (See also
15062 && XMARKER (w
->start
)->buffer
== current_buffer
15063 && compute_window_start_on_continuation_line (w
))
15065 w
->force_start
= Qt
;
15066 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15071 debug_method_add (w
, "same window start");
15074 /* Try to redisplay starting at same place as before.
15075 If point has not moved off frame, accept the results. */
15076 if (!current_matrix_up_to_date_p
15077 /* Don't use try_window_reusing_current_matrix in this case
15078 because a window scroll function can have changed the
15080 || !NILP (Vwindow_scroll_functions
)
15081 || MINI_WINDOW_P (w
)
15082 || !(used_current_matrix_p
15083 = try_window_reusing_current_matrix (w
)))
15085 IF_DEBUG (debug_method_add (w
, "1"));
15086 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15087 /* -1 means we need to scroll.
15088 0 means we need new matrices, but fonts_changed_p
15089 is set in that case, so we will detect it below. */
15090 goto try_to_scroll
;
15093 if (fonts_changed_p
)
15094 goto need_larger_matrices
;
15096 if (w
->cursor
.vpos
>= 0)
15098 if (!just_this_one_p
15099 || current_buffer
->clip_changed
15100 || BEG_UNCHANGED
< CHARPOS (startp
))
15101 /* Forget any recorded base line for line number display. */
15102 w
->base_line_number
= Qnil
;
15104 if (!cursor_row_fully_visible_p (w
, 1, 0))
15106 clear_glyph_matrix (w
->desired_matrix
);
15107 last_line_misfit
= 1;
15109 /* Drop through and scroll. */
15114 clear_glyph_matrix (w
->desired_matrix
);
15119 w
->last_modified
= make_number (0);
15120 w
->last_overlay_modified
= make_number (0);
15122 /* Redisplay the mode line. Select the buffer properly for that. */
15123 if (!update_mode_line
)
15125 update_mode_line
= 1;
15126 w
->update_mode_line
= Qt
;
15129 /* Try to scroll by specified few lines. */
15130 if ((scroll_conservatively
15131 || emacs_scroll_step
15132 || temp_scroll_step
15133 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15134 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15135 && CHARPOS (startp
) >= BEGV
15136 && CHARPOS (startp
) <= ZV
)
15138 /* The function returns -1 if new fonts were loaded, 1 if
15139 successful, 0 if not successful. */
15140 int ss
= try_scrolling (window
, just_this_one_p
,
15141 scroll_conservatively
,
15143 temp_scroll_step
, last_line_misfit
);
15146 case SCROLLING_SUCCESS
:
15149 case SCROLLING_NEED_LARGER_MATRICES
:
15150 goto need_larger_matrices
;
15152 case SCROLLING_FAILED
:
15160 /* Finally, just choose a place to start which positions point
15161 according to user preferences. */
15166 debug_method_add (w
, "recenter");
15169 /* w->vscroll = 0; */
15171 /* Forget any previously recorded base line for line number display. */
15172 if (!buffer_unchanged_p
)
15173 w
->base_line_number
= Qnil
;
15175 /* Determine the window start relative to point. */
15176 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15177 it
.current_y
= it
.last_visible_y
;
15178 if (centering_position
< 0)
15182 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15184 EMACS_INT margin_pos
= CHARPOS (startp
);
15186 Lisp_Object aggressive
;
15188 /* If there is a scroll margin at the top of the window, find
15189 its character position. */
15191 /* Cannot call start_display if startp is not in the
15192 accessible region of the buffer. This can happen when we
15193 have just switched to a different buffer and/or changed
15194 its restriction. In that case, startp is initialized to
15195 the character position 1 (BEG) because we did not yet
15196 have chance to display the buffer even once. */
15197 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15200 void *it1data
= NULL
;
15202 SAVE_IT (it1
, it
, it1data
);
15203 start_display (&it1
, w
, startp
);
15204 move_it_vertically (&it1
, margin
);
15205 margin_pos
= IT_CHARPOS (it1
);
15206 RESTORE_IT (&it
, &it
, it1data
);
15208 scrolling_up
= PT
> margin_pos
;
15211 ? BVAR (current_buffer
, scroll_up_aggressively
)
15212 : BVAR (current_buffer
, scroll_down_aggressively
);
15214 if (!MINI_WINDOW_P (w
)
15215 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15219 /* Setting scroll-conservatively overrides
15220 scroll-*-aggressively. */
15221 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15223 double float_amount
= XFLOATINT (aggressive
);
15225 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15226 if (pt_offset
== 0 && float_amount
> 0)
15231 /* Compute how much to move the window start backward from
15232 point so that point will be displayed where the user
15236 centering_position
= it
.last_visible_y
;
15238 centering_position
-= pt_offset
;
15239 centering_position
-=
15240 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0));
15241 /* Don't let point enter the scroll margin near top of
15243 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15244 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15247 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15250 /* Set the window start half the height of the window backward
15252 centering_position
= window_box_height (w
) / 2;
15254 move_it_vertically_backward (&it
, centering_position
);
15256 xassert (IT_CHARPOS (it
) >= BEGV
);
15258 /* The function move_it_vertically_backward may move over more
15259 than the specified y-distance. If it->w is small, e.g. a
15260 mini-buffer window, we may end up in front of the window's
15261 display area. Start displaying at the start of the line
15262 containing PT in this case. */
15263 if (it
.current_y
<= 0)
15265 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15266 move_it_vertically_backward (&it
, 0);
15270 it
.current_x
= it
.hpos
= 0;
15272 /* Set the window start position here explicitly, to avoid an
15273 infinite loop in case the functions in window-scroll-functions
15275 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15277 /* Run scroll hooks. */
15278 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15280 /* Redisplay the window. */
15281 if (!current_matrix_up_to_date_p
15282 || windows_or_buffers_changed
15283 || cursor_type_changed
15284 /* Don't use try_window_reusing_current_matrix in this case
15285 because it can have changed the buffer. */
15286 || !NILP (Vwindow_scroll_functions
)
15287 || !just_this_one_p
15288 || MINI_WINDOW_P (w
)
15289 || !(used_current_matrix_p
15290 = try_window_reusing_current_matrix (w
)))
15291 try_window (window
, startp
, 0);
15293 /* If new fonts have been loaded (due to fontsets), give up. We
15294 have to start a new redisplay since we need to re-adjust glyph
15296 if (fonts_changed_p
)
15297 goto need_larger_matrices
;
15299 /* If cursor did not appear assume that the middle of the window is
15300 in the first line of the window. Do it again with the next line.
15301 (Imagine a window of height 100, displaying two lines of height
15302 60. Moving back 50 from it->last_visible_y will end in the first
15304 if (w
->cursor
.vpos
< 0)
15306 if (!NILP (w
->window_end_valid
)
15307 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15309 clear_glyph_matrix (w
->desired_matrix
);
15310 move_it_by_lines (&it
, 1);
15311 try_window (window
, it
.current
.pos
, 0);
15313 else if (PT
< IT_CHARPOS (it
))
15315 clear_glyph_matrix (w
->desired_matrix
);
15316 move_it_by_lines (&it
, -1);
15317 try_window (window
, it
.current
.pos
, 0);
15321 /* Not much we can do about it. */
15325 /* Consider the following case: Window starts at BEGV, there is
15326 invisible, intangible text at BEGV, so that display starts at
15327 some point START > BEGV. It can happen that we are called with
15328 PT somewhere between BEGV and START. Try to handle that case. */
15329 if (w
->cursor
.vpos
< 0)
15331 struct glyph_row
*row
= w
->current_matrix
->rows
;
15332 if (row
->mode_line_p
)
15334 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15337 if (!cursor_row_fully_visible_p (w
, 0, 0))
15339 /* If vscroll is enabled, disable it and try again. */
15343 clear_glyph_matrix (w
->desired_matrix
);
15347 /* If centering point failed to make the whole line visible,
15348 put point at the top instead. That has to make the whole line
15349 visible, if it can be done. */
15350 if (centering_position
== 0)
15353 clear_glyph_matrix (w
->desired_matrix
);
15354 centering_position
= 0;
15360 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15361 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15362 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15365 /* Display the mode line, if we must. */
15366 if ((update_mode_line
15367 /* If window not full width, must redo its mode line
15368 if (a) the window to its side is being redone and
15369 (b) we do a frame-based redisplay. This is a consequence
15370 of how inverted lines are drawn in frame-based redisplay. */
15371 || (!just_this_one_p
15372 && !FRAME_WINDOW_P (f
)
15373 && !WINDOW_FULL_WIDTH_P (w
))
15374 /* Line number to display. */
15375 || INTEGERP (w
->base_line_pos
)
15376 /* Column number is displayed and different from the one displayed. */
15377 || (!NILP (w
->column_number_displayed
)
15378 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15379 /* This means that the window has a mode line. */
15380 && (WINDOW_WANTS_MODELINE_P (w
)
15381 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15383 display_mode_lines (w
);
15385 /* If mode line height has changed, arrange for a thorough
15386 immediate redisplay using the correct mode line height. */
15387 if (WINDOW_WANTS_MODELINE_P (w
)
15388 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15390 fonts_changed_p
= 1;
15391 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15392 = DESIRED_MODE_LINE_HEIGHT (w
);
15395 /* If header line height has changed, arrange for a thorough
15396 immediate redisplay using the correct header line height. */
15397 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15398 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15400 fonts_changed_p
= 1;
15401 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15402 = DESIRED_HEADER_LINE_HEIGHT (w
);
15405 if (fonts_changed_p
)
15406 goto need_larger_matrices
;
15409 if (!line_number_displayed
15410 && !BUFFERP (w
->base_line_pos
))
15412 w
->base_line_pos
= Qnil
;
15413 w
->base_line_number
= Qnil
;
15418 /* When we reach a frame's selected window, redo the frame's menu bar. */
15419 if (update_mode_line
15420 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15422 int redisplay_menu_p
= 0;
15424 if (FRAME_WINDOW_P (f
))
15426 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15427 || defined (HAVE_NS) || defined (USE_GTK)
15428 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15430 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15434 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15436 if (redisplay_menu_p
)
15437 display_menu_bar (w
);
15439 #ifdef HAVE_WINDOW_SYSTEM
15440 if (FRAME_WINDOW_P (f
))
15442 #if defined (USE_GTK) || defined (HAVE_NS)
15443 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15444 redisplay_tool_bar (f
);
15446 if (WINDOWP (f
->tool_bar_window
)
15447 && (FRAME_TOOL_BAR_LINES (f
) > 0
15448 || !NILP (Vauto_resize_tool_bars
))
15449 && redisplay_tool_bar (f
))
15450 ignore_mouse_drag_p
= 1;
15456 #ifdef HAVE_WINDOW_SYSTEM
15457 if (FRAME_WINDOW_P (f
)
15458 && update_window_fringes (w
, (just_this_one_p
15459 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15460 || w
->pseudo_window_p
)))
15464 if (draw_window_fringes (w
, 1))
15465 x_draw_vertical_border (w
);
15469 #endif /* HAVE_WINDOW_SYSTEM */
15471 /* We go to this label, with fonts_changed_p nonzero,
15472 if it is necessary to try again using larger glyph matrices.
15473 We have to redeem the scroll bar even in this case,
15474 because the loop in redisplay_internal expects that. */
15475 need_larger_matrices
:
15477 finish_scroll_bars
:
15479 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15481 /* Set the thumb's position and size. */
15482 set_vertical_scroll_bar (w
);
15484 /* Note that we actually used the scroll bar attached to this
15485 window, so it shouldn't be deleted at the end of redisplay. */
15486 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15487 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15490 /* Restore current_buffer and value of point in it. The window
15491 update may have changed the buffer, so first make sure `opoint'
15492 is still valid (Bug#6177). */
15493 if (CHARPOS (opoint
) < BEGV
)
15494 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15495 else if (CHARPOS (opoint
) > ZV
)
15496 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15498 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15500 set_buffer_internal_1 (old
);
15501 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15502 shorter. This can be caused by log truncation in *Messages*. */
15503 if (CHARPOS (lpoint
) <= ZV
)
15504 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15506 unbind_to (count
, Qnil
);
15510 /* Build the complete desired matrix of WINDOW with a window start
15511 buffer position POS.
15513 Value is 1 if successful. It is zero if fonts were loaded during
15514 redisplay which makes re-adjusting glyph matrices necessary, and -1
15515 if point would appear in the scroll margins.
15516 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15517 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15521 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15523 struct window
*w
= XWINDOW (window
);
15525 struct glyph_row
*last_text_row
= NULL
;
15526 struct frame
*f
= XFRAME (w
->frame
);
15528 /* Make POS the new window start. */
15529 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15531 /* Mark cursor position as unknown. No overlay arrow seen. */
15532 w
->cursor
.vpos
= -1;
15533 overlay_arrow_seen
= 0;
15535 /* Initialize iterator and info to start at POS. */
15536 start_display (&it
, w
, pos
);
15538 /* Display all lines of W. */
15539 while (it
.current_y
< it
.last_visible_y
)
15541 if (display_line (&it
))
15542 last_text_row
= it
.glyph_row
- 1;
15543 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15547 /* Don't let the cursor end in the scroll margins. */
15548 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15549 && !MINI_WINDOW_P (w
))
15551 int this_scroll_margin
;
15553 if (scroll_margin
> 0)
15555 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15556 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15559 this_scroll_margin
= 0;
15561 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15562 && w
->cursor
.y
< this_scroll_margin
15563 && CHARPOS (pos
) > BEGV
15564 && IT_CHARPOS (it
) < ZV
)
15565 /* rms: considering make_cursor_line_fully_visible_p here
15566 seems to give wrong results. We don't want to recenter
15567 when the last line is partly visible, we want to allow
15568 that case to be handled in the usual way. */
15569 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15571 w
->cursor
.vpos
= -1;
15572 clear_glyph_matrix (w
->desired_matrix
);
15577 /* If bottom moved off end of frame, change mode line percentage. */
15578 if (XFASTINT (w
->window_end_pos
) <= 0
15579 && Z
!= IT_CHARPOS (it
))
15580 w
->update_mode_line
= Qt
;
15582 /* Set window_end_pos to the offset of the last character displayed
15583 on the window from the end of current_buffer. Set
15584 window_end_vpos to its row number. */
15587 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15588 w
->window_end_bytepos
15589 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15591 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15593 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15594 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15595 ->displays_text_p
);
15599 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15600 w
->window_end_pos
= make_number (Z
- ZV
);
15601 w
->window_end_vpos
= make_number (0);
15604 /* But that is not valid info until redisplay finishes. */
15605 w
->window_end_valid
= Qnil
;
15611 /************************************************************************
15612 Window redisplay reusing current matrix when buffer has not changed
15613 ************************************************************************/
15615 /* Try redisplay of window W showing an unchanged buffer with a
15616 different window start than the last time it was displayed by
15617 reusing its current matrix. Value is non-zero if successful.
15618 W->start is the new window start. */
15621 try_window_reusing_current_matrix (struct window
*w
)
15623 struct frame
*f
= XFRAME (w
->frame
);
15624 struct glyph_row
*bottom_row
;
15627 struct text_pos start
, new_start
;
15628 int nrows_scrolled
, i
;
15629 struct glyph_row
*last_text_row
;
15630 struct glyph_row
*last_reused_text_row
;
15631 struct glyph_row
*start_row
;
15632 int start_vpos
, min_y
, max_y
;
15635 if (inhibit_try_window_reusing
)
15639 if (/* This function doesn't handle terminal frames. */
15640 !FRAME_WINDOW_P (f
)
15641 /* Don't try to reuse the display if windows have been split
15643 || windows_or_buffers_changed
15644 || cursor_type_changed
)
15647 /* Can't do this if region may have changed. */
15648 if ((!NILP (Vtransient_mark_mode
)
15649 && !NILP (BVAR (current_buffer
, mark_active
)))
15650 || !NILP (w
->region_showing
)
15651 || !NILP (Vshow_trailing_whitespace
))
15654 /* If top-line visibility has changed, give up. */
15655 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15656 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
15659 /* Give up if old or new display is scrolled vertically. We could
15660 make this function handle this, but right now it doesn't. */
15661 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15662 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
15665 /* The variable new_start now holds the new window start. The old
15666 start `start' can be determined from the current matrix. */
15667 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
15668 start
= start_row
->minpos
;
15669 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15671 /* Clear the desired matrix for the display below. */
15672 clear_glyph_matrix (w
->desired_matrix
);
15674 if (CHARPOS (new_start
) <= CHARPOS (start
))
15676 /* Don't use this method if the display starts with an ellipsis
15677 displayed for invisible text. It's not easy to handle that case
15678 below, and it's certainly not worth the effort since this is
15679 not a frequent case. */
15680 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
15683 IF_DEBUG (debug_method_add (w
, "twu1"));
15685 /* Display up to a row that can be reused. The variable
15686 last_text_row is set to the last row displayed that displays
15687 text. Note that it.vpos == 0 if or if not there is a
15688 header-line; it's not the same as the MATRIX_ROW_VPOS! */
15689 start_display (&it
, w
, new_start
);
15690 w
->cursor
.vpos
= -1;
15691 last_text_row
= last_reused_text_row
= NULL
;
15693 while (it
.current_y
< it
.last_visible_y
15694 && !fonts_changed_p
)
15696 /* If we have reached into the characters in the START row,
15697 that means the line boundaries have changed. So we
15698 can't start copying with the row START. Maybe it will
15699 work to start copying with the following row. */
15700 while (IT_CHARPOS (it
) > CHARPOS (start
))
15702 /* Advance to the next row as the "start". */
15704 start
= start_row
->minpos
;
15705 /* If there are no more rows to try, or just one, give up. */
15706 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
15707 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
15708 || CHARPOS (start
) == ZV
)
15710 clear_glyph_matrix (w
->desired_matrix
);
15714 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
15716 /* If we have reached alignment,
15717 we can copy the rest of the rows. */
15718 if (IT_CHARPOS (it
) == CHARPOS (start
))
15721 if (display_line (&it
))
15722 last_text_row
= it
.glyph_row
- 1;
15725 /* A value of current_y < last_visible_y means that we stopped
15726 at the previous window start, which in turn means that we
15727 have at least one reusable row. */
15728 if (it
.current_y
< it
.last_visible_y
)
15730 struct glyph_row
*row
;
15732 /* IT.vpos always starts from 0; it counts text lines. */
15733 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
15735 /* Find PT if not already found in the lines displayed. */
15736 if (w
->cursor
.vpos
< 0)
15738 int dy
= it
.current_y
- start_row
->y
;
15740 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15741 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
15743 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
15744 dy
, nrows_scrolled
);
15747 clear_glyph_matrix (w
->desired_matrix
);
15752 /* Scroll the display. Do it before the current matrix is
15753 changed. The problem here is that update has not yet
15754 run, i.e. part of the current matrix is not up to date.
15755 scroll_run_hook will clear the cursor, and use the
15756 current matrix to get the height of the row the cursor is
15758 run
.current_y
= start_row
->y
;
15759 run
.desired_y
= it
.current_y
;
15760 run
.height
= it
.last_visible_y
- it
.current_y
;
15762 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
15765 FRAME_RIF (f
)->update_window_begin_hook (w
);
15766 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15767 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15768 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15772 /* Shift current matrix down by nrows_scrolled lines. */
15773 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15774 rotate_matrix (w
->current_matrix
,
15776 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15779 /* Disable lines that must be updated. */
15780 for (i
= 0; i
< nrows_scrolled
; ++i
)
15781 (start_row
+ i
)->enabled_p
= 0;
15783 /* Re-compute Y positions. */
15784 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15785 max_y
= it
.last_visible_y
;
15786 for (row
= start_row
+ nrows_scrolled
;
15790 row
->y
= it
.current_y
;
15791 row
->visible_height
= row
->height
;
15793 if (row
->y
< min_y
)
15794 row
->visible_height
-= min_y
- row
->y
;
15795 if (row
->y
+ row
->height
> max_y
)
15796 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15797 if (row
->fringe_bitmap_periodic_p
)
15798 row
->redraw_fringe_bitmaps_p
= 1;
15800 it
.current_y
+= row
->height
;
15802 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
15803 last_reused_text_row
= row
;
15804 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
15808 /* Disable lines in the current matrix which are now
15809 below the window. */
15810 for (++row
; row
< bottom_row
; ++row
)
15811 row
->enabled_p
= row
->mode_line_p
= 0;
15814 /* Update window_end_pos etc.; last_reused_text_row is the last
15815 reused row from the current matrix containing text, if any.
15816 The value of last_text_row is the last displayed line
15817 containing text. */
15818 if (last_reused_text_row
)
15820 w
->window_end_bytepos
15821 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
15823 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
15825 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
15826 w
->current_matrix
));
15828 else if (last_text_row
)
15830 w
->window_end_bytepos
15831 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15833 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15835 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15839 /* This window must be completely empty. */
15840 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15841 w
->window_end_pos
= make_number (Z
- ZV
);
15842 w
->window_end_vpos
= make_number (0);
15844 w
->window_end_valid
= Qnil
;
15846 /* Update hint: don't try scrolling again in update_window. */
15847 w
->desired_matrix
->no_scrolling_p
= 1;
15850 debug_method_add (w
, "try_window_reusing_current_matrix 1");
15854 else if (CHARPOS (new_start
) > CHARPOS (start
))
15856 struct glyph_row
*pt_row
, *row
;
15857 struct glyph_row
*first_reusable_row
;
15858 struct glyph_row
*first_row_to_display
;
15860 int yb
= window_text_bottom_y (w
);
15862 /* Find the row starting at new_start, if there is one. Don't
15863 reuse a partially visible line at the end. */
15864 first_reusable_row
= start_row
;
15865 while (first_reusable_row
->enabled_p
15866 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
15867 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15868 < CHARPOS (new_start
)))
15869 ++first_reusable_row
;
15871 /* Give up if there is no row to reuse. */
15872 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
15873 || !first_reusable_row
->enabled_p
15874 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
15875 != CHARPOS (new_start
)))
15878 /* We can reuse fully visible rows beginning with
15879 first_reusable_row to the end of the window. Set
15880 first_row_to_display to the first row that cannot be reused.
15881 Set pt_row to the row containing point, if there is any. */
15883 for (first_row_to_display
= first_reusable_row
;
15884 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
15885 ++first_row_to_display
)
15887 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
15888 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
15889 pt_row
= first_row_to_display
;
15892 /* Start displaying at the start of first_row_to_display. */
15893 xassert (first_row_to_display
->y
< yb
);
15894 init_to_row_start (&it
, w
, first_row_to_display
);
15896 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
15898 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
15900 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
15901 + WINDOW_HEADER_LINE_HEIGHT (w
));
15903 /* Display lines beginning with first_row_to_display in the
15904 desired matrix. Set last_text_row to the last row displayed
15905 that displays text. */
15906 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
15907 if (pt_row
== NULL
)
15908 w
->cursor
.vpos
= -1;
15909 last_text_row
= NULL
;
15910 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
15911 if (display_line (&it
))
15912 last_text_row
= it
.glyph_row
- 1;
15914 /* If point is in a reused row, adjust y and vpos of the cursor
15918 w
->cursor
.vpos
-= nrows_scrolled
;
15919 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
15922 /* Give up if point isn't in a row displayed or reused. (This
15923 also handles the case where w->cursor.vpos < nrows_scrolled
15924 after the calls to display_line, which can happen with scroll
15925 margins. See bug#1295.) */
15926 if (w
->cursor
.vpos
< 0)
15928 clear_glyph_matrix (w
->desired_matrix
);
15932 /* Scroll the display. */
15933 run
.current_y
= first_reusable_row
->y
;
15934 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15935 run
.height
= it
.last_visible_y
- run
.current_y
;
15936 dy
= run
.current_y
- run
.desired_y
;
15941 FRAME_RIF (f
)->update_window_begin_hook (w
);
15942 FRAME_RIF (f
)->clear_window_mouse_face (w
);
15943 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
15944 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
15948 /* Adjust Y positions of reused rows. */
15949 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
15950 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
15951 max_y
= it
.last_visible_y
;
15952 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
15955 row
->visible_height
= row
->height
;
15956 if (row
->y
< min_y
)
15957 row
->visible_height
-= min_y
- row
->y
;
15958 if (row
->y
+ row
->height
> max_y
)
15959 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
15960 if (row
->fringe_bitmap_periodic_p
)
15961 row
->redraw_fringe_bitmaps_p
= 1;
15964 /* Scroll the current matrix. */
15965 xassert (nrows_scrolled
> 0);
15966 rotate_matrix (w
->current_matrix
,
15968 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
15971 /* Disable rows not reused. */
15972 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
15973 row
->enabled_p
= 0;
15975 /* Point may have moved to a different line, so we cannot assume that
15976 the previous cursor position is valid; locate the correct row. */
15979 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15980 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
15984 w
->cursor
.y
= row
->y
;
15986 if (row
< bottom_row
)
15988 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15989 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
15991 /* Can't use this optimization with bidi-reordered glyph
15992 rows, unless cursor is already at point. */
15993 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
15995 if (!(w
->cursor
.hpos
>= 0
15996 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
15997 && BUFFERP (glyph
->object
)
15998 && glyph
->charpos
== PT
))
16003 && (!BUFFERP (glyph
->object
)
16004 || glyph
->charpos
< PT
);
16008 w
->cursor
.x
+= glyph
->pixel_width
;
16013 /* Adjust window end. A null value of last_text_row means that
16014 the window end is in reused rows which in turn means that
16015 only its vpos can have changed. */
16018 w
->window_end_bytepos
16019 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16021 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16023 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16028 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16031 w
->window_end_valid
= Qnil
;
16032 w
->desired_matrix
->no_scrolling_p
= 1;
16035 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16045 /************************************************************************
16046 Window redisplay reusing current matrix when buffer has changed
16047 ************************************************************************/
16049 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16050 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16051 EMACS_INT
*, EMACS_INT
*);
16052 static struct glyph_row
*
16053 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16054 struct glyph_row
*);
16057 /* Return the last row in MATRIX displaying text. If row START is
16058 non-null, start searching with that row. IT gives the dimensions
16059 of the display. Value is null if matrix is empty; otherwise it is
16060 a pointer to the row found. */
16062 static struct glyph_row
*
16063 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16064 struct glyph_row
*start
)
16066 struct glyph_row
*row
, *row_found
;
16068 /* Set row_found to the last row in IT->w's current matrix
16069 displaying text. The loop looks funny but think of partially
16072 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16073 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16075 xassert (row
->enabled_p
);
16077 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16086 /* Return the last row in the current matrix of W that is not affected
16087 by changes at the start of current_buffer that occurred since W's
16088 current matrix was built. Value is null if no such row exists.
16090 BEG_UNCHANGED us the number of characters unchanged at the start of
16091 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16092 first changed character in current_buffer. Characters at positions <
16093 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16094 when the current matrix was built. */
16096 static struct glyph_row
*
16097 find_last_unchanged_at_beg_row (struct window
*w
)
16099 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16100 struct glyph_row
*row
;
16101 struct glyph_row
*row_found
= NULL
;
16102 int yb
= window_text_bottom_y (w
);
16104 /* Find the last row displaying unchanged text. */
16105 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16106 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16107 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16110 if (/* If row ends before first_changed_pos, it is unchanged,
16111 except in some case. */
16112 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16113 /* When row ends in ZV and we write at ZV it is not
16115 && !row
->ends_at_zv_p
16116 /* When first_changed_pos is the end of a continued line,
16117 row is not unchanged because it may be no longer
16119 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16120 && (row
->continued_p
16121 || row
->exact_window_width_line_p
)))
16124 /* Stop if last visible row. */
16125 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16133 /* Find the first glyph row in the current matrix of W that is not
16134 affected by changes at the end of current_buffer since the
16135 time W's current matrix was built.
16137 Return in *DELTA the number of chars by which buffer positions in
16138 unchanged text at the end of current_buffer must be adjusted.
16140 Return in *DELTA_BYTES the corresponding number of bytes.
16142 Value is null if no such row exists, i.e. all rows are affected by
16145 static struct glyph_row
*
16146 find_first_unchanged_at_end_row (struct window
*w
,
16147 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16149 struct glyph_row
*row
;
16150 struct glyph_row
*row_found
= NULL
;
16152 *delta
= *delta_bytes
= 0;
16154 /* Display must not have been paused, otherwise the current matrix
16155 is not up to date. */
16156 eassert (!NILP (w
->window_end_valid
));
16158 /* A value of window_end_pos >= END_UNCHANGED means that the window
16159 end is in the range of changed text. If so, there is no
16160 unchanged row at the end of W's current matrix. */
16161 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16164 /* Set row to the last row in W's current matrix displaying text. */
16165 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16167 /* If matrix is entirely empty, no unchanged row exists. */
16168 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16170 /* The value of row is the last glyph row in the matrix having a
16171 meaningful buffer position in it. The end position of row
16172 corresponds to window_end_pos. This allows us to translate
16173 buffer positions in the current matrix to current buffer
16174 positions for characters not in changed text. */
16176 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16177 EMACS_INT Z_BYTE_old
=
16178 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16179 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16180 struct glyph_row
*first_text_row
16181 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16183 *delta
= Z
- Z_old
;
16184 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16186 /* Set last_unchanged_pos to the buffer position of the last
16187 character in the buffer that has not been changed. Z is the
16188 index + 1 of the last character in current_buffer, i.e. by
16189 subtracting END_UNCHANGED we get the index of the last
16190 unchanged character, and we have to add BEG to get its buffer
16192 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16193 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16195 /* Search backward from ROW for a row displaying a line that
16196 starts at a minimum position >= last_unchanged_pos_old. */
16197 for (; row
> first_text_row
; --row
)
16199 /* This used to abort, but it can happen.
16200 It is ok to just stop the search instead here. KFS. */
16201 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16204 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16209 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16215 /* Make sure that glyph rows in the current matrix of window W
16216 reference the same glyph memory as corresponding rows in the
16217 frame's frame matrix. This function is called after scrolling W's
16218 current matrix on a terminal frame in try_window_id and
16219 try_window_reusing_current_matrix. */
16222 sync_frame_with_window_matrix_rows (struct window
*w
)
16224 struct frame
*f
= XFRAME (w
->frame
);
16225 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16227 /* Preconditions: W must be a leaf window and full-width. Its frame
16228 must have a frame matrix. */
16229 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16230 xassert (WINDOW_FULL_WIDTH_P (w
));
16231 xassert (!FRAME_WINDOW_P (f
));
16233 /* If W is a full-width window, glyph pointers in W's current matrix
16234 have, by definition, to be the same as glyph pointers in the
16235 corresponding frame matrix. Note that frame matrices have no
16236 marginal areas (see build_frame_matrix). */
16237 window_row
= w
->current_matrix
->rows
;
16238 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16239 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16240 while (window_row
< window_row_end
)
16242 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16243 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16245 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16246 frame_row
->glyphs
[TEXT_AREA
] = start
;
16247 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16248 frame_row
->glyphs
[LAST_AREA
] = end
;
16250 /* Disable frame rows whose corresponding window rows have
16251 been disabled in try_window_id. */
16252 if (!window_row
->enabled_p
)
16253 frame_row
->enabled_p
= 0;
16255 ++window_row
, ++frame_row
;
16260 /* Find the glyph row in window W containing CHARPOS. Consider all
16261 rows between START and END (not inclusive). END null means search
16262 all rows to the end of the display area of W. Value is the row
16263 containing CHARPOS or null. */
16266 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16267 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16269 struct glyph_row
*row
= start
;
16270 struct glyph_row
*best_row
= NULL
;
16271 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16274 /* If we happen to start on a header-line, skip that. */
16275 if (row
->mode_line_p
)
16278 if ((end
&& row
>= end
) || !row
->enabled_p
)
16281 last_y
= window_text_bottom_y (w
) - dy
;
16285 /* Give up if we have gone too far. */
16286 if (end
&& row
>= end
)
16288 /* This formerly returned if they were equal.
16289 I think that both quantities are of a "last plus one" type;
16290 if so, when they are equal, the row is within the screen. -- rms. */
16291 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16294 /* If it is in this row, return this row. */
16295 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16296 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16297 /* The end position of a row equals the start
16298 position of the next row. If CHARPOS is there, we
16299 would rather display it in the next line, except
16300 when this line ends in ZV. */
16301 && !row
->ends_at_zv_p
16302 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16303 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16307 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16308 || (!best_row
&& !row
->continued_p
))
16310 /* In bidi-reordered rows, there could be several rows
16311 occluding point, all of them belonging to the same
16312 continued line. We need to find the row which fits
16313 CHARPOS the best. */
16314 for (g
= row
->glyphs
[TEXT_AREA
];
16315 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16318 if (!STRINGP (g
->object
))
16320 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16322 mindif
= eabs (g
->charpos
- charpos
);
16324 /* Exact match always wins. */
16331 else if (best_row
&& !row
->continued_p
)
16338 /* Try to redisplay window W by reusing its existing display. W's
16339 current matrix must be up to date when this function is called,
16340 i.e. window_end_valid must not be nil.
16344 1 if display has been updated
16345 0 if otherwise unsuccessful
16346 -1 if redisplay with same window start is known not to succeed
16348 The following steps are performed:
16350 1. Find the last row in the current matrix of W that is not
16351 affected by changes at the start of current_buffer. If no such row
16354 2. Find the first row in W's current matrix that is not affected by
16355 changes at the end of current_buffer. Maybe there is no such row.
16357 3. Display lines beginning with the row + 1 found in step 1 to the
16358 row found in step 2 or, if step 2 didn't find a row, to the end of
16361 4. If cursor is not known to appear on the window, give up.
16363 5. If display stopped at the row found in step 2, scroll the
16364 display and current matrix as needed.
16366 6. Maybe display some lines at the end of W, if we must. This can
16367 happen under various circumstances, like a partially visible line
16368 becoming fully visible, or because newly displayed lines are displayed
16369 in smaller font sizes.
16371 7. Update W's window end information. */
16374 try_window_id (struct window
*w
)
16376 struct frame
*f
= XFRAME (w
->frame
);
16377 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16378 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16379 struct glyph_row
*last_unchanged_at_beg_row
;
16380 struct glyph_row
*first_unchanged_at_end_row
;
16381 struct glyph_row
*row
;
16382 struct glyph_row
*bottom_row
;
16385 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16387 struct text_pos start_pos
;
16389 int first_unchanged_at_end_vpos
= 0;
16390 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16391 struct text_pos start
;
16392 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16395 if (inhibit_try_window_id
)
16399 /* This is handy for debugging. */
16401 #define GIVE_UP(X) \
16403 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16407 #define GIVE_UP(X) return 0
16410 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16412 /* Don't use this for mini-windows because these can show
16413 messages and mini-buffers, and we don't handle that here. */
16414 if (MINI_WINDOW_P (w
))
16417 /* This flag is used to prevent redisplay optimizations. */
16418 if (windows_or_buffers_changed
|| cursor_type_changed
)
16421 /* Verify that narrowing has not changed.
16422 Also verify that we were not told to prevent redisplay optimizations.
16423 It would be nice to further
16424 reduce the number of cases where this prevents try_window_id. */
16425 if (current_buffer
->clip_changed
16426 || current_buffer
->prevent_redisplay_optimizations_p
)
16429 /* Window must either use window-based redisplay or be full width. */
16430 if (!FRAME_WINDOW_P (f
)
16431 && (!FRAME_LINE_INS_DEL_OK (f
)
16432 || !WINDOW_FULL_WIDTH_P (w
)))
16435 /* Give up if point is known NOT to appear in W. */
16436 if (PT
< CHARPOS (start
))
16439 /* Another way to prevent redisplay optimizations. */
16440 if (XFASTINT (w
->last_modified
) == 0)
16443 /* Verify that window is not hscrolled. */
16444 if (XFASTINT (w
->hscroll
) != 0)
16447 /* Verify that display wasn't paused. */
16448 if (NILP (w
->window_end_valid
))
16451 /* Can't use this if highlighting a region because a cursor movement
16452 will do more than just set the cursor. */
16453 if (!NILP (Vtransient_mark_mode
)
16454 && !NILP (BVAR (current_buffer
, mark_active
)))
16457 /* Likewise if highlighting trailing whitespace. */
16458 if (!NILP (Vshow_trailing_whitespace
))
16461 /* Likewise if showing a region. */
16462 if (!NILP (w
->region_showing
))
16465 /* Can't use this if overlay arrow position and/or string have
16467 if (overlay_arrows_changed_p ())
16470 /* When word-wrap is on, adding a space to the first word of a
16471 wrapped line can change the wrap position, altering the line
16472 above it. It might be worthwhile to handle this more
16473 intelligently, but for now just redisplay from scratch. */
16474 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16477 /* Under bidi reordering, adding or deleting a character in the
16478 beginning of a paragraph, before the first strong directional
16479 character, can change the base direction of the paragraph (unless
16480 the buffer specifies a fixed paragraph direction), which will
16481 require to redisplay the whole paragraph. It might be worthwhile
16482 to find the paragraph limits and widen the range of redisplayed
16483 lines to that, but for now just give up this optimization and
16484 redisplay from scratch. */
16485 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16486 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16489 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16490 only if buffer has really changed. The reason is that the gap is
16491 initially at Z for freshly visited files. The code below would
16492 set end_unchanged to 0 in that case. */
16493 if (MODIFF
> SAVE_MODIFF
16494 /* This seems to happen sometimes after saving a buffer. */
16495 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16497 if (GPT
- BEG
< BEG_UNCHANGED
)
16498 BEG_UNCHANGED
= GPT
- BEG
;
16499 if (Z
- GPT
< END_UNCHANGED
)
16500 END_UNCHANGED
= Z
- GPT
;
16503 /* The position of the first and last character that has been changed. */
16504 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16505 last_changed_charpos
= Z
- END_UNCHANGED
;
16507 /* If window starts after a line end, and the last change is in
16508 front of that newline, then changes don't affect the display.
16509 This case happens with stealth-fontification. Note that although
16510 the display is unchanged, glyph positions in the matrix have to
16511 be adjusted, of course. */
16512 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16513 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16514 && ((last_changed_charpos
< CHARPOS (start
)
16515 && CHARPOS (start
) == BEGV
)
16516 || (last_changed_charpos
< CHARPOS (start
) - 1
16517 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16519 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16520 struct glyph_row
*r0
;
16522 /* Compute how many chars/bytes have been added to or removed
16523 from the buffer. */
16524 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16525 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16526 Z_delta
= Z
- Z_old
;
16527 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16529 /* Give up if PT is not in the window. Note that it already has
16530 been checked at the start of try_window_id that PT is not in
16531 front of the window start. */
16532 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16535 /* If window start is unchanged, we can reuse the whole matrix
16536 as is, after adjusting glyph positions. No need to compute
16537 the window end again, since its offset from Z hasn't changed. */
16538 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16539 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16540 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16541 /* PT must not be in a partially visible line. */
16542 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16543 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16545 /* Adjust positions in the glyph matrix. */
16546 if (Z_delta
|| Z_delta_bytes
)
16548 struct glyph_row
*r1
16549 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16550 increment_matrix_positions (w
->current_matrix
,
16551 MATRIX_ROW_VPOS (r0
, current_matrix
),
16552 MATRIX_ROW_VPOS (r1
, current_matrix
),
16553 Z_delta
, Z_delta_bytes
);
16556 /* Set the cursor. */
16557 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16559 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16566 /* Handle the case that changes are all below what is displayed in
16567 the window, and that PT is in the window. This shortcut cannot
16568 be taken if ZV is visible in the window, and text has been added
16569 there that is visible in the window. */
16570 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16571 /* ZV is not visible in the window, or there are no
16572 changes at ZV, actually. */
16573 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16574 || first_changed_charpos
== last_changed_charpos
))
16576 struct glyph_row
*r0
;
16578 /* Give up if PT is not in the window. Note that it already has
16579 been checked at the start of try_window_id that PT is not in
16580 front of the window start. */
16581 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16584 /* If window start is unchanged, we can reuse the whole matrix
16585 as is, without changing glyph positions since no text has
16586 been added/removed in front of the window end. */
16587 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16588 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16589 /* PT must not be in a partially visible line. */
16590 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16591 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16593 /* We have to compute the window end anew since text
16594 could have been added/removed after it. */
16596 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16597 w
->window_end_bytepos
16598 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
16600 /* Set the cursor. */
16601 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16603 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16610 /* Give up if window start is in the changed area.
16612 The condition used to read
16614 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
16616 but why that was tested escapes me at the moment. */
16617 if (CHARPOS (start
) >= first_changed_charpos
16618 && CHARPOS (start
) <= last_changed_charpos
)
16621 /* Check that window start agrees with the start of the first glyph
16622 row in its current matrix. Check this after we know the window
16623 start is not in changed text, otherwise positions would not be
16625 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16626 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
16629 /* Give up if the window ends in strings. Overlay strings
16630 at the end are difficult to handle, so don't try. */
16631 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
16632 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
16635 /* Compute the position at which we have to start displaying new
16636 lines. Some of the lines at the top of the window might be
16637 reusable because they are not displaying changed text. Find the
16638 last row in W's current matrix not affected by changes at the
16639 start of current_buffer. Value is null if changes start in the
16640 first line of window. */
16641 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
16642 if (last_unchanged_at_beg_row
)
16644 /* Avoid starting to display in the moddle of a character, a TAB
16645 for instance. This is easier than to set up the iterator
16646 exactly, and it's not a frequent case, so the additional
16647 effort wouldn't really pay off. */
16648 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
16649 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
16650 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
16651 --last_unchanged_at_beg_row
;
16653 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
16656 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
16658 start_pos
= it
.current
.pos
;
16660 /* Start displaying new lines in the desired matrix at the same
16661 vpos we would use in the current matrix, i.e. below
16662 last_unchanged_at_beg_row. */
16663 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
16665 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
16666 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
16668 xassert (it
.hpos
== 0 && it
.current_x
== 0);
16672 /* There are no reusable lines at the start of the window.
16673 Start displaying in the first text line. */
16674 start_display (&it
, w
, start
);
16675 it
.vpos
= it
.first_vpos
;
16676 start_pos
= it
.current
.pos
;
16679 /* Find the first row that is not affected by changes at the end of
16680 the buffer. Value will be null if there is no unchanged row, in
16681 which case we must redisplay to the end of the window. delta
16682 will be set to the value by which buffer positions beginning with
16683 first_unchanged_at_end_row have to be adjusted due to text
16685 first_unchanged_at_end_row
16686 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
16687 IF_DEBUG (debug_delta
= delta
);
16688 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
16690 /* Set stop_pos to the buffer position up to which we will have to
16691 display new lines. If first_unchanged_at_end_row != NULL, this
16692 is the buffer position of the start of the line displayed in that
16693 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
16694 that we don't stop at a buffer position. */
16696 if (first_unchanged_at_end_row
)
16698 xassert (last_unchanged_at_beg_row
== NULL
16699 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
16701 /* If this is a continuation line, move forward to the next one
16702 that isn't. Changes in lines above affect this line.
16703 Caution: this may move first_unchanged_at_end_row to a row
16704 not displaying text. */
16705 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
16706 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16707 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16708 < it
.last_visible_y
))
16709 ++first_unchanged_at_end_row
;
16711 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
16712 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
16713 >= it
.last_visible_y
))
16714 first_unchanged_at_end_row
= NULL
;
16717 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
16719 first_unchanged_at_end_vpos
16720 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
16721 xassert (stop_pos
>= Z
- END_UNCHANGED
);
16724 else if (last_unchanged_at_beg_row
== NULL
)
16730 /* Either there is no unchanged row at the end, or the one we have
16731 now displays text. This is a necessary condition for the window
16732 end pos calculation at the end of this function. */
16733 xassert (first_unchanged_at_end_row
== NULL
16734 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
16736 debug_last_unchanged_at_beg_vpos
16737 = (last_unchanged_at_beg_row
16738 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
16740 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
16742 #endif /* GLYPH_DEBUG != 0 */
16745 /* Display new lines. Set last_text_row to the last new line
16746 displayed which has text on it, i.e. might end up as being the
16747 line where the window_end_vpos is. */
16748 w
->cursor
.vpos
= -1;
16749 last_text_row
= NULL
;
16750 overlay_arrow_seen
= 0;
16751 while (it
.current_y
< it
.last_visible_y
16752 && !fonts_changed_p
16753 && (first_unchanged_at_end_row
== NULL
16754 || IT_CHARPOS (it
) < stop_pos
))
16756 if (display_line (&it
))
16757 last_text_row
= it
.glyph_row
- 1;
16760 if (fonts_changed_p
)
16764 /* Compute differences in buffer positions, y-positions etc. for
16765 lines reused at the bottom of the window. Compute what we can
16767 if (first_unchanged_at_end_row
16768 /* No lines reused because we displayed everything up to the
16769 bottom of the window. */
16770 && it
.current_y
< it
.last_visible_y
)
16773 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
16775 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
16776 run
.current_y
= first_unchanged_at_end_row
->y
;
16777 run
.desired_y
= run
.current_y
+ dy
;
16778 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
16782 delta
= delta_bytes
= dvpos
= dy
16783 = run
.current_y
= run
.desired_y
= run
.height
= 0;
16784 first_unchanged_at_end_row
= NULL
;
16786 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
16789 /* Find the cursor if not already found. We have to decide whether
16790 PT will appear on this window (it sometimes doesn't, but this is
16791 not a very frequent case.) This decision has to be made before
16792 the current matrix is altered. A value of cursor.vpos < 0 means
16793 that PT is either in one of the lines beginning at
16794 first_unchanged_at_end_row or below the window. Don't care for
16795 lines that might be displayed later at the window end; as
16796 mentioned, this is not a frequent case. */
16797 if (w
->cursor
.vpos
< 0)
16799 /* Cursor in unchanged rows at the top? */
16800 if (PT
< CHARPOS (start_pos
)
16801 && last_unchanged_at_beg_row
)
16803 row
= row_containing_pos (w
, PT
,
16804 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
16805 last_unchanged_at_beg_row
+ 1, 0);
16807 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16810 /* Start from first_unchanged_at_end_row looking for PT. */
16811 else if (first_unchanged_at_end_row
)
16813 row
= row_containing_pos (w
, PT
- delta
,
16814 first_unchanged_at_end_row
, NULL
, 0);
16816 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
16817 delta_bytes
, dy
, dvpos
);
16820 /* Give up if cursor was not found. */
16821 if (w
->cursor
.vpos
< 0)
16823 clear_glyph_matrix (w
->desired_matrix
);
16828 /* Don't let the cursor end in the scroll margins. */
16830 int this_scroll_margin
, cursor_height
;
16832 this_scroll_margin
= max (0, scroll_margin
);
16833 this_scroll_margin
= min (this_scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
16834 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
16835 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
16837 if ((w
->cursor
.y
< this_scroll_margin
16838 && CHARPOS (start
) > BEGV
)
16839 /* Old redisplay didn't take scroll margin into account at the bottom,
16840 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
16841 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
16842 ? cursor_height
+ this_scroll_margin
16843 : 1)) > it
.last_visible_y
)
16845 w
->cursor
.vpos
= -1;
16846 clear_glyph_matrix (w
->desired_matrix
);
16851 /* Scroll the display. Do it before changing the current matrix so
16852 that xterm.c doesn't get confused about where the cursor glyph is
16854 if (dy
&& run
.height
)
16858 if (FRAME_WINDOW_P (f
))
16860 FRAME_RIF (f
)->update_window_begin_hook (w
);
16861 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16862 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16863 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16867 /* Terminal frame. In this case, dvpos gives the number of
16868 lines to scroll by; dvpos < 0 means scroll up. */
16870 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
16871 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
16872 int end
= (WINDOW_TOP_EDGE_LINE (w
)
16873 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
16874 + window_internal_height (w
));
16876 #if defined (HAVE_GPM) || defined (MSDOS)
16877 x_clear_window_mouse_face (w
);
16879 /* Perform the operation on the screen. */
16882 /* Scroll last_unchanged_at_beg_row to the end of the
16883 window down dvpos lines. */
16884 set_terminal_window (f
, end
);
16886 /* On dumb terminals delete dvpos lines at the end
16887 before inserting dvpos empty lines. */
16888 if (!FRAME_SCROLL_REGION_OK (f
))
16889 ins_del_lines (f
, end
- dvpos
, -dvpos
);
16891 /* Insert dvpos empty lines in front of
16892 last_unchanged_at_beg_row. */
16893 ins_del_lines (f
, from
, dvpos
);
16895 else if (dvpos
< 0)
16897 /* Scroll up last_unchanged_at_beg_vpos to the end of
16898 the window to last_unchanged_at_beg_vpos - |dvpos|. */
16899 set_terminal_window (f
, end
);
16901 /* Delete dvpos lines in front of
16902 last_unchanged_at_beg_vpos. ins_del_lines will set
16903 the cursor to the given vpos and emit |dvpos| delete
16905 ins_del_lines (f
, from
+ dvpos
, dvpos
);
16907 /* On a dumb terminal insert dvpos empty lines at the
16909 if (!FRAME_SCROLL_REGION_OK (f
))
16910 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
16913 set_terminal_window (f
, 0);
16919 /* Shift reused rows of the current matrix to the right position.
16920 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
16922 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16923 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
16926 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
16927 bottom_vpos
, dvpos
);
16928 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
16931 else if (dvpos
> 0)
16933 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
16934 bottom_vpos
, dvpos
);
16935 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
16936 first_unchanged_at_end_vpos
+ dvpos
, 0);
16939 /* For frame-based redisplay, make sure that current frame and window
16940 matrix are in sync with respect to glyph memory. */
16941 if (!FRAME_WINDOW_P (f
))
16942 sync_frame_with_window_matrix_rows (w
);
16944 /* Adjust buffer positions in reused rows. */
16945 if (delta
|| delta_bytes
)
16946 increment_matrix_positions (current_matrix
,
16947 first_unchanged_at_end_vpos
+ dvpos
,
16948 bottom_vpos
, delta
, delta_bytes
);
16950 /* Adjust Y positions. */
16952 shift_glyph_matrix (w
, current_matrix
,
16953 first_unchanged_at_end_vpos
+ dvpos
,
16956 if (first_unchanged_at_end_row
)
16958 first_unchanged_at_end_row
+= dvpos
;
16959 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
16960 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
16961 first_unchanged_at_end_row
= NULL
;
16964 /* If scrolling up, there may be some lines to display at the end of
16966 last_text_row_at_end
= NULL
;
16969 /* Scrolling up can leave for example a partially visible line
16970 at the end of the window to be redisplayed. */
16971 /* Set last_row to the glyph row in the current matrix where the
16972 window end line is found. It has been moved up or down in
16973 the matrix by dvpos. */
16974 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
16975 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
16977 /* If last_row is the window end line, it should display text. */
16978 xassert (last_row
->displays_text_p
);
16980 /* If window end line was partially visible before, begin
16981 displaying at that line. Otherwise begin displaying with the
16982 line following it. */
16983 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
16985 init_to_row_start (&it
, w
, last_row
);
16986 it
.vpos
= last_vpos
;
16987 it
.current_y
= last_row
->y
;
16991 init_to_row_end (&it
, w
, last_row
);
16992 it
.vpos
= 1 + last_vpos
;
16993 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
16997 /* We may start in a continuation line. If so, we have to
16998 get the right continuation_lines_width and current_x. */
16999 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17000 it
.hpos
= it
.current_x
= 0;
17002 /* Display the rest of the lines at the window end. */
17003 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17004 while (it
.current_y
< it
.last_visible_y
17005 && !fonts_changed_p
)
17007 /* Is it always sure that the display agrees with lines in
17008 the current matrix? I don't think so, so we mark rows
17009 displayed invalid in the current matrix by setting their
17010 enabled_p flag to zero. */
17011 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17012 if (display_line (&it
))
17013 last_text_row_at_end
= it
.glyph_row
- 1;
17017 /* Update window_end_pos and window_end_vpos. */
17018 if (first_unchanged_at_end_row
17019 && !last_text_row_at_end
)
17021 /* Window end line if one of the preserved rows from the current
17022 matrix. Set row to the last row displaying text in current
17023 matrix starting at first_unchanged_at_end_row, after
17025 xassert (first_unchanged_at_end_row
->displays_text_p
);
17026 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17027 first_unchanged_at_end_row
);
17028 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17030 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17031 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17033 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17034 xassert (w
->window_end_bytepos
>= 0);
17035 IF_DEBUG (debug_method_add (w
, "A"));
17037 else if (last_text_row_at_end
)
17040 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17041 w
->window_end_bytepos
17042 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17044 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17045 xassert (w
->window_end_bytepos
>= 0);
17046 IF_DEBUG (debug_method_add (w
, "B"));
17048 else if (last_text_row
)
17050 /* We have displayed either to the end of the window or at the
17051 end of the window, i.e. the last row with text is to be found
17052 in the desired matrix. */
17054 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17055 w
->window_end_bytepos
17056 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17058 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17059 xassert (w
->window_end_bytepos
>= 0);
17061 else if (first_unchanged_at_end_row
== NULL
17062 && last_text_row
== NULL
17063 && last_text_row_at_end
== NULL
)
17065 /* Displayed to end of window, but no line containing text was
17066 displayed. Lines were deleted at the end of the window. */
17067 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17068 int vpos
= XFASTINT (w
->window_end_vpos
);
17069 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17070 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17073 row
== NULL
&& vpos
>= first_vpos
;
17074 --vpos
, --current_row
, --desired_row
)
17076 if (desired_row
->enabled_p
)
17078 if (desired_row
->displays_text_p
)
17081 else if (current_row
->displays_text_p
)
17085 xassert (row
!= NULL
);
17086 w
->window_end_vpos
= make_number (vpos
+ 1);
17087 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17088 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17089 xassert (w
->window_end_bytepos
>= 0);
17090 IF_DEBUG (debug_method_add (w
, "C"));
17095 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17096 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17098 /* Record that display has not been completed. */
17099 w
->window_end_valid
= Qnil
;
17100 w
->desired_matrix
->no_scrolling_p
= 1;
17108 /***********************************************************************
17109 More debugging support
17110 ***********************************************************************/
17114 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17115 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17116 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17119 /* Dump the contents of glyph matrix MATRIX on stderr.
17121 GLYPHS 0 means don't show glyph contents.
17122 GLYPHS 1 means show glyphs in short form
17123 GLYPHS > 1 means show glyphs in long form. */
17126 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17129 for (i
= 0; i
< matrix
->nrows
; ++i
)
17130 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17134 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17135 the glyph row and area where the glyph comes from. */
17138 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17140 if (glyph
->type
== CHAR_GLYPH
)
17143 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17144 glyph
- row
->glyphs
[TEXT_AREA
],
17147 (BUFFERP (glyph
->object
)
17149 : (STRINGP (glyph
->object
)
17152 glyph
->pixel_width
,
17154 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17158 glyph
->left_box_line_p
,
17159 glyph
->right_box_line_p
);
17161 else if (glyph
->type
== STRETCH_GLYPH
)
17164 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17165 glyph
- row
->glyphs
[TEXT_AREA
],
17168 (BUFFERP (glyph
->object
)
17170 : (STRINGP (glyph
->object
)
17173 glyph
->pixel_width
,
17177 glyph
->left_box_line_p
,
17178 glyph
->right_box_line_p
);
17180 else if (glyph
->type
== IMAGE_GLYPH
)
17183 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17184 glyph
- row
->glyphs
[TEXT_AREA
],
17187 (BUFFERP (glyph
->object
)
17189 : (STRINGP (glyph
->object
)
17192 glyph
->pixel_width
,
17196 glyph
->left_box_line_p
,
17197 glyph
->right_box_line_p
);
17199 else if (glyph
->type
== COMPOSITE_GLYPH
)
17202 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17203 glyph
- row
->glyphs
[TEXT_AREA
],
17206 (BUFFERP (glyph
->object
)
17208 : (STRINGP (glyph
->object
)
17211 glyph
->pixel_width
,
17213 if (glyph
->u
.cmp
.automatic
)
17216 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17217 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17219 glyph
->left_box_line_p
,
17220 glyph
->right_box_line_p
);
17225 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17226 GLYPHS 0 means don't show glyph contents.
17227 GLYPHS 1 means show glyphs in short form
17228 GLYPHS > 1 means show glyphs in long form. */
17231 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17235 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17236 fprintf (stderr
, "======================================================================\n");
17238 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17239 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17241 MATRIX_ROW_START_CHARPOS (row
),
17242 MATRIX_ROW_END_CHARPOS (row
),
17243 row
->used
[TEXT_AREA
],
17244 row
->contains_overlapping_glyphs_p
,
17246 row
->truncated_on_left_p
,
17247 row
->truncated_on_right_p
,
17249 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17250 row
->displays_text_p
,
17253 row
->ends_in_middle_of_char_p
,
17254 row
->starts_in_middle_of_char_p
,
17260 row
->visible_height
,
17263 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17264 row
->end
.overlay_string_index
,
17265 row
->continuation_lines_width
);
17266 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17267 CHARPOS (row
->start
.string_pos
),
17268 CHARPOS (row
->end
.string_pos
));
17269 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17270 row
->end
.dpvec_index
);
17277 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17279 struct glyph
*glyph
= row
->glyphs
[area
];
17280 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17282 /* Glyph for a line end in text. */
17283 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17286 if (glyph
< glyph_end
)
17287 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17289 for (; glyph
< glyph_end
; ++glyph
)
17290 dump_glyph (row
, glyph
, area
);
17293 else if (glyphs
== 1)
17297 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17299 char *s
= (char *) alloca (row
->used
[area
] + 1);
17302 for (i
= 0; i
< row
->used
[area
]; ++i
)
17304 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17305 if (glyph
->type
== CHAR_GLYPH
17306 && glyph
->u
.ch
< 0x80
17307 && glyph
->u
.ch
>= ' ')
17308 s
[i
] = glyph
->u
.ch
;
17314 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17320 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17321 Sdump_glyph_matrix
, 0, 1, "p",
17322 doc
: /* Dump the current matrix of the selected window to stderr.
17323 Shows contents of glyph row structures. With non-nil
17324 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17325 glyphs in short form, otherwise show glyphs in long form. */)
17326 (Lisp_Object glyphs
)
17328 struct window
*w
= XWINDOW (selected_window
);
17329 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17331 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17332 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17333 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17334 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17335 fprintf (stderr
, "=============================================\n");
17336 dump_glyph_matrix (w
->current_matrix
,
17337 NILP (glyphs
) ? 0 : XINT (glyphs
));
17342 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17343 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17346 struct frame
*f
= XFRAME (selected_frame
);
17347 dump_glyph_matrix (f
->current_matrix
, 1);
17352 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17353 doc
: /* Dump glyph row ROW to stderr.
17354 GLYPH 0 means don't dump glyphs.
17355 GLYPH 1 means dump glyphs in short form.
17356 GLYPH > 1 or omitted means dump glyphs in long form. */)
17357 (Lisp_Object row
, Lisp_Object glyphs
)
17359 struct glyph_matrix
*matrix
;
17362 CHECK_NUMBER (row
);
17363 matrix
= XWINDOW (selected_window
)->current_matrix
;
17365 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17366 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17368 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17373 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17374 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17375 GLYPH 0 means don't dump glyphs.
17376 GLYPH 1 means dump glyphs in short form.
17377 GLYPH > 1 or omitted means dump glyphs in long form. */)
17378 (Lisp_Object row
, Lisp_Object glyphs
)
17380 struct frame
*sf
= SELECTED_FRAME ();
17381 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17384 CHECK_NUMBER (row
);
17386 if (vpos
>= 0 && vpos
< m
->nrows
)
17387 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17388 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17393 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17394 doc
: /* Toggle tracing of redisplay.
17395 With ARG, turn tracing on if and only if ARG is positive. */)
17399 trace_redisplay_p
= !trace_redisplay_p
;
17402 arg
= Fprefix_numeric_value (arg
);
17403 trace_redisplay_p
= XINT (arg
) > 0;
17410 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17411 doc
: /* Like `format', but print result to stderr.
17412 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17413 (ptrdiff_t nargs
, Lisp_Object
*args
)
17415 Lisp_Object s
= Fformat (nargs
, args
);
17416 fprintf (stderr
, "%s", SDATA (s
));
17420 #endif /* GLYPH_DEBUG */
17424 /***********************************************************************
17425 Building Desired Matrix Rows
17426 ***********************************************************************/
17428 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17429 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17431 static struct glyph_row
*
17432 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17434 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17435 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17436 struct buffer
*old
= current_buffer
;
17437 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17438 int arrow_len
= SCHARS (overlay_arrow_string
);
17439 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17440 const unsigned char *p
;
17443 int n_glyphs_before
;
17445 set_buffer_temp (buffer
);
17446 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17447 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17448 SET_TEXT_POS (it
.position
, 0, 0);
17450 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17452 while (p
< arrow_end
)
17454 Lisp_Object face
, ilisp
;
17456 /* Get the next character. */
17458 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17461 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17462 if (! ASCII_CHAR_P (it
.c
))
17463 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17467 /* Get its face. */
17468 ilisp
= make_number (p
- arrow_string
);
17469 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17470 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17472 /* Compute its width, get its glyphs. */
17473 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17474 SET_TEXT_POS (it
.position
, -1, -1);
17475 PRODUCE_GLYPHS (&it
);
17477 /* If this character doesn't fit any more in the line, we have
17478 to remove some glyphs. */
17479 if (it
.current_x
> it
.last_visible_x
)
17481 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17486 set_buffer_temp (old
);
17487 return it
.glyph_row
;
17491 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17492 glyphs are only inserted for terminal frames since we can't really
17493 win with truncation glyphs when partially visible glyphs are
17494 involved. Which glyphs to insert is determined by
17495 produce_special_glyphs. */
17498 insert_left_trunc_glyphs (struct it
*it
)
17500 struct it truncate_it
;
17501 struct glyph
*from
, *end
, *to
, *toend
;
17503 xassert (!FRAME_WINDOW_P (it
->f
));
17505 /* Get the truncation glyphs. */
17507 truncate_it
.current_x
= 0;
17508 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17509 truncate_it
.glyph_row
= &scratch_glyph_row
;
17510 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17511 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17512 truncate_it
.object
= make_number (0);
17513 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17515 /* Overwrite glyphs from IT with truncation glyphs. */
17516 if (!it
->glyph_row
->reversed_p
)
17518 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17519 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17520 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17521 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17526 /* There may be padding glyphs left over. Overwrite them too. */
17527 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17529 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17535 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17539 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17540 that back to front. */
17541 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17542 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17543 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17544 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17546 while (from
>= end
&& to
>= toend
)
17548 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17551 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17552 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17553 while (from
>= end
&& to
>= toend
)
17558 /* Need to free some room before prepending additional
17560 int move_by
= from
- end
+ 1;
17561 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17562 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17564 for ( ; g
>= g0
; g
--)
17566 while (from
>= end
)
17568 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17574 /* Compute the pixel height and width of IT->glyph_row.
17576 Most of the time, ascent and height of a display line will be equal
17577 to the max_ascent and max_height values of the display iterator
17578 structure. This is not the case if
17580 1. We hit ZV without displaying anything. In this case, max_ascent
17581 and max_height will be zero.
17583 2. We have some glyphs that don't contribute to the line height.
17584 (The glyph row flag contributes_to_line_height_p is for future
17585 pixmap extensions).
17587 The first case is easily covered by using default values because in
17588 these cases, the line height does not really matter, except that it
17589 must not be zero. */
17592 compute_line_metrics (struct it
*it
)
17594 struct glyph_row
*row
= it
->glyph_row
;
17596 if (FRAME_WINDOW_P (it
->f
))
17598 int i
, min_y
, max_y
;
17600 /* The line may consist of one space only, that was added to
17601 place the cursor on it. If so, the row's height hasn't been
17603 if (row
->height
== 0)
17605 if (it
->max_ascent
+ it
->max_descent
== 0)
17606 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
17607 row
->ascent
= it
->max_ascent
;
17608 row
->height
= it
->max_ascent
+ it
->max_descent
;
17609 row
->phys_ascent
= it
->max_phys_ascent
;
17610 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
17611 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
17614 /* Compute the width of this line. */
17615 row
->pixel_width
= row
->x
;
17616 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
17617 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
17619 xassert (row
->pixel_width
>= 0);
17620 xassert (row
->ascent
>= 0 && row
->height
> 0);
17622 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
17623 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
17625 /* If first line's physical ascent is larger than its logical
17626 ascent, use the physical ascent, and make the row taller.
17627 This makes accented characters fully visible. */
17628 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
17629 && row
->phys_ascent
> row
->ascent
)
17631 row
->height
+= row
->phys_ascent
- row
->ascent
;
17632 row
->ascent
= row
->phys_ascent
;
17635 /* Compute how much of the line is visible. */
17636 row
->visible_height
= row
->height
;
17638 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
17639 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
17641 if (row
->y
< min_y
)
17642 row
->visible_height
-= min_y
- row
->y
;
17643 if (row
->y
+ row
->height
> max_y
)
17644 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17648 row
->pixel_width
= row
->used
[TEXT_AREA
];
17649 if (row
->continued_p
)
17650 row
->pixel_width
-= it
->continuation_pixel_width
;
17651 else if (row
->truncated_on_right_p
)
17652 row
->pixel_width
-= it
->truncation_pixel_width
;
17653 row
->ascent
= row
->phys_ascent
= 0;
17654 row
->height
= row
->phys_height
= row
->visible_height
= 1;
17655 row
->extra_line_spacing
= 0;
17658 /* Compute a hash code for this row. */
17662 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17663 for (i
= 0; i
< row
->used
[area
]; ++i
)
17664 row
->hash
= ((((row
->hash
<< 4) + (row
->hash
>> 24)) & 0x0fffffff)
17665 + row
->glyphs
[area
][i
].u
.val
17666 + row
->glyphs
[area
][i
].face_id
17667 + row
->glyphs
[area
][i
].padding_p
17668 + (row
->glyphs
[area
][i
].type
<< 2));
17671 it
->max_ascent
= it
->max_descent
= 0;
17672 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
17676 /* Append one space to the glyph row of iterator IT if doing a
17677 window-based redisplay. The space has the same face as
17678 IT->face_id. Value is non-zero if a space was added.
17680 This function is called to make sure that there is always one glyph
17681 at the end of a glyph row that the cursor can be set on under
17682 window-systems. (If there weren't such a glyph we would not know
17683 how wide and tall a box cursor should be displayed).
17685 At the same time this space let's a nicely handle clearing to the
17686 end of the line if the row ends in italic text. */
17689 append_space_for_newline (struct it
*it
, int default_face_p
)
17691 if (FRAME_WINDOW_P (it
->f
))
17693 int n
= it
->glyph_row
->used
[TEXT_AREA
];
17695 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
17696 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
17698 /* Save some values that must not be changed.
17699 Must save IT->c and IT->len because otherwise
17700 ITERATOR_AT_END_P wouldn't work anymore after
17701 append_space_for_newline has been called. */
17702 enum display_element_type saved_what
= it
->what
;
17703 int saved_c
= it
->c
, saved_len
= it
->len
;
17704 int saved_char_to_display
= it
->char_to_display
;
17705 int saved_x
= it
->current_x
;
17706 int saved_face_id
= it
->face_id
;
17707 struct text_pos saved_pos
;
17708 Lisp_Object saved_object
;
17711 saved_object
= it
->object
;
17712 saved_pos
= it
->position
;
17714 it
->what
= IT_CHARACTER
;
17715 memset (&it
->position
, 0, sizeof it
->position
);
17716 it
->object
= make_number (0);
17717 it
->c
= it
->char_to_display
= ' ';
17720 if (default_face_p
)
17721 it
->face_id
= DEFAULT_FACE_ID
;
17722 else if (it
->face_before_selective_p
)
17723 it
->face_id
= it
->saved_face_id
;
17724 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
17725 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
17727 PRODUCE_GLYPHS (it
);
17729 it
->override_ascent
= -1;
17730 it
->constrain_row_ascent_descent_p
= 0;
17731 it
->current_x
= saved_x
;
17732 it
->object
= saved_object
;
17733 it
->position
= saved_pos
;
17734 it
->what
= saved_what
;
17735 it
->face_id
= saved_face_id
;
17736 it
->len
= saved_len
;
17738 it
->char_to_display
= saved_char_to_display
;
17747 /* Extend the face of the last glyph in the text area of IT->glyph_row
17748 to the end of the display line. Called from display_line. If the
17749 glyph row is empty, add a space glyph to it so that we know the
17750 face to draw. Set the glyph row flag fill_line_p. If the glyph
17751 row is R2L, prepend a stretch glyph to cover the empty space to the
17752 left of the leftmost glyph. */
17755 extend_face_to_end_of_line (struct it
*it
)
17758 struct frame
*f
= it
->f
;
17760 /* If line is already filled, do nothing. Non window-system frames
17761 get a grace of one more ``pixel'' because their characters are
17762 1-``pixel'' wide, so they hit the equality too early. This grace
17763 is needed only for R2L rows that are not continued, to produce
17764 one extra blank where we could display the cursor. */
17765 if (it
->current_x
>= it
->last_visible_x
17766 + (!FRAME_WINDOW_P (f
)
17767 && it
->glyph_row
->reversed_p
17768 && !it
->glyph_row
->continued_p
))
17771 /* Face extension extends the background and box of IT->face_id
17772 to the end of the line. If the background equals the background
17773 of the frame, we don't have to do anything. */
17774 if (it
->face_before_selective_p
)
17775 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
17777 face
= FACE_FROM_ID (f
, it
->face_id
);
17779 if (FRAME_WINDOW_P (f
)
17780 && it
->glyph_row
->displays_text_p
17781 && face
->box
== FACE_NO_BOX
17782 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
17784 && !it
->glyph_row
->reversed_p
)
17787 /* Set the glyph row flag indicating that the face of the last glyph
17788 in the text area has to be drawn to the end of the text area. */
17789 it
->glyph_row
->fill_line_p
= 1;
17791 /* If current character of IT is not ASCII, make sure we have the
17792 ASCII face. This will be automatically undone the next time
17793 get_next_display_element returns a multibyte character. Note
17794 that the character will always be single byte in unibyte
17796 if (!ASCII_CHAR_P (it
->c
))
17798 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
17801 if (FRAME_WINDOW_P (f
))
17803 /* If the row is empty, add a space with the current face of IT,
17804 so that we know which face to draw. */
17805 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
17807 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
17808 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
17809 it
->glyph_row
->used
[TEXT_AREA
] = 1;
17811 #ifdef HAVE_WINDOW_SYSTEM
17812 if (it
->glyph_row
->reversed_p
)
17814 /* Prepend a stretch glyph to the row, such that the
17815 rightmost glyph will be drawn flushed all the way to the
17816 right margin of the window. The stretch glyph that will
17817 occupy the empty space, if any, to the left of the
17819 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
17820 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17821 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
17823 int row_width
, stretch_ascent
, stretch_width
;
17824 struct text_pos saved_pos
;
17825 int saved_face_id
, saved_avoid_cursor
;
17827 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
17828 row_width
+= g
->pixel_width
;
17829 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
17830 if (stretch_width
> 0)
17833 (((it
->ascent
+ it
->descent
)
17834 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
17835 saved_pos
= it
->position
;
17836 memset (&it
->position
, 0, sizeof it
->position
);
17837 saved_avoid_cursor
= it
->avoid_cursor_p
;
17838 it
->avoid_cursor_p
= 1;
17839 saved_face_id
= it
->face_id
;
17840 /* The last row's stretch glyph should get the default
17841 face, to avoid painting the rest of the window with
17842 the region face, if the region ends at ZV. */
17843 if (it
->glyph_row
->ends_at_zv_p
)
17844 it
->face_id
= DEFAULT_FACE_ID
;
17846 it
->face_id
= face
->id
;
17847 append_stretch_glyph (it
, make_number (0), stretch_width
,
17848 it
->ascent
+ it
->descent
, stretch_ascent
);
17849 it
->position
= saved_pos
;
17850 it
->avoid_cursor_p
= saved_avoid_cursor
;
17851 it
->face_id
= saved_face_id
;
17854 #endif /* HAVE_WINDOW_SYSTEM */
17858 /* Save some values that must not be changed. */
17859 int saved_x
= it
->current_x
;
17860 struct text_pos saved_pos
;
17861 Lisp_Object saved_object
;
17862 enum display_element_type saved_what
= it
->what
;
17863 int saved_face_id
= it
->face_id
;
17865 saved_object
= it
->object
;
17866 saved_pos
= it
->position
;
17868 it
->what
= IT_CHARACTER
;
17869 memset (&it
->position
, 0, sizeof it
->position
);
17870 it
->object
= make_number (0);
17871 it
->c
= it
->char_to_display
= ' ';
17873 /* The last row's blank glyphs should get the default face, to
17874 avoid painting the rest of the window with the region face,
17875 if the region ends at ZV. */
17876 if (it
->glyph_row
->ends_at_zv_p
)
17877 it
->face_id
= DEFAULT_FACE_ID
;
17879 it
->face_id
= face
->id
;
17881 PRODUCE_GLYPHS (it
);
17883 while (it
->current_x
<= it
->last_visible_x
)
17884 PRODUCE_GLYPHS (it
);
17886 /* Don't count these blanks really. It would let us insert a left
17887 truncation glyph below and make us set the cursor on them, maybe. */
17888 it
->current_x
= saved_x
;
17889 it
->object
= saved_object
;
17890 it
->position
= saved_pos
;
17891 it
->what
= saved_what
;
17892 it
->face_id
= saved_face_id
;
17897 /* Value is non-zero if text starting at CHARPOS in current_buffer is
17898 trailing whitespace. */
17901 trailing_whitespace_p (EMACS_INT charpos
)
17903 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
17906 while (bytepos
< ZV_BYTE
17907 && (c
= FETCH_CHAR (bytepos
),
17908 c
== ' ' || c
== '\t'))
17911 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
17913 if (bytepos
!= PT_BYTE
)
17920 /* Highlight trailing whitespace, if any, in ROW. */
17923 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
17925 int used
= row
->used
[TEXT_AREA
];
17929 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
17930 struct glyph
*glyph
= start
+ used
- 1;
17932 if (row
->reversed_p
)
17934 /* Right-to-left rows need to be processed in the opposite
17935 direction, so swap the edge pointers. */
17937 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
17940 /* Skip over glyphs inserted to display the cursor at the
17941 end of a line, for extending the face of the last glyph
17942 to the end of the line on terminals, and for truncation
17943 and continuation glyphs. */
17944 if (!row
->reversed_p
)
17946 while (glyph
>= start
17947 && glyph
->type
== CHAR_GLYPH
17948 && INTEGERP (glyph
->object
))
17953 while (glyph
<= start
17954 && glyph
->type
== CHAR_GLYPH
17955 && INTEGERP (glyph
->object
))
17959 /* If last glyph is a space or stretch, and it's trailing
17960 whitespace, set the face of all trailing whitespace glyphs in
17961 IT->glyph_row to `trailing-whitespace'. */
17962 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
17963 && BUFFERP (glyph
->object
)
17964 && (glyph
->type
== STRETCH_GLYPH
17965 || (glyph
->type
== CHAR_GLYPH
17966 && glyph
->u
.ch
== ' '))
17967 && trailing_whitespace_p (glyph
->charpos
))
17969 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
17973 if (!row
->reversed_p
)
17975 while (glyph
>= start
17976 && BUFFERP (glyph
->object
)
17977 && (glyph
->type
== STRETCH_GLYPH
17978 || (glyph
->type
== CHAR_GLYPH
17979 && glyph
->u
.ch
== ' ')))
17980 (glyph
--)->face_id
= face_id
;
17984 while (glyph
<= start
17985 && BUFFERP (glyph
->object
)
17986 && (glyph
->type
== STRETCH_GLYPH
17987 || (glyph
->type
== CHAR_GLYPH
17988 && glyph
->u
.ch
== ' ')))
17989 (glyph
++)->face_id
= face_id
;
17996 /* Value is non-zero if glyph row ROW should be
17997 used to hold the cursor. */
18000 cursor_row_p (struct glyph_row
*row
)
18004 if (PT
== CHARPOS (row
->end
.pos
))
18006 /* Suppose the row ends on a string.
18007 Unless the row is continued, that means it ends on a newline
18008 in the string. If it's anything other than a display string
18009 (e.g. a before-string from an overlay), we don't want the
18010 cursor there. (This heuristic seems to give the optimal
18011 behavior for the various types of multi-line strings.) */
18012 if (CHARPOS (row
->end
.string_pos
) >= 0)
18014 if (row
->continued_p
)
18018 /* Check for `display' property. */
18019 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18020 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18021 struct glyph
*glyph
;
18024 for (glyph
= end
; glyph
>= beg
; --glyph
)
18025 if (STRINGP (glyph
->object
))
18028 = Fget_char_property (make_number (PT
),
18032 && display_prop_string_p (prop
, glyph
->object
));
18037 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18039 /* If the row ends in middle of a real character,
18040 and the line is continued, we want the cursor here.
18041 That's because CHARPOS (ROW->end.pos) would equal
18042 PT if PT is before the character. */
18043 if (!row
->ends_in_ellipsis_p
)
18044 result
= row
->continued_p
;
18046 /* If the row ends in an ellipsis, then
18047 CHARPOS (ROW->end.pos) will equal point after the
18048 invisible text. We want that position to be displayed
18049 after the ellipsis. */
18052 /* If the row ends at ZV, display the cursor at the end of that
18053 row instead of at the start of the row below. */
18054 else if (row
->ends_at_zv_p
)
18065 /* Push the property PROP so that it will be rendered at the current
18066 position in IT. Return 1 if PROP was successfully pushed, 0
18067 otherwise. Called from handle_line_prefix to handle the
18068 `line-prefix' and `wrap-prefix' properties. */
18071 push_display_prop (struct it
*it
, Lisp_Object prop
)
18073 struct text_pos pos
=
18074 (it
->method
== GET_FROM_STRING
) ? it
->current
.string_pos
: it
->current
.pos
;
18076 xassert (it
->method
== GET_FROM_BUFFER
18077 || it
->method
== GET_FROM_STRING
);
18079 /* We need to save the current buffer/string position, so it will be
18080 restored by pop_it, because iterate_out_of_display_property
18081 depends on that being set correctly, but some situations leave
18082 it->position not yet set when this function is called. */
18083 push_it (it
, &pos
);
18085 if (STRINGP (prop
))
18087 if (SCHARS (prop
) == 0)
18094 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18095 it
->current
.overlay_string_index
= -1;
18096 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18097 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18098 it
->method
= GET_FROM_STRING
;
18099 it
->stop_charpos
= 0;
18101 it
->base_level_stop
= 0;
18103 /* Force paragraph direction to be that of the parent
18105 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18106 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18108 it
->paragraph_embedding
= L2R
;
18110 /* Set up the bidi iterator for this display string. */
18113 it
->bidi_it
.string
.lstring
= it
->string
;
18114 it
->bidi_it
.string
.s
= NULL
;
18115 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18116 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18117 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18118 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18119 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18122 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18124 it
->method
= GET_FROM_STRETCH
;
18127 #ifdef HAVE_WINDOW_SYSTEM
18128 else if (IMAGEP (prop
))
18130 it
->what
= IT_IMAGE
;
18131 it
->image_id
= lookup_image (it
->f
, prop
);
18132 it
->method
= GET_FROM_IMAGE
;
18134 #endif /* HAVE_WINDOW_SYSTEM */
18137 pop_it (it
); /* bogus display property, give up */
18144 /* Return the character-property PROP at the current position in IT. */
18147 get_it_property (struct it
*it
, Lisp_Object prop
)
18149 Lisp_Object position
;
18151 if (STRINGP (it
->object
))
18152 position
= make_number (IT_STRING_CHARPOS (*it
));
18153 else if (BUFFERP (it
->object
))
18154 position
= make_number (IT_CHARPOS (*it
));
18158 return Fget_char_property (position
, prop
, it
->object
);
18161 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18164 handle_line_prefix (struct it
*it
)
18166 Lisp_Object prefix
;
18168 if (it
->continuation_lines_width
> 0)
18170 prefix
= get_it_property (it
, Qwrap_prefix
);
18172 prefix
= Vwrap_prefix
;
18176 prefix
= get_it_property (it
, Qline_prefix
);
18178 prefix
= Vline_prefix
;
18180 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18182 /* If the prefix is wider than the window, and we try to wrap
18183 it, it would acquire its own wrap prefix, and so on till the
18184 iterator stack overflows. So, don't wrap the prefix. */
18185 it
->line_wrap
= TRUNCATE
;
18186 it
->avoid_cursor_p
= 1;
18192 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18193 only for R2L lines from display_line and display_string, when they
18194 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18195 the line/string needs to be continued on the next glyph row. */
18197 unproduce_glyphs (struct it
*it
, int n
)
18199 struct glyph
*glyph
, *end
;
18201 xassert (it
->glyph_row
);
18202 xassert (it
->glyph_row
->reversed_p
);
18203 xassert (it
->area
== TEXT_AREA
);
18204 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18206 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18207 n
= it
->glyph_row
->used
[TEXT_AREA
];
18208 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18209 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18210 for ( ; glyph
< end
; glyph
++)
18211 glyph
[-n
] = *glyph
;
18214 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18215 and ROW->maxpos. */
18217 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18218 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18219 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18221 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18222 lines' rows is implemented for bidi-reordered rows. */
18224 /* ROW->minpos is the value of min_pos, the minimal buffer position
18225 we have in ROW, or ROW->start.pos if that is smaller. */
18226 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18227 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18229 /* We didn't find buffer positions smaller than ROW->start, or
18230 didn't find _any_ valid buffer positions in any of the glyphs,
18231 so we must trust the iterator's computed positions. */
18232 row
->minpos
= row
->start
.pos
;
18235 max_pos
= CHARPOS (it
->current
.pos
);
18236 max_bpos
= BYTEPOS (it
->current
.pos
);
18239 /* Here are the various use-cases for ending the row, and the
18240 corresponding values for ROW->maxpos:
18242 Line ends in a newline from buffer eol_pos + 1
18243 Line is continued from buffer max_pos + 1
18244 Line is truncated on right it->current.pos
18245 Line ends in a newline from string max_pos
18246 Line is continued from string max_pos
18247 Line is continued from display vector max_pos
18248 Line is entirely from a string min_pos == max_pos
18249 Line is entirely from a display vector min_pos == max_pos
18250 Line that ends at ZV ZV
18252 If you discover other use-cases, please add them here as
18254 if (row
->ends_at_zv_p
)
18255 row
->maxpos
= it
->current
.pos
;
18256 else if (row
->used
[TEXT_AREA
])
18258 if (row
->ends_in_newline_from_string_p
)
18259 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18260 else if (CHARPOS (it
->eol_pos
) > 0)
18261 SET_TEXT_POS (row
->maxpos
,
18262 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18263 else if (row
->continued_p
)
18265 /* If max_pos is different from IT's current position, it
18266 means IT->method does not belong to the display element
18267 at max_pos. However, it also means that the display
18268 element at max_pos was displayed in its entirety on this
18269 line, which is equivalent to saying that the next line
18270 starts at the next buffer position. */
18271 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18272 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18275 INC_BOTH (max_pos
, max_bpos
);
18276 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18279 else if (row
->truncated_on_right_p
)
18280 /* display_line already called reseat_at_next_visible_line_start,
18281 which puts the iterator at the beginning of the next line, in
18282 the logical order. */
18283 row
->maxpos
= it
->current
.pos
;
18284 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18285 /* A line that is entirely from a string/image/stretch... */
18286 row
->maxpos
= row
->minpos
;
18291 row
->maxpos
= it
->current
.pos
;
18294 /* Construct the glyph row IT->glyph_row in the desired matrix of
18295 IT->w from text at the current position of IT. See dispextern.h
18296 for an overview of struct it. Value is non-zero if
18297 IT->glyph_row displays text, as opposed to a line displaying ZV
18301 display_line (struct it
*it
)
18303 struct glyph_row
*row
= it
->glyph_row
;
18304 Lisp_Object overlay_arrow_string
;
18306 void *wrap_data
= NULL
;
18307 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18308 int wrap_row_used
= -1;
18309 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18310 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18311 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18312 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18313 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18315 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18316 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18318 /* We always start displaying at hpos zero even if hscrolled. */
18319 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18321 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18322 >= it
->w
->desired_matrix
->nrows
)
18324 it
->w
->nrows_scale_factor
++;
18325 fonts_changed_p
= 1;
18329 /* Is IT->w showing the region? */
18330 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18332 /* Clear the result glyph row and enable it. */
18333 prepare_desired_row (row
);
18335 row
->y
= it
->current_y
;
18336 row
->start
= it
->start
;
18337 row
->continuation_lines_width
= it
->continuation_lines_width
;
18338 row
->displays_text_p
= 1;
18339 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18340 it
->starts_in_middle_of_char_p
= 0;
18342 /* Arrange the overlays nicely for our purposes. Usually, we call
18343 display_line on only one line at a time, in which case this
18344 can't really hurt too much, or we call it on lines which appear
18345 one after another in the buffer, in which case all calls to
18346 recenter_overlay_lists but the first will be pretty cheap. */
18347 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18349 /* Move over display elements that are not visible because we are
18350 hscrolled. This may stop at an x-position < IT->first_visible_x
18351 if the first glyph is partially visible or if we hit a line end. */
18352 if (it
->current_x
< it
->first_visible_x
)
18354 this_line_min_pos
= row
->start
.pos
;
18355 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18356 MOVE_TO_POS
| MOVE_TO_X
);
18357 /* Record the smallest positions seen while we moved over
18358 display elements that are not visible. This is needed by
18359 redisplay_internal for optimizing the case where the cursor
18360 stays inside the same line. The rest of this function only
18361 considers positions that are actually displayed, so
18362 RECORD_MAX_MIN_POS will not otherwise record positions that
18363 are hscrolled to the left of the left edge of the window. */
18364 min_pos
= CHARPOS (this_line_min_pos
);
18365 min_bpos
= BYTEPOS (this_line_min_pos
);
18369 /* We only do this when not calling `move_it_in_display_line_to'
18370 above, because move_it_in_display_line_to calls
18371 handle_line_prefix itself. */
18372 handle_line_prefix (it
);
18375 /* Get the initial row height. This is either the height of the
18376 text hscrolled, if there is any, or zero. */
18377 row
->ascent
= it
->max_ascent
;
18378 row
->height
= it
->max_ascent
+ it
->max_descent
;
18379 row
->phys_ascent
= it
->max_phys_ascent
;
18380 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18381 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18383 /* Utility macro to record max and min buffer positions seen until now. */
18384 #define RECORD_MAX_MIN_POS(IT) \
18387 int composition_p = (IT)->what == IT_COMPOSITION; \
18388 EMACS_INT current_pos = \
18389 composition_p ? (IT)->cmp_it.charpos \
18390 : IT_CHARPOS (*(IT)); \
18391 EMACS_INT current_bpos = \
18392 composition_p ? CHAR_TO_BYTE (current_pos) \
18393 : IT_BYTEPOS (*(IT)); \
18394 if (current_pos < min_pos) \
18396 min_pos = current_pos; \
18397 min_bpos = current_bpos; \
18399 if (current_pos > max_pos) \
18401 max_pos = current_pos; \
18402 max_bpos = current_bpos; \
18407 /* Loop generating characters. The loop is left with IT on the next
18408 character to display. */
18411 int n_glyphs_before
, hpos_before
, x_before
;
18413 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18415 /* Retrieve the next thing to display. Value is zero if end of
18417 if (!get_next_display_element (it
))
18419 /* Maybe add a space at the end of this line that is used to
18420 display the cursor there under X. Set the charpos of the
18421 first glyph of blank lines not corresponding to any text
18423 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18424 row
->exact_window_width_line_p
= 1;
18425 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18426 || row
->used
[TEXT_AREA
] == 0)
18428 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18429 row
->displays_text_p
= 0;
18431 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18432 && (!MINI_WINDOW_P (it
->w
)
18433 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18434 row
->indicate_empty_line_p
= 1;
18437 it
->continuation_lines_width
= 0;
18438 row
->ends_at_zv_p
= 1;
18439 /* A row that displays right-to-left text must always have
18440 its last face extended all the way to the end of line,
18441 even if this row ends in ZV, because we still write to
18442 the screen left to right. */
18443 if (row
->reversed_p
)
18444 extend_face_to_end_of_line (it
);
18448 /* Now, get the metrics of what we want to display. This also
18449 generates glyphs in `row' (which is IT->glyph_row). */
18450 n_glyphs_before
= row
->used
[TEXT_AREA
];
18453 /* Remember the line height so far in case the next element doesn't
18454 fit on the line. */
18455 if (it
->line_wrap
!= TRUNCATE
)
18457 ascent
= it
->max_ascent
;
18458 descent
= it
->max_descent
;
18459 phys_ascent
= it
->max_phys_ascent
;
18460 phys_descent
= it
->max_phys_descent
;
18462 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18464 if (IT_DISPLAYING_WHITESPACE (it
))
18468 SAVE_IT (wrap_it
, *it
, wrap_data
);
18470 wrap_row_used
= row
->used
[TEXT_AREA
];
18471 wrap_row_ascent
= row
->ascent
;
18472 wrap_row_height
= row
->height
;
18473 wrap_row_phys_ascent
= row
->phys_ascent
;
18474 wrap_row_phys_height
= row
->phys_height
;
18475 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18476 wrap_row_min_pos
= min_pos
;
18477 wrap_row_min_bpos
= min_bpos
;
18478 wrap_row_max_pos
= max_pos
;
18479 wrap_row_max_bpos
= max_bpos
;
18485 PRODUCE_GLYPHS (it
);
18487 /* If this display element was in marginal areas, continue with
18489 if (it
->area
!= TEXT_AREA
)
18491 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18492 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18493 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18494 row
->phys_height
= max (row
->phys_height
,
18495 it
->max_phys_ascent
+ it
->max_phys_descent
);
18496 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18497 it
->max_extra_line_spacing
);
18498 set_iterator_to_next (it
, 1);
18502 /* Does the display element fit on the line? If we truncate
18503 lines, we should draw past the right edge of the window. If
18504 we don't truncate, we want to stop so that we can display the
18505 continuation glyph before the right margin. If lines are
18506 continued, there are two possible strategies for characters
18507 resulting in more than 1 glyph (e.g. tabs): Display as many
18508 glyphs as possible in this line and leave the rest for the
18509 continuation line, or display the whole element in the next
18510 line. Original redisplay did the former, so we do it also. */
18511 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18512 hpos_before
= it
->hpos
;
18515 if (/* Not a newline. */
18517 /* Glyphs produced fit entirely in the line. */
18518 && it
->current_x
< it
->last_visible_x
)
18520 it
->hpos
+= nglyphs
;
18521 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18522 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18523 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18524 row
->phys_height
= max (row
->phys_height
,
18525 it
->max_phys_ascent
+ it
->max_phys_descent
);
18526 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18527 it
->max_extra_line_spacing
);
18528 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
18529 row
->x
= x
- it
->first_visible_x
;
18530 /* Record the maximum and minimum buffer positions seen so
18531 far in glyphs that will be displayed by this row. */
18533 RECORD_MAX_MIN_POS (it
);
18538 struct glyph
*glyph
;
18540 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
18542 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
18543 new_x
= x
+ glyph
->pixel_width
;
18545 if (/* Lines are continued. */
18546 it
->line_wrap
!= TRUNCATE
18547 && (/* Glyph doesn't fit on the line. */
18548 new_x
> it
->last_visible_x
18549 /* Or it fits exactly on a window system frame. */
18550 || (new_x
== it
->last_visible_x
18551 && FRAME_WINDOW_P (it
->f
))))
18553 /* End of a continued line. */
18556 || (new_x
== it
->last_visible_x
18557 && FRAME_WINDOW_P (it
->f
)))
18559 /* Current glyph is the only one on the line or
18560 fits exactly on the line. We must continue
18561 the line because we can't draw the cursor
18562 after the glyph. */
18563 row
->continued_p
= 1;
18564 it
->current_x
= new_x
;
18565 it
->continuation_lines_width
+= new_x
;
18567 /* Record the maximum and minimum buffer
18568 positions seen so far in glyphs that will be
18569 displayed by this row. */
18571 RECORD_MAX_MIN_POS (it
);
18572 if (i
== nglyphs
- 1)
18574 /* If line-wrap is on, check if a previous
18575 wrap point was found. */
18576 if (wrap_row_used
> 0
18577 /* Even if there is a previous wrap
18578 point, continue the line here as
18579 usual, if (i) the previous character
18580 was a space or tab AND (ii) the
18581 current character is not. */
18583 || IT_DISPLAYING_WHITESPACE (it
)))
18586 set_iterator_to_next (it
, 1);
18587 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18589 if (!get_next_display_element (it
))
18591 row
->exact_window_width_line_p
= 1;
18592 it
->continuation_lines_width
= 0;
18593 row
->continued_p
= 0;
18594 row
->ends_at_zv_p
= 1;
18596 else if (ITERATOR_AT_END_OF_LINE_P (it
))
18598 row
->continued_p
= 0;
18599 row
->exact_window_width_line_p
= 1;
18604 else if (CHAR_GLYPH_PADDING_P (*glyph
)
18605 && !FRAME_WINDOW_P (it
->f
))
18607 /* A padding glyph that doesn't fit on this line.
18608 This means the whole character doesn't fit
18610 if (row
->reversed_p
)
18611 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18612 - n_glyphs_before
);
18613 row
->used
[TEXT_AREA
] = n_glyphs_before
;
18615 /* Fill the rest of the row with continuation
18616 glyphs like in 20.x. */
18617 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
18618 < row
->glyphs
[1 + TEXT_AREA
])
18619 produce_special_glyphs (it
, IT_CONTINUATION
);
18621 row
->continued_p
= 1;
18622 it
->current_x
= x_before
;
18623 it
->continuation_lines_width
+= x_before
;
18625 /* Restore the height to what it was before the
18626 element not fitting on the line. */
18627 it
->max_ascent
= ascent
;
18628 it
->max_descent
= descent
;
18629 it
->max_phys_ascent
= phys_ascent
;
18630 it
->max_phys_descent
= phys_descent
;
18632 else if (wrap_row_used
> 0)
18635 if (row
->reversed_p
)
18636 unproduce_glyphs (it
,
18637 row
->used
[TEXT_AREA
] - wrap_row_used
);
18638 RESTORE_IT (it
, &wrap_it
, wrap_data
);
18639 it
->continuation_lines_width
+= wrap_x
;
18640 row
->used
[TEXT_AREA
] = wrap_row_used
;
18641 row
->ascent
= wrap_row_ascent
;
18642 row
->height
= wrap_row_height
;
18643 row
->phys_ascent
= wrap_row_phys_ascent
;
18644 row
->phys_height
= wrap_row_phys_height
;
18645 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
18646 min_pos
= wrap_row_min_pos
;
18647 min_bpos
= wrap_row_min_bpos
;
18648 max_pos
= wrap_row_max_pos
;
18649 max_bpos
= wrap_row_max_bpos
;
18650 row
->continued_p
= 1;
18651 row
->ends_at_zv_p
= 0;
18652 row
->exact_window_width_line_p
= 0;
18653 it
->continuation_lines_width
+= x
;
18655 /* Make sure that a non-default face is extended
18656 up to the right margin of the window. */
18657 extend_face_to_end_of_line (it
);
18659 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
18661 /* A TAB that extends past the right edge of the
18662 window. This produces a single glyph on
18663 window system frames. We leave the glyph in
18664 this row and let it fill the row, but don't
18665 consume the TAB. */
18666 it
->continuation_lines_width
+= it
->last_visible_x
;
18667 row
->ends_in_middle_of_char_p
= 1;
18668 row
->continued_p
= 1;
18669 glyph
->pixel_width
= it
->last_visible_x
- x
;
18670 it
->starts_in_middle_of_char_p
= 1;
18674 /* Something other than a TAB that draws past
18675 the right edge of the window. Restore
18676 positions to values before the element. */
18677 if (row
->reversed_p
)
18678 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
18679 - (n_glyphs_before
+ i
));
18680 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
18682 /* Display continuation glyphs. */
18683 if (!FRAME_WINDOW_P (it
->f
))
18684 produce_special_glyphs (it
, IT_CONTINUATION
);
18685 row
->continued_p
= 1;
18687 it
->current_x
= x_before
;
18688 it
->continuation_lines_width
+= x
;
18689 extend_face_to_end_of_line (it
);
18691 if (nglyphs
> 1 && i
> 0)
18693 row
->ends_in_middle_of_char_p
= 1;
18694 it
->starts_in_middle_of_char_p
= 1;
18697 /* Restore the height to what it was before the
18698 element not fitting on the line. */
18699 it
->max_ascent
= ascent
;
18700 it
->max_descent
= descent
;
18701 it
->max_phys_ascent
= phys_ascent
;
18702 it
->max_phys_descent
= phys_descent
;
18707 else if (new_x
> it
->first_visible_x
)
18709 /* Increment number of glyphs actually displayed. */
18712 /* Record the maximum and minimum buffer positions
18713 seen so far in glyphs that will be displayed by
18716 RECORD_MAX_MIN_POS (it
);
18718 if (x
< it
->first_visible_x
)
18719 /* Glyph is partially visible, i.e. row starts at
18720 negative X position. */
18721 row
->x
= x
- it
->first_visible_x
;
18725 /* Glyph is completely off the left margin of the
18726 window. This should not happen because of the
18727 move_it_in_display_line at the start of this
18728 function, unless the text display area of the
18729 window is empty. */
18730 xassert (it
->first_visible_x
<= it
->last_visible_x
);
18734 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18735 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18736 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18737 row
->phys_height
= max (row
->phys_height
,
18738 it
->max_phys_ascent
+ it
->max_phys_descent
);
18739 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18740 it
->max_extra_line_spacing
);
18742 /* End of this display line if row is continued. */
18743 if (row
->continued_p
|| row
->ends_at_zv_p
)
18748 /* Is this a line end? If yes, we're also done, after making
18749 sure that a non-default face is extended up to the right
18750 margin of the window. */
18751 if (ITERATOR_AT_END_OF_LINE_P (it
))
18753 int used_before
= row
->used
[TEXT_AREA
];
18755 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
18757 /* Add a space at the end of the line that is used to
18758 display the cursor there. */
18759 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18760 append_space_for_newline (it
, 0);
18762 /* Extend the face to the end of the line. */
18763 extend_face_to_end_of_line (it
);
18765 /* Make sure we have the position. */
18766 if (used_before
== 0)
18767 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
18769 /* Record the position of the newline, for use in
18771 it
->eol_pos
= it
->current
.pos
;
18773 /* Consume the line end. This skips over invisible lines. */
18774 set_iterator_to_next (it
, 1);
18775 it
->continuation_lines_width
= 0;
18779 /* Proceed with next display element. Note that this skips
18780 over lines invisible because of selective display. */
18781 set_iterator_to_next (it
, 1);
18783 /* If we truncate lines, we are done when the last displayed
18784 glyphs reach past the right margin of the window. */
18785 if (it
->line_wrap
== TRUNCATE
18786 && (FRAME_WINDOW_P (it
->f
)
18787 ? (it
->current_x
>= it
->last_visible_x
)
18788 : (it
->current_x
> it
->last_visible_x
)))
18790 /* Maybe add truncation glyphs. */
18791 if (!FRAME_WINDOW_P (it
->f
))
18795 if (!row
->reversed_p
)
18797 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
18798 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18803 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
18804 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
18806 /* Remove any padding glyphs at the front of ROW, to
18807 make room for the truncation glyphs we will be
18808 adding below. The loop below always inserts at
18809 least one truncation glyph, so also remove the
18810 last glyph added to ROW. */
18811 unproduce_glyphs (it
, i
+ 1);
18812 /* Adjust i for the loop below. */
18813 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
18816 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
18818 row
->used
[TEXT_AREA
] = i
;
18819 produce_special_glyphs (it
, IT_TRUNCATION
);
18822 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18824 /* Don't truncate if we can overflow newline into fringe. */
18825 if (!get_next_display_element (it
))
18827 it
->continuation_lines_width
= 0;
18828 row
->ends_at_zv_p
= 1;
18829 row
->exact_window_width_line_p
= 1;
18832 if (ITERATOR_AT_END_OF_LINE_P (it
))
18834 row
->exact_window_width_line_p
= 1;
18835 goto at_end_of_line
;
18839 row
->truncated_on_right_p
= 1;
18840 it
->continuation_lines_width
= 0;
18841 reseat_at_next_visible_line_start (it
, 0);
18842 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
18843 it
->hpos
= hpos_before
;
18844 it
->current_x
= x_before
;
18850 bidi_unshelve_cache (wrap_data
, 1);
18852 /* If line is not empty and hscrolled, maybe insert truncation glyphs
18853 at the left window margin. */
18854 if (it
->first_visible_x
18855 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
18857 if (!FRAME_WINDOW_P (it
->f
))
18858 insert_left_trunc_glyphs (it
);
18859 row
->truncated_on_left_p
= 1;
18862 /* Remember the position at which this line ends.
18864 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
18865 cannot be before the call to find_row_edges below, since that is
18866 where these positions are determined. */
18867 row
->end
= it
->current
;
18870 row
->minpos
= row
->start
.pos
;
18871 row
->maxpos
= row
->end
.pos
;
18875 /* ROW->minpos and ROW->maxpos must be the smallest and
18876 `1 + the largest' buffer positions in ROW. But if ROW was
18877 bidi-reordered, these two positions can be anywhere in the
18878 row, so we must determine them now. */
18879 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
18882 /* If the start of this line is the overlay arrow-position, then
18883 mark this glyph row as the one containing the overlay arrow.
18884 This is clearly a mess with variable size fonts. It would be
18885 better to let it be displayed like cursors under X. */
18886 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
18887 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
18888 !NILP (overlay_arrow_string
)))
18890 /* Overlay arrow in window redisplay is a fringe bitmap. */
18891 if (STRINGP (overlay_arrow_string
))
18893 struct glyph_row
*arrow_row
18894 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
18895 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
18896 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
18897 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
18898 struct glyph
*p2
, *end
;
18900 /* Copy the arrow glyphs. */
18901 while (glyph
< arrow_end
)
18904 /* Throw away padding glyphs. */
18906 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
18907 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
18913 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
18918 xassert (INTEGERP (overlay_arrow_string
));
18919 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
18921 overlay_arrow_seen
= 1;
18924 /* Compute pixel dimensions of this line. */
18925 compute_line_metrics (it
);
18927 /* Record whether this row ends inside an ellipsis. */
18928 row
->ends_in_ellipsis_p
18929 = (it
->method
== GET_FROM_DISPLAY_VECTOR
18930 && it
->ellipsis_p
);
18932 /* Save fringe bitmaps in this row. */
18933 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
18934 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
18935 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
18936 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
18938 it
->left_user_fringe_bitmap
= 0;
18939 it
->left_user_fringe_face_id
= 0;
18940 it
->right_user_fringe_bitmap
= 0;
18941 it
->right_user_fringe_face_id
= 0;
18943 /* Maybe set the cursor. */
18944 cvpos
= it
->w
->cursor
.vpos
;
18946 /* In bidi-reordered rows, keep checking for proper cursor
18947 position even if one has been found already, because buffer
18948 positions in such rows change non-linearly with ROW->VPOS,
18949 when a line is continued. One exception: when we are at ZV,
18950 display cursor on the first suitable glyph row, since all
18951 the empty rows after that also have their position set to ZV. */
18952 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18953 lines' rows is implemented for bidi-reordered rows. */
18955 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
18956 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
18957 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
18958 && cursor_row_p (row
))
18959 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
18961 /* Highlight trailing whitespace. */
18962 if (!NILP (Vshow_trailing_whitespace
))
18963 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
18965 /* Prepare for the next line. This line starts horizontally at (X
18966 HPOS) = (0 0). Vertical positions are incremented. As a
18967 convenience for the caller, IT->glyph_row is set to the next
18969 it
->current_x
= it
->hpos
= 0;
18970 it
->current_y
+= row
->height
;
18971 SET_TEXT_POS (it
->eol_pos
, 0, 0);
18974 /* The next row should by default use the same value of the
18975 reversed_p flag as this one. set_iterator_to_next decides when
18976 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
18977 the flag accordingly. */
18978 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
18979 it
->glyph_row
->reversed_p
= row
->reversed_p
;
18980 it
->start
= row
->end
;
18981 return row
->displays_text_p
;
18983 #undef RECORD_MAX_MIN_POS
18986 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
18987 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
18988 doc
: /* Return paragraph direction at point in BUFFER.
18989 Value is either `left-to-right' or `right-to-left'.
18990 If BUFFER is omitted or nil, it defaults to the current buffer.
18992 Paragraph direction determines how the text in the paragraph is displayed.
18993 In left-to-right paragraphs, text begins at the left margin of the window
18994 and the reading direction is generally left to right. In right-to-left
18995 paragraphs, text begins at the right margin and is read from right to left.
18997 See also `bidi-paragraph-direction'. */)
18998 (Lisp_Object buffer
)
19000 struct buffer
*buf
= current_buffer
;
19001 struct buffer
*old
= buf
;
19003 if (! NILP (buffer
))
19005 CHECK_BUFFER (buffer
);
19006 buf
= XBUFFER (buffer
);
19009 if (NILP (BVAR (buf
, bidi_display_reordering
)))
19010 return Qleft_to_right
;
19011 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19012 return BVAR (buf
, bidi_paragraph_direction
);
19015 /* Determine the direction from buffer text. We could try to
19016 use current_matrix if it is up to date, but this seems fast
19017 enough as it is. */
19018 struct bidi_it itb
;
19019 EMACS_INT pos
= BUF_PT (buf
);
19020 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19023 set_buffer_temp (buf
);
19024 /* bidi_paragraph_init finds the base direction of the paragraph
19025 by searching forward from paragraph start. We need the base
19026 direction of the current or _previous_ paragraph, so we need
19027 to make sure we are within that paragraph. To that end, find
19028 the previous non-empty line. */
19029 if (pos
>= ZV
&& pos
> BEGV
)
19032 bytepos
= CHAR_TO_BYTE (pos
);
19034 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19035 || c
== ' ' || c
== '\t' || c
== '\f')
19037 if (bytepos
<= BEGV_BYTE
)
19042 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19045 itb
.bytepos
= bytepos
;
19047 itb
.string
.s
= NULL
;
19048 itb
.string
.lstring
= Qnil
;
19049 itb
.frame_window_p
= FRAME_WINDOW_P (SELECTED_FRAME ()); /* guesswork */
19051 itb
.separator_limit
= -1;
19052 itb
.paragraph_dir
= NEUTRAL_DIR
;
19054 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19055 set_buffer_temp (old
);
19056 switch (itb
.paragraph_dir
)
19059 return Qleft_to_right
;
19062 return Qright_to_left
;
19072 /***********************************************************************
19074 ***********************************************************************/
19076 /* Redisplay the menu bar in the frame for window W.
19078 The menu bar of X frames that don't have X toolkit support is
19079 displayed in a special window W->frame->menu_bar_window.
19081 The menu bar of terminal frames is treated specially as far as
19082 glyph matrices are concerned. Menu bar lines are not part of
19083 windows, so the update is done directly on the frame matrix rows
19084 for the menu bar. */
19087 display_menu_bar (struct window
*w
)
19089 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19094 /* Don't do all this for graphical frames. */
19096 if (FRAME_W32_P (f
))
19099 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19105 if (FRAME_NS_P (f
))
19107 #endif /* HAVE_NS */
19109 #ifdef USE_X_TOOLKIT
19110 xassert (!FRAME_WINDOW_P (f
));
19111 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19112 it
.first_visible_x
= 0;
19113 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19114 #else /* not USE_X_TOOLKIT */
19115 if (FRAME_WINDOW_P (f
))
19117 /* Menu bar lines are displayed in the desired matrix of the
19118 dummy window menu_bar_window. */
19119 struct window
*menu_w
;
19120 xassert (WINDOWP (f
->menu_bar_window
));
19121 menu_w
= XWINDOW (f
->menu_bar_window
);
19122 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19124 it
.first_visible_x
= 0;
19125 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19129 /* This is a TTY frame, i.e. character hpos/vpos are used as
19131 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19133 it
.first_visible_x
= 0;
19134 it
.last_visible_x
= FRAME_COLS (f
);
19136 #endif /* not USE_X_TOOLKIT */
19138 /* FIXME: This should be controlled by a user option. See the
19139 comments in redisplay_tool_bar and display_mode_line about
19141 it
.paragraph_embedding
= L2R
;
19143 if (! mode_line_inverse_video
)
19144 /* Force the menu-bar to be displayed in the default face. */
19145 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19147 /* Clear all rows of the menu bar. */
19148 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19150 struct glyph_row
*row
= it
.glyph_row
+ i
;
19151 clear_glyph_row (row
);
19152 row
->enabled_p
= 1;
19153 row
->full_width_p
= 1;
19156 /* Display all items of the menu bar. */
19157 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19158 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19160 Lisp_Object string
;
19162 /* Stop at nil string. */
19163 string
= AREF (items
, i
+ 1);
19167 /* Remember where item was displayed. */
19168 ASET (items
, i
+ 3, make_number (it
.hpos
));
19170 /* Display the item, pad with one space. */
19171 if (it
.current_x
< it
.last_visible_x
)
19172 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19173 SCHARS (string
) + 1, 0, 0, -1);
19176 /* Fill out the line with spaces. */
19177 if (it
.current_x
< it
.last_visible_x
)
19178 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19180 /* Compute the total height of the lines. */
19181 compute_line_metrics (&it
);
19186 /***********************************************************************
19188 ***********************************************************************/
19190 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19191 FORCE is non-zero, redisplay mode lines unconditionally.
19192 Otherwise, redisplay only mode lines that are garbaged. Value is
19193 the number of windows whose mode lines were redisplayed. */
19196 redisplay_mode_lines (Lisp_Object window
, int force
)
19200 while (!NILP (window
))
19202 struct window
*w
= XWINDOW (window
);
19204 if (WINDOWP (w
->hchild
))
19205 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19206 else if (WINDOWP (w
->vchild
))
19207 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19209 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19210 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19212 struct text_pos lpoint
;
19213 struct buffer
*old
= current_buffer
;
19215 /* Set the window's buffer for the mode line display. */
19216 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19217 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19219 /* Point refers normally to the selected window. For any
19220 other window, set up appropriate value. */
19221 if (!EQ (window
, selected_window
))
19223 struct text_pos pt
;
19225 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19226 if (CHARPOS (pt
) < BEGV
)
19227 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19228 else if (CHARPOS (pt
) > (ZV
- 1))
19229 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19231 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19234 /* Display mode lines. */
19235 clear_glyph_matrix (w
->desired_matrix
);
19236 if (display_mode_lines (w
))
19239 w
->must_be_updated_p
= 1;
19242 /* Restore old settings. */
19243 set_buffer_internal_1 (old
);
19244 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19254 /* Display the mode and/or header line of window W. Value is the
19255 sum number of mode lines and header lines displayed. */
19258 display_mode_lines (struct window
*w
)
19260 Lisp_Object old_selected_window
, old_selected_frame
;
19263 old_selected_frame
= selected_frame
;
19264 selected_frame
= w
->frame
;
19265 old_selected_window
= selected_window
;
19266 XSETWINDOW (selected_window
, w
);
19268 /* These will be set while the mode line specs are processed. */
19269 line_number_displayed
= 0;
19270 w
->column_number_displayed
= Qnil
;
19272 if (WINDOW_WANTS_MODELINE_P (w
))
19274 struct window
*sel_w
= XWINDOW (old_selected_window
);
19276 /* Select mode line face based on the real selected window. */
19277 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19278 BVAR (current_buffer
, mode_line_format
));
19282 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19284 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19285 BVAR (current_buffer
, header_line_format
));
19289 selected_frame
= old_selected_frame
;
19290 selected_window
= old_selected_window
;
19295 /* Display mode or header line of window W. FACE_ID specifies which
19296 line to display; it is either MODE_LINE_FACE_ID or
19297 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19298 display. Value is the pixel height of the mode/header line
19302 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19306 int count
= SPECPDL_INDEX ();
19308 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19309 /* Don't extend on a previously drawn mode-line.
19310 This may happen if called from pos_visible_p. */
19311 it
.glyph_row
->enabled_p
= 0;
19312 prepare_desired_row (it
.glyph_row
);
19314 it
.glyph_row
->mode_line_p
= 1;
19316 if (! mode_line_inverse_video
)
19317 /* Force the mode-line to be displayed in the default face. */
19318 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19320 /* FIXME: This should be controlled by a user option. But
19321 supporting such an option is not trivial, since the mode line is
19322 made up of many separate strings. */
19323 it
.paragraph_embedding
= L2R
;
19325 record_unwind_protect (unwind_format_mode_line
,
19326 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19328 mode_line_target
= MODE_LINE_DISPLAY
;
19330 /* Temporarily make frame's keyboard the current kboard so that
19331 kboard-local variables in the mode_line_format will get the right
19333 push_kboard (FRAME_KBOARD (it
.f
));
19334 record_unwind_save_match_data ();
19335 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19338 unbind_to (count
, Qnil
);
19340 /* Fill up with spaces. */
19341 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19343 compute_line_metrics (&it
);
19344 it
.glyph_row
->full_width_p
= 1;
19345 it
.glyph_row
->continued_p
= 0;
19346 it
.glyph_row
->truncated_on_left_p
= 0;
19347 it
.glyph_row
->truncated_on_right_p
= 0;
19349 /* Make a 3D mode-line have a shadow at its right end. */
19350 face
= FACE_FROM_ID (it
.f
, face_id
);
19351 extend_face_to_end_of_line (&it
);
19352 if (face
->box
!= FACE_NO_BOX
)
19354 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19355 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19356 last
->right_box_line_p
= 1;
19359 return it
.glyph_row
->height
;
19362 /* Move element ELT in LIST to the front of LIST.
19363 Return the updated list. */
19366 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19368 register Lisp_Object tail
, prev
;
19369 register Lisp_Object tem
;
19373 while (CONSP (tail
))
19379 /* Splice out the link TAIL. */
19381 list
= XCDR (tail
);
19383 Fsetcdr (prev
, XCDR (tail
));
19385 /* Now make it the first. */
19386 Fsetcdr (tail
, list
);
19391 tail
= XCDR (tail
);
19395 /* Not found--return unchanged LIST. */
19399 /* Contribute ELT to the mode line for window IT->w. How it
19400 translates into text depends on its data type.
19402 IT describes the display environment in which we display, as usual.
19404 DEPTH is the depth in recursion. It is used to prevent
19405 infinite recursion here.
19407 FIELD_WIDTH is the number of characters the display of ELT should
19408 occupy in the mode line, and PRECISION is the maximum number of
19409 characters to display from ELT's representation. See
19410 display_string for details.
19412 Returns the hpos of the end of the text generated by ELT.
19414 PROPS is a property list to add to any string we encounter.
19416 If RISKY is nonzero, remove (disregard) any properties in any string
19417 we encounter, and ignore :eval and :propertize.
19419 The global variable `mode_line_target' determines whether the
19420 output is passed to `store_mode_line_noprop',
19421 `store_mode_line_string', or `display_string'. */
19424 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19425 Lisp_Object elt
, Lisp_Object props
, int risky
)
19427 int n
= 0, field
, prec
;
19432 elt
= build_string ("*too-deep*");
19436 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19440 /* A string: output it and check for %-constructs within it. */
19442 EMACS_INT offset
= 0;
19444 if (SCHARS (elt
) > 0
19445 && (!NILP (props
) || risky
))
19447 Lisp_Object oprops
, aelt
;
19448 oprops
= Ftext_properties_at (make_number (0), elt
);
19450 /* If the starting string's properties are not what
19451 we want, translate the string. Also, if the string
19452 is risky, do that anyway. */
19454 if (NILP (Fequal (props
, oprops
)) || risky
)
19456 /* If the starting string has properties,
19457 merge the specified ones onto the existing ones. */
19458 if (! NILP (oprops
) && !risky
)
19462 oprops
= Fcopy_sequence (oprops
);
19464 while (CONSP (tem
))
19466 oprops
= Fplist_put (oprops
, XCAR (tem
),
19467 XCAR (XCDR (tem
)));
19468 tem
= XCDR (XCDR (tem
));
19473 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19474 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19476 /* AELT is what we want. Move it to the front
19477 without consing. */
19479 mode_line_proptrans_alist
19480 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19486 /* If AELT has the wrong props, it is useless.
19487 so get rid of it. */
19489 mode_line_proptrans_alist
19490 = Fdelq (aelt
, mode_line_proptrans_alist
);
19492 elt
= Fcopy_sequence (elt
);
19493 Fset_text_properties (make_number (0), Flength (elt
),
19495 /* Add this item to mode_line_proptrans_alist. */
19496 mode_line_proptrans_alist
19497 = Fcons (Fcons (elt
, props
),
19498 mode_line_proptrans_alist
);
19499 /* Truncate mode_line_proptrans_alist
19500 to at most 50 elements. */
19501 tem
= Fnthcdr (make_number (50),
19502 mode_line_proptrans_alist
);
19504 XSETCDR (tem
, Qnil
);
19513 prec
= precision
- n
;
19514 switch (mode_line_target
)
19516 case MODE_LINE_NOPROP
:
19517 case MODE_LINE_TITLE
:
19518 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
19520 case MODE_LINE_STRING
:
19521 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
19523 case MODE_LINE_DISPLAY
:
19524 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
19525 0, prec
, 0, STRING_MULTIBYTE (elt
));
19532 /* Handle the non-literal case. */
19534 while ((precision
<= 0 || n
< precision
)
19535 && SREF (elt
, offset
) != 0
19536 && (mode_line_target
!= MODE_LINE_DISPLAY
19537 || it
->current_x
< it
->last_visible_x
))
19539 EMACS_INT last_offset
= offset
;
19541 /* Advance to end of string or next format specifier. */
19542 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
19545 if (offset
- 1 != last_offset
)
19547 EMACS_INT nchars
, nbytes
;
19549 /* Output to end of string or up to '%'. Field width
19550 is length of string. Don't output more than
19551 PRECISION allows us. */
19554 prec
= c_string_width (SDATA (elt
) + last_offset
,
19555 offset
- last_offset
, precision
- n
,
19558 switch (mode_line_target
)
19560 case MODE_LINE_NOPROP
:
19561 case MODE_LINE_TITLE
:
19562 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
19564 case MODE_LINE_STRING
:
19566 EMACS_INT bytepos
= last_offset
;
19567 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19568 EMACS_INT endpos
= (precision
<= 0
19569 ? string_byte_to_char (elt
, offset
)
19570 : charpos
+ nchars
);
19572 n
+= store_mode_line_string (NULL
,
19573 Fsubstring (elt
, make_number (charpos
),
19574 make_number (endpos
)),
19578 case MODE_LINE_DISPLAY
:
19580 EMACS_INT bytepos
= last_offset
;
19581 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
19583 if (precision
<= 0)
19584 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
19585 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
19587 STRING_MULTIBYTE (elt
));
19592 else /* c == '%' */
19594 EMACS_INT percent_position
= offset
;
19596 /* Get the specified minimum width. Zero means
19599 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
19600 field
= field
* 10 + c
- '0';
19602 /* Don't pad beyond the total padding allowed. */
19603 if (field_width
- n
> 0 && field
> field_width
- n
)
19604 field
= field_width
- n
;
19606 /* Note that either PRECISION <= 0 or N < PRECISION. */
19607 prec
= precision
- n
;
19610 n
+= display_mode_element (it
, depth
, field
, prec
,
19611 Vglobal_mode_string
, props
,
19616 EMACS_INT bytepos
, charpos
;
19618 Lisp_Object string
;
19620 bytepos
= percent_position
;
19621 charpos
= (STRING_MULTIBYTE (elt
)
19622 ? string_byte_to_char (elt
, bytepos
)
19624 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
19625 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
19627 switch (mode_line_target
)
19629 case MODE_LINE_NOPROP
:
19630 case MODE_LINE_TITLE
:
19631 n
+= store_mode_line_noprop (spec
, field
, prec
);
19633 case MODE_LINE_STRING
:
19635 Lisp_Object tem
= build_string (spec
);
19636 props
= Ftext_properties_at (make_number (charpos
), elt
);
19637 /* Should only keep face property in props */
19638 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
19641 case MODE_LINE_DISPLAY
:
19643 int nglyphs_before
, nwritten
;
19645 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
19646 nwritten
= display_string (spec
, string
, elt
,
19651 /* Assign to the glyphs written above the
19652 string where the `%x' came from, position
19656 struct glyph
*glyph
19657 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
19661 for (i
= 0; i
< nwritten
; ++i
)
19663 glyph
[i
].object
= elt
;
19664 glyph
[i
].charpos
= charpos
;
19681 /* A symbol: process the value of the symbol recursively
19682 as if it appeared here directly. Avoid error if symbol void.
19683 Special case: if value of symbol is a string, output the string
19686 register Lisp_Object tem
;
19688 /* If the variable is not marked as risky to set
19689 then its contents are risky to use. */
19690 if (NILP (Fget (elt
, Qrisky_local_variable
)))
19693 tem
= Fboundp (elt
);
19696 tem
= Fsymbol_value (elt
);
19697 /* If value is a string, output that string literally:
19698 don't check for % within it. */
19702 if (!EQ (tem
, elt
))
19704 /* Give up right away for nil or t. */
19714 register Lisp_Object car
, tem
;
19716 /* A cons cell: five distinct cases.
19717 If first element is :eval or :propertize, do something special.
19718 If first element is a string or a cons, process all the elements
19719 and effectively concatenate them.
19720 If first element is a negative number, truncate displaying cdr to
19721 at most that many characters. If positive, pad (with spaces)
19722 to at least that many characters.
19723 If first element is a symbol, process the cadr or caddr recursively
19724 according to whether the symbol's value is non-nil or nil. */
19726 if (EQ (car
, QCeval
))
19728 /* An element of the form (:eval FORM) means evaluate FORM
19729 and use the result as mode line elements. */
19734 if (CONSP (XCDR (elt
)))
19737 spec
= safe_eval (XCAR (XCDR (elt
)));
19738 n
+= display_mode_element (it
, depth
, field_width
- n
,
19739 precision
- n
, spec
, props
,
19743 else if (EQ (car
, QCpropertize
))
19745 /* An element of the form (:propertize ELT PROPS...)
19746 means display ELT but applying properties PROPS. */
19751 if (CONSP (XCDR (elt
)))
19752 n
+= display_mode_element (it
, depth
, field_width
- n
,
19753 precision
- n
, XCAR (XCDR (elt
)),
19754 XCDR (XCDR (elt
)), risky
);
19756 else if (SYMBOLP (car
))
19758 tem
= Fboundp (car
);
19762 /* elt is now the cdr, and we know it is a cons cell.
19763 Use its car if CAR has a non-nil value. */
19766 tem
= Fsymbol_value (car
);
19773 /* Symbol's value is nil (or symbol is unbound)
19774 Get the cddr of the original list
19775 and if possible find the caddr and use that. */
19779 else if (!CONSP (elt
))
19784 else if (INTEGERP (car
))
19786 register int lim
= XINT (car
);
19790 /* Negative int means reduce maximum width. */
19791 if (precision
<= 0)
19794 precision
= min (precision
, -lim
);
19798 /* Padding specified. Don't let it be more than
19799 current maximum. */
19801 lim
= min (precision
, lim
);
19803 /* If that's more padding than already wanted, queue it.
19804 But don't reduce padding already specified even if
19805 that is beyond the current truncation point. */
19806 field_width
= max (lim
, field_width
);
19810 else if (STRINGP (car
) || CONSP (car
))
19812 Lisp_Object halftail
= elt
;
19816 && (precision
<= 0 || n
< precision
))
19818 n
+= display_mode_element (it
, depth
,
19819 /* Do padding only after the last
19820 element in the list. */
19821 (! CONSP (XCDR (elt
))
19824 precision
- n
, XCAR (elt
),
19828 if ((len
& 1) == 0)
19829 halftail
= XCDR (halftail
);
19830 /* Check for cycle. */
19831 if (EQ (halftail
, elt
))
19840 elt
= build_string ("*invalid*");
19844 /* Pad to FIELD_WIDTH. */
19845 if (field_width
> 0 && n
< field_width
)
19847 switch (mode_line_target
)
19849 case MODE_LINE_NOPROP
:
19850 case MODE_LINE_TITLE
:
19851 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
19853 case MODE_LINE_STRING
:
19854 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
19856 case MODE_LINE_DISPLAY
:
19857 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
19866 /* Store a mode-line string element in mode_line_string_list.
19868 If STRING is non-null, display that C string. Otherwise, the Lisp
19869 string LISP_STRING is displayed.
19871 FIELD_WIDTH is the minimum number of output glyphs to produce.
19872 If STRING has fewer characters than FIELD_WIDTH, pad to the right
19873 with spaces. FIELD_WIDTH <= 0 means don't pad.
19875 PRECISION is the maximum number of characters to output from
19876 STRING. PRECISION <= 0 means don't truncate the string.
19878 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
19879 properties to the string.
19881 PROPS are the properties to add to the string.
19882 The mode_line_string_face face property is always added to the string.
19886 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
19887 int field_width
, int precision
, Lisp_Object props
)
19892 if (string
!= NULL
)
19894 len
= strlen (string
);
19895 if (precision
> 0 && len
> precision
)
19897 lisp_string
= make_string (string
, len
);
19899 props
= mode_line_string_face_prop
;
19900 else if (!NILP (mode_line_string_face
))
19902 Lisp_Object face
= Fplist_get (props
, Qface
);
19903 props
= Fcopy_sequence (props
);
19905 face
= mode_line_string_face
;
19907 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19908 props
= Fplist_put (props
, Qface
, face
);
19910 Fadd_text_properties (make_number (0), make_number (len
),
19911 props
, lisp_string
);
19915 len
= XFASTINT (Flength (lisp_string
));
19916 if (precision
> 0 && len
> precision
)
19919 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
19922 if (!NILP (mode_line_string_face
))
19926 props
= Ftext_properties_at (make_number (0), lisp_string
);
19927 face
= Fplist_get (props
, Qface
);
19929 face
= mode_line_string_face
;
19931 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
19932 props
= Fcons (Qface
, Fcons (face
, Qnil
));
19934 lisp_string
= Fcopy_sequence (lisp_string
);
19937 Fadd_text_properties (make_number (0), make_number (len
),
19938 props
, lisp_string
);
19943 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19947 if (field_width
> len
)
19949 field_width
-= len
;
19950 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
19952 Fadd_text_properties (make_number (0), make_number (field_width
),
19953 props
, lisp_string
);
19954 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
19962 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
19964 doc
: /* Format a string out of a mode line format specification.
19965 First arg FORMAT specifies the mode line format (see `mode-line-format'
19966 for details) to use.
19968 By default, the format is evaluated for the currently selected window.
19970 Optional second arg FACE specifies the face property to put on all
19971 characters for which no face is specified. The value nil means the
19972 default face. The value t means whatever face the window's mode line
19973 currently uses (either `mode-line' or `mode-line-inactive',
19974 depending on whether the window is the selected window or not).
19975 An integer value means the value string has no text
19978 Optional third and fourth args WINDOW and BUFFER specify the window
19979 and buffer to use as the context for the formatting (defaults
19980 are the selected window and the WINDOW's buffer). */)
19981 (Lisp_Object format
, Lisp_Object face
,
19982 Lisp_Object window
, Lisp_Object buffer
)
19987 struct buffer
*old_buffer
= NULL
;
19989 int no_props
= INTEGERP (face
);
19990 int count
= SPECPDL_INDEX ();
19992 int string_start
= 0;
19995 window
= selected_window
;
19996 CHECK_WINDOW (window
);
19997 w
= XWINDOW (window
);
20000 buffer
= w
->buffer
;
20001 CHECK_BUFFER (buffer
);
20003 /* Make formatting the modeline a non-op when noninteractive, otherwise
20004 there will be problems later caused by a partially initialized frame. */
20005 if (NILP (format
) || noninteractive
)
20006 return empty_unibyte_string
;
20011 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20012 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20013 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20014 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20015 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20016 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20017 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20020 if (XBUFFER (buffer
) != current_buffer
)
20021 old_buffer
= current_buffer
;
20023 /* Save things including mode_line_proptrans_alist,
20024 and set that to nil so that we don't alter the outer value. */
20025 record_unwind_protect (unwind_format_mode_line
,
20026 format_mode_line_unwind_data
20027 (old_buffer
, selected_window
, 1));
20028 mode_line_proptrans_alist
= Qnil
;
20030 Fselect_window (window
, Qt
);
20032 set_buffer_internal_1 (XBUFFER (buffer
));
20034 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20038 mode_line_target
= MODE_LINE_NOPROP
;
20039 mode_line_string_face_prop
= Qnil
;
20040 mode_line_string_list
= Qnil
;
20041 string_start
= MODE_LINE_NOPROP_LEN (0);
20045 mode_line_target
= MODE_LINE_STRING
;
20046 mode_line_string_list
= Qnil
;
20047 mode_line_string_face
= face
;
20048 mode_line_string_face_prop
20049 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20052 push_kboard (FRAME_KBOARD (it
.f
));
20053 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20058 len
= MODE_LINE_NOPROP_LEN (string_start
);
20059 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20063 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20064 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20065 empty_unibyte_string
);
20068 unbind_to (count
, Qnil
);
20072 /* Write a null-terminated, right justified decimal representation of
20073 the positive integer D to BUF using a minimal field width WIDTH. */
20076 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20078 register char *p
= buf
;
20086 *p
++ = d
% 10 + '0';
20091 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20102 /* Write a null-terminated, right justified decimal and "human
20103 readable" representation of the nonnegative integer D to BUF using
20104 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20106 static const char power_letter
[] =
20120 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20122 /* We aim to represent the nonnegative integer D as
20123 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20124 EMACS_INT quotient
= d
;
20126 /* -1 means: do not use TENTHS. */
20130 /* Length of QUOTIENT.TENTHS as a string. */
20136 if (1000 <= quotient
)
20138 /* Scale to the appropriate EXPONENT. */
20141 remainder
= quotient
% 1000;
20145 while (1000 <= quotient
);
20147 /* Round to nearest and decide whether to use TENTHS or not. */
20150 tenths
= remainder
/ 100;
20151 if (50 <= remainder
% 100)
20158 if (quotient
== 10)
20166 if (500 <= remainder
)
20168 if (quotient
< 999)
20179 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20180 if (tenths
== -1 && quotient
<= 99)
20187 p
= psuffix
= buf
+ max (width
, length
);
20189 /* Print EXPONENT. */
20190 *psuffix
++ = power_letter
[exponent
];
20193 /* Print TENTHS. */
20196 *--p
= '0' + tenths
;
20200 /* Print QUOTIENT. */
20203 int digit
= quotient
% 10;
20204 *--p
= '0' + digit
;
20206 while ((quotient
/= 10) != 0);
20208 /* Print leading spaces. */
20213 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20214 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20215 type of CODING_SYSTEM. Return updated pointer into BUF. */
20217 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20220 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20223 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20224 const unsigned char *eol_str
;
20226 /* The EOL conversion we are using. */
20227 Lisp_Object eoltype
;
20229 val
= CODING_SYSTEM_SPEC (coding_system
);
20232 if (!VECTORP (val
)) /* Not yet decided. */
20237 eoltype
= eol_mnemonic_undecided
;
20238 /* Don't mention EOL conversion if it isn't decided. */
20243 Lisp_Object eolvalue
;
20245 attrs
= AREF (val
, 0);
20246 eolvalue
= AREF (val
, 2);
20249 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20253 /* The EOL conversion that is normal on this system. */
20255 if (NILP (eolvalue
)) /* Not yet decided. */
20256 eoltype
= eol_mnemonic_undecided
;
20257 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20258 eoltype
= eol_mnemonic_undecided
;
20259 else /* eolvalue is Qunix, Qdos, or Qmac. */
20260 eoltype
= (EQ (eolvalue
, Qunix
)
20261 ? eol_mnemonic_unix
20262 : (EQ (eolvalue
, Qdos
) == 1
20263 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20269 /* Mention the EOL conversion if it is not the usual one. */
20270 if (STRINGP (eoltype
))
20272 eol_str
= SDATA (eoltype
);
20273 eol_str_len
= SBYTES (eoltype
);
20275 else if (CHARACTERP (eoltype
))
20277 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20278 int c
= XFASTINT (eoltype
);
20279 eol_str_len
= CHAR_STRING (c
, tmp
);
20284 eol_str
= invalid_eol_type
;
20285 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20287 memcpy (buf
, eol_str
, eol_str_len
);
20288 buf
+= eol_str_len
;
20294 /* Return a string for the output of a mode line %-spec for window W,
20295 generated by character C. FIELD_WIDTH > 0 means pad the string
20296 returned with spaces to that value. Return a Lisp string in
20297 *STRING if the resulting string is taken from that Lisp string.
20299 Note we operate on the current buffer for most purposes,
20300 the exception being w->base_line_pos. */
20302 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20304 static const char *
20305 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20306 Lisp_Object
*string
)
20309 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20310 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20311 struct buffer
*b
= current_buffer
;
20319 if (!NILP (BVAR (b
, read_only
)))
20321 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20326 /* This differs from %* only for a modified read-only buffer. */
20327 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20329 if (!NILP (BVAR (b
, read_only
)))
20334 /* This differs from %* in ignoring read-only-ness. */
20335 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20347 if (command_loop_level
> 5)
20349 p
= decode_mode_spec_buf
;
20350 for (i
= 0; i
< command_loop_level
; i
++)
20353 return decode_mode_spec_buf
;
20361 if (command_loop_level
> 5)
20363 p
= decode_mode_spec_buf
;
20364 for (i
= 0; i
< command_loop_level
; i
++)
20367 return decode_mode_spec_buf
;
20374 /* Let lots_of_dashes be a string of infinite length. */
20375 if (mode_line_target
== MODE_LINE_NOPROP
||
20376 mode_line_target
== MODE_LINE_STRING
)
20378 if (field_width
<= 0
20379 || field_width
> sizeof (lots_of_dashes
))
20381 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20382 decode_mode_spec_buf
[i
] = '-';
20383 decode_mode_spec_buf
[i
] = '\0';
20384 return decode_mode_spec_buf
;
20387 return lots_of_dashes
;
20391 obj
= BVAR (b
, name
);
20395 /* %c and %l are ignored in `frame-title-format'.
20396 (In redisplay_internal, the frame title is drawn _before_ the
20397 windows are updated, so the stuff which depends on actual
20398 window contents (such as %l) may fail to render properly, or
20399 even crash emacs.) */
20400 if (mode_line_target
== MODE_LINE_TITLE
)
20404 EMACS_INT col
= current_column ();
20405 w
->column_number_displayed
= make_number (col
);
20406 pint2str (decode_mode_spec_buf
, field_width
, col
);
20407 return decode_mode_spec_buf
;
20411 #ifndef SYSTEM_MALLOC
20413 if (NILP (Vmemory_full
))
20416 return "!MEM FULL! ";
20423 /* %F displays the frame name. */
20424 if (!NILP (f
->title
))
20425 return SSDATA (f
->title
);
20426 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20427 return SSDATA (f
->name
);
20431 obj
= BVAR (b
, filename
);
20436 EMACS_INT size
= ZV
- BEGV
;
20437 pint2str (decode_mode_spec_buf
, field_width
, size
);
20438 return decode_mode_spec_buf
;
20443 EMACS_INT size
= ZV
- BEGV
;
20444 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20445 return decode_mode_spec_buf
;
20450 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20451 EMACS_INT topline
, nlines
, height
;
20454 /* %c and %l are ignored in `frame-title-format'. */
20455 if (mode_line_target
== MODE_LINE_TITLE
)
20458 startpos
= XMARKER (w
->start
)->charpos
;
20459 startpos_byte
= marker_byte_position (w
->start
);
20460 height
= WINDOW_TOTAL_LINES (w
);
20462 /* If we decided that this buffer isn't suitable for line numbers,
20463 don't forget that too fast. */
20464 if (EQ (w
->base_line_pos
, w
->buffer
))
20466 /* But do forget it, if the window shows a different buffer now. */
20467 else if (BUFFERP (w
->base_line_pos
))
20468 w
->base_line_pos
= Qnil
;
20470 /* If the buffer is very big, don't waste time. */
20471 if (INTEGERP (Vline_number_display_limit
)
20472 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20474 w
->base_line_pos
= Qnil
;
20475 w
->base_line_number
= Qnil
;
20479 if (INTEGERP (w
->base_line_number
)
20480 && INTEGERP (w
->base_line_pos
)
20481 && XFASTINT (w
->base_line_pos
) <= startpos
)
20483 line
= XFASTINT (w
->base_line_number
);
20484 linepos
= XFASTINT (w
->base_line_pos
);
20485 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20490 linepos
= BUF_BEGV (b
);
20491 linepos_byte
= BUF_BEGV_BYTE (b
);
20494 /* Count lines from base line to window start position. */
20495 nlines
= display_count_lines (linepos_byte
,
20499 topline
= nlines
+ line
;
20501 /* Determine a new base line, if the old one is too close
20502 or too far away, or if we did not have one.
20503 "Too close" means it's plausible a scroll-down would
20504 go back past it. */
20505 if (startpos
== BUF_BEGV (b
))
20507 w
->base_line_number
= make_number (topline
);
20508 w
->base_line_pos
= make_number (BUF_BEGV (b
));
20510 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
20511 || linepos
== BUF_BEGV (b
))
20513 EMACS_INT limit
= BUF_BEGV (b
);
20514 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
20515 EMACS_INT position
;
20516 EMACS_INT distance
=
20517 (height
* 2 + 30) * line_number_display_limit_width
;
20519 if (startpos
- distance
> limit
)
20521 limit
= startpos
- distance
;
20522 limit_byte
= CHAR_TO_BYTE (limit
);
20525 nlines
= display_count_lines (startpos_byte
,
20527 - (height
* 2 + 30),
20529 /* If we couldn't find the lines we wanted within
20530 line_number_display_limit_width chars per line,
20531 give up on line numbers for this window. */
20532 if (position
== limit_byte
&& limit
== startpos
- distance
)
20534 w
->base_line_pos
= w
->buffer
;
20535 w
->base_line_number
= Qnil
;
20539 w
->base_line_number
= make_number (topline
- nlines
);
20540 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
20543 /* Now count lines from the start pos to point. */
20544 nlines
= display_count_lines (startpos_byte
,
20545 PT_BYTE
, PT
, &junk
);
20547 /* Record that we did display the line number. */
20548 line_number_displayed
= 1;
20550 /* Make the string to show. */
20551 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
20552 return decode_mode_spec_buf
;
20555 char* p
= decode_mode_spec_buf
;
20556 int pad
= field_width
- 2;
20562 return decode_mode_spec_buf
;
20568 obj
= BVAR (b
, mode_name
);
20572 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
20578 EMACS_INT pos
= marker_position (w
->start
);
20579 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20581 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
20583 if (pos
<= BUF_BEGV (b
))
20588 else if (pos
<= BUF_BEGV (b
))
20592 if (total
> 1000000)
20593 /* Do it differently for a large value, to avoid overflow. */
20594 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20596 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20597 /* We can't normally display a 3-digit number,
20598 so get us a 2-digit number that is close. */
20601 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20602 return decode_mode_spec_buf
;
20606 /* Display percentage of size above the bottom of the screen. */
20609 EMACS_INT toppos
= marker_position (w
->start
);
20610 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
20611 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
20613 if (botpos
>= BUF_ZV (b
))
20615 if (toppos
<= BUF_BEGV (b
))
20622 if (total
> 1000000)
20623 /* Do it differently for a large value, to avoid overflow. */
20624 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
20626 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
20627 /* We can't normally display a 3-digit number,
20628 so get us a 2-digit number that is close. */
20631 if (toppos
<= BUF_BEGV (b
))
20632 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
20634 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
20635 return decode_mode_spec_buf
;
20640 /* status of process */
20641 obj
= Fget_buffer_process (Fcurrent_buffer ());
20643 return "no process";
20645 obj
= Fsymbol_name (Fprocess_status (obj
));
20651 int count
= inhibit_garbage_collection ();
20652 Lisp_Object val
= call1 (intern ("file-remote-p"),
20653 BVAR (current_buffer
, directory
));
20654 unbind_to (count
, Qnil
);
20662 case 't': /* indicate TEXT or BINARY */
20666 /* coding-system (not including end-of-line format) */
20668 /* coding-system (including end-of-line type) */
20670 int eol_flag
= (c
== 'Z');
20671 char *p
= decode_mode_spec_buf
;
20673 if (! FRAME_WINDOW_P (f
))
20675 /* No need to mention EOL here--the terminal never needs
20676 to do EOL conversion. */
20677 p
= decode_mode_spec_coding (CODING_ID_NAME
20678 (FRAME_KEYBOARD_CODING (f
)->id
),
20680 p
= decode_mode_spec_coding (CODING_ID_NAME
20681 (FRAME_TERMINAL_CODING (f
)->id
),
20684 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
20687 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
20688 #ifdef subprocesses
20689 obj
= Fget_buffer_process (Fcurrent_buffer ());
20690 if (PROCESSP (obj
))
20692 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
20694 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
20697 #endif /* subprocesses */
20700 return decode_mode_spec_buf
;
20707 return SSDATA (obj
);
20714 /* Count up to COUNT lines starting from START_BYTE.
20715 But don't go beyond LIMIT_BYTE.
20716 Return the number of lines thus found (always nonnegative).
20718 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
20721 display_count_lines (EMACS_INT start_byte
,
20722 EMACS_INT limit_byte
, EMACS_INT count
,
20723 EMACS_INT
*byte_pos_ptr
)
20725 register unsigned char *cursor
;
20726 unsigned char *base
;
20728 register EMACS_INT ceiling
;
20729 register unsigned char *ceiling_addr
;
20730 EMACS_INT orig_count
= count
;
20732 /* If we are not in selective display mode,
20733 check only for newlines. */
20734 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
20735 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
20739 while (start_byte
< limit_byte
)
20741 ceiling
= BUFFER_CEILING_OF (start_byte
);
20742 ceiling
= min (limit_byte
- 1, ceiling
);
20743 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
20744 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
20747 if (selective_display
)
20748 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
20751 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
20754 if (cursor
!= ceiling_addr
)
20758 start_byte
+= cursor
- base
+ 1;
20759 *byte_pos_ptr
= start_byte
;
20763 if (++cursor
== ceiling_addr
)
20769 start_byte
+= cursor
- base
;
20774 while (start_byte
> limit_byte
)
20776 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
20777 ceiling
= max (limit_byte
, ceiling
);
20778 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
20779 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
20782 if (selective_display
)
20783 while (--cursor
!= ceiling_addr
20784 && *cursor
!= '\n' && *cursor
!= 015)
20787 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
20790 if (cursor
!= ceiling_addr
)
20794 start_byte
+= cursor
- base
+ 1;
20795 *byte_pos_ptr
= start_byte
;
20796 /* When scanning backwards, we should
20797 not count the newline posterior to which we stop. */
20798 return - orig_count
- 1;
20804 /* Here we add 1 to compensate for the last decrement
20805 of CURSOR, which took it past the valid range. */
20806 start_byte
+= cursor
- base
+ 1;
20810 *byte_pos_ptr
= limit_byte
;
20813 return - orig_count
+ count
;
20814 return orig_count
- count
;
20820 /***********************************************************************
20822 ***********************************************************************/
20824 /* Display a NUL-terminated string, starting with index START.
20826 If STRING is non-null, display that C string. Otherwise, the Lisp
20827 string LISP_STRING is displayed. There's a case that STRING is
20828 non-null and LISP_STRING is not nil. It means STRING is a string
20829 data of LISP_STRING. In that case, we display LISP_STRING while
20830 ignoring its text properties.
20832 If FACE_STRING is not nil, FACE_STRING_POS is a position in
20833 FACE_STRING. Display STRING or LISP_STRING with the face at
20834 FACE_STRING_POS in FACE_STRING:
20836 Display the string in the environment given by IT, but use the
20837 standard display table, temporarily.
20839 FIELD_WIDTH is the minimum number of output glyphs to produce.
20840 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20841 with spaces. If STRING has more characters, more than FIELD_WIDTH
20842 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
20844 PRECISION is the maximum number of characters to output from
20845 STRING. PRECISION < 0 means don't truncate the string.
20847 This is roughly equivalent to printf format specifiers:
20849 FIELD_WIDTH PRECISION PRINTF
20850 ----------------------------------------
20856 MULTIBYTE zero means do not display multibyte chars, > 0 means do
20857 display them, and < 0 means obey the current buffer's value of
20858 enable_multibyte_characters.
20860 Value is the number of columns displayed. */
20863 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
20864 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
20865 int field_width
, int precision
, int max_x
, int multibyte
)
20867 int hpos_at_start
= it
->hpos
;
20868 int saved_face_id
= it
->face_id
;
20869 struct glyph_row
*row
= it
->glyph_row
;
20870 EMACS_INT it_charpos
;
20872 /* Initialize the iterator IT for iteration over STRING beginning
20873 with index START. */
20874 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
20875 precision
, field_width
, multibyte
);
20876 if (string
&& STRINGP (lisp_string
))
20877 /* LISP_STRING is the one returned by decode_mode_spec. We should
20878 ignore its text properties. */
20879 it
->stop_charpos
= it
->end_charpos
;
20881 /* If displaying STRING, set up the face of the iterator from
20882 FACE_STRING, if that's given. */
20883 if (STRINGP (face_string
))
20889 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
20890 0, it
->region_beg_charpos
,
20891 it
->region_end_charpos
,
20892 &endptr
, it
->base_face_id
, 0);
20893 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
20894 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
20897 /* Set max_x to the maximum allowed X position. Don't let it go
20898 beyond the right edge of the window. */
20900 max_x
= it
->last_visible_x
;
20902 max_x
= min (max_x
, it
->last_visible_x
);
20904 /* Skip over display elements that are not visible. because IT->w is
20906 if (it
->current_x
< it
->first_visible_x
)
20907 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
20908 MOVE_TO_POS
| MOVE_TO_X
);
20910 row
->ascent
= it
->max_ascent
;
20911 row
->height
= it
->max_ascent
+ it
->max_descent
;
20912 row
->phys_ascent
= it
->max_phys_ascent
;
20913 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20914 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20916 if (STRINGP (it
->string
))
20917 it_charpos
= IT_STRING_CHARPOS (*it
);
20919 it_charpos
= IT_CHARPOS (*it
);
20921 /* This condition is for the case that we are called with current_x
20922 past last_visible_x. */
20923 while (it
->current_x
< max_x
)
20925 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
20927 /* Get the next display element. */
20928 if (!get_next_display_element (it
))
20931 /* Produce glyphs. */
20932 x_before
= it
->current_x
;
20933 n_glyphs_before
= row
->used
[TEXT_AREA
];
20934 PRODUCE_GLYPHS (it
);
20936 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20939 while (i
< nglyphs
)
20941 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20943 if (it
->line_wrap
!= TRUNCATE
20944 && x
+ glyph
->pixel_width
> max_x
)
20946 /* End of continued line or max_x reached. */
20947 if (CHAR_GLYPH_PADDING_P (*glyph
))
20949 /* A wide character is unbreakable. */
20950 if (row
->reversed_p
)
20951 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20952 - n_glyphs_before
);
20953 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20954 it
->current_x
= x_before
;
20958 if (row
->reversed_p
)
20959 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20960 - (n_glyphs_before
+ i
));
20961 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20966 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
20968 /* Glyph is at least partially visible. */
20970 if (x
< it
->first_visible_x
)
20971 row
->x
= x
- it
->first_visible_x
;
20975 /* Glyph is off the left margin of the display area.
20976 Should not happen. */
20980 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20981 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20982 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20983 row
->phys_height
= max (row
->phys_height
,
20984 it
->max_phys_ascent
+ it
->max_phys_descent
);
20985 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20986 it
->max_extra_line_spacing
);
20987 x
+= glyph
->pixel_width
;
20991 /* Stop if max_x reached. */
20995 /* Stop at line ends. */
20996 if (ITERATOR_AT_END_OF_LINE_P (it
))
20998 it
->continuation_lines_width
= 0;
21002 set_iterator_to_next (it
, 1);
21003 if (STRINGP (it
->string
))
21004 it_charpos
= IT_STRING_CHARPOS (*it
);
21006 it_charpos
= IT_CHARPOS (*it
);
21008 /* Stop if truncating at the right edge. */
21009 if (it
->line_wrap
== TRUNCATE
21010 && it
->current_x
>= it
->last_visible_x
)
21012 /* Add truncation mark, but don't do it if the line is
21013 truncated at a padding space. */
21014 if (it_charpos
< it
->string_nchars
)
21016 if (!FRAME_WINDOW_P (it
->f
))
21020 if (it
->current_x
> it
->last_visible_x
)
21022 if (!row
->reversed_p
)
21024 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21025 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21030 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21031 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21033 unproduce_glyphs (it
, ii
+ 1);
21034 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21036 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21038 row
->used
[TEXT_AREA
] = ii
;
21039 produce_special_glyphs (it
, IT_TRUNCATION
);
21042 produce_special_glyphs (it
, IT_TRUNCATION
);
21044 row
->truncated_on_right_p
= 1;
21050 /* Maybe insert a truncation at the left. */
21051 if (it
->first_visible_x
21054 if (!FRAME_WINDOW_P (it
->f
))
21055 insert_left_trunc_glyphs (it
);
21056 row
->truncated_on_left_p
= 1;
21059 it
->face_id
= saved_face_id
;
21061 /* Value is number of columns displayed. */
21062 return it
->hpos
- hpos_at_start
;
21067 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21068 appears as an element of LIST or as the car of an element of LIST.
21069 If PROPVAL is a list, compare each element against LIST in that
21070 way, and return 1/2 if any element of PROPVAL is found in LIST.
21071 Otherwise return 0. This function cannot quit.
21072 The return value is 2 if the text is invisible but with an ellipsis
21073 and 1 if it's invisible and without an ellipsis. */
21076 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21078 register Lisp_Object tail
, proptail
;
21080 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21082 register Lisp_Object tem
;
21084 if (EQ (propval
, tem
))
21086 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21087 return NILP (XCDR (tem
)) ? 1 : 2;
21090 if (CONSP (propval
))
21092 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21094 Lisp_Object propelt
;
21095 propelt
= XCAR (proptail
);
21096 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21098 register Lisp_Object tem
;
21100 if (EQ (propelt
, tem
))
21102 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21103 return NILP (XCDR (tem
)) ? 1 : 2;
21111 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21112 doc
: /* Non-nil if the property makes the text invisible.
21113 POS-OR-PROP can be a marker or number, in which case it is taken to be
21114 a position in the current buffer and the value of the `invisible' property
21115 is checked; or it can be some other value, which is then presumed to be the
21116 value of the `invisible' property of the text of interest.
21117 The non-nil value returned can be t for truly invisible text or something
21118 else if the text is replaced by an ellipsis. */)
21119 (Lisp_Object pos_or_prop
)
21122 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21123 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21125 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21126 return (invis
== 0 ? Qnil
21128 : make_number (invis
));
21131 /* Calculate a width or height in pixels from a specification using
21132 the following elements:
21135 NUM - a (fractional) multiple of the default font width/height
21136 (NUM) - specifies exactly NUM pixels
21137 UNIT - a fixed number of pixels, see below.
21138 ELEMENT - size of a display element in pixels, see below.
21139 (NUM . SPEC) - equals NUM * SPEC
21140 (+ SPEC SPEC ...) - add pixel values
21141 (- SPEC SPEC ...) - subtract pixel values
21142 (- SPEC) - negate pixel value
21145 INT or FLOAT - a number constant
21146 SYMBOL - use symbol's (buffer local) variable binding.
21149 in - pixels per inch *)
21150 mm - pixels per 1/1000 meter *)
21151 cm - pixels per 1/100 meter *)
21152 width - width of current font in pixels.
21153 height - height of current font in pixels.
21155 *) using the ratio(s) defined in display-pixels-per-inch.
21159 left-fringe - left fringe width in pixels
21160 right-fringe - right fringe width in pixels
21162 left-margin - left margin width in pixels
21163 right-margin - right margin width in pixels
21165 scroll-bar - scroll-bar area width in pixels
21169 Pixels corresponding to 5 inches:
21172 Total width of non-text areas on left side of window (if scroll-bar is on left):
21173 '(space :width (+ left-fringe left-margin scroll-bar))
21175 Align to first text column (in header line):
21176 '(space :align-to 0)
21178 Align to middle of text area minus half the width of variable `my-image'
21179 containing a loaded image:
21180 '(space :align-to (0.5 . (- text my-image)))
21182 Width of left margin minus width of 1 character in the default font:
21183 '(space :width (- left-margin 1))
21185 Width of left margin minus width of 2 characters in the current font:
21186 '(space :width (- left-margin (2 . width)))
21188 Center 1 character over left-margin (in header line):
21189 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21191 Different ways to express width of left fringe plus left margin minus one pixel:
21192 '(space :width (- (+ left-fringe left-margin) (1)))
21193 '(space :width (+ left-fringe left-margin (- (1))))
21194 '(space :width (+ left-fringe left-margin (-1)))
21198 #define NUMVAL(X) \
21199 ((INTEGERP (X) || FLOATP (X)) \
21204 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21205 struct font
*font
, int width_p
, int *align_to
)
21209 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21210 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21213 return OK_PIXELS (0);
21215 xassert (FRAME_LIVE_P (it
->f
));
21217 if (SYMBOLP (prop
))
21219 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21221 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21223 if (unit
[0] == 'i' && unit
[1] == 'n')
21225 else if (unit
[0] == 'm' && unit
[1] == 'm')
21227 else if (unit
[0] == 'c' && unit
[1] == 'm')
21234 #ifdef HAVE_WINDOW_SYSTEM
21235 if (FRAME_WINDOW_P (it
->f
)
21237 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21238 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21240 return OK_PIXELS (ppi
/ pixels
);
21243 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21244 || (CONSP (Vdisplay_pixels_per_inch
)
21246 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21247 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21249 return OK_PIXELS (ppi
/ pixels
);
21255 #ifdef HAVE_WINDOW_SYSTEM
21256 if (EQ (prop
, Qheight
))
21257 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21258 if (EQ (prop
, Qwidth
))
21259 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21261 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21262 return OK_PIXELS (1);
21265 if (EQ (prop
, Qtext
))
21266 return OK_PIXELS (width_p
21267 ? window_box_width (it
->w
, TEXT_AREA
)
21268 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21270 if (align_to
&& *align_to
< 0)
21273 if (EQ (prop
, Qleft
))
21274 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21275 if (EQ (prop
, Qright
))
21276 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21277 if (EQ (prop
, Qcenter
))
21278 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21279 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21280 if (EQ (prop
, Qleft_fringe
))
21281 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21282 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21283 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21284 if (EQ (prop
, Qright_fringe
))
21285 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21286 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21287 : window_box_right_offset (it
->w
, TEXT_AREA
));
21288 if (EQ (prop
, Qleft_margin
))
21289 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21290 if (EQ (prop
, Qright_margin
))
21291 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21292 if (EQ (prop
, Qscroll_bar
))
21293 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21295 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21296 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21297 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21302 if (EQ (prop
, Qleft_fringe
))
21303 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21304 if (EQ (prop
, Qright_fringe
))
21305 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21306 if (EQ (prop
, Qleft_margin
))
21307 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21308 if (EQ (prop
, Qright_margin
))
21309 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21310 if (EQ (prop
, Qscroll_bar
))
21311 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21314 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21317 if (INTEGERP (prop
) || FLOATP (prop
))
21319 int base_unit
= (width_p
21320 ? FRAME_COLUMN_WIDTH (it
->f
)
21321 : FRAME_LINE_HEIGHT (it
->f
));
21322 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21327 Lisp_Object car
= XCAR (prop
);
21328 Lisp_Object cdr
= XCDR (prop
);
21332 #ifdef HAVE_WINDOW_SYSTEM
21333 if (FRAME_WINDOW_P (it
->f
)
21334 && valid_image_p (prop
))
21336 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21337 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21339 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21342 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21348 while (CONSP (cdr
))
21350 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21351 font
, width_p
, align_to
))
21354 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21359 if (EQ (car
, Qminus
))
21361 return OK_PIXELS (pixels
);
21364 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21367 if (INTEGERP (car
) || FLOATP (car
))
21370 pixels
= XFLOATINT (car
);
21372 return OK_PIXELS (pixels
);
21373 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21374 font
, width_p
, align_to
))
21375 return OK_PIXELS (pixels
* fact
);
21386 /***********************************************************************
21388 ***********************************************************************/
21390 #ifdef HAVE_WINDOW_SYSTEM
21395 dump_glyph_string (struct glyph_string
*s
)
21397 fprintf (stderr
, "glyph string\n");
21398 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21399 s
->x
, s
->y
, s
->width
, s
->height
);
21400 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21401 fprintf (stderr
, " hl = %d\n", s
->hl
);
21402 fprintf (stderr
, " left overhang = %d, right = %d\n",
21403 s
->left_overhang
, s
->right_overhang
);
21404 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21405 fprintf (stderr
, " extends to end of line = %d\n",
21406 s
->extends_to_end_of_line_p
);
21407 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21408 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21411 #endif /* GLYPH_DEBUG */
21413 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21414 of XChar2b structures for S; it can't be allocated in
21415 init_glyph_string because it must be allocated via `alloca'. W
21416 is the window on which S is drawn. ROW and AREA are the glyph row
21417 and area within the row from which S is constructed. START is the
21418 index of the first glyph structure covered by S. HL is a
21419 face-override for drawing S. */
21422 #define OPTIONAL_HDC(hdc) HDC hdc,
21423 #define DECLARE_HDC(hdc) HDC hdc;
21424 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21425 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21428 #ifndef OPTIONAL_HDC
21429 #define OPTIONAL_HDC(hdc)
21430 #define DECLARE_HDC(hdc)
21431 #define ALLOCATE_HDC(hdc, f)
21432 #define RELEASE_HDC(hdc, f)
21436 init_glyph_string (struct glyph_string
*s
,
21438 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21439 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21441 memset (s
, 0, sizeof *s
);
21443 s
->f
= XFRAME (w
->frame
);
21447 s
->display
= FRAME_X_DISPLAY (s
->f
);
21448 s
->window
= FRAME_X_WINDOW (s
->f
);
21449 s
->char2b
= char2b
;
21453 s
->first_glyph
= row
->glyphs
[area
] + start
;
21454 s
->height
= row
->height
;
21455 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21456 s
->ybase
= s
->y
+ row
->ascent
;
21460 /* Append the list of glyph strings with head H and tail T to the list
21461 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21464 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21465 struct glyph_string
*h
, struct glyph_string
*t
)
21479 /* Prepend the list of glyph strings with head H and tail T to the
21480 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21484 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21485 struct glyph_string
*h
, struct glyph_string
*t
)
21499 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
21500 Set *HEAD and *TAIL to the resulting list. */
21503 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
21504 struct glyph_string
*s
)
21506 s
->next
= s
->prev
= NULL
;
21507 append_glyph_string_lists (head
, tail
, s
, s
);
21511 /* Get face and two-byte form of character C in face FACE_ID on frame F.
21512 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
21513 make sure that X resources for the face returned are allocated.
21514 Value is a pointer to a realized face that is ready for display if
21515 DISPLAY_P is non-zero. */
21517 static inline struct face
*
21518 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
21519 XChar2b
*char2b
, int display_p
)
21521 struct face
*face
= FACE_FROM_ID (f
, face_id
);
21525 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
21527 if (code
!= FONT_INVALID_CODE
)
21528 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21530 STORE_XCHAR2B (char2b
, 0, 0);
21533 /* Make sure X resources of the face are allocated. */
21534 #ifdef HAVE_X_WINDOWS
21538 xassert (face
!= NULL
);
21539 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21546 /* Get face and two-byte form of character glyph GLYPH on frame F.
21547 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
21548 a pointer to a realized face that is ready for display. */
21550 static inline struct face
*
21551 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
21552 XChar2b
*char2b
, int *two_byte_p
)
21556 xassert (glyph
->type
== CHAR_GLYPH
);
21557 face
= FACE_FROM_ID (f
, glyph
->face_id
);
21566 if (CHAR_BYTE8_P (glyph
->u
.ch
))
21567 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
21569 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
21571 if (code
!= FONT_INVALID_CODE
)
21572 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21574 STORE_XCHAR2B (char2b
, 0, 0);
21577 /* Make sure X resources of the face are allocated. */
21578 xassert (face
!= NULL
);
21579 PREPARE_FACE_FOR_DISPLAY (f
, face
);
21584 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
21585 Retunr 1 if FONT has a glyph for C, otherwise return 0. */
21588 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
21592 if (CHAR_BYTE8_P (c
))
21593 code
= CHAR_TO_BYTE8 (c
);
21595 code
= font
->driver
->encode_char (font
, c
);
21597 if (code
== FONT_INVALID_CODE
)
21599 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
21604 /* Fill glyph string S with composition components specified by S->cmp.
21606 BASE_FACE is the base face of the composition.
21607 S->cmp_from is the index of the first component for S.
21609 OVERLAPS non-zero means S should draw the foreground only, and use
21610 its physical height for clipping. See also draw_glyphs.
21612 Value is the index of a component not in S. */
21615 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
21619 /* For all glyphs of this composition, starting at the offset
21620 S->cmp_from, until we reach the end of the definition or encounter a
21621 glyph that requires the different face, add it to S. */
21626 s
->for_overlaps
= overlaps
;
21629 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
21631 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
21635 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
21638 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
21645 s
->font
= s
->face
->font
;
21647 else if (s
->face
!= face
)
21655 /* All glyph strings for the same composition has the same width,
21656 i.e. the width set for the first component of the composition. */
21657 s
->width
= s
->first_glyph
->pixel_width
;
21659 /* If the specified font could not be loaded, use the frame's
21660 default font, but record the fact that we couldn't load it in
21661 the glyph string so that we can draw rectangles for the
21662 characters of the glyph string. */
21663 if (s
->font
== NULL
)
21665 s
->font_not_found_p
= 1;
21666 s
->font
= FRAME_FONT (s
->f
);
21669 /* Adjust base line for subscript/superscript text. */
21670 s
->ybase
+= s
->first_glyph
->voffset
;
21672 /* This glyph string must always be drawn with 16-bit functions. */
21679 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
21680 int start
, int end
, int overlaps
)
21682 struct glyph
*glyph
, *last
;
21683 Lisp_Object lgstring
;
21686 s
->for_overlaps
= overlaps
;
21687 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21688 last
= s
->row
->glyphs
[s
->area
] + end
;
21689 s
->cmp_id
= glyph
->u
.cmp
.id
;
21690 s
->cmp_from
= glyph
->slice
.cmp
.from
;
21691 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
21692 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21693 lgstring
= composition_gstring_from_id (s
->cmp_id
);
21694 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
21696 while (glyph
< last
21697 && glyph
->u
.cmp
.automatic
21698 && glyph
->u
.cmp
.id
== s
->cmp_id
21699 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
21700 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
21702 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
21704 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
21705 unsigned code
= LGLYPH_CODE (lglyph
);
21707 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
21709 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
21710 return glyph
- s
->row
->glyphs
[s
->area
];
21714 /* Fill glyph string S from a sequence glyphs for glyphless characters.
21715 See the comment of fill_glyph_string for arguments.
21716 Value is the index of the first glyph not in S. */
21720 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
21721 int start
, int end
, int overlaps
)
21723 struct glyph
*glyph
, *last
;
21726 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
21727 s
->for_overlaps
= overlaps
;
21728 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21729 last
= s
->row
->glyphs
[s
->area
] + end
;
21730 voffset
= glyph
->voffset
;
21731 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21732 s
->font
= s
->face
->font
;
21734 s
->width
= glyph
->pixel_width
;
21736 while (glyph
< last
21737 && glyph
->type
== GLYPHLESS_GLYPH
21738 && glyph
->voffset
== voffset
21739 && glyph
->face_id
== face_id
)
21742 s
->width
+= glyph
->pixel_width
;
21745 s
->ybase
+= voffset
;
21746 return glyph
- s
->row
->glyphs
[s
->area
];
21750 /* Fill glyph string S from a sequence of character glyphs.
21752 FACE_ID is the face id of the string. START is the index of the
21753 first glyph to consider, END is the index of the last + 1.
21754 OVERLAPS non-zero means S should draw the foreground only, and use
21755 its physical height for clipping. See also draw_glyphs.
21757 Value is the index of the first glyph not in S. */
21760 fill_glyph_string (struct glyph_string
*s
, int face_id
,
21761 int start
, int end
, int overlaps
)
21763 struct glyph
*glyph
, *last
;
21765 int glyph_not_available_p
;
21767 xassert (s
->f
== XFRAME (s
->w
->frame
));
21768 xassert (s
->nchars
== 0);
21769 xassert (start
>= 0 && end
> start
);
21771 s
->for_overlaps
= overlaps
;
21772 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21773 last
= s
->row
->glyphs
[s
->area
] + end
;
21774 voffset
= glyph
->voffset
;
21775 s
->padding_p
= glyph
->padding_p
;
21776 glyph_not_available_p
= glyph
->glyph_not_available_p
;
21778 while (glyph
< last
21779 && glyph
->type
== CHAR_GLYPH
21780 && glyph
->voffset
== voffset
21781 /* Same face id implies same font, nowadays. */
21782 && glyph
->face_id
== face_id
21783 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
21787 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
21788 s
->char2b
+ s
->nchars
,
21790 s
->two_byte_p
= two_byte_p
;
21792 xassert (s
->nchars
<= end
- start
);
21793 s
->width
+= glyph
->pixel_width
;
21794 if (glyph
++->padding_p
!= s
->padding_p
)
21798 s
->font
= s
->face
->font
;
21800 /* If the specified font could not be loaded, use the frame's font,
21801 but record the fact that we couldn't load it in
21802 S->font_not_found_p so that we can draw rectangles for the
21803 characters of the glyph string. */
21804 if (s
->font
== NULL
|| glyph_not_available_p
)
21806 s
->font_not_found_p
= 1;
21807 s
->font
= FRAME_FONT (s
->f
);
21810 /* Adjust base line for subscript/superscript text. */
21811 s
->ybase
+= voffset
;
21813 xassert (s
->face
&& s
->face
->gc
);
21814 return glyph
- s
->row
->glyphs
[s
->area
];
21818 /* Fill glyph string S from image glyph S->first_glyph. */
21821 fill_image_glyph_string (struct glyph_string
*s
)
21823 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
21824 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
21826 s
->slice
= s
->first_glyph
->slice
.img
;
21827 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
21828 s
->font
= s
->face
->font
;
21829 s
->width
= s
->first_glyph
->pixel_width
;
21831 /* Adjust base line for subscript/superscript text. */
21832 s
->ybase
+= s
->first_glyph
->voffset
;
21836 /* Fill glyph string S from a sequence of stretch glyphs.
21838 START is the index of the first glyph to consider,
21839 END is the index of the last + 1.
21841 Value is the index of the first glyph not in S. */
21844 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
21846 struct glyph
*glyph
, *last
;
21847 int voffset
, face_id
;
21849 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
21851 glyph
= s
->row
->glyphs
[s
->area
] + start
;
21852 last
= s
->row
->glyphs
[s
->area
] + end
;
21853 face_id
= glyph
->face_id
;
21854 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
21855 s
->font
= s
->face
->font
;
21856 s
->width
= glyph
->pixel_width
;
21858 voffset
= glyph
->voffset
;
21862 && glyph
->type
== STRETCH_GLYPH
21863 && glyph
->voffset
== voffset
21864 && glyph
->face_id
== face_id
);
21866 s
->width
+= glyph
->pixel_width
;
21868 /* Adjust base line for subscript/superscript text. */
21869 s
->ybase
+= voffset
;
21871 /* The case that face->gc == 0 is handled when drawing the glyph
21872 string by calling PREPARE_FACE_FOR_DISPLAY. */
21874 return glyph
- s
->row
->glyphs
[s
->area
];
21877 static struct font_metrics
*
21878 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
21880 static struct font_metrics metrics
;
21881 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
21883 if (! font
|| code
== FONT_INVALID_CODE
)
21885 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
21890 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
21891 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
21892 assumed to be zero. */
21895 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
21897 *left
= *right
= 0;
21899 if (glyph
->type
== CHAR_GLYPH
)
21903 struct font_metrics
*pcm
;
21905 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
21906 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
21908 if (pcm
->rbearing
> pcm
->width
)
21909 *right
= pcm
->rbearing
- pcm
->width
;
21910 if (pcm
->lbearing
< 0)
21911 *left
= -pcm
->lbearing
;
21914 else if (glyph
->type
== COMPOSITE_GLYPH
)
21916 if (! glyph
->u
.cmp
.automatic
)
21918 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
21920 if (cmp
->rbearing
> cmp
->pixel_width
)
21921 *right
= cmp
->rbearing
- cmp
->pixel_width
;
21922 if (cmp
->lbearing
< 0)
21923 *left
= - cmp
->lbearing
;
21927 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
21928 struct font_metrics metrics
;
21930 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
21931 glyph
->slice
.cmp
.to
+ 1, &metrics
);
21932 if (metrics
.rbearing
> metrics
.width
)
21933 *right
= metrics
.rbearing
- metrics
.width
;
21934 if (metrics
.lbearing
< 0)
21935 *left
= - metrics
.lbearing
;
21941 /* Return the index of the first glyph preceding glyph string S that
21942 is overwritten by S because of S's left overhang. Value is -1
21943 if no glyphs are overwritten. */
21946 left_overwritten (struct glyph_string
*s
)
21950 if (s
->left_overhang
)
21953 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21954 int first
= s
->first_glyph
- glyphs
;
21956 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
21957 x
-= glyphs
[i
].pixel_width
;
21968 /* Return the index of the first glyph preceding glyph string S that
21969 is overwriting S because of its right overhang. Value is -1 if no
21970 glyph in front of S overwrites S. */
21973 left_overwriting (struct glyph_string
*s
)
21976 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
21977 int first
= s
->first_glyph
- glyphs
;
21981 for (i
= first
- 1; i
>= 0; --i
)
21984 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
21987 x
-= glyphs
[i
].pixel_width
;
21994 /* Return the index of the last glyph following glyph string S that is
21995 overwritten by S because of S's right overhang. Value is -1 if
21996 no such glyph is found. */
21999 right_overwritten (struct glyph_string
*s
)
22003 if (s
->right_overhang
)
22006 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22007 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22008 int end
= s
->row
->used
[s
->area
];
22010 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22011 x
+= glyphs
[i
].pixel_width
;
22020 /* Return the index of the last glyph following glyph string S that
22021 overwrites S because of its left overhang. Value is negative
22022 if no such glyph is found. */
22025 right_overwriting (struct glyph_string
*s
)
22028 int end
= s
->row
->used
[s
->area
];
22029 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22030 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22034 for (i
= first
; i
< end
; ++i
)
22037 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22040 x
+= glyphs
[i
].pixel_width
;
22047 /* Set background width of glyph string S. START is the index of the
22048 first glyph following S. LAST_X is the right-most x-position + 1
22049 in the drawing area. */
22052 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22054 /* If the face of this glyph string has to be drawn to the end of
22055 the drawing area, set S->extends_to_end_of_line_p. */
22057 if (start
== s
->row
->used
[s
->area
]
22058 && s
->area
== TEXT_AREA
22059 && ((s
->row
->fill_line_p
22060 && (s
->hl
== DRAW_NORMAL_TEXT
22061 || s
->hl
== DRAW_IMAGE_RAISED
22062 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22063 || s
->hl
== DRAW_MOUSE_FACE
))
22064 s
->extends_to_end_of_line_p
= 1;
22066 /* If S extends its face to the end of the line, set its
22067 background_width to the distance to the right edge of the drawing
22069 if (s
->extends_to_end_of_line_p
)
22070 s
->background_width
= last_x
- s
->x
+ 1;
22072 s
->background_width
= s
->width
;
22076 /* Compute overhangs and x-positions for glyph string S and its
22077 predecessors, or successors. X is the starting x-position for S.
22078 BACKWARD_P non-zero means process predecessors. */
22081 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22087 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22088 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22098 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22099 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22109 /* The following macros are only called from draw_glyphs below.
22110 They reference the following parameters of that function directly:
22111 `w', `row', `area', and `overlap_p'
22112 as well as the following local variables:
22113 `s', `f', and `hdc' (in W32) */
22116 /* On W32, silently add local `hdc' variable to argument list of
22117 init_glyph_string. */
22118 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22119 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22121 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22122 init_glyph_string (s, char2b, w, row, area, start, hl)
22125 /* Add a glyph string for a stretch glyph to the list of strings
22126 between HEAD and TAIL. START is the index of the stretch glyph in
22127 row area AREA of glyph row ROW. END is the index of the last glyph
22128 in that glyph row area. X is the current output position assigned
22129 to the new glyph string constructed. HL overrides that face of the
22130 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22131 is the right-most x-position of the drawing area. */
22133 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22134 and below -- keep them on one line. */
22135 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22138 s = (struct glyph_string *) alloca (sizeof *s); \
22139 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22140 START = fill_stretch_glyph_string (s, START, END); \
22141 append_glyph_string (&HEAD, &TAIL, s); \
22147 /* Add a glyph string for an image glyph to the list of strings
22148 between HEAD and TAIL. START is the index of the image glyph in
22149 row area AREA of glyph row ROW. END is the index of the last glyph
22150 in that glyph row area. X is the current output position assigned
22151 to the new glyph string constructed. HL overrides that face of the
22152 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22153 is the right-most x-position of the drawing area. */
22155 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22158 s = (struct glyph_string *) alloca (sizeof *s); \
22159 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22160 fill_image_glyph_string (s); \
22161 append_glyph_string (&HEAD, &TAIL, s); \
22168 /* Add a glyph string for a sequence of character glyphs to the list
22169 of strings between HEAD and TAIL. START is the index of the first
22170 glyph in row area AREA of glyph row ROW that is part of the new
22171 glyph string. END is the index of the last glyph in that glyph row
22172 area. X is the current output position assigned to the new glyph
22173 string constructed. HL overrides that face of the glyph; e.g. it
22174 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22175 right-most x-position of the drawing area. */
22177 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22183 face_id = (row)->glyphs[area][START].face_id; \
22185 s = (struct glyph_string *) alloca (sizeof *s); \
22186 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22187 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22188 append_glyph_string (&HEAD, &TAIL, s); \
22190 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22195 /* Add a glyph string for a composite sequence to the list of strings
22196 between HEAD and TAIL. START is the index of the first glyph in
22197 row area AREA of glyph row ROW that is part of the new glyph
22198 string. END is the index of the last glyph in that glyph row area.
22199 X is the current output position assigned to the new glyph string
22200 constructed. HL overrides that face of the glyph; e.g. it is
22201 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22202 x-position of the drawing area. */
22204 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22206 int face_id = (row)->glyphs[area][START].face_id; \
22207 struct face *base_face = FACE_FROM_ID (f, face_id); \
22208 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22209 struct composition *cmp = composition_table[cmp_id]; \
22211 struct glyph_string *first_s IF_LINT (= NULL); \
22214 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22216 /* Make glyph_strings for each glyph sequence that is drawable by \
22217 the same face, and append them to HEAD/TAIL. */ \
22218 for (n = 0; n < cmp->glyph_len;) \
22220 s = (struct glyph_string *) alloca (sizeof *s); \
22221 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22222 append_glyph_string (&(HEAD), &(TAIL), s); \
22228 n = fill_composite_glyph_string (s, base_face, overlaps); \
22236 /* Add a glyph string for a glyph-string sequence to the list of strings
22237 between HEAD and TAIL. */
22239 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22243 Lisp_Object gstring; \
22245 face_id = (row)->glyphs[area][START].face_id; \
22246 gstring = (composition_gstring_from_id \
22247 ((row)->glyphs[area][START].u.cmp.id)); \
22248 s = (struct glyph_string *) alloca (sizeof *s); \
22249 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22250 * LGSTRING_GLYPH_LEN (gstring)); \
22251 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22252 append_glyph_string (&(HEAD), &(TAIL), s); \
22254 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22258 /* Add a glyph string for a sequence of glyphless character's glyphs
22259 to the list of strings between HEAD and TAIL. The meanings of
22260 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22262 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22267 face_id = (row)->glyphs[area][START].face_id; \
22269 s = (struct glyph_string *) alloca (sizeof *s); \
22270 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22271 append_glyph_string (&HEAD, &TAIL, s); \
22273 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22279 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22280 of AREA of glyph row ROW on window W between indices START and END.
22281 HL overrides the face for drawing glyph strings, e.g. it is
22282 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22283 x-positions of the drawing area.
22285 This is an ugly monster macro construct because we must use alloca
22286 to allocate glyph strings (because draw_glyphs can be called
22287 asynchronously). */
22289 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22292 HEAD = TAIL = NULL; \
22293 while (START < END) \
22295 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22296 switch (first_glyph->type) \
22299 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22303 case COMPOSITE_GLYPH: \
22304 if (first_glyph->u.cmp.automatic) \
22305 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22308 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22312 case STRETCH_GLYPH: \
22313 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22317 case IMAGE_GLYPH: \
22318 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22322 case GLYPHLESS_GLYPH: \
22323 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22333 set_glyph_string_background_width (s, START, LAST_X); \
22340 /* Draw glyphs between START and END in AREA of ROW on window W,
22341 starting at x-position X. X is relative to AREA in W. HL is a
22342 face-override with the following meaning:
22344 DRAW_NORMAL_TEXT draw normally
22345 DRAW_CURSOR draw in cursor face
22346 DRAW_MOUSE_FACE draw in mouse face.
22347 DRAW_INVERSE_VIDEO draw in mode line face
22348 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22349 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22351 If OVERLAPS is non-zero, draw only the foreground of characters and
22352 clip to the physical height of ROW. Non-zero value also defines
22353 the overlapping part to be drawn:
22355 OVERLAPS_PRED overlap with preceding rows
22356 OVERLAPS_SUCC overlap with succeeding rows
22357 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22358 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22360 Value is the x-position reached, relative to AREA of W. */
22363 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22364 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22365 enum draw_glyphs_face hl
, int overlaps
)
22367 struct glyph_string
*head
, *tail
;
22368 struct glyph_string
*s
;
22369 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22370 int i
, j
, x_reached
, last_x
, area_left
= 0;
22371 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22374 ALLOCATE_HDC (hdc
, f
);
22376 /* Let's rather be paranoid than getting a SEGV. */
22377 end
= min (end
, row
->used
[area
]);
22378 start
= max (0, start
);
22379 start
= min (end
, start
);
22381 /* Translate X to frame coordinates. Set last_x to the right
22382 end of the drawing area. */
22383 if (row
->full_width_p
)
22385 /* X is relative to the left edge of W, without scroll bars
22387 area_left
= WINDOW_LEFT_EDGE_X (w
);
22388 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22392 area_left
= window_box_left (w
, area
);
22393 last_x
= area_left
+ window_box_width (w
, area
);
22397 /* Build a doubly-linked list of glyph_string structures between
22398 head and tail from what we have to draw. Note that the macro
22399 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22400 the reason we use a separate variable `i'. */
22402 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22404 x_reached
= tail
->x
+ tail
->background_width
;
22408 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22409 the row, redraw some glyphs in front or following the glyph
22410 strings built above. */
22411 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22413 struct glyph_string
*h
, *t
;
22414 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22415 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22416 int check_mouse_face
= 0;
22419 /* If mouse highlighting is on, we may need to draw adjacent
22420 glyphs using mouse-face highlighting. */
22421 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22423 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22425 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22426 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22428 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22430 check_mouse_face
= 1;
22431 mouse_beg_col
= (row
== mouse_beg_row
)
22432 ? hlinfo
->mouse_face_beg_col
: 0;
22433 mouse_end_col
= (row
== mouse_end_row
)
22434 ? hlinfo
->mouse_face_end_col
22435 : row
->used
[TEXT_AREA
];
22439 /* Compute overhangs for all glyph strings. */
22440 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22441 for (s
= head
; s
; s
= s
->next
)
22442 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22444 /* Prepend glyph strings for glyphs in front of the first glyph
22445 string that are overwritten because of the first glyph
22446 string's left overhang. The background of all strings
22447 prepended must be drawn because the first glyph string
22449 i
= left_overwritten (head
);
22452 enum draw_glyphs_face overlap_hl
;
22454 /* If this row contains mouse highlighting, attempt to draw
22455 the overlapped glyphs with the correct highlight. This
22456 code fails if the overlap encompasses more than one glyph
22457 and mouse-highlight spans only some of these glyphs.
22458 However, making it work perfectly involves a lot more
22459 code, and I don't know if the pathological case occurs in
22460 practice, so we'll stick to this for now. --- cyd */
22461 if (check_mouse_face
22462 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22463 overlap_hl
= DRAW_MOUSE_FACE
;
22465 overlap_hl
= DRAW_NORMAL_TEXT
;
22468 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22469 overlap_hl
, dummy_x
, last_x
);
22471 compute_overhangs_and_x (t
, head
->x
, 1);
22472 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22476 /* Prepend glyph strings for glyphs in front of the first glyph
22477 string that overwrite that glyph string because of their
22478 right overhang. For these strings, only the foreground must
22479 be drawn, because it draws over the glyph string at `head'.
22480 The background must not be drawn because this would overwrite
22481 right overhangs of preceding glyphs for which no glyph
22483 i
= left_overwriting (head
);
22486 enum draw_glyphs_face overlap_hl
;
22488 if (check_mouse_face
22489 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22490 overlap_hl
= DRAW_MOUSE_FACE
;
22492 overlap_hl
= DRAW_NORMAL_TEXT
;
22495 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
22496 overlap_hl
, dummy_x
, last_x
);
22497 for (s
= h
; s
; s
= s
->next
)
22498 s
->background_filled_p
= 1;
22499 compute_overhangs_and_x (t
, head
->x
, 1);
22500 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22503 /* Append glyphs strings for glyphs following the last glyph
22504 string tail that are overwritten by tail. The background of
22505 these strings has to be drawn because tail's foreground draws
22507 i
= right_overwritten (tail
);
22510 enum draw_glyphs_face overlap_hl
;
22512 if (check_mouse_face
22513 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22514 overlap_hl
= DRAW_MOUSE_FACE
;
22516 overlap_hl
= DRAW_NORMAL_TEXT
;
22518 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22519 overlap_hl
, x
, last_x
);
22520 /* Because BUILD_GLYPH_STRINGS updates the first argument,
22521 we don't have `end = i;' here. */
22522 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22523 append_glyph_string_lists (&head
, &tail
, h
, t
);
22527 /* Append glyph strings for glyphs following the last glyph
22528 string tail that overwrite tail. The foreground of such
22529 glyphs has to be drawn because it writes into the background
22530 of tail. The background must not be drawn because it could
22531 paint over the foreground of following glyphs. */
22532 i
= right_overwriting (tail
);
22535 enum draw_glyphs_face overlap_hl
;
22536 if (check_mouse_face
22537 && mouse_beg_col
< i
&& mouse_end_col
> end
)
22538 overlap_hl
= DRAW_MOUSE_FACE
;
22540 overlap_hl
= DRAW_NORMAL_TEXT
;
22543 i
++; /* We must include the Ith glyph. */
22544 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
22545 overlap_hl
, x
, last_x
);
22546 for (s
= h
; s
; s
= s
->next
)
22547 s
->background_filled_p
= 1;
22548 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
22549 append_glyph_string_lists (&head
, &tail
, h
, t
);
22551 if (clip_head
|| clip_tail
)
22552 for (s
= head
; s
; s
= s
->next
)
22554 s
->clip_head
= clip_head
;
22555 s
->clip_tail
= clip_tail
;
22559 /* Draw all strings. */
22560 for (s
= head
; s
; s
= s
->next
)
22561 FRAME_RIF (f
)->draw_glyph_string (s
);
22564 /* When focus a sole frame and move horizontally, this sets on_p to 0
22565 causing a failure to erase prev cursor position. */
22566 if (area
== TEXT_AREA
22567 && !row
->full_width_p
22568 /* When drawing overlapping rows, only the glyph strings'
22569 foreground is drawn, which doesn't erase a cursor
22573 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
22574 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
22575 : (tail
? tail
->x
+ tail
->background_width
: x
));
22579 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
22580 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
22584 /* Value is the x-position up to which drawn, relative to AREA of W.
22585 This doesn't include parts drawn because of overhangs. */
22586 if (row
->full_width_p
)
22587 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
22589 x_reached
-= area_left
;
22591 RELEASE_HDC (hdc
, f
);
22596 /* Expand row matrix if too narrow. Don't expand if area
22599 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
22601 if (!fonts_changed_p \
22602 && (it->glyph_row->glyphs[area] \
22603 < it->glyph_row->glyphs[area + 1])) \
22605 it->w->ncols_scale_factor++; \
22606 fonts_changed_p = 1; \
22610 /* Store one glyph for IT->char_to_display in IT->glyph_row.
22611 Called from x_produce_glyphs when IT->glyph_row is non-null. */
22614 append_glyph (struct it
*it
)
22616 struct glyph
*glyph
;
22617 enum glyph_row_area area
= it
->area
;
22619 xassert (it
->glyph_row
);
22620 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
22622 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22623 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22625 /* If the glyph row is reversed, we need to prepend the glyph
22626 rather than append it. */
22627 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22631 /* Make room for the additional glyph. */
22632 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22634 glyph
= it
->glyph_row
->glyphs
[area
];
22636 glyph
->charpos
= CHARPOS (it
->position
);
22637 glyph
->object
= it
->object
;
22638 if (it
->pixel_width
> 0)
22640 glyph
->pixel_width
= it
->pixel_width
;
22641 glyph
->padding_p
= 0;
22645 /* Assure at least 1-pixel width. Otherwise, cursor can't
22646 be displayed correctly. */
22647 glyph
->pixel_width
= 1;
22648 glyph
->padding_p
= 1;
22650 glyph
->ascent
= it
->ascent
;
22651 glyph
->descent
= it
->descent
;
22652 glyph
->voffset
= it
->voffset
;
22653 glyph
->type
= CHAR_GLYPH
;
22654 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22655 glyph
->multibyte_p
= it
->multibyte_p
;
22656 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22657 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22658 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22659 || it
->phys_descent
> it
->descent
);
22660 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
22661 glyph
->face_id
= it
->face_id
;
22662 glyph
->u
.ch
= it
->char_to_display
;
22663 glyph
->slice
.img
= null_glyph_slice
;
22664 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22667 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22668 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22670 glyph
->bidi_type
= it
->bidi_it
.type
;
22674 glyph
->resolved_level
= 0;
22675 glyph
->bidi_type
= UNKNOWN_BT
;
22677 ++it
->glyph_row
->used
[area
];
22680 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22683 /* Store one glyph for the composition IT->cmp_it.id in
22684 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
22688 append_composite_glyph (struct it
*it
)
22690 struct glyph
*glyph
;
22691 enum glyph_row_area area
= it
->area
;
22693 xassert (it
->glyph_row
);
22695 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22696 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22698 /* If the glyph row is reversed, we need to prepend the glyph
22699 rather than append it. */
22700 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
22704 /* Make room for the new glyph. */
22705 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
22707 glyph
= it
->glyph_row
->glyphs
[it
->area
];
22709 glyph
->charpos
= it
->cmp_it
.charpos
;
22710 glyph
->object
= it
->object
;
22711 glyph
->pixel_width
= it
->pixel_width
;
22712 glyph
->ascent
= it
->ascent
;
22713 glyph
->descent
= it
->descent
;
22714 glyph
->voffset
= it
->voffset
;
22715 glyph
->type
= COMPOSITE_GLYPH
;
22716 if (it
->cmp_it
.ch
< 0)
22718 glyph
->u
.cmp
.automatic
= 0;
22719 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22720 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
22724 glyph
->u
.cmp
.automatic
= 1;
22725 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
22726 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
22727 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
22729 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22730 glyph
->multibyte_p
= it
->multibyte_p
;
22731 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22732 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22733 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
22734 || it
->phys_descent
> it
->descent
);
22735 glyph
->padding_p
= 0;
22736 glyph
->glyph_not_available_p
= 0;
22737 glyph
->face_id
= it
->face_id
;
22738 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22741 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22742 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22744 glyph
->bidi_type
= it
->bidi_it
.type
;
22746 ++it
->glyph_row
->used
[area
];
22749 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22753 /* Change IT->ascent and IT->height according to the setting of
22757 take_vertical_position_into_account (struct it
*it
)
22761 if (it
->voffset
< 0)
22762 /* Increase the ascent so that we can display the text higher
22764 it
->ascent
-= it
->voffset
;
22766 /* Increase the descent so that we can display the text lower
22768 it
->descent
+= it
->voffset
;
22773 /* Produce glyphs/get display metrics for the image IT is loaded with.
22774 See the description of struct display_iterator in dispextern.h for
22775 an overview of struct display_iterator. */
22778 produce_image_glyph (struct it
*it
)
22782 int glyph_ascent
, crop
;
22783 struct glyph_slice slice
;
22785 xassert (it
->what
== IT_IMAGE
);
22787 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
22789 /* Make sure X resources of the face is loaded. */
22790 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
22792 if (it
->image_id
< 0)
22794 /* Fringe bitmap. */
22795 it
->ascent
= it
->phys_ascent
= 0;
22796 it
->descent
= it
->phys_descent
= 0;
22797 it
->pixel_width
= 0;
22802 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
22804 /* Make sure X resources of the image is loaded. */
22805 prepare_image_for_display (it
->f
, img
);
22807 slice
.x
= slice
.y
= 0;
22808 slice
.width
= img
->width
;
22809 slice
.height
= img
->height
;
22811 if (INTEGERP (it
->slice
.x
))
22812 slice
.x
= XINT (it
->slice
.x
);
22813 else if (FLOATP (it
->slice
.x
))
22814 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
22816 if (INTEGERP (it
->slice
.y
))
22817 slice
.y
= XINT (it
->slice
.y
);
22818 else if (FLOATP (it
->slice
.y
))
22819 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
22821 if (INTEGERP (it
->slice
.width
))
22822 slice
.width
= XINT (it
->slice
.width
);
22823 else if (FLOATP (it
->slice
.width
))
22824 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
22826 if (INTEGERP (it
->slice
.height
))
22827 slice
.height
= XINT (it
->slice
.height
);
22828 else if (FLOATP (it
->slice
.height
))
22829 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
22831 if (slice
.x
>= img
->width
)
22832 slice
.x
= img
->width
;
22833 if (slice
.y
>= img
->height
)
22834 slice
.y
= img
->height
;
22835 if (slice
.x
+ slice
.width
>= img
->width
)
22836 slice
.width
= img
->width
- slice
.x
;
22837 if (slice
.y
+ slice
.height
> img
->height
)
22838 slice
.height
= img
->height
- slice
.y
;
22840 if (slice
.width
== 0 || slice
.height
== 0)
22843 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
22845 it
->descent
= slice
.height
- glyph_ascent
;
22847 it
->descent
+= img
->vmargin
;
22848 if (slice
.y
+ slice
.height
== img
->height
)
22849 it
->descent
+= img
->vmargin
;
22850 it
->phys_descent
= it
->descent
;
22852 it
->pixel_width
= slice
.width
;
22854 it
->pixel_width
+= img
->hmargin
;
22855 if (slice
.x
+ slice
.width
== img
->width
)
22856 it
->pixel_width
+= img
->hmargin
;
22858 /* It's quite possible for images to have an ascent greater than
22859 their height, so don't get confused in that case. */
22860 if (it
->descent
< 0)
22865 if (face
->box
!= FACE_NO_BOX
)
22867 if (face
->box_line_width
> 0)
22870 it
->ascent
+= face
->box_line_width
;
22871 if (slice
.y
+ slice
.height
== img
->height
)
22872 it
->descent
+= face
->box_line_width
;
22875 if (it
->start_of_box_run_p
&& slice
.x
== 0)
22876 it
->pixel_width
+= eabs (face
->box_line_width
);
22877 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
22878 it
->pixel_width
+= eabs (face
->box_line_width
);
22881 take_vertical_position_into_account (it
);
22883 /* Automatically crop wide image glyphs at right edge so we can
22884 draw the cursor on same display row. */
22885 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
22886 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
22888 it
->pixel_width
-= crop
;
22889 slice
.width
-= crop
;
22894 struct glyph
*glyph
;
22895 enum glyph_row_area area
= it
->area
;
22897 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22898 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22900 glyph
->charpos
= CHARPOS (it
->position
);
22901 glyph
->object
= it
->object
;
22902 glyph
->pixel_width
= it
->pixel_width
;
22903 glyph
->ascent
= glyph_ascent
;
22904 glyph
->descent
= it
->descent
;
22905 glyph
->voffset
= it
->voffset
;
22906 glyph
->type
= IMAGE_GLYPH
;
22907 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22908 glyph
->multibyte_p
= it
->multibyte_p
;
22909 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22910 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22911 glyph
->overlaps_vertically_p
= 0;
22912 glyph
->padding_p
= 0;
22913 glyph
->glyph_not_available_p
= 0;
22914 glyph
->face_id
= it
->face_id
;
22915 glyph
->u
.img_id
= img
->id
;
22916 glyph
->slice
.img
= slice
;
22917 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22920 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22921 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22923 glyph
->bidi_type
= it
->bidi_it
.type
;
22925 ++it
->glyph_row
->used
[area
];
22928 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22933 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
22934 of the glyph, WIDTH and HEIGHT are the width and height of the
22935 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
22938 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
22939 int width
, int height
, int ascent
)
22941 struct glyph
*glyph
;
22942 enum glyph_row_area area
= it
->area
;
22944 xassert (ascent
>= 0 && ascent
<= height
);
22946 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
22947 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
22949 /* If the glyph row is reversed, we need to prepend the glyph
22950 rather than append it. */
22951 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
22955 /* Make room for the additional glyph. */
22956 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
22958 glyph
= it
->glyph_row
->glyphs
[area
];
22960 glyph
->charpos
= CHARPOS (it
->position
);
22961 glyph
->object
= object
;
22962 glyph
->pixel_width
= width
;
22963 glyph
->ascent
= ascent
;
22964 glyph
->descent
= height
- ascent
;
22965 glyph
->voffset
= it
->voffset
;
22966 glyph
->type
= STRETCH_GLYPH
;
22967 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
22968 glyph
->multibyte_p
= it
->multibyte_p
;
22969 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
22970 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
22971 glyph
->overlaps_vertically_p
= 0;
22972 glyph
->padding_p
= 0;
22973 glyph
->glyph_not_available_p
= 0;
22974 glyph
->face_id
= it
->face_id
;
22975 glyph
->u
.stretch
.ascent
= ascent
;
22976 glyph
->u
.stretch
.height
= height
;
22977 glyph
->slice
.img
= null_glyph_slice
;
22978 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
22981 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
22982 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
22984 glyph
->bidi_type
= it
->bidi_it
.type
;
22988 glyph
->resolved_level
= 0;
22989 glyph
->bidi_type
= UNKNOWN_BT
;
22991 ++it
->glyph_row
->used
[area
];
22994 IT_EXPAND_MATRIX_WIDTH (it
, area
);
22998 /* Produce a stretch glyph for iterator IT. IT->object is the value
22999 of the glyph property displayed. The value must be a list
23000 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23003 1. `:width WIDTH' specifies that the space should be WIDTH *
23004 canonical char width wide. WIDTH may be an integer or floating
23007 2. `:relative-width FACTOR' specifies that the width of the stretch
23008 should be computed from the width of the first character having the
23009 `glyph' property, and should be FACTOR times that width.
23011 3. `:align-to HPOS' specifies that the space should be wide enough
23012 to reach HPOS, a value in canonical character units.
23014 Exactly one of the above pairs must be present.
23016 4. `:height HEIGHT' specifies that the height of the stretch produced
23017 should be HEIGHT, measured in canonical character units.
23019 5. `:relative-height FACTOR' specifies that the height of the
23020 stretch should be FACTOR times the height of the characters having
23021 the glyph property.
23023 Either none or exactly one of 4 or 5 must be present.
23025 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23026 of the stretch should be used for the ascent of the stretch.
23027 ASCENT must be in the range 0 <= ASCENT <= 100. */
23030 produce_stretch_glyph (struct it
*it
)
23032 /* (space :width WIDTH :height HEIGHT ...) */
23033 Lisp_Object prop
, plist
;
23034 int width
= 0, height
= 0, align_to
= -1;
23035 int zero_width_ok_p
= 0, zero_height_ok_p
= 0;
23038 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23039 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23041 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23043 /* List should start with `space'. */
23044 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23045 plist
= XCDR (it
->object
);
23047 /* Compute the width of the stretch. */
23048 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23049 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23051 /* Absolute width `:width WIDTH' specified and valid. */
23052 zero_width_ok_p
= 1;
23055 else if (prop
= Fplist_get (plist
, QCrelative_width
),
23058 /* Relative width `:relative-width FACTOR' specified and valid.
23059 Compute the width of the characters having the `glyph'
23062 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23065 if (it
->multibyte_p
)
23066 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23069 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23070 if (! ASCII_CHAR_P (it2
.c
))
23071 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23074 it2
.glyph_row
= NULL
;
23075 it2
.what
= IT_CHARACTER
;
23076 x_produce_glyphs (&it2
);
23077 width
= NUMVAL (prop
) * it2
.pixel_width
;
23079 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23080 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23082 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23083 align_to
= (align_to
< 0
23085 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23086 else if (align_to
< 0)
23087 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23088 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23089 zero_width_ok_p
= 1;
23092 /* Nothing specified -> width defaults to canonical char width. */
23093 width
= FRAME_COLUMN_WIDTH (it
->f
);
23095 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23098 /* Compute height. */
23099 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23100 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23103 zero_height_ok_p
= 1;
23105 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23107 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23109 height
= FONT_HEIGHT (font
);
23111 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23114 /* Compute percentage of height used for ascent. If
23115 `:ascent ASCENT' is present and valid, use that. Otherwise,
23116 derive the ascent from the font in use. */
23117 if (prop
= Fplist_get (plist
, QCascent
),
23118 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23119 ascent
= height
* NUMVAL (prop
) / 100.0;
23120 else if (!NILP (prop
)
23121 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23122 ascent
= min (max (0, (int)tem
), height
);
23124 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23126 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23127 && it
->current_x
+ width
> it
->last_visible_x
)
23128 width
= it
->last_visible_x
- it
->current_x
- 1;
23130 if (width
> 0 && height
> 0 && it
->glyph_row
)
23132 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23133 if (!STRINGP (object
))
23134 object
= it
->w
->buffer
;
23135 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23138 it
->pixel_width
= width
;
23139 it
->ascent
= it
->phys_ascent
= ascent
;
23140 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23141 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23143 take_vertical_position_into_account (it
);
23146 /* Calculate line-height and line-spacing properties.
23147 An integer value specifies explicit pixel value.
23148 A float value specifies relative value to current face height.
23149 A cons (float . face-name) specifies relative value to
23150 height of specified face font.
23152 Returns height in pixels, or nil. */
23156 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23157 int boff
, int override
)
23159 Lisp_Object face_name
= Qnil
;
23160 int ascent
, descent
, height
;
23162 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23167 face_name
= XCAR (val
);
23169 if (!NUMBERP (val
))
23170 val
= make_number (1);
23171 if (NILP (face_name
))
23173 height
= it
->ascent
+ it
->descent
;
23178 if (NILP (face_name
))
23180 font
= FRAME_FONT (it
->f
);
23181 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23183 else if (EQ (face_name
, Qt
))
23192 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23194 return make_number (-1);
23196 face
= FACE_FROM_ID (it
->f
, face_id
);
23199 return make_number (-1);
23200 boff
= font
->baseline_offset
;
23201 if (font
->vertical_centering
)
23202 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23205 ascent
= FONT_BASE (font
) + boff
;
23206 descent
= FONT_DESCENT (font
) - boff
;
23210 it
->override_ascent
= ascent
;
23211 it
->override_descent
= descent
;
23212 it
->override_boff
= boff
;
23215 height
= ascent
+ descent
;
23219 height
= (int)(XFLOAT_DATA (val
) * height
);
23220 else if (INTEGERP (val
))
23221 height
*= XINT (val
);
23223 return make_number (height
);
23227 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23228 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23229 and only if this is for a character for which no font was found.
23231 If the display method (it->glyphless_method) is
23232 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23233 length of the acronym or the hexadecimal string, UPPER_XOFF and
23234 UPPER_YOFF are pixel offsets for the upper part of the string,
23235 LOWER_XOFF and LOWER_YOFF are for the lower part.
23237 For the other display methods, LEN through LOWER_YOFF are zero. */
23240 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23241 short upper_xoff
, short upper_yoff
,
23242 short lower_xoff
, short lower_yoff
)
23244 struct glyph
*glyph
;
23245 enum glyph_row_area area
= it
->area
;
23247 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23248 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23250 /* If the glyph row is reversed, we need to prepend the glyph
23251 rather than append it. */
23252 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23256 /* Make room for the additional glyph. */
23257 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23259 glyph
= it
->glyph_row
->glyphs
[area
];
23261 glyph
->charpos
= CHARPOS (it
->position
);
23262 glyph
->object
= it
->object
;
23263 glyph
->pixel_width
= it
->pixel_width
;
23264 glyph
->ascent
= it
->ascent
;
23265 glyph
->descent
= it
->descent
;
23266 glyph
->voffset
= it
->voffset
;
23267 glyph
->type
= GLYPHLESS_GLYPH
;
23268 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23269 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23270 glyph
->u
.glyphless
.len
= len
;
23271 glyph
->u
.glyphless
.ch
= it
->c
;
23272 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23273 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23274 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23275 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23276 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23277 glyph
->multibyte_p
= it
->multibyte_p
;
23278 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23279 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23280 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23281 || it
->phys_descent
> it
->descent
);
23282 glyph
->padding_p
= 0;
23283 glyph
->glyph_not_available_p
= 0;
23284 glyph
->face_id
= face_id
;
23285 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23288 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23289 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23291 glyph
->bidi_type
= it
->bidi_it
.type
;
23293 ++it
->glyph_row
->used
[area
];
23296 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23300 /* Produce a glyph for a glyphless character for iterator IT.
23301 IT->glyphless_method specifies which method to use for displaying
23302 the character. See the description of enum
23303 glyphless_display_method in dispextern.h for the detail.
23305 FOR_NO_FONT is nonzero if and only if this is for a character for
23306 which no font was found. ACRONYM, if non-nil, is an acronym string
23307 for the character. */
23310 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23315 int base_width
, base_height
, width
, height
;
23316 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23319 /* Get the metrics of the base font. We always refer to the current
23321 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23322 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23323 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23324 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23325 base_height
= it
->ascent
+ it
->descent
;
23326 base_width
= font
->average_width
;
23328 /* Get a face ID for the glyph by utilizing a cache (the same way as
23329 done for `escape-glyph' in get_next_display_element). */
23330 if (it
->f
== last_glyphless_glyph_frame
23331 && it
->face_id
== last_glyphless_glyph_face_id
)
23333 face_id
= last_glyphless_glyph_merged_face_id
;
23337 /* Merge the `glyphless-char' face into the current face. */
23338 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23339 last_glyphless_glyph_frame
= it
->f
;
23340 last_glyphless_glyph_face_id
= it
->face_id
;
23341 last_glyphless_glyph_merged_face_id
= face_id
;
23344 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23346 it
->pixel_width
= THIN_SPACE_WIDTH
;
23348 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23350 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23352 width
= CHAR_WIDTH (it
->c
);
23355 else if (width
> 4)
23357 it
->pixel_width
= base_width
* width
;
23359 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23365 unsigned int code
[6];
23367 int ascent
, descent
;
23368 struct font_metrics metrics_upper
, metrics_lower
;
23370 face
= FACE_FROM_ID (it
->f
, face_id
);
23371 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23372 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23374 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23376 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23377 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23378 if (CONSP (acronym
))
23379 acronym
= XCAR (acronym
);
23380 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23384 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23385 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23388 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23389 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23390 upper_len
= (len
+ 1) / 2;
23391 font
->driver
->text_extents (font
, code
, upper_len
,
23393 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23398 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23399 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23400 upper_xoff
= upper_yoff
= 2; /* the typical case */
23401 if (base_width
>= width
)
23403 /* Align the upper to the left, the lower to the right. */
23404 it
->pixel_width
= base_width
;
23405 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23409 /* Center the shorter one. */
23410 it
->pixel_width
= width
;
23411 if (metrics_upper
.width
>= metrics_lower
.width
)
23412 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23415 /* FIXME: This code doesn't look right. It formerly was
23416 missing the "lower_xoff = 0;", which couldn't have
23417 been right since it left lower_xoff uninitialized. */
23419 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23423 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23424 top, bottom, and between upper and lower strings. */
23425 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23426 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23427 /* Center vertically.
23428 H:base_height, D:base_descent
23429 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23431 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23432 descent = D - H/2 + h/2;
23433 lower_yoff = descent - 2 - ld;
23434 upper_yoff = lower_yoff - la - 1 - ud; */
23435 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23436 descent
= it
->descent
- (base_height
- height
) / 2;
23437 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23438 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23439 - metrics_upper
.descent
);
23440 /* Don't make the height shorter than the base height. */
23441 if (height
> base_height
)
23443 it
->ascent
= ascent
;
23444 it
->descent
= descent
;
23448 it
->phys_ascent
= it
->ascent
;
23449 it
->phys_descent
= it
->descent
;
23451 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
23452 upper_xoff
, upper_yoff
,
23453 lower_xoff
, lower_yoff
);
23455 take_vertical_position_into_account (it
);
23460 Produce glyphs/get display metrics for the display element IT is
23461 loaded with. See the description of struct it in dispextern.h
23462 for an overview of struct it. */
23465 x_produce_glyphs (struct it
*it
)
23467 int extra_line_spacing
= it
->extra_line_spacing
;
23469 it
->glyph_not_available_p
= 0;
23471 if (it
->what
== IT_CHARACTER
)
23474 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23475 struct font
*font
= face
->font
;
23476 struct font_metrics
*pcm
= NULL
;
23477 int boff
; /* baseline offset */
23481 /* When no suitable font is found, display this character by
23482 the method specified in the first extra slot of
23483 Vglyphless_char_display. */
23484 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
23486 xassert (it
->what
== IT_GLYPHLESS
);
23487 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
23491 boff
= font
->baseline_offset
;
23492 if (font
->vertical_centering
)
23493 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23495 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
23501 if (it
->override_ascent
>= 0)
23503 it
->ascent
= it
->override_ascent
;
23504 it
->descent
= it
->override_descent
;
23505 boff
= it
->override_boff
;
23509 it
->ascent
= FONT_BASE (font
) + boff
;
23510 it
->descent
= FONT_DESCENT (font
) - boff
;
23513 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
23515 pcm
= get_per_char_metric (font
, &char2b
);
23516 if (pcm
->width
== 0
23517 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
23523 it
->phys_ascent
= pcm
->ascent
+ boff
;
23524 it
->phys_descent
= pcm
->descent
- boff
;
23525 it
->pixel_width
= pcm
->width
;
23529 it
->glyph_not_available_p
= 1;
23530 it
->phys_ascent
= it
->ascent
;
23531 it
->phys_descent
= it
->descent
;
23532 it
->pixel_width
= font
->space_width
;
23535 if (it
->constrain_row_ascent_descent_p
)
23537 if (it
->descent
> it
->max_descent
)
23539 it
->ascent
+= it
->descent
- it
->max_descent
;
23540 it
->descent
= it
->max_descent
;
23542 if (it
->ascent
> it
->max_ascent
)
23544 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23545 it
->ascent
= it
->max_ascent
;
23547 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23548 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23549 extra_line_spacing
= 0;
23552 /* If this is a space inside a region of text with
23553 `space-width' property, change its width. */
23554 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
23556 it
->pixel_width
*= XFLOATINT (it
->space_width
);
23558 /* If face has a box, add the box thickness to the character
23559 height. If character has a box line to the left and/or
23560 right, add the box line width to the character's width. */
23561 if (face
->box
!= FACE_NO_BOX
)
23563 int thick
= face
->box_line_width
;
23567 it
->ascent
+= thick
;
23568 it
->descent
+= thick
;
23573 if (it
->start_of_box_run_p
)
23574 it
->pixel_width
+= thick
;
23575 if (it
->end_of_box_run_p
)
23576 it
->pixel_width
+= thick
;
23579 /* If face has an overline, add the height of the overline
23580 (1 pixel) and a 1 pixel margin to the character height. */
23581 if (face
->overline_p
)
23582 it
->ascent
+= overline_margin
;
23584 if (it
->constrain_row_ascent_descent_p
)
23586 if (it
->ascent
> it
->max_ascent
)
23587 it
->ascent
= it
->max_ascent
;
23588 if (it
->descent
> it
->max_descent
)
23589 it
->descent
= it
->max_descent
;
23592 take_vertical_position_into_account (it
);
23594 /* If we have to actually produce glyphs, do it. */
23599 /* Translate a space with a `space-width' property
23600 into a stretch glyph. */
23601 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
23602 / FONT_HEIGHT (font
));
23603 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23604 it
->ascent
+ it
->descent
, ascent
);
23609 /* If characters with lbearing or rbearing are displayed
23610 in this line, record that fact in a flag of the
23611 glyph row. This is used to optimize X output code. */
23612 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
23613 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
23615 if (! stretched_p
&& it
->pixel_width
== 0)
23616 /* We assure that all visible glyphs have at least 1-pixel
23618 it
->pixel_width
= 1;
23620 else if (it
->char_to_display
== '\n')
23622 /* A newline has no width, but we need the height of the
23623 line. But if previous part of the line sets a height,
23624 don't increase that height */
23626 Lisp_Object height
;
23627 Lisp_Object total_height
= Qnil
;
23629 it
->override_ascent
= -1;
23630 it
->pixel_width
= 0;
23633 height
= get_it_property (it
, Qline_height
);
23634 /* Split (line-height total-height) list */
23636 && CONSP (XCDR (height
))
23637 && NILP (XCDR (XCDR (height
))))
23639 total_height
= XCAR (XCDR (height
));
23640 height
= XCAR (height
);
23642 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
23644 if (it
->override_ascent
>= 0)
23646 it
->ascent
= it
->override_ascent
;
23647 it
->descent
= it
->override_descent
;
23648 boff
= it
->override_boff
;
23652 it
->ascent
= FONT_BASE (font
) + boff
;
23653 it
->descent
= FONT_DESCENT (font
) - boff
;
23656 if (EQ (height
, Qt
))
23658 if (it
->descent
> it
->max_descent
)
23660 it
->ascent
+= it
->descent
- it
->max_descent
;
23661 it
->descent
= it
->max_descent
;
23663 if (it
->ascent
> it
->max_ascent
)
23665 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
23666 it
->ascent
= it
->max_ascent
;
23668 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
23669 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
23670 it
->constrain_row_ascent_descent_p
= 1;
23671 extra_line_spacing
= 0;
23675 Lisp_Object spacing
;
23677 it
->phys_ascent
= it
->ascent
;
23678 it
->phys_descent
= it
->descent
;
23680 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
23681 && face
->box
!= FACE_NO_BOX
23682 && face
->box_line_width
> 0)
23684 it
->ascent
+= face
->box_line_width
;
23685 it
->descent
+= face
->box_line_width
;
23688 && XINT (height
) > it
->ascent
+ it
->descent
)
23689 it
->ascent
= XINT (height
) - it
->descent
;
23691 if (!NILP (total_height
))
23692 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
23695 spacing
= get_it_property (it
, Qline_spacing
);
23696 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
23698 if (INTEGERP (spacing
))
23700 extra_line_spacing
= XINT (spacing
);
23701 if (!NILP (total_height
))
23702 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
23706 else /* i.e. (it->char_to_display == '\t') */
23708 if (font
->space_width
> 0)
23710 int tab_width
= it
->tab_width
* font
->space_width
;
23711 int x
= it
->current_x
+ it
->continuation_lines_width
;
23712 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
23714 /* If the distance from the current position to the next tab
23715 stop is less than a space character width, use the
23716 tab stop after that. */
23717 if (next_tab_x
- x
< font
->space_width
)
23718 next_tab_x
+= tab_width
;
23720 it
->pixel_width
= next_tab_x
- x
;
23722 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
23723 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
23727 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
23728 it
->ascent
+ it
->descent
, it
->ascent
);
23733 it
->pixel_width
= 0;
23738 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
23740 /* A static composition.
23742 Note: A composition is represented as one glyph in the
23743 glyph matrix. There are no padding glyphs.
23745 Important note: pixel_width, ascent, and descent are the
23746 values of what is drawn by draw_glyphs (i.e. the values of
23747 the overall glyphs composed). */
23748 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23749 int boff
; /* baseline offset */
23750 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
23751 int glyph_len
= cmp
->glyph_len
;
23752 struct font
*font
= face
->font
;
23756 /* If we have not yet calculated pixel size data of glyphs of
23757 the composition for the current face font, calculate them
23758 now. Theoretically, we have to check all fonts for the
23759 glyphs, but that requires much time and memory space. So,
23760 here we check only the font of the first glyph. This may
23761 lead to incorrect display, but it's very rare, and C-l
23762 (recenter-top-bottom) can correct the display anyway. */
23763 if (! cmp
->font
|| cmp
->font
!= font
)
23765 /* Ascent and descent of the font of the first character
23766 of this composition (adjusted by baseline offset).
23767 Ascent and descent of overall glyphs should not be less
23768 than these, respectively. */
23769 int font_ascent
, font_descent
, font_height
;
23770 /* Bounding box of the overall glyphs. */
23771 int leftmost
, rightmost
, lowest
, highest
;
23772 int lbearing
, rbearing
;
23773 int i
, width
, ascent
, descent
;
23774 int left_padded
= 0, right_padded
= 0;
23775 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
23777 struct font_metrics
*pcm
;
23778 int font_not_found_p
;
23781 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
23782 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
23784 if (glyph_len
< cmp
->glyph_len
)
23786 for (i
= 0; i
< glyph_len
; i
++)
23788 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
23790 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23795 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
23796 : IT_CHARPOS (*it
));
23797 /* If no suitable font is found, use the default font. */
23798 font_not_found_p
= font
== NULL
;
23799 if (font_not_found_p
)
23801 face
= face
->ascii_face
;
23804 boff
= font
->baseline_offset
;
23805 if (font
->vertical_centering
)
23806 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23807 font_ascent
= FONT_BASE (font
) + boff
;
23808 font_descent
= FONT_DESCENT (font
) - boff
;
23809 font_height
= FONT_HEIGHT (font
);
23811 cmp
->font
= (void *) font
;
23814 if (! font_not_found_p
)
23816 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
23818 pcm
= get_per_char_metric (font
, &char2b
);
23821 /* Initialize the bounding box. */
23824 width
= pcm
->width
;
23825 ascent
= pcm
->ascent
;
23826 descent
= pcm
->descent
;
23827 lbearing
= pcm
->lbearing
;
23828 rbearing
= pcm
->rbearing
;
23832 width
= font
->space_width
;
23833 ascent
= FONT_BASE (font
);
23834 descent
= FONT_DESCENT (font
);
23841 lowest
= - descent
+ boff
;
23842 highest
= ascent
+ boff
;
23844 if (! font_not_found_p
23845 && font
->default_ascent
23846 && CHAR_TABLE_P (Vuse_default_ascent
)
23847 && !NILP (Faref (Vuse_default_ascent
,
23848 make_number (it
->char_to_display
))))
23849 highest
= font
->default_ascent
+ boff
;
23851 /* Draw the first glyph at the normal position. It may be
23852 shifted to right later if some other glyphs are drawn
23854 cmp
->offsets
[i
* 2] = 0;
23855 cmp
->offsets
[i
* 2 + 1] = boff
;
23856 cmp
->lbearing
= lbearing
;
23857 cmp
->rbearing
= rbearing
;
23859 /* Set cmp->offsets for the remaining glyphs. */
23860 for (i
++; i
< glyph_len
; i
++)
23862 int left
, right
, btm
, top
;
23863 int ch
= COMPOSITION_GLYPH (cmp
, i
);
23865 struct face
*this_face
;
23869 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
23870 this_face
= FACE_FROM_ID (it
->f
, face_id
);
23871 font
= this_face
->font
;
23877 get_char_face_and_encoding (it
->f
, ch
, face_id
,
23879 pcm
= get_per_char_metric (font
, &char2b
);
23882 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
23885 width
= pcm
->width
;
23886 ascent
= pcm
->ascent
;
23887 descent
= pcm
->descent
;
23888 lbearing
= pcm
->lbearing
;
23889 rbearing
= pcm
->rbearing
;
23890 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
23892 /* Relative composition with or without
23893 alternate chars. */
23894 left
= (leftmost
+ rightmost
- width
) / 2;
23895 btm
= - descent
+ boff
;
23896 if (font
->relative_compose
23897 && (! CHAR_TABLE_P (Vignore_relative_composition
)
23898 || NILP (Faref (Vignore_relative_composition
,
23899 make_number (ch
)))))
23902 if (- descent
>= font
->relative_compose
)
23903 /* One extra pixel between two glyphs. */
23905 else if (ascent
<= 0)
23906 /* One extra pixel between two glyphs. */
23907 btm
= lowest
- 1 - ascent
- descent
;
23912 /* A composition rule is specified by an integer
23913 value that encodes global and new reference
23914 points (GREF and NREF). GREF and NREF are
23915 specified by numbers as below:
23917 0---1---2 -- ascent
23921 9--10--11 -- center
23923 ---3---4---5--- baseline
23925 6---7---8 -- descent
23927 int rule
= COMPOSITION_RULE (cmp
, i
);
23928 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
23930 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
23931 grefx
= gref
% 3, nrefx
= nref
% 3;
23932 grefy
= gref
/ 3, nrefy
= nref
/ 3;
23934 xoff
= font_height
* (xoff
- 128) / 256;
23936 yoff
= font_height
* (yoff
- 128) / 256;
23939 + grefx
* (rightmost
- leftmost
) / 2
23940 - nrefx
* width
/ 2
23943 btm
= ((grefy
== 0 ? highest
23945 : grefy
== 2 ? lowest
23946 : (highest
+ lowest
) / 2)
23947 - (nrefy
== 0 ? ascent
+ descent
23948 : nrefy
== 1 ? descent
- boff
23950 : (ascent
+ descent
) / 2)
23954 cmp
->offsets
[i
* 2] = left
;
23955 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
23957 /* Update the bounding box of the overall glyphs. */
23960 right
= left
+ width
;
23961 if (left
< leftmost
)
23963 if (right
> rightmost
)
23966 top
= btm
+ descent
+ ascent
;
23972 if (cmp
->lbearing
> left
+ lbearing
)
23973 cmp
->lbearing
= left
+ lbearing
;
23974 if (cmp
->rbearing
< left
+ rbearing
)
23975 cmp
->rbearing
= left
+ rbearing
;
23979 /* If there are glyphs whose x-offsets are negative,
23980 shift all glyphs to the right and make all x-offsets
23984 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23985 cmp
->offsets
[i
* 2] -= leftmost
;
23986 rightmost
-= leftmost
;
23987 cmp
->lbearing
-= leftmost
;
23988 cmp
->rbearing
-= leftmost
;
23991 if (left_padded
&& cmp
->lbearing
< 0)
23993 for (i
= 0; i
< cmp
->glyph_len
; i
++)
23994 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
23995 rightmost
-= cmp
->lbearing
;
23996 cmp
->rbearing
-= cmp
->lbearing
;
23999 if (right_padded
&& rightmost
< cmp
->rbearing
)
24001 rightmost
= cmp
->rbearing
;
24004 cmp
->pixel_width
= rightmost
;
24005 cmp
->ascent
= highest
;
24006 cmp
->descent
= - lowest
;
24007 if (cmp
->ascent
< font_ascent
)
24008 cmp
->ascent
= font_ascent
;
24009 if (cmp
->descent
< font_descent
)
24010 cmp
->descent
= font_descent
;
24014 && (cmp
->lbearing
< 0
24015 || cmp
->rbearing
> cmp
->pixel_width
))
24016 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24018 it
->pixel_width
= cmp
->pixel_width
;
24019 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24020 it
->descent
= it
->phys_descent
= cmp
->descent
;
24021 if (face
->box
!= FACE_NO_BOX
)
24023 int thick
= face
->box_line_width
;
24027 it
->ascent
+= thick
;
24028 it
->descent
+= thick
;
24033 if (it
->start_of_box_run_p
)
24034 it
->pixel_width
+= thick
;
24035 if (it
->end_of_box_run_p
)
24036 it
->pixel_width
+= thick
;
24039 /* If face has an overline, add the height of the overline
24040 (1 pixel) and a 1 pixel margin to the character height. */
24041 if (face
->overline_p
)
24042 it
->ascent
+= overline_margin
;
24044 take_vertical_position_into_account (it
);
24045 if (it
->ascent
< 0)
24047 if (it
->descent
< 0)
24051 append_composite_glyph (it
);
24053 else if (it
->what
== IT_COMPOSITION
)
24055 /* A dynamic (automatic) composition. */
24056 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24057 Lisp_Object gstring
;
24058 struct font_metrics metrics
;
24060 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24062 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24065 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24066 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24067 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24068 it
->descent
= it
->phys_descent
= metrics
.descent
;
24069 if (face
->box
!= FACE_NO_BOX
)
24071 int thick
= face
->box_line_width
;
24075 it
->ascent
+= thick
;
24076 it
->descent
+= thick
;
24081 if (it
->start_of_box_run_p
)
24082 it
->pixel_width
+= thick
;
24083 if (it
->end_of_box_run_p
)
24084 it
->pixel_width
+= thick
;
24086 /* If face has an overline, add the height of the overline
24087 (1 pixel) and a 1 pixel margin to the character height. */
24088 if (face
->overline_p
)
24089 it
->ascent
+= overline_margin
;
24090 take_vertical_position_into_account (it
);
24091 if (it
->ascent
< 0)
24093 if (it
->descent
< 0)
24097 append_composite_glyph (it
);
24099 else if (it
->what
== IT_GLYPHLESS
)
24100 produce_glyphless_glyph (it
, 0, Qnil
);
24101 else if (it
->what
== IT_IMAGE
)
24102 produce_image_glyph (it
);
24103 else if (it
->what
== IT_STRETCH
)
24104 produce_stretch_glyph (it
);
24107 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24108 because this isn't true for images with `:ascent 100'. */
24109 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24110 if (it
->area
== TEXT_AREA
)
24111 it
->current_x
+= it
->pixel_width
;
24113 if (extra_line_spacing
> 0)
24115 it
->descent
+= extra_line_spacing
;
24116 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24117 it
->max_extra_line_spacing
= extra_line_spacing
;
24120 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24121 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24122 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24123 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24127 Output LEN glyphs starting at START at the nominal cursor position.
24128 Advance the nominal cursor over the text. The global variable
24129 updated_window contains the window being updated, updated_row is
24130 the glyph row being updated, and updated_area is the area of that
24131 row being updated. */
24134 x_write_glyphs (struct glyph
*start
, int len
)
24138 xassert (updated_window
&& updated_row
);
24141 /* Write glyphs. */
24143 hpos
= start
- updated_row
->glyphs
[updated_area
];
24144 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24145 updated_row
, updated_area
,
24147 DRAW_NORMAL_TEXT
, 0);
24149 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24150 if (updated_area
== TEXT_AREA
24151 && updated_window
->phys_cursor_on_p
24152 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24153 && updated_window
->phys_cursor
.hpos
>= hpos
24154 && updated_window
->phys_cursor
.hpos
< hpos
+ len
)
24155 updated_window
->phys_cursor_on_p
= 0;
24159 /* Advance the output cursor. */
24160 output_cursor
.hpos
+= len
;
24161 output_cursor
.x
= x
;
24166 Insert LEN glyphs from START at the nominal cursor position. */
24169 x_insert_glyphs (struct glyph
*start
, int len
)
24173 int line_height
, shift_by_width
, shifted_region_width
;
24174 struct glyph_row
*row
;
24175 struct glyph
*glyph
;
24176 int frame_x
, frame_y
;
24179 xassert (updated_window
&& updated_row
);
24181 w
= updated_window
;
24182 f
= XFRAME (WINDOW_FRAME (w
));
24184 /* Get the height of the line we are in. */
24186 line_height
= row
->height
;
24188 /* Get the width of the glyphs to insert. */
24189 shift_by_width
= 0;
24190 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24191 shift_by_width
+= glyph
->pixel_width
;
24193 /* Get the width of the region to shift right. */
24194 shifted_region_width
= (window_box_width (w
, updated_area
)
24199 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24200 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24202 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24203 line_height
, shift_by_width
);
24205 /* Write the glyphs. */
24206 hpos
= start
- row
->glyphs
[updated_area
];
24207 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24209 DRAW_NORMAL_TEXT
, 0);
24211 /* Advance the output cursor. */
24212 output_cursor
.hpos
+= len
;
24213 output_cursor
.x
+= shift_by_width
;
24219 Erase the current text line from the nominal cursor position
24220 (inclusive) to pixel column TO_X (exclusive). The idea is that
24221 everything from TO_X onward is already erased.
24223 TO_X is a pixel position relative to updated_area of
24224 updated_window. TO_X == -1 means clear to the end of this area. */
24227 x_clear_end_of_line (int to_x
)
24230 struct window
*w
= updated_window
;
24231 int max_x
, min_y
, max_y
;
24232 int from_x
, from_y
, to_y
;
24234 xassert (updated_window
&& updated_row
);
24235 f
= XFRAME (w
->frame
);
24237 if (updated_row
->full_width_p
)
24238 max_x
= WINDOW_TOTAL_WIDTH (w
);
24240 max_x
= window_box_width (w
, updated_area
);
24241 max_y
= window_text_bottom_y (w
);
24243 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24244 of window. For TO_X > 0, truncate to end of drawing area. */
24250 to_x
= min (to_x
, max_x
);
24252 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24254 /* Notice if the cursor will be cleared by this operation. */
24255 if (!updated_row
->full_width_p
)
24256 notice_overwritten_cursor (w
, updated_area
,
24257 output_cursor
.x
, -1,
24259 MATRIX_ROW_BOTTOM_Y (updated_row
));
24261 from_x
= output_cursor
.x
;
24263 /* Translate to frame coordinates. */
24264 if (updated_row
->full_width_p
)
24266 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24267 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24271 int area_left
= window_box_left (w
, updated_area
);
24272 from_x
+= area_left
;
24276 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24277 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24278 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24280 /* Prevent inadvertently clearing to end of the X window. */
24281 if (to_x
> from_x
&& to_y
> from_y
)
24284 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24285 to_x
- from_x
, to_y
- from_y
);
24290 #endif /* HAVE_WINDOW_SYSTEM */
24294 /***********************************************************************
24296 ***********************************************************************/
24298 /* Value is the internal representation of the specified cursor type
24299 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24300 of the bar cursor. */
24302 static enum text_cursor_kinds
24303 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24305 enum text_cursor_kinds type
;
24310 if (EQ (arg
, Qbox
))
24311 return FILLED_BOX_CURSOR
;
24313 if (EQ (arg
, Qhollow
))
24314 return HOLLOW_BOX_CURSOR
;
24316 if (EQ (arg
, Qbar
))
24323 && EQ (XCAR (arg
), Qbar
)
24324 && INTEGERP (XCDR (arg
))
24325 && XINT (XCDR (arg
)) >= 0)
24327 *width
= XINT (XCDR (arg
));
24331 if (EQ (arg
, Qhbar
))
24334 return HBAR_CURSOR
;
24338 && EQ (XCAR (arg
), Qhbar
)
24339 && INTEGERP (XCDR (arg
))
24340 && XINT (XCDR (arg
)) >= 0)
24342 *width
= XINT (XCDR (arg
));
24343 return HBAR_CURSOR
;
24346 /* Treat anything unknown as "hollow box cursor".
24347 It was bad to signal an error; people have trouble fixing
24348 .Xdefaults with Emacs, when it has something bad in it. */
24349 type
= HOLLOW_BOX_CURSOR
;
24354 /* Set the default cursor types for specified frame. */
24356 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24361 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24362 FRAME_CURSOR_WIDTH (f
) = width
;
24364 /* By default, set up the blink-off state depending on the on-state. */
24366 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24369 FRAME_BLINK_OFF_CURSOR (f
)
24370 = get_specified_cursor_type (XCDR (tem
), &width
);
24371 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24374 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24378 #ifdef HAVE_WINDOW_SYSTEM
24380 /* Return the cursor we want to be displayed in window W. Return
24381 width of bar/hbar cursor through WIDTH arg. Return with
24382 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24383 (i.e. if the `system caret' should track this cursor).
24385 In a mini-buffer window, we want the cursor only to appear if we
24386 are reading input from this window. For the selected window, we
24387 want the cursor type given by the frame parameter or buffer local
24388 setting of cursor-type. If explicitly marked off, draw no cursor.
24389 In all other cases, we want a hollow box cursor. */
24391 static enum text_cursor_kinds
24392 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24393 int *active_cursor
)
24395 struct frame
*f
= XFRAME (w
->frame
);
24396 struct buffer
*b
= XBUFFER (w
->buffer
);
24397 int cursor_type
= DEFAULT_CURSOR
;
24398 Lisp_Object alt_cursor
;
24399 int non_selected
= 0;
24401 *active_cursor
= 1;
24404 if (cursor_in_echo_area
24405 && FRAME_HAS_MINIBUF_P (f
)
24406 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24408 if (w
== XWINDOW (echo_area_window
))
24410 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24412 *width
= FRAME_CURSOR_WIDTH (f
);
24413 return FRAME_DESIRED_CURSOR (f
);
24416 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24419 *active_cursor
= 0;
24423 /* Detect a nonselected window or nonselected frame. */
24424 else if (w
!= XWINDOW (f
->selected_window
)
24425 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24427 *active_cursor
= 0;
24429 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
24435 /* Never display a cursor in a window in which cursor-type is nil. */
24436 if (NILP (BVAR (b
, cursor_type
)))
24439 /* Get the normal cursor type for this window. */
24440 if (EQ (BVAR (b
, cursor_type
), Qt
))
24442 cursor_type
= FRAME_DESIRED_CURSOR (f
);
24443 *width
= FRAME_CURSOR_WIDTH (f
);
24446 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24448 /* Use cursor-in-non-selected-windows instead
24449 for non-selected window or frame. */
24452 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
24453 if (!EQ (Qt
, alt_cursor
))
24454 return get_specified_cursor_type (alt_cursor
, width
);
24455 /* t means modify the normal cursor type. */
24456 if (cursor_type
== FILLED_BOX_CURSOR
)
24457 cursor_type
= HOLLOW_BOX_CURSOR
;
24458 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
24460 return cursor_type
;
24463 /* Use normal cursor if not blinked off. */
24464 if (!w
->cursor_off_p
)
24466 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
24468 if (cursor_type
== FILLED_BOX_CURSOR
)
24470 /* Using a block cursor on large images can be very annoying.
24471 So use a hollow cursor for "large" images.
24472 If image is not transparent (no mask), also use hollow cursor. */
24473 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
24474 if (img
!= NULL
&& IMAGEP (img
->spec
))
24476 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
24477 where N = size of default frame font size.
24478 This should cover most of the "tiny" icons people may use. */
24480 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
24481 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
24482 cursor_type
= HOLLOW_BOX_CURSOR
;
24485 else if (cursor_type
!= NO_CURSOR
)
24487 /* Display current only supports BOX and HOLLOW cursors for images.
24488 So for now, unconditionally use a HOLLOW cursor when cursor is
24489 not a solid box cursor. */
24490 cursor_type
= HOLLOW_BOX_CURSOR
;
24493 return cursor_type
;
24496 /* Cursor is blinked off, so determine how to "toggle" it. */
24498 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
24499 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
24500 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
24502 /* Then see if frame has specified a specific blink off cursor type. */
24503 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
24505 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
24506 return FRAME_BLINK_OFF_CURSOR (f
);
24510 /* Some people liked having a permanently visible blinking cursor,
24511 while others had very strong opinions against it. So it was
24512 decided to remove it. KFS 2003-09-03 */
24514 /* Finally perform built-in cursor blinking:
24515 filled box <-> hollow box
24516 wide [h]bar <-> narrow [h]bar
24517 narrow [h]bar <-> no cursor
24518 other type <-> no cursor */
24520 if (cursor_type
== FILLED_BOX_CURSOR
)
24521 return HOLLOW_BOX_CURSOR
;
24523 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
24526 return cursor_type
;
24534 /* Notice when the text cursor of window W has been completely
24535 overwritten by a drawing operation that outputs glyphs in AREA
24536 starting at X0 and ending at X1 in the line starting at Y0 and
24537 ending at Y1. X coordinates are area-relative. X1 < 0 means all
24538 the rest of the line after X0 has been written. Y coordinates
24539 are window-relative. */
24542 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
24543 int x0
, int x1
, int y0
, int y1
)
24545 int cx0
, cx1
, cy0
, cy1
;
24546 struct glyph_row
*row
;
24548 if (!w
->phys_cursor_on_p
)
24550 if (area
!= TEXT_AREA
)
24553 if (w
->phys_cursor
.vpos
< 0
24554 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
24555 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
24556 !(row
->enabled_p
&& row
->displays_text_p
)))
24559 if (row
->cursor_in_fringe_p
)
24561 row
->cursor_in_fringe_p
= 0;
24562 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
24563 w
->phys_cursor_on_p
= 0;
24567 cx0
= w
->phys_cursor
.x
;
24568 cx1
= cx0
+ w
->phys_cursor_width
;
24569 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
24572 /* The cursor image will be completely removed from the
24573 screen if the output area intersects the cursor area in
24574 y-direction. When we draw in [y0 y1[, and some part of
24575 the cursor is at y < y0, that part must have been drawn
24576 before. When scrolling, the cursor is erased before
24577 actually scrolling, so we don't come here. When not
24578 scrolling, the rows above the old cursor row must have
24579 changed, and in this case these rows must have written
24580 over the cursor image.
24582 Likewise if part of the cursor is below y1, with the
24583 exception of the cursor being in the first blank row at
24584 the buffer and window end because update_text_area
24585 doesn't draw that row. (Except when it does, but
24586 that's handled in update_text_area.) */
24588 cy0
= w
->phys_cursor
.y
;
24589 cy1
= cy0
+ w
->phys_cursor_height
;
24590 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
24593 w
->phys_cursor_on_p
= 0;
24596 #endif /* HAVE_WINDOW_SYSTEM */
24599 /************************************************************************
24601 ************************************************************************/
24603 #ifdef HAVE_WINDOW_SYSTEM
24606 Fix the display of area AREA of overlapping row ROW in window W
24607 with respect to the overlapping part OVERLAPS. */
24610 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
24611 enum glyph_row_area area
, int overlaps
)
24618 for (i
= 0; i
< row
->used
[area
];)
24620 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
24622 int start
= i
, start_x
= x
;
24626 x
+= row
->glyphs
[area
][i
].pixel_width
;
24629 while (i
< row
->used
[area
]
24630 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
24632 draw_glyphs (w
, start_x
, row
, area
,
24634 DRAW_NORMAL_TEXT
, overlaps
);
24638 x
+= row
->glyphs
[area
][i
].pixel_width
;
24648 Draw the cursor glyph of window W in glyph row ROW. See the
24649 comment of draw_glyphs for the meaning of HL. */
24652 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
24653 enum draw_glyphs_face hl
)
24655 /* If cursor hpos is out of bounds, don't draw garbage. This can
24656 happen in mini-buffer windows when switching between echo area
24657 glyphs and mini-buffer. */
24658 if ((row
->reversed_p
24659 ? (w
->phys_cursor
.hpos
>= 0)
24660 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
24662 int on_p
= w
->phys_cursor_on_p
;
24664 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
,
24665 w
->phys_cursor
.hpos
, w
->phys_cursor
.hpos
+ 1,
24667 w
->phys_cursor_on_p
= on_p
;
24669 if (hl
== DRAW_CURSOR
)
24670 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24671 /* When we erase the cursor, and ROW is overlapped by other
24672 rows, make sure that these overlapping parts of other rows
24674 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
24676 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
24678 if (row
> w
->current_matrix
->rows
24679 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
24680 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
24681 OVERLAPS_ERASED_CURSOR
);
24683 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
24684 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
24685 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
24686 OVERLAPS_ERASED_CURSOR
);
24693 Erase the image of a cursor of window W from the screen. */
24696 erase_phys_cursor (struct window
*w
)
24698 struct frame
*f
= XFRAME (w
->frame
);
24699 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24700 int hpos
= w
->phys_cursor
.hpos
;
24701 int vpos
= w
->phys_cursor
.vpos
;
24702 int mouse_face_here_p
= 0;
24703 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
24704 struct glyph_row
*cursor_row
;
24705 struct glyph
*cursor_glyph
;
24706 enum draw_glyphs_face hl
;
24708 /* No cursor displayed or row invalidated => nothing to do on the
24710 if (w
->phys_cursor_type
== NO_CURSOR
)
24711 goto mark_cursor_off
;
24713 /* VPOS >= active_glyphs->nrows means that window has been resized.
24714 Don't bother to erase the cursor. */
24715 if (vpos
>= active_glyphs
->nrows
)
24716 goto mark_cursor_off
;
24718 /* If row containing cursor is marked invalid, there is nothing we
24720 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
24721 if (!cursor_row
->enabled_p
)
24722 goto mark_cursor_off
;
24724 /* If line spacing is > 0, old cursor may only be partially visible in
24725 window after split-window. So adjust visible height. */
24726 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
24727 window_text_bottom_y (w
) - cursor_row
->y
);
24729 /* If row is completely invisible, don't attempt to delete a cursor which
24730 isn't there. This can happen if cursor is at top of a window, and
24731 we switch to a buffer with a header line in that window. */
24732 if (cursor_row
->visible_height
<= 0)
24733 goto mark_cursor_off
;
24735 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
24736 if (cursor_row
->cursor_in_fringe_p
)
24738 cursor_row
->cursor_in_fringe_p
= 0;
24739 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
24740 goto mark_cursor_off
;
24743 /* This can happen when the new row is shorter than the old one.
24744 In this case, either draw_glyphs or clear_end_of_line
24745 should have cleared the cursor. Note that we wouldn't be
24746 able to erase the cursor in this case because we don't have a
24747 cursor glyph at hand. */
24748 if ((cursor_row
->reversed_p
24749 ? (w
->phys_cursor
.hpos
< 0)
24750 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
24751 goto mark_cursor_off
;
24753 /* If the cursor is in the mouse face area, redisplay that when
24754 we clear the cursor. */
24755 if (! NILP (hlinfo
->mouse_face_window
)
24756 && coords_in_mouse_face_p (w
, hpos
, vpos
)
24757 /* Don't redraw the cursor's spot in mouse face if it is at the
24758 end of a line (on a newline). The cursor appears there, but
24759 mouse highlighting does not. */
24760 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
24761 mouse_face_here_p
= 1;
24763 /* Maybe clear the display under the cursor. */
24764 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
24767 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
24770 cursor_glyph
= get_phys_cursor_glyph (w
);
24771 if (cursor_glyph
== NULL
)
24772 goto mark_cursor_off
;
24774 width
= cursor_glyph
->pixel_width
;
24775 left_x
= window_box_left_offset (w
, TEXT_AREA
);
24776 x
= w
->phys_cursor
.x
;
24778 width
-= left_x
- x
;
24779 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
24780 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
24781 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
24784 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
24787 /* Erase the cursor by redrawing the character underneath it. */
24788 if (mouse_face_here_p
)
24789 hl
= DRAW_MOUSE_FACE
;
24791 hl
= DRAW_NORMAL_TEXT
;
24792 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
24795 w
->phys_cursor_on_p
= 0;
24796 w
->phys_cursor_type
= NO_CURSOR
;
24801 Display or clear cursor of window W. If ON is zero, clear the
24802 cursor. If it is non-zero, display the cursor. If ON is nonzero,
24803 where to put the cursor is specified by HPOS, VPOS, X and Y. */
24806 display_and_set_cursor (struct window
*w
, int on
,
24807 int hpos
, int vpos
, int x
, int y
)
24809 struct frame
*f
= XFRAME (w
->frame
);
24810 int new_cursor_type
;
24811 int new_cursor_width
;
24813 struct glyph_row
*glyph_row
;
24814 struct glyph
*glyph
;
24816 /* This is pointless on invisible frames, and dangerous on garbaged
24817 windows and frames; in the latter case, the frame or window may
24818 be in the midst of changing its size, and x and y may be off the
24820 if (! FRAME_VISIBLE_P (f
)
24821 || FRAME_GARBAGED_P (f
)
24822 || vpos
>= w
->current_matrix
->nrows
24823 || hpos
>= w
->current_matrix
->matrix_w
)
24826 /* If cursor is off and we want it off, return quickly. */
24827 if (!on
&& !w
->phys_cursor_on_p
)
24830 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
24831 /* If cursor row is not enabled, we don't really know where to
24832 display the cursor. */
24833 if (!glyph_row
->enabled_p
)
24835 w
->phys_cursor_on_p
= 0;
24840 if (!glyph_row
->exact_window_width_line_p
24841 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
24842 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
24844 xassert (interrupt_input_blocked
);
24846 /* Set new_cursor_type to the cursor we want to be displayed. */
24847 new_cursor_type
= get_window_cursor_type (w
, glyph
,
24848 &new_cursor_width
, &active_cursor
);
24850 /* If cursor is currently being shown and we don't want it to be or
24851 it is in the wrong place, or the cursor type is not what we want,
24853 if (w
->phys_cursor_on_p
24855 || w
->phys_cursor
.x
!= x
24856 || w
->phys_cursor
.y
!= y
24857 || new_cursor_type
!= w
->phys_cursor_type
24858 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
24859 && new_cursor_width
!= w
->phys_cursor_width
)))
24860 erase_phys_cursor (w
);
24862 /* Don't check phys_cursor_on_p here because that flag is only set
24863 to zero in some cases where we know that the cursor has been
24864 completely erased, to avoid the extra work of erasing the cursor
24865 twice. In other words, phys_cursor_on_p can be 1 and the cursor
24866 still not be visible, or it has only been partly erased. */
24869 w
->phys_cursor_ascent
= glyph_row
->ascent
;
24870 w
->phys_cursor_height
= glyph_row
->height
;
24872 /* Set phys_cursor_.* before x_draw_.* is called because some
24873 of them may need the information. */
24874 w
->phys_cursor
.x
= x
;
24875 w
->phys_cursor
.y
= glyph_row
->y
;
24876 w
->phys_cursor
.hpos
= hpos
;
24877 w
->phys_cursor
.vpos
= vpos
;
24880 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
24881 new_cursor_type
, new_cursor_width
,
24882 on
, active_cursor
);
24886 /* Switch the display of W's cursor on or off, according to the value
24890 update_window_cursor (struct window
*w
, int on
)
24892 /* Don't update cursor in windows whose frame is in the process
24893 of being deleted. */
24894 if (w
->current_matrix
)
24897 display_and_set_cursor (w
, on
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
24898 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
24904 /* Call update_window_cursor with parameter ON_P on all leaf windows
24905 in the window tree rooted at W. */
24908 update_cursor_in_window_tree (struct window
*w
, int on_p
)
24912 if (!NILP (w
->hchild
))
24913 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
24914 else if (!NILP (w
->vchild
))
24915 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
24917 update_window_cursor (w
, on_p
);
24919 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
24925 Display the cursor on window W, or clear it, according to ON_P.
24926 Don't change the cursor's position. */
24929 x_update_cursor (struct frame
*f
, int on_p
)
24931 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
24936 Clear the cursor of window W to background color, and mark the
24937 cursor as not shown. This is used when the text where the cursor
24938 is about to be rewritten. */
24941 x_clear_cursor (struct window
*w
)
24943 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
24944 update_window_cursor (w
, 0);
24947 #endif /* HAVE_WINDOW_SYSTEM */
24949 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
24952 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
24953 int start_hpos
, int end_hpos
,
24954 enum draw_glyphs_face draw
)
24956 #ifdef HAVE_WINDOW_SYSTEM
24957 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
24959 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
24963 #if defined (HAVE_GPM) || defined (MSDOS)
24964 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
24968 /* Display the active region described by mouse_face_* according to DRAW. */
24971 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
24973 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
24974 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24976 if (/* If window is in the process of being destroyed, don't bother
24978 w
->current_matrix
!= NULL
24979 /* Don't update mouse highlight if hidden */
24980 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
24981 /* Recognize when we are called to operate on rows that don't exist
24982 anymore. This can happen when a window is split. */
24983 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
24985 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
24986 struct glyph_row
*row
, *first
, *last
;
24988 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
24989 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
24991 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
24993 int start_hpos
, end_hpos
, start_x
;
24995 /* For all but the first row, the highlight starts at column 0. */
24998 /* R2L rows have BEG and END in reversed order, but the
24999 screen drawing geometry is always left to right. So
25000 we need to mirror the beginning and end of the
25001 highlighted area in R2L rows. */
25002 if (!row
->reversed_p
)
25004 start_hpos
= hlinfo
->mouse_face_beg_col
;
25005 start_x
= hlinfo
->mouse_face_beg_x
;
25007 else if (row
== last
)
25009 start_hpos
= hlinfo
->mouse_face_end_col
;
25010 start_x
= hlinfo
->mouse_face_end_x
;
25018 else if (row
->reversed_p
&& row
== last
)
25020 start_hpos
= hlinfo
->mouse_face_end_col
;
25021 start_x
= hlinfo
->mouse_face_end_x
;
25031 if (!row
->reversed_p
)
25032 end_hpos
= hlinfo
->mouse_face_end_col
;
25033 else if (row
== first
)
25034 end_hpos
= hlinfo
->mouse_face_beg_col
;
25037 end_hpos
= row
->used
[TEXT_AREA
];
25038 if (draw
== DRAW_NORMAL_TEXT
)
25039 row
->fill_line_p
= 1; /* Clear to end of line */
25042 else if (row
->reversed_p
&& row
== first
)
25043 end_hpos
= hlinfo
->mouse_face_beg_col
;
25046 end_hpos
= row
->used
[TEXT_AREA
];
25047 if (draw
== DRAW_NORMAL_TEXT
)
25048 row
->fill_line_p
= 1; /* Clear to end of line */
25051 if (end_hpos
> start_hpos
)
25053 draw_row_with_mouse_face (w
, start_x
, row
,
25054 start_hpos
, end_hpos
, draw
);
25057 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25061 #ifdef HAVE_WINDOW_SYSTEM
25062 /* When we've written over the cursor, arrange for it to
25063 be displayed again. */
25064 if (FRAME_WINDOW_P (f
)
25065 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25068 display_and_set_cursor (w
, 1,
25069 w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
,
25070 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25073 #endif /* HAVE_WINDOW_SYSTEM */
25076 #ifdef HAVE_WINDOW_SYSTEM
25077 /* Change the mouse cursor. */
25078 if (FRAME_WINDOW_P (f
))
25080 if (draw
== DRAW_NORMAL_TEXT
25081 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25082 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25083 else if (draw
== DRAW_MOUSE_FACE
)
25084 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25086 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25088 #endif /* HAVE_WINDOW_SYSTEM */
25092 Clear out the mouse-highlighted active region.
25093 Redraw it un-highlighted first. Value is non-zero if mouse
25094 face was actually drawn unhighlighted. */
25097 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25101 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25103 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25107 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25108 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25109 hlinfo
->mouse_face_window
= Qnil
;
25110 hlinfo
->mouse_face_overlay
= Qnil
;
25114 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25115 within the mouse face on that window. */
25117 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25119 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25121 /* Quickly resolve the easy cases. */
25122 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25123 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25125 if (vpos
< hlinfo
->mouse_face_beg_row
25126 || vpos
> hlinfo
->mouse_face_end_row
)
25128 if (vpos
> hlinfo
->mouse_face_beg_row
25129 && vpos
< hlinfo
->mouse_face_end_row
)
25132 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25134 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25136 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25139 else if ((vpos
== hlinfo
->mouse_face_beg_row
25140 && hpos
>= hlinfo
->mouse_face_beg_col
)
25141 || (vpos
== hlinfo
->mouse_face_end_row
25142 && hpos
< hlinfo
->mouse_face_end_col
))
25147 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25149 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25152 else if ((vpos
== hlinfo
->mouse_face_beg_row
25153 && hpos
<= hlinfo
->mouse_face_beg_col
)
25154 || (vpos
== hlinfo
->mouse_face_end_row
25155 && hpos
> hlinfo
->mouse_face_end_col
))
25163 Non-zero if physical cursor of window W is within mouse face. */
25166 cursor_in_mouse_face_p (struct window
*w
)
25168 return coords_in_mouse_face_p (w
, w
->phys_cursor
.hpos
, w
->phys_cursor
.vpos
);
25173 /* Find the glyph rows START_ROW and END_ROW of window W that display
25174 characters between buffer positions START_CHARPOS and END_CHARPOS
25175 (excluding END_CHARPOS). This is similar to row_containing_pos,
25176 but is more accurate when bidi reordering makes buffer positions
25177 change non-linearly with glyph rows. */
25179 rows_from_pos_range (struct window
*w
,
25180 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25181 struct glyph_row
**start
, struct glyph_row
**end
)
25183 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25184 int last_y
= window_text_bottom_y (w
);
25185 struct glyph_row
*row
;
25190 while (!first
->enabled_p
25191 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25194 /* Find the START row. */
25196 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25199 /* A row can potentially be the START row if the range of the
25200 characters it displays intersects the range
25201 [START_CHARPOS..END_CHARPOS). */
25202 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25203 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25204 /* See the commentary in row_containing_pos, for the
25205 explanation of the complicated way to check whether
25206 some position is beyond the end of the characters
25207 displayed by a row. */
25208 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25209 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25210 && !row
->ends_at_zv_p
25211 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25212 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25213 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25214 && !row
->ends_at_zv_p
25215 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25217 /* Found a candidate row. Now make sure at least one of the
25218 glyphs it displays has a charpos from the range
25219 [START_CHARPOS..END_CHARPOS).
25221 This is not obvious because bidi reordering could make
25222 buffer positions of a row be 1,2,3,102,101,100, and if we
25223 want to highlight characters in [50..60), we don't want
25224 this row, even though [50..60) does intersect [1..103),
25225 the range of character positions given by the row's start
25226 and end positions. */
25227 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25228 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25232 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25233 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25242 /* Find the END row. */
25244 /* If the last row is partially visible, start looking for END
25245 from that row, instead of starting from FIRST. */
25246 && !(row
->enabled_p
25247 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25249 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25251 struct glyph_row
*next
= row
+ 1;
25253 if (!next
->enabled_p
25254 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25255 /* The first row >= START whose range of displayed characters
25256 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25257 is the row END + 1. */
25258 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25259 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25260 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25261 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25262 && !next
->ends_at_zv_p
25263 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25264 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25265 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25266 && !next
->ends_at_zv_p
25267 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25274 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25275 but none of the characters it displays are in the range, it is
25277 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25278 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25282 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25283 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25296 /* This function sets the mouse_face_* elements of HLINFO, assuming
25297 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25298 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25299 for the overlay or run of text properties specifying the mouse
25300 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25301 before-string and after-string that must also be highlighted.
25302 COVER_STRING, if non-nil, is a display string that may cover some
25303 or all of the highlighted text. */
25306 mouse_face_from_buffer_pos (Lisp_Object window
,
25307 Mouse_HLInfo
*hlinfo
,
25308 EMACS_INT mouse_charpos
,
25309 EMACS_INT start_charpos
,
25310 EMACS_INT end_charpos
,
25311 Lisp_Object before_string
,
25312 Lisp_Object after_string
,
25313 Lisp_Object cover_string
)
25315 struct window
*w
= XWINDOW (window
);
25316 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25317 struct glyph_row
*r1
, *r2
;
25318 struct glyph
*glyph
, *end
;
25319 EMACS_INT ignore
, pos
;
25322 xassert (NILP (cover_string
) || STRINGP (cover_string
));
25323 xassert (NILP (before_string
) || STRINGP (before_string
));
25324 xassert (NILP (after_string
) || STRINGP (after_string
));
25326 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25327 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25329 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25330 /* If the before-string or display-string contains newlines,
25331 rows_from_pos_range skips to its last row. Move back. */
25332 if (!NILP (before_string
) || !NILP (cover_string
))
25334 struct glyph_row
*prev
;
25335 while ((prev
= r1
- 1, prev
>= first
)
25336 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25337 && prev
->used
[TEXT_AREA
] > 0)
25339 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25340 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25341 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25343 || !(EQ (glyph
->object
, before_string
)
25344 || EQ (glyph
->object
, cover_string
)))
25351 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25352 hlinfo
->mouse_face_past_end
= 1;
25354 else if (!NILP (after_string
))
25356 /* If the after-string has newlines, advance to its last row. */
25357 struct glyph_row
*next
;
25358 struct glyph_row
*last
25359 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25361 for (next
= r2
+ 1;
25363 && next
->used
[TEXT_AREA
] > 0
25364 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25368 /* The rest of the display engine assumes that mouse_face_beg_row is
25369 either above below mouse_face_end_row or identical to it. But
25370 with bidi-reordered continued lines, the row for START_CHARPOS
25371 could be below the row for END_CHARPOS. If so, swap the rows and
25372 store them in correct order. */
25375 struct glyph_row
*tem
= r2
;
25381 hlinfo
->mouse_face_beg_y
= r1
->y
;
25382 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
25383 hlinfo
->mouse_face_end_y
= r2
->y
;
25384 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
25386 /* For a bidi-reordered row, the positions of BEFORE_STRING,
25387 AFTER_STRING, COVER_STRING, START_CHARPOS, and END_CHARPOS
25388 could be anywhere in the row and in any order. The strategy
25389 below is to find the leftmost and the rightmost glyph that
25390 belongs to either of these 3 strings, or whose position is
25391 between START_CHARPOS and END_CHARPOS, and highlight all the
25392 glyphs between those two. This may cover more than just the text
25393 between START_CHARPOS and END_CHARPOS if the range of characters
25394 strides the bidi level boundary, e.g. if the beginning is in R2L
25395 text while the end is in L2R text or vice versa. */
25396 if (!r1
->reversed_p
)
25398 /* This row is in a left to right paragraph. Scan it left to
25400 glyph
= r1
->glyphs
[TEXT_AREA
];
25401 end
= glyph
+ r1
->used
[TEXT_AREA
];
25404 /* Skip truncation glyphs at the start of the glyph row. */
25405 if (r1
->displays_text_p
)
25407 && INTEGERP (glyph
->object
)
25408 && glyph
->charpos
< 0;
25410 x
+= glyph
->pixel_width
;
25412 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25413 or COVER_STRING, and the first glyph from buffer whose
25414 position is between START_CHARPOS and END_CHARPOS. */
25416 && !INTEGERP (glyph
->object
)
25417 && !EQ (glyph
->object
, cover_string
)
25418 && !(BUFFERP (glyph
->object
)
25419 && (glyph
->charpos
>= start_charpos
25420 && glyph
->charpos
< end_charpos
));
25423 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25424 are present at buffer positions between START_CHARPOS and
25425 END_CHARPOS, or if they come from an overlay. */
25426 if (EQ (glyph
->object
, before_string
))
25428 pos
= string_buffer_position (before_string
,
25430 /* If pos == 0, it means before_string came from an
25431 overlay, not from a buffer position. */
25432 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25435 else if (EQ (glyph
->object
, after_string
))
25437 pos
= string_buffer_position (after_string
, end_charpos
);
25438 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25441 x
+= glyph
->pixel_width
;
25443 hlinfo
->mouse_face_beg_x
= x
;
25444 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25448 /* This row is in a right to left paragraph. Scan it right to
25452 end
= r1
->glyphs
[TEXT_AREA
] - 1;
25453 glyph
= end
+ r1
->used
[TEXT_AREA
];
25455 /* Skip truncation glyphs at the start of the glyph row. */
25456 if (r1
->displays_text_p
)
25458 && INTEGERP (glyph
->object
)
25459 && glyph
->charpos
< 0;
25463 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
25464 or COVER_STRING, and the first glyph from buffer whose
25465 position is between START_CHARPOS and END_CHARPOS. */
25467 && !INTEGERP (glyph
->object
)
25468 && !EQ (glyph
->object
, cover_string
)
25469 && !(BUFFERP (glyph
->object
)
25470 && (glyph
->charpos
>= start_charpos
25471 && glyph
->charpos
< end_charpos
));
25474 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25475 are present at buffer positions between START_CHARPOS and
25476 END_CHARPOS, or if they come from an overlay. */
25477 if (EQ (glyph
->object
, before_string
))
25479 pos
= string_buffer_position (before_string
, start_charpos
);
25480 /* If pos == 0, it means before_string came from an
25481 overlay, not from a buffer position. */
25482 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25485 else if (EQ (glyph
->object
, after_string
))
25487 pos
= string_buffer_position (after_string
, end_charpos
);
25488 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25493 glyph
++; /* first glyph to the right of the highlighted area */
25494 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
25495 x
+= g
->pixel_width
;
25496 hlinfo
->mouse_face_beg_x
= x
;
25497 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
25500 /* If the highlight ends in a different row, compute GLYPH and END
25501 for the end row. Otherwise, reuse the values computed above for
25502 the row where the highlight begins. */
25505 if (!r2
->reversed_p
)
25507 glyph
= r2
->glyphs
[TEXT_AREA
];
25508 end
= glyph
+ r2
->used
[TEXT_AREA
];
25513 end
= r2
->glyphs
[TEXT_AREA
] - 1;
25514 glyph
= end
+ r2
->used
[TEXT_AREA
];
25518 if (!r2
->reversed_p
)
25520 /* Skip truncation and continuation glyphs near the end of the
25521 row, and also blanks and stretch glyphs inserted by
25522 extend_face_to_end_of_line. */
25524 && INTEGERP ((end
- 1)->object
)
25525 && (end
- 1)->charpos
<= 0)
25527 /* Scan the rest of the glyph row from the end, looking for the
25528 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25529 COVER_STRING, or whose position is between START_CHARPOS
25533 && !INTEGERP (end
->object
)
25534 && !EQ (end
->object
, cover_string
)
25535 && !(BUFFERP (end
->object
)
25536 && (end
->charpos
>= start_charpos
25537 && end
->charpos
< end_charpos
));
25540 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25541 are present at buffer positions between START_CHARPOS and
25542 END_CHARPOS, or if they come from an overlay. */
25543 if (EQ (end
->object
, before_string
))
25545 pos
= string_buffer_position (before_string
, start_charpos
);
25546 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25549 else if (EQ (end
->object
, after_string
))
25551 pos
= string_buffer_position (after_string
, end_charpos
);
25552 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25556 /* Find the X coordinate of the last glyph to be highlighted. */
25557 for (; glyph
<= end
; ++glyph
)
25558 x
+= glyph
->pixel_width
;
25560 hlinfo
->mouse_face_end_x
= x
;
25561 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
25565 /* Skip truncation and continuation glyphs near the end of the
25566 row, and also blanks and stretch glyphs inserted by
25567 extend_face_to_end_of_line. */
25571 && INTEGERP (end
->object
)
25572 && end
->charpos
<= 0)
25574 x
+= end
->pixel_width
;
25577 /* Scan the rest of the glyph row from the end, looking for the
25578 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
25579 COVER_STRING, or whose position is between START_CHARPOS
25583 && !INTEGERP (end
->object
)
25584 && !EQ (end
->object
, cover_string
)
25585 && !(BUFFERP (end
->object
)
25586 && (end
->charpos
>= start_charpos
25587 && end
->charpos
< end_charpos
));
25590 /* BEFORE_STRING or AFTER_STRING are only relevant if they
25591 are present at buffer positions between START_CHARPOS and
25592 END_CHARPOS, or if they come from an overlay. */
25593 if (EQ (end
->object
, before_string
))
25595 pos
= string_buffer_position (before_string
, start_charpos
);
25596 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25599 else if (EQ (end
->object
, after_string
))
25601 pos
= string_buffer_position (after_string
, end_charpos
);
25602 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
25605 x
+= end
->pixel_width
;
25607 hlinfo
->mouse_face_end_x
= x
;
25608 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
25611 hlinfo
->mouse_face_window
= window
;
25612 hlinfo
->mouse_face_face_id
25613 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
25615 !hlinfo
->mouse_face_hidden
, -1);
25616 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
25619 /* The following function is not used anymore (replaced with
25620 mouse_face_from_string_pos), but I leave it here for the time
25621 being, in case someone would. */
25623 #if 0 /* not used */
25625 /* Find the position of the glyph for position POS in OBJECT in
25626 window W's current matrix, and return in *X, *Y the pixel
25627 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
25629 RIGHT_P non-zero means return the position of the right edge of the
25630 glyph, RIGHT_P zero means return the left edge position.
25632 If no glyph for POS exists in the matrix, return the position of
25633 the glyph with the next smaller position that is in the matrix, if
25634 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
25635 exists in the matrix, return the position of the glyph with the
25636 next larger position in OBJECT.
25638 Value is non-zero if a glyph was found. */
25641 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
25642 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
25644 int yb
= window_text_bottom_y (w
);
25645 struct glyph_row
*r
;
25646 struct glyph
*best_glyph
= NULL
;
25647 struct glyph_row
*best_row
= NULL
;
25650 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25651 r
->enabled_p
&& r
->y
< yb
;
25654 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
25655 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
25658 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25659 if (EQ (g
->object
, object
))
25661 if (g
->charpos
== pos
)
25668 else if (best_glyph
== NULL
25669 || ((eabs (g
->charpos
- pos
)
25670 < eabs (best_glyph
->charpos
- pos
))
25673 : g
->charpos
> pos
)))
25687 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
25691 *x
+= best_glyph
->pixel_width
;
25696 *vpos
= best_row
- w
->current_matrix
->rows
;
25699 return best_glyph
!= NULL
;
25701 #endif /* not used */
25703 /* Find the positions of the first and the last glyphs in window W's
25704 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
25705 (assumed to be a string), and return in HLINFO's mouse_face_*
25706 members the pixel and column/row coordinates of those glyphs. */
25709 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
25710 Lisp_Object object
,
25711 EMACS_INT startpos
, EMACS_INT endpos
)
25713 int yb
= window_text_bottom_y (w
);
25714 struct glyph_row
*r
;
25715 struct glyph
*g
, *e
;
25719 /* Find the glyph row with at least one position in the range
25720 [STARTPOS..ENDPOS], and the first glyph in that row whose
25721 position belongs to that range. */
25722 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25723 r
->enabled_p
&& r
->y
< yb
;
25726 if (!r
->reversed_p
)
25728 g
= r
->glyphs
[TEXT_AREA
];
25729 e
= g
+ r
->used
[TEXT_AREA
];
25730 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
25731 if (EQ (g
->object
, object
)
25732 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25734 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25735 hlinfo
->mouse_face_beg_y
= r
->y
;
25736 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25737 hlinfo
->mouse_face_beg_x
= gx
;
25746 e
= r
->glyphs
[TEXT_AREA
];
25747 g
= e
+ r
->used
[TEXT_AREA
];
25748 for ( ; g
> e
; --g
)
25749 if (EQ ((g
-1)->object
, object
)
25750 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
25752 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
25753 hlinfo
->mouse_face_beg_y
= r
->y
;
25754 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
25755 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
25756 gx
+= g1
->pixel_width
;
25757 hlinfo
->mouse_face_beg_x
= gx
;
25769 /* Starting with the next row, look for the first row which does NOT
25770 include any glyphs whose positions are in the range. */
25771 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
25773 g
= r
->glyphs
[TEXT_AREA
];
25774 e
= g
+ r
->used
[TEXT_AREA
];
25776 for ( ; g
< e
; ++g
)
25777 if (EQ (g
->object
, object
)
25778 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
25787 /* The highlighted region ends on the previous row. */
25790 /* Set the end row and its vertical pixel coordinate. */
25791 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
25792 hlinfo
->mouse_face_end_y
= r
->y
;
25794 /* Compute and set the end column and the end column's horizontal
25795 pixel coordinate. */
25796 if (!r
->reversed_p
)
25798 g
= r
->glyphs
[TEXT_AREA
];
25799 e
= g
+ r
->used
[TEXT_AREA
];
25800 for ( ; e
> g
; --e
)
25801 if (EQ ((e
-1)->object
, object
)
25802 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
25804 hlinfo
->mouse_face_end_col
= e
- g
;
25806 for (gx
= r
->x
; g
< e
; ++g
)
25807 gx
+= g
->pixel_width
;
25808 hlinfo
->mouse_face_end_x
= gx
;
25812 e
= r
->glyphs
[TEXT_AREA
];
25813 g
= e
+ r
->used
[TEXT_AREA
];
25814 for (gx
= r
->x
; e
< g
; ++e
)
25816 if (EQ (e
->object
, object
)
25817 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
25819 gx
+= e
->pixel_width
;
25821 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
25822 hlinfo
->mouse_face_end_x
= gx
;
25826 #ifdef HAVE_WINDOW_SYSTEM
25828 /* See if position X, Y is within a hot-spot of an image. */
25831 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
25833 if (!CONSP (hot_spot
))
25836 if (EQ (XCAR (hot_spot
), Qrect
))
25838 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
25839 Lisp_Object rect
= XCDR (hot_spot
);
25843 if (!CONSP (XCAR (rect
)))
25845 if (!CONSP (XCDR (rect
)))
25847 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
25849 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
25851 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
25853 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
25857 else if (EQ (XCAR (hot_spot
), Qcircle
))
25859 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
25860 Lisp_Object circ
= XCDR (hot_spot
);
25861 Lisp_Object lr
, lx0
, ly0
;
25863 && CONSP (XCAR (circ
))
25864 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
25865 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
25866 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
25868 double r
= XFLOATINT (lr
);
25869 double dx
= XINT (lx0
) - x
;
25870 double dy
= XINT (ly0
) - y
;
25871 return (dx
* dx
+ dy
* dy
<= r
* r
);
25874 else if (EQ (XCAR (hot_spot
), Qpoly
))
25876 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
25877 if (VECTORP (XCDR (hot_spot
)))
25879 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
25880 Lisp_Object
*poly
= v
->contents
;
25881 int n
= v
->header
.size
;
25884 Lisp_Object lx
, ly
;
25887 /* Need an even number of coordinates, and at least 3 edges. */
25888 if (n
< 6 || n
& 1)
25891 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
25892 If count is odd, we are inside polygon. Pixels on edges
25893 may or may not be included depending on actual geometry of the
25895 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
25896 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
25898 x0
= XINT (lx
), y0
= XINT (ly
);
25899 for (i
= 0; i
< n
; i
+= 2)
25901 int x1
= x0
, y1
= y0
;
25902 if ((lx
= poly
[i
], !INTEGERP (lx
))
25903 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
25905 x0
= XINT (lx
), y0
= XINT (ly
);
25907 /* Does this segment cross the X line? */
25915 if (y
> y0
&& y
> y1
)
25917 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
25927 find_hot_spot (Lisp_Object map
, int x
, int y
)
25929 while (CONSP (map
))
25931 if (CONSP (XCAR (map
))
25932 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
25940 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
25942 doc
: /* Lookup in image map MAP coordinates X and Y.
25943 An image map is an alist where each element has the format (AREA ID PLIST).
25944 An AREA is specified as either a rectangle, a circle, or a polygon:
25945 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
25946 pixel coordinates of the upper left and bottom right corners.
25947 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
25948 and the radius of the circle; r may be a float or integer.
25949 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
25950 vector describes one corner in the polygon.
25951 Returns the alist element for the first matching AREA in MAP. */)
25952 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
25960 return find_hot_spot (map
, XINT (x
), XINT (y
));
25964 /* Display frame CURSOR, optionally using shape defined by POINTER. */
25966 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
25968 /* Do not change cursor shape while dragging mouse. */
25969 if (!NILP (do_mouse_tracking
))
25972 if (!NILP (pointer
))
25974 if (EQ (pointer
, Qarrow
))
25975 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25976 else if (EQ (pointer
, Qhand
))
25977 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
25978 else if (EQ (pointer
, Qtext
))
25979 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
25980 else if (EQ (pointer
, intern ("hdrag")))
25981 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
25982 #ifdef HAVE_X_WINDOWS
25983 else if (EQ (pointer
, intern ("vdrag")))
25984 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
25986 else if (EQ (pointer
, intern ("hourglass")))
25987 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
25988 else if (EQ (pointer
, Qmodeline
))
25989 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
25991 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
25994 if (cursor
!= No_Cursor
)
25995 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
25998 #endif /* HAVE_WINDOW_SYSTEM */
26000 /* Take proper action when mouse has moved to the mode or header line
26001 or marginal area AREA of window W, x-position X and y-position Y.
26002 X is relative to the start of the text display area of W, so the
26003 width of bitmap areas and scroll bars must be subtracted to get a
26004 position relative to the start of the mode line. */
26007 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26008 enum window_part area
)
26010 struct window
*w
= XWINDOW (window
);
26011 struct frame
*f
= XFRAME (w
->frame
);
26012 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26013 #ifdef HAVE_WINDOW_SYSTEM
26014 Display_Info
*dpyinfo
;
26016 Cursor cursor
= No_Cursor
;
26017 Lisp_Object pointer
= Qnil
;
26018 int dx
, dy
, width
, height
;
26020 Lisp_Object string
, object
= Qnil
;
26021 Lisp_Object pos
, help
;
26023 Lisp_Object mouse_face
;
26024 int original_x_pixel
= x
;
26025 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26026 struct glyph_row
*row
;
26028 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26033 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26034 returns them in row/column units! */
26035 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26036 &object
, &dx
, &dy
, &width
, &height
);
26038 row
= (area
== ON_MODE_LINE
26039 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26040 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26042 /* Find the glyph under the mouse pointer. */
26043 if (row
->mode_line_p
&& row
->enabled_p
)
26045 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26046 end
= glyph
+ row
->used
[TEXT_AREA
];
26048 for (x0
= original_x_pixel
;
26049 glyph
< end
&& x0
>= glyph
->pixel_width
;
26051 x0
-= glyph
->pixel_width
;
26059 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26060 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26061 returns them in row/column units! */
26062 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26063 &object
, &dx
, &dy
, &width
, &height
);
26068 #ifdef HAVE_WINDOW_SYSTEM
26069 if (IMAGEP (object
))
26071 Lisp_Object image_map
, hotspot
;
26072 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26074 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26076 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26080 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26081 If so, we could look for mouse-enter, mouse-leave
26082 properties in PLIST (and do something...). */
26083 hotspot
= XCDR (hotspot
);
26084 if (CONSP (hotspot
)
26085 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26087 pointer
= Fplist_get (plist
, Qpointer
);
26088 if (NILP (pointer
))
26090 help
= Fplist_get (plist
, Qhelp_echo
);
26093 help_echo_string
= help
;
26094 /* Is this correct? ++kfs */
26095 XSETWINDOW (help_echo_window
, w
);
26096 help_echo_object
= w
->buffer
;
26097 help_echo_pos
= charpos
;
26101 if (NILP (pointer
))
26102 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26104 #endif /* HAVE_WINDOW_SYSTEM */
26106 if (STRINGP (string
))
26108 pos
= make_number (charpos
);
26109 /* If we're on a string with `help-echo' text property, arrange
26110 for the help to be displayed. This is done by setting the
26111 global variable help_echo_string to the help string. */
26114 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26117 help_echo_string
= help
;
26118 XSETWINDOW (help_echo_window
, w
);
26119 help_echo_object
= string
;
26120 help_echo_pos
= charpos
;
26124 #ifdef HAVE_WINDOW_SYSTEM
26125 if (FRAME_WINDOW_P (f
))
26127 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26128 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26129 if (NILP (pointer
))
26130 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26132 /* Change the mouse pointer according to what is under X/Y. */
26134 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26137 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26138 if (!KEYMAPP (map
))
26139 map
= Fget_text_property (pos
, Qkeymap
, string
);
26140 if (!KEYMAPP (map
))
26141 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26146 /* Change the mouse face according to what is under X/Y. */
26147 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26148 if (!NILP (mouse_face
)
26149 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26154 struct glyph
* tmp_glyph
;
26158 int total_pixel_width
;
26159 EMACS_INT begpos
, endpos
, ignore
;
26163 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26164 Qmouse_face
, string
, Qnil
);
26170 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26172 endpos
= SCHARS (string
);
26176 /* Calculate the glyph position GPOS of GLYPH in the
26177 displayed string, relative to the beginning of the
26178 highlighted part of the string.
26180 Note: GPOS is different from CHARPOS. CHARPOS is the
26181 position of GLYPH in the internal string object. A mode
26182 line string format has structures which are converted to
26183 a flattened string by the Emacs Lisp interpreter. The
26184 internal string is an element of those structures. The
26185 displayed string is the flattened string. */
26186 tmp_glyph
= row_start_glyph
;
26187 while (tmp_glyph
< glyph
26188 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26189 && begpos
<= tmp_glyph
->charpos
26190 && tmp_glyph
->charpos
< endpos
)))
26192 gpos
= glyph
- tmp_glyph
;
26194 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26195 the highlighted part of the displayed string to which
26196 GLYPH belongs. Note: GSEQ_LENGTH is different from
26197 SCHARS (STRING), because the latter returns the length of
26198 the internal string. */
26199 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26201 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26202 && begpos
<= tmp_glyph
->charpos
26203 && tmp_glyph
->charpos
< endpos
));
26206 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26208 /* Calculate the total pixel width of all the glyphs between
26209 the beginning of the highlighted area and GLYPH. */
26210 total_pixel_width
= 0;
26211 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26212 total_pixel_width
+= tmp_glyph
->pixel_width
;
26214 /* Pre calculation of re-rendering position. Note: X is in
26215 column units here, after the call to mode_line_string or
26216 marginal_area_string. */
26218 vpos
= (area
== ON_MODE_LINE
26219 ? (w
->current_matrix
)->nrows
- 1
26222 /* If GLYPH's position is included in the region that is
26223 already drawn in mouse face, we have nothing to do. */
26224 if ( EQ (window
, hlinfo
->mouse_face_window
)
26225 && (!row
->reversed_p
26226 ? (hlinfo
->mouse_face_beg_col
<= hpos
26227 && hpos
< hlinfo
->mouse_face_end_col
)
26228 /* In R2L rows we swap BEG and END, see below. */
26229 : (hlinfo
->mouse_face_end_col
<= hpos
26230 && hpos
< hlinfo
->mouse_face_beg_col
))
26231 && hlinfo
->mouse_face_beg_row
== vpos
)
26234 if (clear_mouse_face (hlinfo
))
26235 cursor
= No_Cursor
;
26237 if (!row
->reversed_p
)
26239 hlinfo
->mouse_face_beg_col
= hpos
;
26240 hlinfo
->mouse_face_beg_x
= original_x_pixel
26241 - (total_pixel_width
+ dx
);
26242 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26243 hlinfo
->mouse_face_end_x
= 0;
26247 /* In R2L rows, show_mouse_face expects BEG and END
26248 coordinates to be swapped. */
26249 hlinfo
->mouse_face_end_col
= hpos
;
26250 hlinfo
->mouse_face_end_x
= original_x_pixel
26251 - (total_pixel_width
+ dx
);
26252 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26253 hlinfo
->mouse_face_beg_x
= 0;
26256 hlinfo
->mouse_face_beg_row
= vpos
;
26257 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26258 hlinfo
->mouse_face_beg_y
= 0;
26259 hlinfo
->mouse_face_end_y
= 0;
26260 hlinfo
->mouse_face_past_end
= 0;
26261 hlinfo
->mouse_face_window
= window
;
26263 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26269 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26271 if (NILP (pointer
))
26274 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26275 clear_mouse_face (hlinfo
);
26277 #ifdef HAVE_WINDOW_SYSTEM
26278 if (FRAME_WINDOW_P (f
))
26279 define_frame_cursor1 (f
, cursor
, pointer
);
26285 Take proper action when the mouse has moved to position X, Y on
26286 frame F as regards highlighting characters that have mouse-face
26287 properties. Also de-highlighting chars where the mouse was before.
26288 X and Y can be negative or out of range. */
26291 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26293 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26294 enum window_part part
;
26295 Lisp_Object window
;
26297 Cursor cursor
= No_Cursor
;
26298 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26301 /* When a menu is active, don't highlight because this looks odd. */
26302 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26303 if (popup_activated ())
26307 if (NILP (Vmouse_highlight
)
26308 || !f
->glyphs_initialized_p
26309 || f
->pointer_invisible
)
26312 hlinfo
->mouse_face_mouse_x
= x
;
26313 hlinfo
->mouse_face_mouse_y
= y
;
26314 hlinfo
->mouse_face_mouse_frame
= f
;
26316 if (hlinfo
->mouse_face_defer
)
26319 if (gc_in_progress
)
26321 hlinfo
->mouse_face_deferred_gc
= 1;
26325 /* Which window is that in? */
26326 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26328 /* If we were displaying active text in another window, clear that.
26329 Also clear if we move out of text area in same window. */
26330 if (! EQ (window
, hlinfo
->mouse_face_window
)
26331 || (part
!= ON_TEXT
&& part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
26332 && !NILP (hlinfo
->mouse_face_window
)))
26333 clear_mouse_face (hlinfo
);
26335 /* Not on a window -> return. */
26336 if (!WINDOWP (window
))
26339 /* Reset help_echo_string. It will get recomputed below. */
26340 help_echo_string
= Qnil
;
26342 /* Convert to window-relative pixel coordinates. */
26343 w
= XWINDOW (window
);
26344 frame_to_window_pixel_xy (w
, &x
, &y
);
26346 #ifdef HAVE_WINDOW_SYSTEM
26347 /* Handle tool-bar window differently since it doesn't display a
26349 if (EQ (window
, f
->tool_bar_window
))
26351 note_tool_bar_highlight (f
, x
, y
);
26356 /* Mouse is on the mode, header line or margin? */
26357 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26358 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26360 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26364 #ifdef HAVE_WINDOW_SYSTEM
26365 if (part
== ON_VERTICAL_BORDER
)
26367 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26368 help_echo_string
= build_string ("drag-mouse-1: resize");
26370 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26371 || part
== ON_SCROLL_BAR
)
26372 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26374 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26377 /* Are we in a window whose display is up to date?
26378 And verify the buffer's text has not changed. */
26379 b
= XBUFFER (w
->buffer
);
26380 if (part
== ON_TEXT
26381 && EQ (w
->window_end_valid
, w
->buffer
)
26382 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
26383 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
26385 int hpos
, vpos
, dx
, dy
, area
;
26387 struct glyph
*glyph
;
26388 Lisp_Object object
;
26389 Lisp_Object mouse_face
= Qnil
, position
;
26390 Lisp_Object
*overlay_vec
= NULL
;
26391 ptrdiff_t i
, noverlays
;
26392 struct buffer
*obuf
;
26393 EMACS_INT obegv
, ozv
;
26396 /* Find the glyph under X/Y. */
26397 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
26399 #ifdef HAVE_WINDOW_SYSTEM
26400 /* Look for :pointer property on image. */
26401 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26403 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26404 if (img
!= NULL
&& IMAGEP (img
->spec
))
26406 Lisp_Object image_map
, hotspot
;
26407 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
26409 && (hotspot
= find_hot_spot (image_map
,
26410 glyph
->slice
.img
.x
+ dx
,
26411 glyph
->slice
.img
.y
+ dy
),
26413 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26417 /* Could check XCAR (hotspot) to see if we enter/leave
26419 If so, we could look for mouse-enter, mouse-leave
26420 properties in PLIST (and do something...). */
26421 hotspot
= XCDR (hotspot
);
26422 if (CONSP (hotspot
)
26423 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26425 pointer
= Fplist_get (plist
, Qpointer
);
26426 if (NILP (pointer
))
26428 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
26429 if (!NILP (help_echo_string
))
26431 help_echo_window
= window
;
26432 help_echo_object
= glyph
->object
;
26433 help_echo_pos
= glyph
->charpos
;
26437 if (NILP (pointer
))
26438 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
26441 #endif /* HAVE_WINDOW_SYSTEM */
26443 /* Clear mouse face if X/Y not over text. */
26445 || area
!= TEXT_AREA
26446 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
26447 /* Glyph's OBJECT is an integer for glyphs inserted by the
26448 display engine for its internal purposes, like truncation
26449 and continuation glyphs and blanks beyond the end of
26450 line's text on text terminals. If we are over such a
26451 glyph, we are not over any text. */
26452 || INTEGERP (glyph
->object
)
26453 /* R2L rows have a stretch glyph at their front, which
26454 stands for no text, whereas L2R rows have no glyphs at
26455 all beyond the end of text. Treat such stretch glyphs
26456 like we do with NULL glyphs in L2R rows. */
26457 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
26458 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
26459 && glyph
->type
== STRETCH_GLYPH
26460 && glyph
->avoid_cursor_p
))
26462 if (clear_mouse_face (hlinfo
))
26463 cursor
= No_Cursor
;
26464 #ifdef HAVE_WINDOW_SYSTEM
26465 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26467 if (area
!= TEXT_AREA
)
26468 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26470 pointer
= Vvoid_text_area_pointer
;
26476 pos
= glyph
->charpos
;
26477 object
= glyph
->object
;
26478 if (!STRINGP (object
) && !BUFFERP (object
))
26481 /* If we get an out-of-range value, return now; avoid an error. */
26482 if (BUFFERP (object
) && pos
> BUF_Z (b
))
26485 /* Make the window's buffer temporarily current for
26486 overlays_at and compute_char_face. */
26487 obuf
= current_buffer
;
26488 current_buffer
= b
;
26494 /* Is this char mouse-active or does it have help-echo? */
26495 position
= make_number (pos
);
26497 if (BUFFERP (object
))
26499 /* Put all the overlays we want in a vector in overlay_vec. */
26500 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
26501 /* Sort overlays into increasing priority order. */
26502 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
26507 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
26510 cursor
= No_Cursor
;
26512 /* Check mouse-face highlighting. */
26514 /* If there exists an overlay with mouse-face overlapping
26515 the one we are currently highlighting, we have to
26516 check if we enter the overlapping overlay, and then
26517 highlight only that. */
26518 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
26519 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
26521 /* Find the highest priority overlay with a mouse-face. */
26522 Lisp_Object overlay
= Qnil
;
26523 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
26525 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
26526 if (!NILP (mouse_face
))
26527 overlay
= overlay_vec
[i
];
26530 /* If we're highlighting the same overlay as before, there's
26531 no need to do that again. */
26532 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
26533 goto check_help_echo
;
26534 hlinfo
->mouse_face_overlay
= overlay
;
26536 /* Clear the display of the old active region, if any. */
26537 if (clear_mouse_face (hlinfo
))
26538 cursor
= No_Cursor
;
26540 /* If no overlay applies, get a text property. */
26541 if (NILP (overlay
))
26542 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
26544 /* Next, compute the bounds of the mouse highlighting and
26546 if (!NILP (mouse_face
) && STRINGP (object
))
26548 /* The mouse-highlighting comes from a display string
26549 with a mouse-face. */
26553 s
= Fprevious_single_property_change
26554 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
26555 e
= Fnext_single_property_change
26556 (position
, Qmouse_face
, object
, Qnil
);
26558 s
= make_number (0);
26560 e
= make_number (SCHARS (object
) - 1);
26561 mouse_face_from_string_pos (w
, hlinfo
, object
,
26562 XINT (s
), XINT (e
));
26563 hlinfo
->mouse_face_past_end
= 0;
26564 hlinfo
->mouse_face_window
= window
;
26565 hlinfo
->mouse_face_face_id
26566 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
26567 glyph
->face_id
, 1);
26568 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26569 cursor
= No_Cursor
;
26573 /* The mouse-highlighting, if any, comes from an overlay
26574 or text property in the buffer. */
26575 Lisp_Object buffer
IF_LINT (= Qnil
);
26576 Lisp_Object cover_string
IF_LINT (= Qnil
);
26578 if (STRINGP (object
))
26580 /* If we are on a display string with no mouse-face,
26581 check if the text under it has one. */
26582 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
26583 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26584 pos
= string_buffer_position (object
, start
);
26587 mouse_face
= get_char_property_and_overlay
26588 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
26589 buffer
= w
->buffer
;
26590 cover_string
= object
;
26596 cover_string
= Qnil
;
26599 if (!NILP (mouse_face
))
26601 Lisp_Object before
, after
;
26602 Lisp_Object before_string
, after_string
;
26603 /* To correctly find the limits of mouse highlight
26604 in a bidi-reordered buffer, we must not use the
26605 optimization of limiting the search in
26606 previous-single-property-change and
26607 next-single-property-change, because
26608 rows_from_pos_range needs the real start and end
26609 positions to DTRT in this case. That's because
26610 the first row visible in a window does not
26611 necessarily display the character whose position
26612 is the smallest. */
26614 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26615 ? Fmarker_position (w
->start
)
26618 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
26619 ? make_number (BUF_Z (XBUFFER (buffer
))
26620 - XFASTINT (w
->window_end_pos
))
26623 if (NILP (overlay
))
26625 /* Handle the text property case. */
26626 before
= Fprevious_single_property_change
26627 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
26628 after
= Fnext_single_property_change
26629 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
26630 before_string
= after_string
= Qnil
;
26634 /* Handle the overlay case. */
26635 before
= Foverlay_start (overlay
);
26636 after
= Foverlay_end (overlay
);
26637 before_string
= Foverlay_get (overlay
, Qbefore_string
);
26638 after_string
= Foverlay_get (overlay
, Qafter_string
);
26640 if (!STRINGP (before_string
)) before_string
= Qnil
;
26641 if (!STRINGP (after_string
)) after_string
= Qnil
;
26644 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
26647 before_string
, after_string
,
26649 cursor
= No_Cursor
;
26656 /* Look for a `help-echo' property. */
26657 if (NILP (help_echo_string
)) {
26658 Lisp_Object help
, overlay
;
26660 /* Check overlays first. */
26661 help
= overlay
= Qnil
;
26662 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
26664 overlay
= overlay_vec
[i
];
26665 help
= Foverlay_get (overlay
, Qhelp_echo
);
26670 help_echo_string
= help
;
26671 help_echo_window
= window
;
26672 help_echo_object
= overlay
;
26673 help_echo_pos
= pos
;
26677 Lisp_Object obj
= glyph
->object
;
26678 EMACS_INT charpos
= glyph
->charpos
;
26680 /* Try text properties. */
26683 && charpos
< SCHARS (obj
))
26685 help
= Fget_text_property (make_number (charpos
),
26689 /* If the string itself doesn't specify a help-echo,
26690 see if the buffer text ``under'' it does. */
26691 struct glyph_row
*r
26692 = MATRIX_ROW (w
->current_matrix
, vpos
);
26693 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26694 EMACS_INT p
= string_buffer_position (obj
, start
);
26697 help
= Fget_char_property (make_number (p
),
26698 Qhelp_echo
, w
->buffer
);
26707 else if (BUFFERP (obj
)
26710 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
26715 help_echo_string
= help
;
26716 help_echo_window
= window
;
26717 help_echo_object
= obj
;
26718 help_echo_pos
= charpos
;
26723 #ifdef HAVE_WINDOW_SYSTEM
26724 /* Look for a `pointer' property. */
26725 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
26727 /* Check overlays first. */
26728 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
26729 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
26731 if (NILP (pointer
))
26733 Lisp_Object obj
= glyph
->object
;
26734 EMACS_INT charpos
= glyph
->charpos
;
26736 /* Try text properties. */
26739 && charpos
< SCHARS (obj
))
26741 pointer
= Fget_text_property (make_number (charpos
),
26743 if (NILP (pointer
))
26745 /* If the string itself doesn't specify a pointer,
26746 see if the buffer text ``under'' it does. */
26747 struct glyph_row
*r
26748 = MATRIX_ROW (w
->current_matrix
, vpos
);
26749 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
26750 EMACS_INT p
= string_buffer_position (obj
, start
);
26752 pointer
= Fget_char_property (make_number (p
),
26753 Qpointer
, w
->buffer
);
26756 else if (BUFFERP (obj
)
26759 pointer
= Fget_text_property (make_number (charpos
),
26763 #endif /* HAVE_WINDOW_SYSTEM */
26767 current_buffer
= obuf
;
26772 #ifdef HAVE_WINDOW_SYSTEM
26773 if (FRAME_WINDOW_P (f
))
26774 define_frame_cursor1 (f
, cursor
, pointer
);
26776 /* This is here to prevent a compiler error, about "label at end of
26777 compound statement". */
26784 Clear any mouse-face on window W. This function is part of the
26785 redisplay interface, and is called from try_window_id and similar
26786 functions to ensure the mouse-highlight is off. */
26789 x_clear_window_mouse_face (struct window
*w
)
26791 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
26792 Lisp_Object window
;
26795 XSETWINDOW (window
, w
);
26796 if (EQ (window
, hlinfo
->mouse_face_window
))
26797 clear_mouse_face (hlinfo
);
26803 Just discard the mouse face information for frame F, if any.
26804 This is used when the size of F is changed. */
26807 cancel_mouse_face (struct frame
*f
)
26809 Lisp_Object window
;
26810 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26812 window
= hlinfo
->mouse_face_window
;
26813 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
26815 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
26816 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
26817 hlinfo
->mouse_face_window
= Qnil
;
26823 /***********************************************************************
26825 ***********************************************************************/
26827 #ifdef HAVE_WINDOW_SYSTEM
26829 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
26830 which intersects rectangle R. R is in window-relative coordinates. */
26833 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
26834 enum glyph_row_area area
)
26836 struct glyph
*first
= row
->glyphs
[area
];
26837 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
26838 struct glyph
*last
;
26839 int first_x
, start_x
, x
;
26841 if (area
== TEXT_AREA
&& row
->fill_line_p
)
26842 /* If row extends face to end of line write the whole line. */
26843 draw_glyphs (w
, 0, row
, area
,
26844 0, row
->used
[area
],
26845 DRAW_NORMAL_TEXT
, 0);
26848 /* Set START_X to the window-relative start position for drawing glyphs of
26849 AREA. The first glyph of the text area can be partially visible.
26850 The first glyphs of other areas cannot. */
26851 start_x
= window_box_left_offset (w
, area
);
26853 if (area
== TEXT_AREA
)
26856 /* Find the first glyph that must be redrawn. */
26858 && x
+ first
->pixel_width
< r
->x
)
26860 x
+= first
->pixel_width
;
26864 /* Find the last one. */
26868 && x
< r
->x
+ r
->width
)
26870 x
+= last
->pixel_width
;
26876 draw_glyphs (w
, first_x
- start_x
, row
, area
,
26877 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
26878 DRAW_NORMAL_TEXT
, 0);
26883 /* Redraw the parts of the glyph row ROW on window W intersecting
26884 rectangle R. R is in window-relative coordinates. Value is
26885 non-zero if mouse-face was overwritten. */
26888 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
26890 xassert (row
->enabled_p
);
26892 if (row
->mode_line_p
|| w
->pseudo_window_p
)
26893 draw_glyphs (w
, 0, row
, TEXT_AREA
,
26894 0, row
->used
[TEXT_AREA
],
26895 DRAW_NORMAL_TEXT
, 0);
26898 if (row
->used
[LEFT_MARGIN_AREA
])
26899 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
26900 if (row
->used
[TEXT_AREA
])
26901 expose_area (w
, row
, r
, TEXT_AREA
);
26902 if (row
->used
[RIGHT_MARGIN_AREA
])
26903 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
26904 draw_row_fringe_bitmaps (w
, row
);
26907 return row
->mouse_face_p
;
26911 /* Redraw those parts of glyphs rows during expose event handling that
26912 overlap other rows. Redrawing of an exposed line writes over parts
26913 of lines overlapping that exposed line; this function fixes that.
26915 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
26916 row in W's current matrix that is exposed and overlaps other rows.
26917 LAST_OVERLAPPING_ROW is the last such row. */
26920 expose_overlaps (struct window
*w
,
26921 struct glyph_row
*first_overlapping_row
,
26922 struct glyph_row
*last_overlapping_row
,
26925 struct glyph_row
*row
;
26927 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
26928 if (row
->overlapping_p
)
26930 xassert (row
->enabled_p
&& !row
->mode_line_p
);
26933 if (row
->used
[LEFT_MARGIN_AREA
])
26934 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
26936 if (row
->used
[TEXT_AREA
])
26937 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
26939 if (row
->used
[RIGHT_MARGIN_AREA
])
26940 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
26946 /* Return non-zero if W's cursor intersects rectangle R. */
26949 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
26951 XRectangle cr
, result
;
26952 struct glyph
*cursor_glyph
;
26953 struct glyph_row
*row
;
26955 if (w
->phys_cursor
.vpos
>= 0
26956 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
26957 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
26959 && row
->cursor_in_fringe_p
)
26961 /* Cursor is in the fringe. */
26962 cr
.x
= window_box_right_offset (w
,
26963 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
26964 ? RIGHT_MARGIN_AREA
26967 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
26968 cr
.height
= row
->height
;
26969 return x_intersect_rectangles (&cr
, r
, &result
);
26972 cursor_glyph
= get_phys_cursor_glyph (w
);
26975 /* r is relative to W's box, but w->phys_cursor.x is relative
26976 to left edge of W's TEXT area. Adjust it. */
26977 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
26978 cr
.y
= w
->phys_cursor
.y
;
26979 cr
.width
= cursor_glyph
->pixel_width
;
26980 cr
.height
= w
->phys_cursor_height
;
26981 /* ++KFS: W32 version used W32-specific IntersectRect here, but
26982 I assume the effect is the same -- and this is portable. */
26983 return x_intersect_rectangles (&cr
, r
, &result
);
26985 /* If we don't understand the format, pretend we're not in the hot-spot. */
26991 Draw a vertical window border to the right of window W if W doesn't
26992 have vertical scroll bars. */
26995 x_draw_vertical_border (struct window
*w
)
26997 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
26999 /* We could do better, if we knew what type of scroll-bar the adjacent
27000 windows (on either side) have... But we don't :-(
27001 However, I think this works ok. ++KFS 2003-04-25 */
27003 /* Redraw borders between horizontally adjacent windows. Don't
27004 do it for frames with vertical scroll bars because either the
27005 right scroll bar of a window, or the left scroll bar of its
27006 neighbor will suffice as a border. */
27007 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27010 if (!WINDOW_RIGHTMOST_P (w
)
27011 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27013 int x0
, x1
, y0
, y1
;
27015 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27018 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27021 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27023 else if (!WINDOW_LEFTMOST_P (w
)
27024 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27026 int x0
, x1
, y0
, y1
;
27028 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27031 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27034 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27039 /* Redraw the part of window W intersection rectangle FR. Pixel
27040 coordinates in FR are frame-relative. Call this function with
27041 input blocked. Value is non-zero if the exposure overwrites
27045 expose_window (struct window
*w
, XRectangle
*fr
)
27047 struct frame
*f
= XFRAME (w
->frame
);
27049 int mouse_face_overwritten_p
= 0;
27051 /* If window is not yet fully initialized, do nothing. This can
27052 happen when toolkit scroll bars are used and a window is split.
27053 Reconfiguring the scroll bar will generate an expose for a newly
27055 if (w
->current_matrix
== NULL
)
27058 /* When we're currently updating the window, display and current
27059 matrix usually don't agree. Arrange for a thorough display
27061 if (w
== updated_window
)
27063 SET_FRAME_GARBAGED (f
);
27067 /* Frame-relative pixel rectangle of W. */
27068 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27069 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27070 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27071 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27073 if (x_intersect_rectangles (fr
, &wr
, &r
))
27075 int yb
= window_text_bottom_y (w
);
27076 struct glyph_row
*row
;
27077 int cursor_cleared_p
;
27078 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27080 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27081 r
.x
, r
.y
, r
.width
, r
.height
));
27083 /* Convert to window coordinates. */
27084 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27085 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27087 /* Turn off the cursor. */
27088 if (!w
->pseudo_window_p
27089 && phys_cursor_in_rect_p (w
, &r
))
27091 x_clear_cursor (w
);
27092 cursor_cleared_p
= 1;
27095 cursor_cleared_p
= 0;
27097 /* Update lines intersecting rectangle R. */
27098 first_overlapping_row
= last_overlapping_row
= NULL
;
27099 for (row
= w
->current_matrix
->rows
;
27104 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27106 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27107 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27108 || (r
.y
>= y0
&& r
.y
< y1
)
27109 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27111 /* A header line may be overlapping, but there is no need
27112 to fix overlapping areas for them. KFS 2005-02-12 */
27113 if (row
->overlapping_p
&& !row
->mode_line_p
)
27115 if (first_overlapping_row
== NULL
)
27116 first_overlapping_row
= row
;
27117 last_overlapping_row
= row
;
27121 if (expose_line (w
, row
, &r
))
27122 mouse_face_overwritten_p
= 1;
27125 else if (row
->overlapping_p
)
27127 /* We must redraw a row overlapping the exposed area. */
27129 ? y0
+ row
->phys_height
> r
.y
27130 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27132 if (first_overlapping_row
== NULL
)
27133 first_overlapping_row
= row
;
27134 last_overlapping_row
= row
;
27142 /* Display the mode line if there is one. */
27143 if (WINDOW_WANTS_MODELINE_P (w
)
27144 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27146 && row
->y
< r
.y
+ r
.height
)
27148 if (expose_line (w
, row
, &r
))
27149 mouse_face_overwritten_p
= 1;
27152 if (!w
->pseudo_window_p
)
27154 /* Fix the display of overlapping rows. */
27155 if (first_overlapping_row
)
27156 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27159 /* Draw border between windows. */
27160 x_draw_vertical_border (w
);
27162 /* Turn the cursor on again. */
27163 if (cursor_cleared_p
)
27164 update_window_cursor (w
, 1);
27168 return mouse_face_overwritten_p
;
27173 /* Redraw (parts) of all windows in the window tree rooted at W that
27174 intersect R. R contains frame pixel coordinates. Value is
27175 non-zero if the exposure overwrites mouse-face. */
27178 expose_window_tree (struct window
*w
, XRectangle
*r
)
27180 struct frame
*f
= XFRAME (w
->frame
);
27181 int mouse_face_overwritten_p
= 0;
27183 while (w
&& !FRAME_GARBAGED_P (f
))
27185 if (!NILP (w
->hchild
))
27186 mouse_face_overwritten_p
27187 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27188 else if (!NILP (w
->vchild
))
27189 mouse_face_overwritten_p
27190 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27192 mouse_face_overwritten_p
|= expose_window (w
, r
);
27194 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27197 return mouse_face_overwritten_p
;
27202 Redisplay an exposed area of frame F. X and Y are the upper-left
27203 corner of the exposed rectangle. W and H are width and height of
27204 the exposed area. All are pixel values. W or H zero means redraw
27205 the entire frame. */
27208 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27211 int mouse_face_overwritten_p
= 0;
27213 TRACE ((stderr
, "expose_frame "));
27215 /* No need to redraw if frame will be redrawn soon. */
27216 if (FRAME_GARBAGED_P (f
))
27218 TRACE ((stderr
, " garbaged\n"));
27222 /* If basic faces haven't been realized yet, there is no point in
27223 trying to redraw anything. This can happen when we get an expose
27224 event while Emacs is starting, e.g. by moving another window. */
27225 if (FRAME_FACE_CACHE (f
) == NULL
27226 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27228 TRACE ((stderr
, " no faces\n"));
27232 if (w
== 0 || h
== 0)
27235 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27236 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27246 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27247 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27249 if (WINDOWP (f
->tool_bar_window
))
27250 mouse_face_overwritten_p
27251 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27253 #ifdef HAVE_X_WINDOWS
27255 #ifndef USE_X_TOOLKIT
27256 if (WINDOWP (f
->menu_bar_window
))
27257 mouse_face_overwritten_p
27258 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27259 #endif /* not USE_X_TOOLKIT */
27263 /* Some window managers support a focus-follows-mouse style with
27264 delayed raising of frames. Imagine a partially obscured frame,
27265 and moving the mouse into partially obscured mouse-face on that
27266 frame. The visible part of the mouse-face will be highlighted,
27267 then the WM raises the obscured frame. With at least one WM, KDE
27268 2.1, Emacs is not getting any event for the raising of the frame
27269 (even tried with SubstructureRedirectMask), only Expose events.
27270 These expose events will draw text normally, i.e. not
27271 highlighted. Which means we must redo the highlight here.
27272 Subsume it under ``we love X''. --gerd 2001-08-15 */
27273 /* Included in Windows version because Windows most likely does not
27274 do the right thing if any third party tool offers
27275 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27276 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27278 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27279 if (f
== hlinfo
->mouse_face_mouse_frame
)
27281 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27282 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27283 clear_mouse_face (hlinfo
);
27284 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27291 Determine the intersection of two rectangles R1 and R2. Return
27292 the intersection in *RESULT. Value is non-zero if RESULT is not
27296 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27298 XRectangle
*left
, *right
;
27299 XRectangle
*upper
, *lower
;
27300 int intersection_p
= 0;
27302 /* Rearrange so that R1 is the left-most rectangle. */
27304 left
= r1
, right
= r2
;
27306 left
= r2
, right
= r1
;
27308 /* X0 of the intersection is right.x0, if this is inside R1,
27309 otherwise there is no intersection. */
27310 if (right
->x
<= left
->x
+ left
->width
)
27312 result
->x
= right
->x
;
27314 /* The right end of the intersection is the minimum of
27315 the right ends of left and right. */
27316 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27319 /* Same game for Y. */
27321 upper
= r1
, lower
= r2
;
27323 upper
= r2
, lower
= r1
;
27325 /* The upper end of the intersection is lower.y0, if this is inside
27326 of upper. Otherwise, there is no intersection. */
27327 if (lower
->y
<= upper
->y
+ upper
->height
)
27329 result
->y
= lower
->y
;
27331 /* The lower end of the intersection is the minimum of the lower
27332 ends of upper and lower. */
27333 result
->height
= (min (lower
->y
+ lower
->height
,
27334 upper
->y
+ upper
->height
)
27336 intersection_p
= 1;
27340 return intersection_p
;
27343 #endif /* HAVE_WINDOW_SYSTEM */
27346 /***********************************************************************
27348 ***********************************************************************/
27351 syms_of_xdisp (void)
27353 Vwith_echo_area_save_vector
= Qnil
;
27354 staticpro (&Vwith_echo_area_save_vector
);
27356 Vmessage_stack
= Qnil
;
27357 staticpro (&Vmessage_stack
);
27359 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27361 message_dolog_marker1
= Fmake_marker ();
27362 staticpro (&message_dolog_marker1
);
27363 message_dolog_marker2
= Fmake_marker ();
27364 staticpro (&message_dolog_marker2
);
27365 message_dolog_marker3
= Fmake_marker ();
27366 staticpro (&message_dolog_marker3
);
27369 defsubr (&Sdump_frame_glyph_matrix
);
27370 defsubr (&Sdump_glyph_matrix
);
27371 defsubr (&Sdump_glyph_row
);
27372 defsubr (&Sdump_tool_bar_row
);
27373 defsubr (&Strace_redisplay
);
27374 defsubr (&Strace_to_stderr
);
27376 #ifdef HAVE_WINDOW_SYSTEM
27377 defsubr (&Stool_bar_lines_needed
);
27378 defsubr (&Slookup_image_map
);
27380 defsubr (&Sformat_mode_line
);
27381 defsubr (&Sinvisible_p
);
27382 defsubr (&Scurrent_bidi_paragraph_direction
);
27384 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
27385 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
27386 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
27387 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
27388 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
27389 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
27390 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
27391 DEFSYM (Qeval
, "eval");
27392 DEFSYM (QCdata
, ":data");
27393 DEFSYM (Qdisplay
, "display");
27394 DEFSYM (Qspace_width
, "space-width");
27395 DEFSYM (Qraise
, "raise");
27396 DEFSYM (Qslice
, "slice");
27397 DEFSYM (Qspace
, "space");
27398 DEFSYM (Qmargin
, "margin");
27399 DEFSYM (Qpointer
, "pointer");
27400 DEFSYM (Qleft_margin
, "left-margin");
27401 DEFSYM (Qright_margin
, "right-margin");
27402 DEFSYM (Qcenter
, "center");
27403 DEFSYM (Qline_height
, "line-height");
27404 DEFSYM (QCalign_to
, ":align-to");
27405 DEFSYM (QCrelative_width
, ":relative-width");
27406 DEFSYM (QCrelative_height
, ":relative-height");
27407 DEFSYM (QCeval
, ":eval");
27408 DEFSYM (QCpropertize
, ":propertize");
27409 DEFSYM (QCfile
, ":file");
27410 DEFSYM (Qfontified
, "fontified");
27411 DEFSYM (Qfontification_functions
, "fontification-functions");
27412 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
27413 DEFSYM (Qescape_glyph
, "escape-glyph");
27414 DEFSYM (Qnobreak_space
, "nobreak-space");
27415 DEFSYM (Qimage
, "image");
27416 DEFSYM (Qtext
, "text");
27417 DEFSYM (Qboth
, "both");
27418 DEFSYM (Qboth_horiz
, "both-horiz");
27419 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
27420 DEFSYM (QCmap
, ":map");
27421 DEFSYM (QCpointer
, ":pointer");
27422 DEFSYM (Qrect
, "rect");
27423 DEFSYM (Qcircle
, "circle");
27424 DEFSYM (Qpoly
, "poly");
27425 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
27426 DEFSYM (Qgrow_only
, "grow-only");
27427 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
27428 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
27429 DEFSYM (Qposition
, "position");
27430 DEFSYM (Qbuffer_position
, "buffer-position");
27431 DEFSYM (Qobject
, "object");
27432 DEFSYM (Qbar
, "bar");
27433 DEFSYM (Qhbar
, "hbar");
27434 DEFSYM (Qbox
, "box");
27435 DEFSYM (Qhollow
, "hollow");
27436 DEFSYM (Qhand
, "hand");
27437 DEFSYM (Qarrow
, "arrow");
27438 DEFSYM (Qtext
, "text");
27439 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
27441 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
27442 Fcons (intern_c_string ("void-variable"), Qnil
)),
27444 staticpro (&list_of_error
);
27446 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
27447 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
27448 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
27449 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
27451 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
27452 staticpro (&echo_buffer
[0]);
27453 staticpro (&echo_buffer
[1]);
27455 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
27456 staticpro (&echo_area_buffer
[0]);
27457 staticpro (&echo_area_buffer
[1]);
27459 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
27460 staticpro (&Vmessages_buffer_name
);
27462 mode_line_proptrans_alist
= Qnil
;
27463 staticpro (&mode_line_proptrans_alist
);
27464 mode_line_string_list
= Qnil
;
27465 staticpro (&mode_line_string_list
);
27466 mode_line_string_face
= Qnil
;
27467 staticpro (&mode_line_string_face
);
27468 mode_line_string_face_prop
= Qnil
;
27469 staticpro (&mode_line_string_face_prop
);
27470 Vmode_line_unwind_vector
= Qnil
;
27471 staticpro (&Vmode_line_unwind_vector
);
27473 help_echo_string
= Qnil
;
27474 staticpro (&help_echo_string
);
27475 help_echo_object
= Qnil
;
27476 staticpro (&help_echo_object
);
27477 help_echo_window
= Qnil
;
27478 staticpro (&help_echo_window
);
27479 previous_help_echo_string
= Qnil
;
27480 staticpro (&previous_help_echo_string
);
27481 help_echo_pos
= -1;
27483 DEFSYM (Qright_to_left
, "right-to-left");
27484 DEFSYM (Qleft_to_right
, "left-to-right");
27486 #ifdef HAVE_WINDOW_SYSTEM
27487 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
27488 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
27489 For example, if a block cursor is over a tab, it will be drawn as
27490 wide as that tab on the display. */);
27491 x_stretch_cursor_p
= 0;
27494 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
27495 doc
: /* *Non-nil means highlight trailing whitespace.
27496 The face used for trailing whitespace is `trailing-whitespace'. */);
27497 Vshow_trailing_whitespace
= Qnil
;
27499 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
27500 doc
: /* *Control highlighting of nobreak space and soft hyphen.
27501 A value of t means highlight the character itself (for nobreak space,
27502 use face `nobreak-space').
27503 A value of nil means no highlighting.
27504 Other values mean display the escape glyph followed by an ordinary
27505 space or ordinary hyphen. */);
27506 Vnobreak_char_display
= Qt
;
27508 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
27509 doc
: /* *The pointer shape to show in void text areas.
27510 A value of nil means to show the text pointer. Other options are `arrow',
27511 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
27512 Vvoid_text_area_pointer
= Qarrow
;
27514 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
27515 doc
: /* Non-nil means don't actually do any redisplay.
27516 This is used for internal purposes. */);
27517 Vinhibit_redisplay
= Qnil
;
27519 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
27520 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
27521 Vglobal_mode_string
= Qnil
;
27523 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
27524 doc
: /* Marker for where to display an arrow on top of the buffer text.
27525 This must be the beginning of a line in order to work.
27526 See also `overlay-arrow-string'. */);
27527 Voverlay_arrow_position
= Qnil
;
27529 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
27530 doc
: /* String to display as an arrow in non-window frames.
27531 See also `overlay-arrow-position'. */);
27532 Voverlay_arrow_string
= make_pure_c_string ("=>");
27534 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
27535 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
27536 The symbols on this list are examined during redisplay to determine
27537 where to display overlay arrows. */);
27538 Voverlay_arrow_variable_list
27539 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
27541 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
27542 doc
: /* *The number of lines to try scrolling a window by when point moves out.
27543 If that fails to bring point back on frame, point is centered instead.
27544 If this is zero, point is always centered after it moves off frame.
27545 If you want scrolling to always be a line at a time, you should set
27546 `scroll-conservatively' to a large value rather than set this to 1. */);
27548 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
27549 doc
: /* *Scroll up to this many lines, to bring point back on screen.
27550 If point moves off-screen, redisplay will scroll by up to
27551 `scroll-conservatively' lines in order to bring point just barely
27552 onto the screen again. If that cannot be done, then redisplay
27553 recenters point as usual.
27555 If the value is greater than 100, redisplay will never recenter point,
27556 but will always scroll just enough text to bring point into view, even
27557 if you move far away.
27559 A value of zero means always recenter point if it moves off screen. */);
27560 scroll_conservatively
= 0;
27562 DEFVAR_INT ("scroll-margin", scroll_margin
,
27563 doc
: /* *Number of lines of margin at the top and bottom of a window.
27564 Recenter the window whenever point gets within this many lines
27565 of the top or bottom of the window. */);
27568 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
27569 doc
: /* Pixels per inch value for non-window system displays.
27570 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
27571 Vdisplay_pixels_per_inch
= make_float (72.0);
27574 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
27577 DEFVAR_LISP ("truncate-partial-width-windows",
27578 Vtruncate_partial_width_windows
,
27579 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
27580 For an integer value, truncate lines in each window narrower than the
27581 full frame width, provided the window width is less than that integer;
27582 otherwise, respect the value of `truncate-lines'.
27584 For any other non-nil value, truncate lines in all windows that do
27585 not span the full frame width.
27587 A value of nil means to respect the value of `truncate-lines'.
27589 If `word-wrap' is enabled, you might want to reduce this. */);
27590 Vtruncate_partial_width_windows
= make_number (50);
27592 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
27593 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
27594 Any other value means to use the appropriate face, `mode-line',
27595 `header-line', or `menu' respectively. */);
27596 mode_line_inverse_video
= 1;
27598 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
27599 doc
: /* *Maximum buffer size for which line number should be displayed.
27600 If the buffer is bigger than this, the line number does not appear
27601 in the mode line. A value of nil means no limit. */);
27602 Vline_number_display_limit
= Qnil
;
27604 DEFVAR_INT ("line-number-display-limit-width",
27605 line_number_display_limit_width
,
27606 doc
: /* *Maximum line width (in characters) for line number display.
27607 If the average length of the lines near point is bigger than this, then the
27608 line number may be omitted from the mode line. */);
27609 line_number_display_limit_width
= 200;
27611 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
27612 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
27613 highlight_nonselected_windows
= 0;
27615 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
27616 doc
: /* Non-nil if more than one frame is visible on this display.
27617 Minibuffer-only frames don't count, but iconified frames do.
27618 This variable is not guaranteed to be accurate except while processing
27619 `frame-title-format' and `icon-title-format'. */);
27621 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
27622 doc
: /* Template for displaying the title bar of visible frames.
27623 \(Assuming the window manager supports this feature.)
27625 This variable has the same structure as `mode-line-format', except that
27626 the %c and %l constructs are ignored. It is used only on frames for
27627 which no explicit name has been set \(see `modify-frame-parameters'). */);
27629 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
27630 doc
: /* Template for displaying the title bar of an iconified frame.
27631 \(Assuming the window manager supports this feature.)
27632 This variable has the same structure as `mode-line-format' (which see),
27633 and is used only on frames for which no explicit name has been set
27634 \(see `modify-frame-parameters'). */);
27636 = Vframe_title_format
27637 = pure_cons (intern_c_string ("multiple-frames"),
27638 pure_cons (make_pure_c_string ("%b"),
27639 pure_cons (pure_cons (empty_unibyte_string
,
27640 pure_cons (intern_c_string ("invocation-name"),
27641 pure_cons (make_pure_c_string ("@"),
27642 pure_cons (intern_c_string ("system-name"),
27646 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
27647 doc
: /* Maximum number of lines to keep in the message log buffer.
27648 If nil, disable message logging. If t, log messages but don't truncate
27649 the buffer when it becomes large. */);
27650 Vmessage_log_max
= make_number (100);
27652 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
27653 doc
: /* Functions called before redisplay, if window sizes have changed.
27654 The value should be a list of functions that take one argument.
27655 Just before redisplay, for each frame, if any of its windows have changed
27656 size since the last redisplay, or have been split or deleted,
27657 all the functions in the list are called, with the frame as argument. */);
27658 Vwindow_size_change_functions
= Qnil
;
27660 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
27661 doc
: /* List of functions to call before redisplaying a window with scrolling.
27662 Each function is called with two arguments, the window and its new
27663 display-start position. Note that these functions are also called by
27664 `set-window-buffer'. Also note that the value of `window-end' is not
27665 valid when these functions are called. */);
27666 Vwindow_scroll_functions
= Qnil
;
27668 DEFVAR_LISP ("window-text-change-functions",
27669 Vwindow_text_change_functions
,
27670 doc
: /* Functions to call in redisplay when text in the window might change. */);
27671 Vwindow_text_change_functions
= Qnil
;
27673 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
27674 doc
: /* Functions called when redisplay of a window reaches the end trigger.
27675 Each function is called with two arguments, the window and the end trigger value.
27676 See `set-window-redisplay-end-trigger'. */);
27677 Vredisplay_end_trigger_functions
= Qnil
;
27679 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
27680 doc
: /* *Non-nil means autoselect window with mouse pointer.
27681 If nil, do not autoselect windows.
27682 A positive number means delay autoselection by that many seconds: a
27683 window is autoselected only after the mouse has remained in that
27684 window for the duration of the delay.
27685 A negative number has a similar effect, but causes windows to be
27686 autoselected only after the mouse has stopped moving. \(Because of
27687 the way Emacs compares mouse events, you will occasionally wait twice
27688 that time before the window gets selected.\)
27689 Any other value means to autoselect window instantaneously when the
27690 mouse pointer enters it.
27692 Autoselection selects the minibuffer only if it is active, and never
27693 unselects the minibuffer if it is active.
27695 When customizing this variable make sure that the actual value of
27696 `focus-follows-mouse' matches the behavior of your window manager. */);
27697 Vmouse_autoselect_window
= Qnil
;
27699 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
27700 doc
: /* *Non-nil means automatically resize tool-bars.
27701 This dynamically changes the tool-bar's height to the minimum height
27702 that is needed to make all tool-bar items visible.
27703 If value is `grow-only', the tool-bar's height is only increased
27704 automatically; to decrease the tool-bar height, use \\[recenter]. */);
27705 Vauto_resize_tool_bars
= Qt
;
27707 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
27708 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
27709 auto_raise_tool_bar_buttons_p
= 1;
27711 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
27712 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
27713 make_cursor_line_fully_visible_p
= 1;
27715 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
27716 doc
: /* *Border below tool-bar in pixels.
27717 If an integer, use it as the height of the border.
27718 If it is one of `internal-border-width' or `border-width', use the
27719 value of the corresponding frame parameter.
27720 Otherwise, no border is added below the tool-bar. */);
27721 Vtool_bar_border
= Qinternal_border_width
;
27723 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
27724 doc
: /* *Margin around tool-bar buttons in pixels.
27725 If an integer, use that for both horizontal and vertical margins.
27726 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
27727 HORZ specifying the horizontal margin, and VERT specifying the
27728 vertical margin. */);
27729 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
27731 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
27732 doc
: /* *Relief thickness of tool-bar buttons. */);
27733 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
27735 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
27736 doc
: /* Tool bar style to use.
27738 image - show images only
27739 text - show text only
27740 both - show both, text below image
27741 both-horiz - show text to the right of the image
27742 text-image-horiz - show text to the left of the image
27743 any other - use system default or image if no system default. */);
27744 Vtool_bar_style
= Qnil
;
27746 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
27747 doc
: /* *Maximum number of characters a label can have to be shown.
27748 The tool bar style must also show labels for this to have any effect, see
27749 `tool-bar-style'. */);
27750 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
27752 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
27753 doc
: /* List of functions to call to fontify regions of text.
27754 Each function is called with one argument POS. Functions must
27755 fontify a region starting at POS in the current buffer, and give
27756 fontified regions the property `fontified'. */);
27757 Vfontification_functions
= Qnil
;
27758 Fmake_variable_buffer_local (Qfontification_functions
);
27760 DEFVAR_BOOL ("unibyte-display-via-language-environment",
27761 unibyte_display_via_language_environment
,
27762 doc
: /* *Non-nil means display unibyte text according to language environment.
27763 Specifically, this means that raw bytes in the range 160-255 decimal
27764 are displayed by converting them to the equivalent multibyte characters
27765 according to the current language environment. As a result, they are
27766 displayed according to the current fontset.
27768 Note that this variable affects only how these bytes are displayed,
27769 but does not change the fact they are interpreted as raw bytes. */);
27770 unibyte_display_via_language_environment
= 0;
27772 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
27773 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
27774 If a float, it specifies a fraction of the mini-window frame's height.
27775 If an integer, it specifies a number of lines. */);
27776 Vmax_mini_window_height
= make_float (0.25);
27778 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
27779 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
27780 A value of nil means don't automatically resize mini-windows.
27781 A value of t means resize them to fit the text displayed in them.
27782 A value of `grow-only', the default, means let mini-windows grow only;
27783 they return to their normal size when the minibuffer is closed, or the
27784 echo area becomes empty. */);
27785 Vresize_mini_windows
= Qgrow_only
;
27787 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
27788 doc
: /* Alist specifying how to blink the cursor off.
27789 Each element has the form (ON-STATE . OFF-STATE). Whenever the
27790 `cursor-type' frame-parameter or variable equals ON-STATE,
27791 comparing using `equal', Emacs uses OFF-STATE to specify
27792 how to blink it off. ON-STATE and OFF-STATE are values for
27793 the `cursor-type' frame parameter.
27795 If a frame's ON-STATE has no entry in this list,
27796 the frame's other specifications determine how to blink the cursor off. */);
27797 Vblink_cursor_alist
= Qnil
;
27799 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
27800 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
27801 If non-nil, windows are automatically scrolled horizontally to make
27802 point visible. */);
27803 automatic_hscrolling_p
= 1;
27804 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
27806 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
27807 doc
: /* *How many columns away from the window edge point is allowed to get
27808 before automatic hscrolling will horizontally scroll the window. */);
27809 hscroll_margin
= 5;
27811 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
27812 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
27813 When point is less than `hscroll-margin' columns from the window
27814 edge, automatic hscrolling will scroll the window by the amount of columns
27815 determined by this variable. If its value is a positive integer, scroll that
27816 many columns. If it's a positive floating-point number, it specifies the
27817 fraction of the window's width to scroll. If it's nil or zero, point will be
27818 centered horizontally after the scroll. Any other value, including negative
27819 numbers, are treated as if the value were zero.
27821 Automatic hscrolling always moves point outside the scroll margin, so if
27822 point was more than scroll step columns inside the margin, the window will
27823 scroll more than the value given by the scroll step.
27825 Note that the lower bound for automatic hscrolling specified by `scroll-left'
27826 and `scroll-right' overrides this variable's effect. */);
27827 Vhscroll_step
= make_number (0);
27829 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
27830 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
27831 Bind this around calls to `message' to let it take effect. */);
27832 message_truncate_lines
= 0;
27834 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
27835 doc
: /* Normal hook run to update the menu bar definitions.
27836 Redisplay runs this hook before it redisplays the menu bar.
27837 This is used to update submenus such as Buffers,
27838 whose contents depend on various data. */);
27839 Vmenu_bar_update_hook
= Qnil
;
27841 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
27842 doc
: /* Frame for which we are updating a menu.
27843 The enable predicate for a menu binding should check this variable. */);
27844 Vmenu_updating_frame
= Qnil
;
27846 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
27847 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
27848 inhibit_menubar_update
= 0;
27850 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
27851 doc
: /* Prefix prepended to all continuation lines at display time.
27852 The value may be a string, an image, or a stretch-glyph; it is
27853 interpreted in the same way as the value of a `display' text property.
27855 This variable is overridden by any `wrap-prefix' text or overlay
27858 To add a prefix to non-continuation lines, use `line-prefix'. */);
27859 Vwrap_prefix
= Qnil
;
27860 DEFSYM (Qwrap_prefix
, "wrap-prefix");
27861 Fmake_variable_buffer_local (Qwrap_prefix
);
27863 DEFVAR_LISP ("line-prefix", Vline_prefix
,
27864 doc
: /* Prefix prepended to all non-continuation lines at display time.
27865 The value may be a string, an image, or a stretch-glyph; it is
27866 interpreted in the same way as the value of a `display' text property.
27868 This variable is overridden by any `line-prefix' text or overlay
27871 To add a prefix to continuation lines, use `wrap-prefix'. */);
27872 Vline_prefix
= Qnil
;
27873 DEFSYM (Qline_prefix
, "line-prefix");
27874 Fmake_variable_buffer_local (Qline_prefix
);
27876 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
27877 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
27878 inhibit_eval_during_redisplay
= 0;
27880 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
27881 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
27882 inhibit_free_realized_faces
= 0;
27885 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
27886 doc
: /* Inhibit try_window_id display optimization. */);
27887 inhibit_try_window_id
= 0;
27889 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
27890 doc
: /* Inhibit try_window_reusing display optimization. */);
27891 inhibit_try_window_reusing
= 0;
27893 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
27894 doc
: /* Inhibit try_cursor_movement display optimization. */);
27895 inhibit_try_cursor_movement
= 0;
27896 #endif /* GLYPH_DEBUG */
27898 DEFVAR_INT ("overline-margin", overline_margin
,
27899 doc
: /* *Space between overline and text, in pixels.
27900 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
27901 margin to the caracter height. */);
27902 overline_margin
= 2;
27904 DEFVAR_INT ("underline-minimum-offset",
27905 underline_minimum_offset
,
27906 doc
: /* Minimum distance between baseline and underline.
27907 This can improve legibility of underlined text at small font sizes,
27908 particularly when using variable `x-use-underline-position-properties'
27909 with fonts that specify an UNDERLINE_POSITION relatively close to the
27910 baseline. The default value is 1. */);
27911 underline_minimum_offset
= 1;
27913 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
27914 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
27915 This feature only works when on a window system that can change
27916 cursor shapes. */);
27917 display_hourglass_p
= 1;
27919 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
27920 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
27921 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
27923 hourglass_atimer
= NULL
;
27924 hourglass_shown_p
= 0;
27926 DEFSYM (Qglyphless_char
, "glyphless-char");
27927 DEFSYM (Qhex_code
, "hex-code");
27928 DEFSYM (Qempty_box
, "empty-box");
27929 DEFSYM (Qthin_space
, "thin-space");
27930 DEFSYM (Qzero_width
, "zero-width");
27932 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
27933 /* Intern this now in case it isn't already done.
27934 Setting this variable twice is harmless.
27935 But don't staticpro it here--that is done in alloc.c. */
27936 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
27937 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
27939 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
27940 doc
: /* Char-table defining glyphless characters.
27941 Each element, if non-nil, should be one of the following:
27942 an ASCII acronym string: display this string in a box
27943 `hex-code': display the hexadecimal code of a character in a box
27944 `empty-box': display as an empty box
27945 `thin-space': display as 1-pixel width space
27946 `zero-width': don't display
27947 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
27948 display method for graphical terminals and text terminals respectively.
27949 GRAPHICAL and TEXT should each have one of the values listed above.
27951 The char-table has one extra slot to control the display of a character for
27952 which no font is found. This slot only takes effect on graphical terminals.
27953 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
27954 `thin-space'. The default is `empty-box'. */);
27955 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
27956 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
27961 /* Initialize this module when Emacs starts. */
27966 current_header_line_height
= current_mode_line_height
= -1;
27968 CHARPOS (this_line_start_pos
) = 0;
27970 if (!noninteractive
)
27972 struct window
*m
= XWINDOW (minibuf_window
);
27973 Lisp_Object frame
= m
->frame
;
27974 struct frame
*f
= XFRAME (frame
);
27975 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
27976 struct window
*r
= XWINDOW (root
);
27979 echo_area_window
= minibuf_window
;
27981 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
27982 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
27983 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
27984 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
27985 XSETFASTINT (m
->total_lines
, 1);
27986 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
27988 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
27989 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
27990 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
27992 /* The default ellipsis glyphs `...'. */
27993 for (i
= 0; i
< 3; ++i
)
27994 default_invis_vector
[i
] = make_number ('.');
27998 /* Allocate the buffer for frame titles.
27999 Also used for `format-mode-line'. */
28001 mode_line_noprop_buf
= (char *) xmalloc (size
);
28002 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28003 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28004 mode_line_target
= MODE_LINE_DISPLAY
;
28007 help_echo_showing_p
= 0;
28010 /* Since w32 does not support atimers, it defines its own implementation of
28011 the following three functions in w32fns.c. */
28014 /* Platform-independent portion of hourglass implementation. */
28016 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28018 hourglass_started (void)
28020 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28023 /* Cancel a currently active hourglass timer, and start a new one. */
28025 start_hourglass (void)
28027 #if defined (HAVE_WINDOW_SYSTEM)
28029 int secs
, usecs
= 0;
28031 cancel_hourglass ();
28033 if (INTEGERP (Vhourglass_delay
)
28034 && XINT (Vhourglass_delay
) > 0)
28035 secs
= XFASTINT (Vhourglass_delay
);
28036 else if (FLOATP (Vhourglass_delay
)
28037 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28040 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28041 secs
= XFASTINT (tem
);
28042 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28045 secs
= DEFAULT_HOURGLASS_DELAY
;
28047 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28048 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28049 show_hourglass
, NULL
);
28054 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28057 cancel_hourglass (void)
28059 #if defined (HAVE_WINDOW_SYSTEM)
28060 if (hourglass_atimer
)
28062 cancel_atimer (hourglass_atimer
);
28063 hourglass_atimer
= NULL
;
28066 if (hourglass_shown_p
)
28070 #endif /* ! WINDOWSNT */