1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2011 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
24 Emacs separates the task of updating the display from code
25 modifying global state, e.g. buffer text. This way functions
26 operating on buffers don't also have to be concerned with updating
29 Updating the display is triggered by the Lisp interpreter when it
30 decides it's time to do it. This is done either automatically for
31 you as part of the interpreter's command loop or as the result of
32 calling Lisp functions like `sit-for'. The C function `redisplay'
33 in xdisp.c is the only entry into the inner redisplay code.
35 The following diagram shows how redisplay code is invoked. As you
36 can see, Lisp calls redisplay and vice versa. Under window systems
37 like X, some portions of the redisplay code are also called
38 asynchronously during mouse movement or expose events. It is very
39 important that these code parts do NOT use the C library (malloc,
40 free) because many C libraries under Unix are not reentrant. They
41 may also NOT call functions of the Lisp interpreter which could
42 change the interpreter's state. If you don't follow these rules,
43 you will encounter bugs which are very hard to explain.
45 +--------------+ redisplay +----------------+
46 | Lisp machine |---------------->| Redisplay code |<--+
47 +--------------+ (xdisp.c) +----------------+ |
49 +----------------------------------+ |
50 Don't use this path when called |
53 expose_window (asynchronous) |
55 X expose events -----+
57 What does redisplay do? Obviously, it has to figure out somehow what
58 has been changed since the last time the display has been updated,
59 and to make these changes visible. Preferably it would do that in
60 a moderately intelligent way, i.e. fast.
62 Changes in buffer text can be deduced from window and buffer
63 structures, and from some global variables like `beg_unchanged' and
64 `end_unchanged'. The contents of the display are additionally
65 recorded in a `glyph matrix', a two-dimensional matrix of glyph
66 structures. Each row in such a matrix corresponds to a line on the
67 display, and each glyph in a row corresponds to a column displaying
68 a character, an image, or what else. This matrix is called the
69 `current glyph matrix' or `current matrix' in redisplay
72 For buffer parts that have been changed since the last update, a
73 second glyph matrix is constructed, the so called `desired glyph
74 matrix' or short `desired matrix'. Current and desired matrix are
75 then compared to find a cheap way to update the display, e.g. by
76 reusing part of the display by scrolling lines.
78 You will find a lot of redisplay optimizations when you start
79 looking at the innards of redisplay. The overall goal of all these
80 optimizations is to make redisplay fast because it is done
81 frequently. Some of these optimizations are implemented by the
86 This function tries to update the display if the text in the
87 window did not change and did not scroll, only point moved, and
88 it did not move off the displayed portion of the text.
90 . try_window_reusing_current_matrix
92 This function reuses the current matrix of a window when text
93 has not changed, but the window start changed (e.g., due to
98 This function attempts to redisplay a window by reusing parts of
99 its existing display. It finds and reuses the part that was not
100 changed, and redraws the rest.
104 This function performs the full redisplay of a single window
105 assuming that its fonts were not changed and that the cursor
106 will not end up in the scroll margins. (Loading fonts requires
107 re-adjustment of dimensions of glyph matrices, which makes this
108 method impossible to use.)
110 These optimizations are tried in sequence (some can be skipped if
111 it is known that they are not applicable). If none of the
112 optimizations were successful, redisplay calls redisplay_windows,
113 which performs a full redisplay of all windows.
117 Desired matrices are always built per Emacs window. The function
118 `display_line' is the central function to look at if you are
119 interested. It constructs one row in a desired matrix given an
120 iterator structure containing both a buffer position and a
121 description of the environment in which the text is to be
122 displayed. But this is too early, read on.
124 Characters and pixmaps displayed for a range of buffer text depend
125 on various settings of buffers and windows, on overlays and text
126 properties, on display tables, on selective display. The good news
127 is that all this hairy stuff is hidden behind a small set of
128 interface functions taking an iterator structure (struct it)
131 Iteration over things to be displayed is then simple. It is
132 started by initializing an iterator with a call to init_iterator,
133 passing it the buffer position where to start iteration. For
134 iteration over strings, pass -1 as the position to init_iterator,
135 and call reseat_to_string when the string is ready, to initialize
136 the iterator for that string. Thereafter, calls to
137 get_next_display_element fill the iterator structure with relevant
138 information about the next thing to display. Calls to
139 set_iterator_to_next move the iterator to the next thing.
141 Besides this, an iterator also contains information about the
142 display environment in which glyphs for display elements are to be
143 produced. It has fields for the width and height of the display,
144 the information whether long lines are truncated or continued, a
145 current X and Y position, and lots of other stuff you can better
148 Glyphs in a desired matrix are normally constructed in a loop
149 calling get_next_display_element and then PRODUCE_GLYPHS. The call
150 to PRODUCE_GLYPHS will fill the iterator structure with pixel
151 information about the element being displayed and at the same time
152 produce glyphs for it. If the display element fits on the line
153 being displayed, set_iterator_to_next is called next, otherwise the
154 glyphs produced are discarded. The function display_line is the
155 workhorse of filling glyph rows in the desired matrix with glyphs.
156 In addition to producing glyphs, it also handles line truncation
157 and continuation, word wrap, and cursor positioning (for the
158 latter, see also set_cursor_from_row).
162 That just couldn't be all, could it? What about terminal types not
163 supporting operations on sub-windows of the screen? To update the
164 display on such a terminal, window-based glyph matrices are not
165 well suited. To be able to reuse part of the display (scrolling
166 lines up and down), we must instead have a view of the whole
167 screen. This is what `frame matrices' are for. They are a trick.
169 Frames on terminals like above have a glyph pool. Windows on such
170 a frame sub-allocate their glyph memory from their frame's glyph
171 pool. The frame itself is given its own glyph matrices. By
172 coincidence---or maybe something else---rows in window glyph
173 matrices are slices of corresponding rows in frame matrices. Thus
174 writing to window matrices implicitly updates a frame matrix which
175 provides us with the view of the whole screen that we originally
176 wanted to have without having to move many bytes around. To be
177 honest, there is a little bit more done, but not much more. If you
178 plan to extend that code, take a look at dispnew.c. The function
179 build_frame_matrix is a good starting point.
181 Bidirectional display.
183 Bidirectional display adds quite some hair to this already complex
184 design. The good news are that a large portion of that hairy stuff
185 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
186 reordering engine which is called by set_iterator_to_next and
187 returns the next character to display in the visual order. See
188 commentary on bidi.c for more details. As far as redisplay is
189 concerned, the effect of calling bidi_move_to_visually_next, the
190 main interface of the reordering engine, is that the iterator gets
191 magically placed on the buffer or string position that is to be
192 displayed next. In other words, a linear iteration through the
193 buffer/string is replaced with a non-linear one. All the rest of
194 the redisplay is oblivious to the bidi reordering.
196 Well, almost oblivious---there are still complications, most of
197 them due to the fact that buffer and string positions no longer
198 change monotonously with glyph indices in a glyph row. Moreover,
199 for continued lines, the buffer positions may not even be
200 monotonously changing with vertical positions. Also, accounting
201 for face changes, overlays, etc. becomes more complex because
202 non-linear iteration could potentially skip many positions with
203 changes, and then cross them again on the way back...
205 One other prominent effect of bidirectional display is that some
206 paragraphs of text need to be displayed starting at the right
207 margin of the window---the so-called right-to-left, or R2L
208 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
209 which have their reversed_p flag set. The bidi reordering engine
210 produces characters in such rows starting from the character which
211 should be the rightmost on display. PRODUCE_GLYPHS then reverses
212 the order, when it fills up the glyph row whose reversed_p flag is
213 set, by prepending each new glyph to what is already there, instead
214 of appending it. When the glyph row is complete, the function
215 extend_face_to_end_of_line fills the empty space to the left of the
216 leftmost character with special glyphs, which will display as,
217 well, empty. On text terminals, these special glyphs are simply
218 blank characters. On graphics terminals, there's a single stretch
219 glyph of a suitably computed width. Both the blanks and the
220 stretch glyph are given the face of the background of the line.
221 This way, the terminal-specific back-end can still draw the glyphs
222 left to right, even for R2L lines.
224 Bidirectional display and character compositions
226 Some scripts cannot be displayed by drawing each character
227 individually, because adjacent characters change each other's shape
228 on display. For example, Arabic and Indic scripts belong to this
231 Emacs display supports this by providing "character compositions",
232 most of which is implemented in composite.c. During the buffer
233 scan that delivers characters to PRODUCE_GLYPHS, if the next
234 character to be delivered is a composed character, the iteration
235 calls composition_reseat_it and next_element_from_composition. If
236 they succeed to compose the character with one or more of the
237 following characters, the whole sequence of characters that where
238 composed is recorded in the `struct composition_it' object that is
239 part of the buffer iterator. The composed sequence could produce
240 one or more font glyphs (called "grapheme clusters") on the screen.
241 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
242 in the direction corresponding to the current bidi scan direction
243 (recorded in the scan_dir member of the `struct bidi_it' object
244 that is part of the buffer iterator). In particular, if the bidi
245 iterator currently scans the buffer backwards, the grapheme
246 clusters are delivered back to front. This reorders the grapheme
247 clusters as appropriate for the current bidi context. Note that
248 this means that the grapheme clusters are always stored in the
249 LGSTRING object (see composite.c) in the logical order.
251 Moving an iterator in bidirectional text
252 without producing glyphs
254 Note one important detail mentioned above: that the bidi reordering
255 engine, driven by the iterator, produces characters in R2L rows
256 starting at the character that will be the rightmost on display.
257 As far as the iterator is concerned, the geometry of such rows is
258 still left to right, i.e. the iterator "thinks" the first character
259 is at the leftmost pixel position. The iterator does not know that
260 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
261 delivers. This is important when functions from the move_it_*
262 family are used to get to certain screen position or to match
263 screen coordinates with buffer coordinates: these functions use the
264 iterator geometry, which is left to right even in R2L paragraphs.
265 This works well with most callers of move_it_*, because they need
266 to get to a specific column, and columns are still numbered in the
267 reading order, i.e. the rightmost character in a R2L paragraph is
268 still column zero. But some callers do not get well with this; a
269 notable example is mouse clicks that need to find the character
270 that corresponds to certain pixel coordinates. See
271 buffer_posn_from_coords in dispnew.c for how this is handled. */
279 #include "keyboard.h"
282 #include "termchar.h"
283 #include "dispextern.h"
285 #include "character.h"
288 #include "commands.h"
292 #include "termhooks.h"
293 #include "termopts.h"
294 #include "intervals.h"
297 #include "region-cache.h"
300 #include "blockinput.h"
302 #ifdef HAVE_X_WINDOWS
317 #ifndef FRAME_X_OUTPUT
318 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
321 #define INFINITY 10000000
323 Lisp_Object Qoverriding_local_map
, Qoverriding_terminal_local_map
;
324 Lisp_Object Qwindow_scroll_functions
;
325 static Lisp_Object Qwindow_text_change_functions
;
326 static Lisp_Object Qredisplay_end_trigger_functions
;
327 Lisp_Object Qinhibit_point_motion_hooks
;
328 static Lisp_Object QCeval
, QCpropertize
;
329 Lisp_Object QCfile
, QCdata
;
330 static Lisp_Object Qfontified
;
331 static Lisp_Object Qgrow_only
;
332 static Lisp_Object Qinhibit_eval_during_redisplay
;
333 static Lisp_Object Qbuffer_position
, Qposition
, Qobject
;
334 static Lisp_Object Qright_to_left
, Qleft_to_right
;
337 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
340 static Lisp_Object Qarrow
, Qhand
;
343 /* Holds the list (error). */
344 static Lisp_Object list_of_error
;
346 static Lisp_Object Qfontification_functions
;
348 static Lisp_Object Qwrap_prefix
;
349 static Lisp_Object Qline_prefix
;
351 /* Non-nil means don't actually do any redisplay. */
353 Lisp_Object Qinhibit_redisplay
;
355 /* Names of text properties relevant for redisplay. */
357 Lisp_Object Qdisplay
;
359 Lisp_Object Qspace
, QCalign_to
;
360 static Lisp_Object QCrelative_width
, QCrelative_height
;
361 Lisp_Object Qleft_margin
, Qright_margin
;
362 static Lisp_Object Qspace_width
, Qraise
;
363 static Lisp_Object Qslice
;
365 static Lisp_Object Qmargin
, Qpointer
;
366 static Lisp_Object Qline_height
;
368 #ifdef HAVE_WINDOW_SYSTEM
370 /* Test if overflow newline into fringe. Called with iterator IT
371 at or past right window margin, and with IT->current_x set. */
373 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
374 (!NILP (Voverflow_newline_into_fringe) \
375 && FRAME_WINDOW_P ((IT)->f) \
376 && ((IT)->bidi_it.paragraph_dir == R2L \
377 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
378 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
379 && (IT)->current_x == (IT)->last_visible_x \
380 && (IT)->line_wrap != WORD_WRAP)
382 #else /* !HAVE_WINDOW_SYSTEM */
383 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
384 #endif /* HAVE_WINDOW_SYSTEM */
386 /* Test if the display element loaded in IT is a space or tab
387 character. This is used to determine word wrapping. */
389 #define IT_DISPLAYING_WHITESPACE(it) \
390 (it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t'))
392 /* Name of the face used to highlight trailing whitespace. */
394 static Lisp_Object Qtrailing_whitespace
;
396 /* Name and number of the face used to highlight escape glyphs. */
398 static Lisp_Object Qescape_glyph
;
400 /* Name and number of the face used to highlight non-breaking spaces. */
402 static Lisp_Object Qnobreak_space
;
404 /* The symbol `image' which is the car of the lists used to represent
405 images in Lisp. Also a tool bar style. */
409 /* The image map types. */
411 static Lisp_Object QCpointer
;
412 static Lisp_Object Qrect
, Qcircle
, Qpoly
;
414 /* Tool bar styles */
415 Lisp_Object Qboth
, Qboth_horiz
, Qtext_image_horiz
;
417 /* Non-zero means print newline to stdout before next mini-buffer
420 int noninteractive_need_newline
;
422 /* Non-zero means print newline to message log before next message. */
424 static int message_log_need_newline
;
426 /* Three markers that message_dolog uses.
427 It could allocate them itself, but that causes trouble
428 in handling memory-full errors. */
429 static Lisp_Object message_dolog_marker1
;
430 static Lisp_Object message_dolog_marker2
;
431 static Lisp_Object message_dolog_marker3
;
433 /* The buffer position of the first character appearing entirely or
434 partially on the line of the selected window which contains the
435 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
436 redisplay optimization in redisplay_internal. */
438 static struct text_pos this_line_start_pos
;
440 /* Number of characters past the end of the line above, including the
441 terminating newline. */
443 static struct text_pos this_line_end_pos
;
445 /* The vertical positions and the height of this line. */
447 static int this_line_vpos
;
448 static int this_line_y
;
449 static int this_line_pixel_height
;
451 /* X position at which this display line starts. Usually zero;
452 negative if first character is partially visible. */
454 static int this_line_start_x
;
456 /* The smallest character position seen by move_it_* functions as they
457 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
458 hscrolled lines, see display_line. */
460 static struct text_pos this_line_min_pos
;
462 /* Buffer that this_line_.* variables are referring to. */
464 static struct buffer
*this_line_buffer
;
467 /* Values of those variables at last redisplay are stored as
468 properties on `overlay-arrow-position' symbol. However, if
469 Voverlay_arrow_position is a marker, last-arrow-position is its
470 numerical position. */
472 static Lisp_Object Qlast_arrow_position
, Qlast_arrow_string
;
474 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
475 properties on a symbol in overlay-arrow-variable-list. */
477 static Lisp_Object Qoverlay_arrow_string
, Qoverlay_arrow_bitmap
;
479 Lisp_Object Qmenu_bar_update_hook
;
481 /* Nonzero if an overlay arrow has been displayed in this window. */
483 static int overlay_arrow_seen
;
485 /* Number of windows showing the buffer of the selected window (or
486 another buffer with the same base buffer). keyboard.c refers to
491 /* Vector containing glyphs for an ellipsis `...'. */
493 static Lisp_Object default_invis_vector
[3];
495 /* This is the window where the echo area message was displayed. It
496 is always a mini-buffer window, but it may not be the same window
497 currently active as a mini-buffer. */
499 Lisp_Object echo_area_window
;
501 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
502 pushes the current message and the value of
503 message_enable_multibyte on the stack, the function restore_message
504 pops the stack and displays MESSAGE again. */
506 static Lisp_Object Vmessage_stack
;
508 /* Nonzero means multibyte characters were enabled when the echo area
509 message was specified. */
511 static int message_enable_multibyte
;
513 /* Nonzero if we should redraw the mode lines on the next redisplay. */
515 int update_mode_lines
;
517 /* Nonzero if window sizes or contents have changed since last
518 redisplay that finished. */
520 int windows_or_buffers_changed
;
522 /* Nonzero means a frame's cursor type has been changed. */
524 int cursor_type_changed
;
526 /* Nonzero after display_mode_line if %l was used and it displayed a
529 static int line_number_displayed
;
531 /* The name of the *Messages* buffer, a string. */
533 static Lisp_Object Vmessages_buffer_name
;
535 /* Current, index 0, and last displayed echo area message. Either
536 buffers from echo_buffers, or nil to indicate no message. */
538 Lisp_Object echo_area_buffer
[2];
540 /* The buffers referenced from echo_area_buffer. */
542 static Lisp_Object echo_buffer
[2];
544 /* A vector saved used in with_area_buffer to reduce consing. */
546 static Lisp_Object Vwith_echo_area_save_vector
;
548 /* Non-zero means display_echo_area should display the last echo area
549 message again. Set by redisplay_preserve_echo_area. */
551 static int display_last_displayed_message_p
;
553 /* Nonzero if echo area is being used by print; zero if being used by
556 static int message_buf_print
;
558 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
560 static Lisp_Object Qinhibit_menubar_update
;
561 static Lisp_Object Qmessage_truncate_lines
;
563 /* Set to 1 in clear_message to make redisplay_internal aware
564 of an emptied echo area. */
566 static int message_cleared_p
;
568 /* A scratch glyph row with contents used for generating truncation
569 glyphs. Also used in direct_output_for_insert. */
571 #define MAX_SCRATCH_GLYPHS 100
572 static struct glyph_row scratch_glyph_row
;
573 static struct glyph scratch_glyphs
[MAX_SCRATCH_GLYPHS
];
575 /* Ascent and height of the last line processed by move_it_to. */
577 static int last_max_ascent
, last_height
;
579 /* Non-zero if there's a help-echo in the echo area. */
581 int help_echo_showing_p
;
583 /* If >= 0, computed, exact values of mode-line and header-line height
584 to use in the macros CURRENT_MODE_LINE_HEIGHT and
585 CURRENT_HEADER_LINE_HEIGHT. */
587 int current_mode_line_height
, current_header_line_height
;
589 /* The maximum distance to look ahead for text properties. Values
590 that are too small let us call compute_char_face and similar
591 functions too often which is expensive. Values that are too large
592 let us call compute_char_face and alike too often because we
593 might not be interested in text properties that far away. */
595 #define TEXT_PROP_DISTANCE_LIMIT 100
597 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
598 iterator state and later restore it. This is needed because the
599 bidi iterator on bidi.c keeps a stacked cache of its states, which
600 is really a singleton. When we use scratch iterator objects to
601 move around the buffer, we can cause the bidi cache to be pushed or
602 popped, and therefore we need to restore the cache state when we
603 return to the original iterator. */
604 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
607 bidi_unshelve_cache (CACHE, 1); \
609 CACHE = bidi_shelve_cache (); \
612 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
614 if (pITORIG != pITCOPY) \
615 *(pITORIG) = *(pITCOPY); \
616 bidi_unshelve_cache (CACHE, 0); \
622 /* Non-zero means print traces of redisplay if compiled with
625 int trace_redisplay_p
;
627 #endif /* GLYPH_DEBUG */
629 #ifdef DEBUG_TRACE_MOVE
630 /* Non-zero means trace with TRACE_MOVE to stderr. */
633 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
635 #define TRACE_MOVE(x) (void) 0
638 static Lisp_Object Qauto_hscroll_mode
;
640 /* Buffer being redisplayed -- for redisplay_window_error. */
642 static struct buffer
*displayed_buffer
;
644 /* Value returned from text property handlers (see below). */
649 HANDLED_RECOMPUTE_PROPS
,
650 HANDLED_OVERLAY_STRING_CONSUMED
,
654 /* A description of text properties that redisplay is interested
659 /* The name of the property. */
662 /* A unique index for the property. */
665 /* A handler function called to set up iterator IT from the property
666 at IT's current position. Value is used to steer handle_stop. */
667 enum prop_handled (*handler
) (struct it
*it
);
670 static enum prop_handled
handle_face_prop (struct it
*);
671 static enum prop_handled
handle_invisible_prop (struct it
*);
672 static enum prop_handled
handle_display_prop (struct it
*);
673 static enum prop_handled
handle_composition_prop (struct it
*);
674 static enum prop_handled
handle_overlay_change (struct it
*);
675 static enum prop_handled
handle_fontified_prop (struct it
*);
677 /* Properties handled by iterators. */
679 static struct props it_props
[] =
681 {&Qfontified
, FONTIFIED_PROP_IDX
, handle_fontified_prop
},
682 /* Handle `face' before `display' because some sub-properties of
683 `display' need to know the face. */
684 {&Qface
, FACE_PROP_IDX
, handle_face_prop
},
685 {&Qdisplay
, DISPLAY_PROP_IDX
, handle_display_prop
},
686 {&Qinvisible
, INVISIBLE_PROP_IDX
, handle_invisible_prop
},
687 {&Qcomposition
, COMPOSITION_PROP_IDX
, handle_composition_prop
},
691 /* Value is the position described by X. If X is a marker, value is
692 the marker_position of X. Otherwise, value is X. */
694 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
696 /* Enumeration returned by some move_it_.* functions internally. */
700 /* Not used. Undefined value. */
703 /* Move ended at the requested buffer position or ZV. */
704 MOVE_POS_MATCH_OR_ZV
,
706 /* Move ended at the requested X pixel position. */
709 /* Move within a line ended at the end of a line that must be
713 /* Move within a line ended at the end of a line that would
714 be displayed truncated. */
717 /* Move within a line ended at a line end. */
721 /* This counter is used to clear the face cache every once in a while
722 in redisplay_internal. It is incremented for each redisplay.
723 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
726 #define CLEAR_FACE_CACHE_COUNT 500
727 static int clear_face_cache_count
;
729 /* Similarly for the image cache. */
731 #ifdef HAVE_WINDOW_SYSTEM
732 #define CLEAR_IMAGE_CACHE_COUNT 101
733 static int clear_image_cache_count
;
735 /* Null glyph slice */
736 static struct glyph_slice null_glyph_slice
= { 0, 0, 0, 0 };
739 /* Non-zero while redisplay_internal is in progress. */
743 static Lisp_Object Qinhibit_free_realized_faces
;
745 /* If a string, XTread_socket generates an event to display that string.
746 (The display is done in read_char.) */
748 Lisp_Object help_echo_string
;
749 Lisp_Object help_echo_window
;
750 Lisp_Object help_echo_object
;
751 EMACS_INT help_echo_pos
;
753 /* Temporary variable for XTread_socket. */
755 Lisp_Object previous_help_echo_string
;
757 /* Platform-independent portion of hourglass implementation. */
759 /* Non-zero means an hourglass cursor is currently shown. */
760 int hourglass_shown_p
;
762 /* If non-null, an asynchronous timer that, when it expires, displays
763 an hourglass cursor on all frames. */
764 struct atimer
*hourglass_atimer
;
766 /* Name of the face used to display glyphless characters. */
767 Lisp_Object Qglyphless_char
;
769 /* Symbol for the purpose of Vglyphless_char_display. */
770 static Lisp_Object Qglyphless_char_display
;
772 /* Method symbols for Vglyphless_char_display. */
773 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
775 /* Default pixel width of `thin-space' display method. */
776 #define THIN_SPACE_WIDTH 1
778 /* Default number of seconds to wait before displaying an hourglass
780 #define DEFAULT_HOURGLASS_DELAY 1
783 /* Function prototypes. */
785 static void setup_for_ellipsis (struct it
*, int);
786 static void set_iterator_to_next (struct it
*, int);
787 static void mark_window_display_accurate_1 (struct window
*, int);
788 static int single_display_spec_string_p (Lisp_Object
, Lisp_Object
);
789 static int display_prop_string_p (Lisp_Object
, Lisp_Object
);
790 static int cursor_row_p (struct glyph_row
*);
791 static int redisplay_mode_lines (Lisp_Object
, int);
792 static char *decode_mode_spec_coding (Lisp_Object
, char *, int);
794 static Lisp_Object
get_it_property (struct it
*it
, Lisp_Object prop
);
796 static void handle_line_prefix (struct it
*);
798 static void pint2str (char *, int, EMACS_INT
);
799 static void pint2hrstr (char *, int, EMACS_INT
);
800 static struct text_pos
run_window_scroll_functions (Lisp_Object
,
802 static void reconsider_clip_changes (struct window
*, struct buffer
*);
803 static int text_outside_line_unchanged_p (struct window
*,
804 EMACS_INT
, EMACS_INT
);
805 static void store_mode_line_noprop_char (char);
806 static int store_mode_line_noprop (const char *, int, int);
807 static void handle_stop (struct it
*);
808 static void handle_stop_backwards (struct it
*, EMACS_INT
);
809 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
810 static void ensure_echo_area_buffers (void);
811 static Lisp_Object
unwind_with_echo_area_buffer (Lisp_Object
);
812 static Lisp_Object
with_echo_area_buffer_unwind_data (struct window
*);
813 static int with_echo_area_buffer (struct window
*, int,
814 int (*) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
815 EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
816 static void clear_garbaged_frames (void);
817 static int current_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
818 static void pop_message (void);
819 static int truncate_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
820 static void set_message (const char *, Lisp_Object
, EMACS_INT
, int);
821 static int set_message_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
822 static int display_echo_area (struct window
*);
823 static int display_echo_area_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
824 static int resize_mini_window_1 (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
);
825 static Lisp_Object
unwind_redisplay (Lisp_Object
);
826 static int string_char_and_length (const unsigned char *, int *);
827 static struct text_pos
display_prop_end (struct it
*, Lisp_Object
,
829 static int compute_window_start_on_continuation_line (struct window
*);
830 static Lisp_Object
safe_eval_handler (Lisp_Object
);
831 static void insert_left_trunc_glyphs (struct it
*);
832 static struct glyph_row
*get_overlay_arrow_glyph_row (struct window
*,
834 static void extend_face_to_end_of_line (struct it
*);
835 static int append_space_for_newline (struct it
*, int);
836 static int cursor_row_fully_visible_p (struct window
*, int, int);
837 static int try_scrolling (Lisp_Object
, int, EMACS_INT
, EMACS_INT
, int, int);
838 static int try_cursor_movement (Lisp_Object
, struct text_pos
, int *);
839 static int trailing_whitespace_p (EMACS_INT
);
840 static intmax_t message_log_check_duplicate (EMACS_INT
, EMACS_INT
);
841 static void push_it (struct it
*, struct text_pos
*);
842 static void pop_it (struct it
*);
843 static void sync_frame_with_window_matrix_rows (struct window
*);
844 static void select_frame_for_redisplay (Lisp_Object
);
845 static void redisplay_internal (void);
846 static int echo_area_display (int);
847 static void redisplay_windows (Lisp_Object
);
848 static void redisplay_window (Lisp_Object
, int);
849 static Lisp_Object
redisplay_window_error (Lisp_Object
);
850 static Lisp_Object
redisplay_window_0 (Lisp_Object
);
851 static Lisp_Object
redisplay_window_1 (Lisp_Object
);
852 static int set_cursor_from_row (struct window
*, struct glyph_row
*,
853 struct glyph_matrix
*, EMACS_INT
, EMACS_INT
,
855 static int update_menu_bar (struct frame
*, int, int);
856 static int try_window_reusing_current_matrix (struct window
*);
857 static int try_window_id (struct window
*);
858 static int display_line (struct it
*);
859 static int display_mode_lines (struct window
*);
860 static int display_mode_line (struct window
*, enum face_id
, Lisp_Object
);
861 static int display_mode_element (struct it
*, int, int, int, Lisp_Object
, Lisp_Object
, int);
862 static int store_mode_line_string (const char *, Lisp_Object
, int, int, int, Lisp_Object
);
863 static const char *decode_mode_spec (struct window
*, int, int, Lisp_Object
*);
864 static void display_menu_bar (struct window
*);
865 static EMACS_INT
display_count_lines (EMACS_INT
, EMACS_INT
, EMACS_INT
,
867 static int display_string (const char *, Lisp_Object
, Lisp_Object
,
868 EMACS_INT
, EMACS_INT
, struct it
*, int, int, int, int);
869 static void compute_line_metrics (struct it
*);
870 static void run_redisplay_end_trigger_hook (struct it
*);
871 static int get_overlay_strings (struct it
*, EMACS_INT
);
872 static int get_overlay_strings_1 (struct it
*, EMACS_INT
, int);
873 static void next_overlay_string (struct it
*);
874 static void reseat (struct it
*, struct text_pos
, int);
875 static void reseat_1 (struct it
*, struct text_pos
, int);
876 static void back_to_previous_visible_line_start (struct it
*);
877 void reseat_at_previous_visible_line_start (struct it
*);
878 static void reseat_at_next_visible_line_start (struct it
*, int);
879 static int next_element_from_ellipsis (struct it
*);
880 static int next_element_from_display_vector (struct it
*);
881 static int next_element_from_string (struct it
*);
882 static int next_element_from_c_string (struct it
*);
883 static int next_element_from_buffer (struct it
*);
884 static int next_element_from_composition (struct it
*);
885 static int next_element_from_image (struct it
*);
886 static int next_element_from_stretch (struct it
*);
887 static void load_overlay_strings (struct it
*, EMACS_INT
);
888 static int init_from_display_pos (struct it
*, struct window
*,
889 struct display_pos
*);
890 static void reseat_to_string (struct it
*, const char *,
891 Lisp_Object
, EMACS_INT
, EMACS_INT
, int, int);
892 static int get_next_display_element (struct it
*);
893 static enum move_it_result
894 move_it_in_display_line_to (struct it
*, EMACS_INT
, int,
895 enum move_operation_enum
);
896 void move_it_vertically_backward (struct it
*, int);
897 static void init_to_row_start (struct it
*, struct window
*,
899 static int init_to_row_end (struct it
*, struct window
*,
901 static void back_to_previous_line_start (struct it
*);
902 static int forward_to_next_line_start (struct it
*, int *, struct bidi_it
*);
903 static struct text_pos
string_pos_nchars_ahead (struct text_pos
,
904 Lisp_Object
, EMACS_INT
);
905 static struct text_pos
string_pos (EMACS_INT
, Lisp_Object
);
906 static struct text_pos
c_string_pos (EMACS_INT
, const char *, int);
907 static EMACS_INT
number_of_chars (const char *, int);
908 static void compute_stop_pos (struct it
*);
909 static void compute_string_pos (struct text_pos
*, struct text_pos
,
911 static int face_before_or_after_it_pos (struct it
*, int);
912 static EMACS_INT
next_overlay_change (EMACS_INT
);
913 static int handle_display_spec (struct it
*, Lisp_Object
, Lisp_Object
,
914 Lisp_Object
, struct text_pos
*, EMACS_INT
, int);
915 static int handle_single_display_spec (struct it
*, Lisp_Object
,
916 Lisp_Object
, Lisp_Object
,
917 struct text_pos
*, EMACS_INT
, int, int);
918 static int underlying_face_id (struct it
*);
919 static int in_ellipses_for_invisible_text_p (struct display_pos
*,
922 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
923 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
925 #ifdef HAVE_WINDOW_SYSTEM
927 static void x_consider_frame_title (Lisp_Object
);
928 static int tool_bar_lines_needed (struct frame
*, int *);
929 static void update_tool_bar (struct frame
*, int);
930 static void build_desired_tool_bar_string (struct frame
*f
);
931 static int redisplay_tool_bar (struct frame
*);
932 static void display_tool_bar_line (struct it
*, int);
933 static void notice_overwritten_cursor (struct window
*,
936 static void append_stretch_glyph (struct it
*, Lisp_Object
,
940 #endif /* HAVE_WINDOW_SYSTEM */
942 static void show_mouse_face (Mouse_HLInfo
*, enum draw_glyphs_face
);
943 static int coords_in_mouse_face_p (struct window
*, int, int);
947 /***********************************************************************
948 Window display dimensions
949 ***********************************************************************/
951 /* Return the bottom boundary y-position for text lines in window W.
952 This is the first y position at which a line cannot start.
953 It is relative to the top of the window.
955 This is the height of W minus the height of a mode line, if any. */
958 window_text_bottom_y (struct window
*w
)
960 int height
= WINDOW_TOTAL_HEIGHT (w
);
962 if (WINDOW_WANTS_MODELINE_P (w
))
963 height
-= CURRENT_MODE_LINE_HEIGHT (w
);
967 /* Return the pixel width of display area AREA of window W. AREA < 0
968 means return the total width of W, not including fringes to
969 the left and right of the window. */
972 window_box_width (struct window
*w
, int area
)
974 int cols
= XFASTINT (w
->total_cols
);
977 if (!w
->pseudo_window_p
)
979 cols
-= WINDOW_SCROLL_BAR_COLS (w
);
981 if (area
== TEXT_AREA
)
983 if (INTEGERP (w
->left_margin_cols
))
984 cols
-= XFASTINT (w
->left_margin_cols
);
985 if (INTEGERP (w
->right_margin_cols
))
986 cols
-= XFASTINT (w
->right_margin_cols
);
987 pixels
= -WINDOW_TOTAL_FRINGE_WIDTH (w
);
989 else if (area
== LEFT_MARGIN_AREA
)
991 cols
= (INTEGERP (w
->left_margin_cols
)
992 ? XFASTINT (w
->left_margin_cols
) : 0);
995 else if (area
== RIGHT_MARGIN_AREA
)
997 cols
= (INTEGERP (w
->right_margin_cols
)
998 ? XFASTINT (w
->right_margin_cols
) : 0);
1003 return cols
* WINDOW_FRAME_COLUMN_WIDTH (w
) + pixels
;
1007 /* Return the pixel height of the display area of window W, not
1008 including mode lines of W, if any. */
1011 window_box_height (struct window
*w
)
1013 struct frame
*f
= XFRAME (w
->frame
);
1014 int height
= WINDOW_TOTAL_HEIGHT (w
);
1016 xassert (height
>= 0);
1018 /* Note: the code below that determines the mode-line/header-line
1019 height is essentially the same as that contained in the macro
1020 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1021 the appropriate glyph row has its `mode_line_p' flag set,
1022 and if it doesn't, uses estimate_mode_line_height instead. */
1024 if (WINDOW_WANTS_MODELINE_P (w
))
1026 struct glyph_row
*ml_row
1027 = (w
->current_matrix
&& w
->current_matrix
->rows
1028 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1030 if (ml_row
&& ml_row
->mode_line_p
)
1031 height
-= ml_row
->height
;
1033 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1036 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1038 struct glyph_row
*hl_row
1039 = (w
->current_matrix
&& w
->current_matrix
->rows
1040 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1042 if (hl_row
&& hl_row
->mode_line_p
)
1043 height
-= hl_row
->height
;
1045 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1048 /* With a very small font and a mode-line that's taller than
1049 default, we might end up with a negative height. */
1050 return max (0, height
);
1053 /* Return the window-relative coordinate of the left edge of display
1054 area AREA of window W. AREA < 0 means return the left edge of the
1055 whole window, to the right of the left fringe of W. */
1058 window_box_left_offset (struct window
*w
, int area
)
1062 if (w
->pseudo_window_p
)
1065 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1067 if (area
== TEXT_AREA
)
1068 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1069 + window_box_width (w
, LEFT_MARGIN_AREA
));
1070 else if (area
== RIGHT_MARGIN_AREA
)
1071 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1072 + window_box_width (w
, LEFT_MARGIN_AREA
)
1073 + window_box_width (w
, TEXT_AREA
)
1074 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1076 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1077 else if (area
== LEFT_MARGIN_AREA
1078 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1079 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1085 /* Return the window-relative coordinate of the right edge of display
1086 area AREA of window W. AREA < 0 means return the right edge of the
1087 whole window, to the left of the right fringe of W. */
1090 window_box_right_offset (struct window
*w
, int area
)
1092 return window_box_left_offset (w
, area
) + window_box_width (w
, area
);
1095 /* Return the frame-relative coordinate of the left edge of display
1096 area AREA of window W. AREA < 0 means return the left edge of the
1097 whole window, to the right of the left fringe of W. */
1100 window_box_left (struct window
*w
, int area
)
1102 struct frame
*f
= XFRAME (w
->frame
);
1105 if (w
->pseudo_window_p
)
1106 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1108 x
= (WINDOW_LEFT_EDGE_X (w
)
1109 + window_box_left_offset (w
, area
));
1115 /* Return the frame-relative coordinate of the right edge of display
1116 area AREA of window W. AREA < 0 means return the right edge of the
1117 whole window, to the left of the right fringe of W. */
1120 window_box_right (struct window
*w
, int area
)
1122 return window_box_left (w
, area
) + window_box_width (w
, area
);
1125 /* Get the bounding box of the display area AREA of window W, without
1126 mode lines, in frame-relative coordinates. AREA < 0 means the
1127 whole window, not including the left and right fringes of
1128 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1129 coordinates of the upper-left corner of the box. Return in
1130 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1133 window_box (struct window
*w
, int area
, int *box_x
, int *box_y
,
1134 int *box_width
, int *box_height
)
1137 *box_width
= window_box_width (w
, area
);
1139 *box_height
= window_box_height (w
);
1141 *box_x
= window_box_left (w
, area
);
1144 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1145 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1146 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1151 /* Get the bounding box of the display area AREA of window W, without
1152 mode lines. AREA < 0 means the whole window, not including the
1153 left and right fringe of the window. Return in *TOP_LEFT_X
1154 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1155 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1156 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1160 window_box_edges (struct window
*w
, int area
, int *top_left_x
, int *top_left_y
,
1161 int *bottom_right_x
, int *bottom_right_y
)
1163 window_box (w
, area
, top_left_x
, top_left_y
, bottom_right_x
,
1165 *bottom_right_x
+= *top_left_x
;
1166 *bottom_right_y
+= *top_left_y
;
1171 /***********************************************************************
1173 ***********************************************************************/
1175 /* Return the bottom y-position of the line the iterator IT is in.
1176 This can modify IT's settings. */
1179 line_bottom_y (struct it
*it
)
1181 int line_height
= it
->max_ascent
+ it
->max_descent
;
1182 int line_top_y
= it
->current_y
;
1184 if (line_height
== 0)
1187 line_height
= last_height
;
1188 else if (IT_CHARPOS (*it
) < ZV
)
1190 move_it_by_lines (it
, 1);
1191 line_height
= (it
->max_ascent
|| it
->max_descent
1192 ? it
->max_ascent
+ it
->max_descent
1197 struct glyph_row
*row
= it
->glyph_row
;
1199 /* Use the default character height. */
1200 it
->glyph_row
= NULL
;
1201 it
->what
= IT_CHARACTER
;
1204 PRODUCE_GLYPHS (it
);
1205 line_height
= it
->ascent
+ it
->descent
;
1206 it
->glyph_row
= row
;
1210 return line_top_y
+ line_height
;
1213 /* Subroutine of pos_visible_p below. Extracts a display string, if
1214 any, from the display spec given as its argument. */
1216 string_from_display_spec (Lisp_Object spec
)
1220 while (CONSP (spec
))
1222 if (STRINGP (XCAR (spec
)))
1227 else if (VECTORP (spec
))
1231 for (i
= 0; i
< ASIZE (spec
); i
++)
1233 if (STRINGP (AREF (spec
, i
)))
1234 return AREF (spec
, i
);
1242 /* Return 1 if position CHARPOS is visible in window W.
1243 CHARPOS < 0 means return info about WINDOW_END position.
1244 If visible, set *X and *Y to pixel coordinates of top left corner.
1245 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1246 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1249 pos_visible_p (struct window
*w
, EMACS_INT charpos
, int *x
, int *y
,
1250 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1253 void *itdata
= bidi_shelve_cache ();
1254 struct text_pos top
;
1256 struct buffer
*old_buffer
= NULL
;
1258 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1261 if (XBUFFER (w
->buffer
) != current_buffer
)
1263 old_buffer
= current_buffer
;
1264 set_buffer_internal_1 (XBUFFER (w
->buffer
));
1267 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1269 /* Compute exact mode line heights. */
1270 if (WINDOW_WANTS_MODELINE_P (w
))
1271 current_mode_line_height
1272 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1273 BVAR (current_buffer
, mode_line_format
));
1275 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1276 current_header_line_height
1277 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1278 BVAR (current_buffer
, header_line_format
));
1280 start_display (&it
, w
, top
);
1281 move_it_to (&it
, charpos
, -1, it
.last_visible_y
-1, -1,
1282 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1285 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
== 1)
1286 && IT_CHARPOS (it
) >= charpos
)
1287 /* When scanning backwards under bidi iteration, move_it_to
1288 stops at or _before_ CHARPOS, because it stops at or to
1289 the _right_ of the character at CHARPOS. */
1290 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1291 && IT_CHARPOS (it
) <= charpos
)))
1293 /* We have reached CHARPOS, or passed it. How the call to
1294 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1295 or covered by a display property, move_it_to stops at the end
1296 of the invisible text, to the right of CHARPOS. (ii) If
1297 CHARPOS is in a display vector, move_it_to stops on its last
1299 int top_x
= it
.current_x
;
1300 int top_y
= it
.current_y
;
1301 enum it_method it_method
= it
.method
;
1302 /* Calling line_bottom_y may change it.method, it.position, etc. */
1303 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1304 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1306 if (top_y
< window_top_y
)
1307 visible_p
= bottom_y
> window_top_y
;
1308 else if (top_y
< it
.last_visible_y
)
1312 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1314 /* We stopped on the last glyph of a display vector.
1315 Try and recompute. Hack alert! */
1316 if (charpos
< 2 || top
.charpos
>= charpos
)
1317 top_x
= it
.glyph_row
->x
;
1321 start_display (&it2
, w
, top
);
1322 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1323 get_next_display_element (&it2
);
1324 PRODUCE_GLYPHS (&it2
);
1325 if (ITERATOR_AT_END_OF_LINE_P (&it2
)
1326 || it2
.current_x
> it2
.last_visible_x
)
1327 top_x
= it
.glyph_row
->x
;
1330 top_x
= it2
.current_x
;
1331 top_y
= it2
.current_y
;
1335 else if (IT_CHARPOS (it
) != charpos
)
1337 Lisp_Object cpos
= make_number (charpos
);
1338 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1339 Lisp_Object string
= string_from_display_spec (spec
);
1340 int newline_in_string
= 0;
1342 if (STRINGP (string
))
1344 const char *s
= SSDATA (string
);
1345 const char *e
= s
+ SBYTES (string
);
1350 newline_in_string
= 1;
1355 /* The tricky code below is needed because there's a
1356 discrepancy between move_it_to and how we set cursor
1357 when the display line ends in a newline from a
1358 display string. move_it_to will stop _after_ such
1359 display strings, whereas set_cursor_from_row
1360 conspires with cursor_row_p to place the cursor on
1361 the first glyph produced from the display string. */
1363 /* We have overshoot PT because it is covered by a
1364 display property whose value is a string. If the
1365 string includes embedded newlines, we are also in the
1366 wrong display line. Backtrack to the correct line,
1367 where the display string begins. */
1368 if (newline_in_string
)
1370 Lisp_Object startpos
, endpos
;
1371 EMACS_INT start
, end
;
1374 /* Find the first and the last buffer positions
1375 covered by the display string. */
1377 Fnext_single_char_property_change (cpos
, Qdisplay
,
1380 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1382 start
= XFASTINT (startpos
);
1383 end
= XFASTINT (endpos
);
1384 /* Move to the last buffer position before the
1385 display property. */
1386 start_display (&it3
, w
, top
);
1387 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1388 /* Move forward one more line if the position before
1389 the display string is a newline or if it is the
1390 rightmost character on a line that is
1391 continued or word-wrapped. */
1392 if (it3
.method
== GET_FROM_BUFFER
1394 move_it_by_lines (&it3
, 1);
1395 else if (move_it_in_display_line_to (&it3
, -1,
1399 == MOVE_LINE_CONTINUED
)
1401 move_it_by_lines (&it3
, 1);
1402 /* When we are under word-wrap, the #$@%!
1403 move_it_by_lines moves 2 lines, so we need to
1405 if (it3
.line_wrap
== WORD_WRAP
)
1406 move_it_by_lines (&it3
, -1);
1409 /* Record the vertical coordinate of the display
1410 line where we wound up. */
1411 top_y
= it3
.current_y
;
1414 /* When characters are reordered for display,
1415 the character displayed to the left of the
1416 display string could be _after_ the display
1417 property in the logical order. Use the
1418 smallest vertical position of these two. */
1419 start_display (&it3
, w
, top
);
1420 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1421 if (it3
.current_y
< top_y
)
1422 top_y
= it3
.current_y
;
1424 /* Move from the top of the window to the beginning
1425 of the display line where the display string
1427 start_display (&it3
, w
, top
);
1428 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1429 /* Finally, advance the iterator until we hit the
1430 first display element whose character position is
1431 CHARPOS, or until the first newline from the
1432 display string, which signals the end of the
1434 while (get_next_display_element (&it3
))
1436 PRODUCE_GLYPHS (&it3
);
1437 if (IT_CHARPOS (it3
) == charpos
1438 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1440 set_iterator_to_next (&it3
, 0);
1442 top_x
= it3
.current_x
- it3
.pixel_width
;
1443 /* Normally, we would exit the above loop because we
1444 found the display element whose character
1445 position is CHARPOS. For the contingency that we
1446 didn't, and stopped at the first newline from the
1447 display string, move back over the glyphs
1448 produced from the string, until we find the
1449 rightmost glyph not from the string. */
1450 if (IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1452 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1453 + it3
.glyph_row
->used
[TEXT_AREA
];
1455 while (EQ ((g
- 1)->object
, string
))
1458 top_x
-= g
->pixel_width
;
1460 xassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1461 + it3
.glyph_row
->used
[TEXT_AREA
]);
1467 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1468 *rtop
= max (0, window_top_y
- top_y
);
1469 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1470 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1471 - max (top_y
, window_top_y
)));
1477 /* We were asked to provide info about WINDOW_END. */
1479 void *it2data
= NULL
;
1481 SAVE_IT (it2
, it
, it2data
);
1482 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1483 move_it_by_lines (&it
, 1);
1484 if (charpos
< IT_CHARPOS (it
)
1485 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1488 RESTORE_IT (&it2
, &it2
, it2data
);
1489 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1491 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1492 *rtop
= max (0, -it2
.current_y
);
1493 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1494 - it
.last_visible_y
));
1495 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1497 - max (it2
.current_y
,
1498 WINDOW_HEADER_LINE_HEIGHT (w
))));
1502 bidi_unshelve_cache (it2data
, 1);
1504 bidi_unshelve_cache (itdata
, 0);
1507 set_buffer_internal_1 (old_buffer
);
1509 current_header_line_height
= current_mode_line_height
= -1;
1511 if (visible_p
&& XFASTINT (w
->hscroll
) > 0)
1512 *x
-= XFASTINT (w
->hscroll
) * WINDOW_FRAME_COLUMN_WIDTH (w
);
1515 /* Debugging code. */
1517 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1518 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1520 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1527 /* Return the next character from STR. Return in *LEN the length of
1528 the character. This is like STRING_CHAR_AND_LENGTH but never
1529 returns an invalid character. If we find one, we return a `?', but
1530 with the length of the invalid character. */
1533 string_char_and_length (const unsigned char *str
, int *len
)
1537 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1538 if (!CHAR_VALID_P (c
))
1539 /* We may not change the length here because other places in Emacs
1540 don't use this function, i.e. they silently accept invalid
1549 /* Given a position POS containing a valid character and byte position
1550 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1552 static struct text_pos
1553 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, EMACS_INT nchars
)
1555 xassert (STRINGP (string
) && nchars
>= 0);
1557 if (STRING_MULTIBYTE (string
))
1559 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1564 string_char_and_length (p
, &len
);
1567 BYTEPOS (pos
) += len
;
1571 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1577 /* Value is the text position, i.e. character and byte position,
1578 for character position CHARPOS in STRING. */
1580 static inline struct text_pos
1581 string_pos (EMACS_INT charpos
, Lisp_Object string
)
1583 struct text_pos pos
;
1584 xassert (STRINGP (string
));
1585 xassert (charpos
>= 0);
1586 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1591 /* Value is a text position, i.e. character and byte position, for
1592 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1593 means recognize multibyte characters. */
1595 static struct text_pos
1596 c_string_pos (EMACS_INT charpos
, const char *s
, int multibyte_p
)
1598 struct text_pos pos
;
1600 xassert (s
!= NULL
);
1601 xassert (charpos
>= 0);
1607 SET_TEXT_POS (pos
, 0, 0);
1610 string_char_and_length ((const unsigned char *) s
, &len
);
1613 BYTEPOS (pos
) += len
;
1617 SET_TEXT_POS (pos
, charpos
, charpos
);
1623 /* Value is the number of characters in C string S. MULTIBYTE_P
1624 non-zero means recognize multibyte characters. */
1627 number_of_chars (const char *s
, int multibyte_p
)
1633 EMACS_INT rest
= strlen (s
);
1635 const unsigned char *p
= (const unsigned char *) s
;
1637 for (nchars
= 0; rest
> 0; ++nchars
)
1639 string_char_and_length (p
, &len
);
1640 rest
-= len
, p
+= len
;
1644 nchars
= strlen (s
);
1650 /* Compute byte position NEWPOS->bytepos corresponding to
1651 NEWPOS->charpos. POS is a known position in string STRING.
1652 NEWPOS->charpos must be >= POS.charpos. */
1655 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1657 xassert (STRINGP (string
));
1658 xassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1660 if (STRING_MULTIBYTE (string
))
1661 *newpos
= string_pos_nchars_ahead (pos
, string
,
1662 CHARPOS (*newpos
) - CHARPOS (pos
));
1664 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1668 Return an estimation of the pixel height of mode or header lines on
1669 frame F. FACE_ID specifies what line's height to estimate. */
1672 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1674 #ifdef HAVE_WINDOW_SYSTEM
1675 if (FRAME_WINDOW_P (f
))
1677 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1679 /* This function is called so early when Emacs starts that the face
1680 cache and mode line face are not yet initialized. */
1681 if (FRAME_FACE_CACHE (f
))
1683 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1687 height
= FONT_HEIGHT (face
->font
);
1688 if (face
->box_line_width
> 0)
1689 height
+= 2 * face
->box_line_width
;
1700 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1701 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1702 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1703 not force the value into range. */
1706 pixel_to_glyph_coords (FRAME_PTR f
, register int pix_x
, register int pix_y
,
1707 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1710 #ifdef HAVE_WINDOW_SYSTEM
1711 if (FRAME_WINDOW_P (f
))
1713 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1714 even for negative values. */
1716 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1718 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1720 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1721 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1724 STORE_NATIVE_RECT (*bounds
,
1725 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1726 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1727 FRAME_COLUMN_WIDTH (f
) - 1,
1728 FRAME_LINE_HEIGHT (f
) - 1);
1734 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1735 pix_x
= FRAME_TOTAL_COLS (f
);
1739 else if (pix_y
> FRAME_LINES (f
))
1740 pix_y
= FRAME_LINES (f
);
1750 /* Find the glyph under window-relative coordinates X/Y in window W.
1751 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1752 strings. Return in *HPOS and *VPOS the row and column number of
1753 the glyph found. Return in *AREA the glyph area containing X.
1754 Value is a pointer to the glyph found or null if X/Y is not on
1755 text, or we can't tell because W's current matrix is not up to
1760 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1761 int *dx
, int *dy
, int *area
)
1763 struct glyph
*glyph
, *end
;
1764 struct glyph_row
*row
= NULL
;
1767 /* Find row containing Y. Give up if some row is not enabled. */
1768 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1770 row
= MATRIX_ROW (w
->current_matrix
, i
);
1771 if (!row
->enabled_p
)
1773 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1780 /* Give up if Y is not in the window. */
1781 if (i
== w
->current_matrix
->nrows
)
1784 /* Get the glyph area containing X. */
1785 if (w
->pseudo_window_p
)
1792 if (x
< window_box_left_offset (w
, TEXT_AREA
))
1794 *area
= LEFT_MARGIN_AREA
;
1795 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
1797 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
1800 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
1804 *area
= RIGHT_MARGIN_AREA
;
1805 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
1809 /* Find glyph containing X. */
1810 glyph
= row
->glyphs
[*area
];
1811 end
= glyph
+ row
->used
[*area
];
1813 while (glyph
< end
&& x
>= glyph
->pixel_width
)
1815 x
-= glyph
->pixel_width
;
1825 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
1828 *hpos
= glyph
- row
->glyphs
[*area
];
1832 /* Convert frame-relative x/y to coordinates relative to window W.
1833 Takes pseudo-windows into account. */
1836 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
1838 if (w
->pseudo_window_p
)
1840 /* A pseudo-window is always full-width, and starts at the
1841 left edge of the frame, plus a frame border. */
1842 struct frame
*f
= XFRAME (w
->frame
);
1843 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
1844 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1848 *x
-= WINDOW_LEFT_EDGE_X (w
);
1849 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
1853 #ifdef HAVE_WINDOW_SYSTEM
1856 Return in RECTS[] at most N clipping rectangles for glyph string S.
1857 Return the number of stored rectangles. */
1860 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
1867 if (s
->row
->full_width_p
)
1869 /* Draw full-width. X coordinates are relative to S->w->left_col. */
1870 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
1871 r
.width
= WINDOW_TOTAL_WIDTH (s
->w
);
1873 /* Unless displaying a mode or menu bar line, which are always
1874 fully visible, clip to the visible part of the row. */
1875 if (s
->w
->pseudo_window_p
)
1876 r
.height
= s
->row
->visible_height
;
1878 r
.height
= s
->height
;
1882 /* This is a text line that may be partially visible. */
1883 r
.x
= window_box_left (s
->w
, s
->area
);
1884 r
.width
= window_box_width (s
->w
, s
->area
);
1885 r
.height
= s
->row
->visible_height
;
1889 if (r
.x
< s
->clip_head
->x
)
1891 if (r
.width
>= s
->clip_head
->x
- r
.x
)
1892 r
.width
-= s
->clip_head
->x
- r
.x
;
1895 r
.x
= s
->clip_head
->x
;
1898 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
1900 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
1901 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
1906 /* If S draws overlapping rows, it's sufficient to use the top and
1907 bottom of the window for clipping because this glyph string
1908 intentionally draws over other lines. */
1909 if (s
->for_overlaps
)
1911 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1912 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
1914 /* Alas, the above simple strategy does not work for the
1915 environments with anti-aliased text: if the same text is
1916 drawn onto the same place multiple times, it gets thicker.
1917 If the overlap we are processing is for the erased cursor, we
1918 take the intersection with the rectagle of the cursor. */
1919 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
1921 XRectangle rc
, r_save
= r
;
1923 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
1924 rc
.y
= s
->w
->phys_cursor
.y
;
1925 rc
.width
= s
->w
->phys_cursor_width
;
1926 rc
.height
= s
->w
->phys_cursor_height
;
1928 x_intersect_rectangles (&r_save
, &rc
, &r
);
1933 /* Don't use S->y for clipping because it doesn't take partially
1934 visible lines into account. For example, it can be negative for
1935 partially visible lines at the top of a window. */
1936 if (!s
->row
->full_width_p
1937 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
1938 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
1940 r
.y
= max (0, s
->row
->y
);
1943 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
1945 /* If drawing the cursor, don't let glyph draw outside its
1946 advertised boundaries. Cleartype does this under some circumstances. */
1947 if (s
->hl
== DRAW_CURSOR
)
1949 struct glyph
*glyph
= s
->first_glyph
;
1954 r
.width
-= s
->x
- r
.x
;
1957 r
.width
= min (r
.width
, glyph
->pixel_width
);
1959 /* If r.y is below window bottom, ensure that we still see a cursor. */
1960 height
= min (glyph
->ascent
+ glyph
->descent
,
1961 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
1962 max_y
= window_text_bottom_y (s
->w
) - height
;
1963 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
1964 if (s
->ybase
- glyph
->ascent
> max_y
)
1971 /* Don't draw cursor glyph taller than our actual glyph. */
1972 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
1973 if (height
< r
.height
)
1975 max_y
= r
.y
+ r
.height
;
1976 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
1977 r
.height
= min (max_y
- r
.y
, height
);
1984 XRectangle r_save
= r
;
1986 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
1990 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
1991 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
1993 #ifdef CONVERT_FROM_XRECT
1994 CONVERT_FROM_XRECT (r
, *rects
);
2002 /* If we are processing overlapping and allowed to return
2003 multiple clipping rectangles, we exclude the row of the glyph
2004 string from the clipping rectangle. This is to avoid drawing
2005 the same text on the environment with anti-aliasing. */
2006 #ifdef CONVERT_FROM_XRECT
2009 XRectangle
*rs
= rects
;
2011 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2013 if (s
->for_overlaps
& OVERLAPS_PRED
)
2016 if (r
.y
+ r
.height
> row_y
)
2019 rs
[i
].height
= row_y
- r
.y
;
2025 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2028 if (r
.y
< row_y
+ s
->row
->visible_height
)
2030 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2032 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2033 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2042 #ifdef CONVERT_FROM_XRECT
2043 for (i
= 0; i
< n
; i
++)
2044 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2051 Return in *NR the clipping rectangle for glyph string S. */
2054 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2056 get_glyph_string_clip_rects (s
, nr
, 1);
2061 Return the position and height of the phys cursor in window W.
2062 Set w->phys_cursor_width to width of phys cursor.
2066 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2067 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2069 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2070 int x
, y
, wd
, h
, h0
, y0
;
2072 /* Compute the width of the rectangle to draw. If on a stretch
2073 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2074 rectangle as wide as the glyph, but use a canonical character
2076 wd
= glyph
->pixel_width
- 1;
2077 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2081 x
= w
->phys_cursor
.x
;
2088 if (glyph
->type
== STRETCH_GLYPH
2089 && !x_stretch_cursor_p
)
2090 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2091 w
->phys_cursor_width
= wd
;
2093 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2095 /* If y is below window bottom, ensure that we still see a cursor. */
2096 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2098 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2099 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2101 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2104 h
= max (h
- (y0
- y
) + 1, h0
);
2109 y0
= window_text_bottom_y (w
) - h0
;
2117 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2118 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2123 * Remember which glyph the mouse is over.
2127 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2131 struct glyph_row
*r
, *gr
, *end_row
;
2132 enum window_part part
;
2133 enum glyph_row_area area
;
2134 int x
, y
, width
, height
;
2136 /* Try to determine frame pixel position and size of the glyph under
2137 frame pixel coordinates X/Y on frame F. */
2139 if (!f
->glyphs_initialized_p
2140 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2143 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2144 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2148 w
= XWINDOW (window
);
2149 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2150 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2152 x
= window_relative_x_coord (w
, part
, gx
);
2153 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2155 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2156 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2158 if (w
->pseudo_window_p
)
2161 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2167 case ON_LEFT_MARGIN
:
2168 area
= LEFT_MARGIN_AREA
;
2171 case ON_RIGHT_MARGIN
:
2172 area
= RIGHT_MARGIN_AREA
;
2175 case ON_HEADER_LINE
:
2177 gr
= (part
== ON_HEADER_LINE
2178 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2179 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2182 goto text_glyph_row_found
;
2189 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2190 if (r
->y
+ r
->height
> y
)
2196 text_glyph_row_found
:
2199 struct glyph
*g
= gr
->glyphs
[area
];
2200 struct glyph
*end
= g
+ gr
->used
[area
];
2202 height
= gr
->height
;
2203 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2204 if (gx
+ g
->pixel_width
> x
)
2209 if (g
->type
== IMAGE_GLYPH
)
2211 /* Don't remember when mouse is over image, as
2212 image may have hot-spots. */
2213 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2216 width
= g
->pixel_width
;
2220 /* Use nominal char spacing at end of line. */
2222 gx
+= (x
/ width
) * width
;
2225 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2226 gx
+= window_box_left_offset (w
, area
);
2230 /* Use nominal line height at end of window. */
2231 gx
= (x
/ width
) * width
;
2233 gy
+= (y
/ height
) * height
;
2237 case ON_LEFT_FRINGE
:
2238 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2239 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2240 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2241 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2244 case ON_RIGHT_FRINGE
:
2245 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2246 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2247 : window_box_right_offset (w
, TEXT_AREA
));
2248 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2252 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2254 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2255 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2256 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2258 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2262 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2263 if (r
->y
+ r
->height
> y
)
2270 height
= gr
->height
;
2273 /* Use nominal line height at end of window. */
2275 gy
+= (y
/ height
) * height
;
2282 /* If there is no glyph under the mouse, then we divide the screen
2283 into a grid of the smallest glyph in the frame, and use that
2286 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2287 round down even for negative values. */
2293 gx
= (gx
/ width
) * width
;
2294 gy
= (gy
/ height
) * height
;
2299 gx
+= WINDOW_LEFT_EDGE_X (w
);
2300 gy
+= WINDOW_TOP_EDGE_Y (w
);
2303 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2305 /* Visible feedback for debugging. */
2308 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2309 f
->output_data
.x
->normal_gc
,
2310 gx
, gy
, width
, height
);
2316 #endif /* HAVE_WINDOW_SYSTEM */
2319 /***********************************************************************
2320 Lisp form evaluation
2321 ***********************************************************************/
2323 /* Error handler for safe_eval and safe_call. */
2326 safe_eval_handler (Lisp_Object arg
)
2328 add_to_log ("Error during redisplay: %S", arg
, Qnil
);
2333 /* Evaluate SEXPR and return the result, or nil if something went
2334 wrong. Prevent redisplay during the evaluation. */
2336 /* Call function ARGS[0] with arguments ARGS[1] to ARGS[NARGS - 1].
2337 Return the result, or nil if something went wrong. Prevent
2338 redisplay during the evaluation. */
2341 safe_call (ptrdiff_t nargs
, Lisp_Object
*args
)
2345 if (inhibit_eval_during_redisplay
)
2349 int count
= SPECPDL_INDEX ();
2350 struct gcpro gcpro1
;
2353 gcpro1
.nvars
= nargs
;
2354 specbind (Qinhibit_redisplay
, Qt
);
2355 /* Use Qt to ensure debugger does not run,
2356 so there is no possibility of wanting to redisplay. */
2357 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2360 val
= unbind_to (count
, val
);
2367 /* Call function FN with one argument ARG.
2368 Return the result, or nil if something went wrong. */
2371 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2373 Lisp_Object args
[2];
2376 return safe_call (2, args
);
2379 static Lisp_Object Qeval
;
2382 safe_eval (Lisp_Object sexpr
)
2384 return safe_call1 (Qeval
, sexpr
);
2387 /* Call function FN with one argument ARG.
2388 Return the result, or nil if something went wrong. */
2391 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2393 Lisp_Object args
[3];
2397 return safe_call (3, args
);
2402 /***********************************************************************
2404 ***********************************************************************/
2408 /* Define CHECK_IT to perform sanity checks on iterators.
2409 This is for debugging. It is too slow to do unconditionally. */
2412 check_it (struct it
*it
)
2414 if (it
->method
== GET_FROM_STRING
)
2416 xassert (STRINGP (it
->string
));
2417 xassert (IT_STRING_CHARPOS (*it
) >= 0);
2421 xassert (IT_STRING_CHARPOS (*it
) < 0);
2422 if (it
->method
== GET_FROM_BUFFER
)
2424 /* Check that character and byte positions agree. */
2425 xassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2430 xassert (it
->current
.dpvec_index
>= 0);
2432 xassert (it
->current
.dpvec_index
< 0);
2435 #define CHECK_IT(IT) check_it ((IT))
2439 #define CHECK_IT(IT) (void) 0
2444 #if GLYPH_DEBUG && XASSERTS
2446 /* Check that the window end of window W is what we expect it
2447 to be---the last row in the current matrix displaying text. */
2450 check_window_end (struct window
*w
)
2452 if (!MINI_WINDOW_P (w
)
2453 && !NILP (w
->window_end_valid
))
2455 struct glyph_row
*row
;
2456 xassert ((row
= MATRIX_ROW (w
->current_matrix
,
2457 XFASTINT (w
->window_end_vpos
)),
2459 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2460 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2464 #define CHECK_WINDOW_END(W) check_window_end ((W))
2468 #define CHECK_WINDOW_END(W) (void) 0
2474 /***********************************************************************
2475 Iterator initialization
2476 ***********************************************************************/
2478 /* Initialize IT for displaying current_buffer in window W, starting
2479 at character position CHARPOS. CHARPOS < 0 means that no buffer
2480 position is specified which is useful when the iterator is assigned
2481 a position later. BYTEPOS is the byte position corresponding to
2482 CHARPOS. BYTEPOS < 0 means compute it from CHARPOS.
2484 If ROW is not null, calls to produce_glyphs with IT as parameter
2485 will produce glyphs in that row.
2487 BASE_FACE_ID is the id of a base face to use. It must be one of
2488 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2489 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2490 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2492 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2493 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2494 will be initialized to use the corresponding mode line glyph row of
2495 the desired matrix of W. */
2498 init_iterator (struct it
*it
, struct window
*w
,
2499 EMACS_INT charpos
, EMACS_INT bytepos
,
2500 struct glyph_row
*row
, enum face_id base_face_id
)
2502 int highlight_region_p
;
2503 enum face_id remapped_base_face_id
= base_face_id
;
2505 /* Some precondition checks. */
2506 xassert (w
!= NULL
&& it
!= NULL
);
2507 xassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2510 /* If face attributes have been changed since the last redisplay,
2511 free realized faces now because they depend on face definitions
2512 that might have changed. Don't free faces while there might be
2513 desired matrices pending which reference these faces. */
2514 if (face_change_count
&& !inhibit_free_realized_faces
)
2516 face_change_count
= 0;
2517 free_all_realized_faces (Qnil
);
2520 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2521 if (! NILP (Vface_remapping_alist
))
2522 remapped_base_face_id
= lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2524 /* Use one of the mode line rows of W's desired matrix if
2528 if (base_face_id
== MODE_LINE_FACE_ID
2529 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2530 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2531 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2532 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2536 memset (it
, 0, sizeof *it
);
2537 it
->current
.overlay_string_index
= -1;
2538 it
->current
.dpvec_index
= -1;
2539 it
->base_face_id
= remapped_base_face_id
;
2541 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2542 it
->paragraph_embedding
= L2R
;
2543 it
->bidi_it
.string
.lstring
= Qnil
;
2544 it
->bidi_it
.string
.s
= NULL
;
2545 it
->bidi_it
.string
.bufpos
= 0;
2547 /* The window in which we iterate over current_buffer: */
2548 XSETWINDOW (it
->window
, w
);
2550 it
->f
= XFRAME (w
->frame
);
2554 /* Extra space between lines (on window systems only). */
2555 if (base_face_id
== DEFAULT_FACE_ID
2556 && FRAME_WINDOW_P (it
->f
))
2558 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2559 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2560 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2561 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2562 * FRAME_LINE_HEIGHT (it
->f
));
2563 else if (it
->f
->extra_line_spacing
> 0)
2564 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2565 it
->max_extra_line_spacing
= 0;
2568 /* If realized faces have been removed, e.g. because of face
2569 attribute changes of named faces, recompute them. When running
2570 in batch mode, the face cache of the initial frame is null. If
2571 we happen to get called, make a dummy face cache. */
2572 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2573 init_frame_faces (it
->f
);
2574 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2575 recompute_basic_faces (it
->f
);
2577 /* Current value of the `slice', `space-width', and 'height' properties. */
2578 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2579 it
->space_width
= Qnil
;
2580 it
->font_height
= Qnil
;
2581 it
->override_ascent
= -1;
2583 /* Are control characters displayed as `^C'? */
2584 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2586 /* -1 means everything between a CR and the following line end
2587 is invisible. >0 means lines indented more than this value are
2589 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2590 ? XINT (BVAR (current_buffer
, selective_display
))
2591 : (!NILP (BVAR (current_buffer
, selective_display
))
2593 it
->selective_display_ellipsis_p
2594 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2596 /* Display table to use. */
2597 it
->dp
= window_display_table (w
);
2599 /* Are multibyte characters enabled in current_buffer? */
2600 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2602 /* Non-zero if we should highlight the region. */
2604 = (!NILP (Vtransient_mark_mode
)
2605 && !NILP (BVAR (current_buffer
, mark_active
))
2606 && XMARKER (BVAR (current_buffer
, mark
))->buffer
!= 0);
2608 /* Set IT->region_beg_charpos and IT->region_end_charpos to the
2609 start and end of a visible region in window IT->w. Set both to
2610 -1 to indicate no region. */
2611 if (highlight_region_p
2612 /* Maybe highlight only in selected window. */
2613 && (/* Either show region everywhere. */
2614 highlight_nonselected_windows
2615 /* Or show region in the selected window. */
2616 || w
== XWINDOW (selected_window
)
2617 /* Or show the region if we are in the mini-buffer and W is
2618 the window the mini-buffer refers to. */
2619 || (MINI_WINDOW_P (XWINDOW (selected_window
))
2620 && WINDOWP (minibuf_selected_window
)
2621 && w
== XWINDOW (minibuf_selected_window
))))
2623 EMACS_INT markpos
= marker_position (BVAR (current_buffer
, mark
));
2624 it
->region_beg_charpos
= min (PT
, markpos
);
2625 it
->region_end_charpos
= max (PT
, markpos
);
2628 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
2630 /* Get the position at which the redisplay_end_trigger hook should
2631 be run, if it is to be run at all. */
2632 if (MARKERP (w
->redisplay_end_trigger
)
2633 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2634 it
->redisplay_end_trigger_charpos
2635 = marker_position (w
->redisplay_end_trigger
);
2636 else if (INTEGERP (w
->redisplay_end_trigger
))
2637 it
->redisplay_end_trigger_charpos
= XINT (w
->redisplay_end_trigger
);
2639 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2641 /* Are lines in the display truncated? */
2642 if (base_face_id
!= DEFAULT_FACE_ID
2643 || XINT (it
->w
->hscroll
)
2644 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2645 && ((!NILP (Vtruncate_partial_width_windows
)
2646 && !INTEGERP (Vtruncate_partial_width_windows
))
2647 || (INTEGERP (Vtruncate_partial_width_windows
)
2648 && (WINDOW_TOTAL_COLS (it
->w
)
2649 < XINT (Vtruncate_partial_width_windows
))))))
2650 it
->line_wrap
= TRUNCATE
;
2651 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2652 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2653 ? WINDOW_WRAP
: WORD_WRAP
;
2655 it
->line_wrap
= TRUNCATE
;
2657 /* Get dimensions of truncation and continuation glyphs. These are
2658 displayed as fringe bitmaps under X, so we don't need them for such
2660 if (!FRAME_WINDOW_P (it
->f
))
2662 if (it
->line_wrap
== TRUNCATE
)
2664 /* We will need the truncation glyph. */
2665 xassert (it
->glyph_row
== NULL
);
2666 produce_special_glyphs (it
, IT_TRUNCATION
);
2667 it
->truncation_pixel_width
= it
->pixel_width
;
2671 /* We will need the continuation glyph. */
2672 xassert (it
->glyph_row
== NULL
);
2673 produce_special_glyphs (it
, IT_CONTINUATION
);
2674 it
->continuation_pixel_width
= it
->pixel_width
;
2677 /* Reset these values to zero because the produce_special_glyphs
2678 above has changed them. */
2679 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2680 it
->phys_ascent
= it
->phys_descent
= 0;
2683 /* Set this after getting the dimensions of truncation and
2684 continuation glyphs, so that we don't produce glyphs when calling
2685 produce_special_glyphs, above. */
2686 it
->glyph_row
= row
;
2687 it
->area
= TEXT_AREA
;
2689 /* Forget any previous info about this row being reversed. */
2691 it
->glyph_row
->reversed_p
= 0;
2693 /* Get the dimensions of the display area. The display area
2694 consists of the visible window area plus a horizontally scrolled
2695 part to the left of the window. All x-values are relative to the
2696 start of this total display area. */
2697 if (base_face_id
!= DEFAULT_FACE_ID
)
2699 /* Mode lines, menu bar in terminal frames. */
2700 it
->first_visible_x
= 0;
2701 it
->last_visible_x
= WINDOW_TOTAL_WIDTH (w
);
2706 = XFASTINT (it
->w
->hscroll
) * FRAME_COLUMN_WIDTH (it
->f
);
2707 it
->last_visible_x
= (it
->first_visible_x
2708 + window_box_width (w
, TEXT_AREA
));
2710 /* If we truncate lines, leave room for the truncator glyph(s) at
2711 the right margin. Otherwise, leave room for the continuation
2712 glyph(s). Truncation and continuation glyphs are not inserted
2713 for window-based redisplay. */
2714 if (!FRAME_WINDOW_P (it
->f
))
2716 if (it
->line_wrap
== TRUNCATE
)
2717 it
->last_visible_x
-= it
->truncation_pixel_width
;
2719 it
->last_visible_x
-= it
->continuation_pixel_width
;
2722 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
2723 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
2726 /* Leave room for a border glyph. */
2727 if (!FRAME_WINDOW_P (it
->f
)
2728 && !WINDOW_RIGHTMOST_P (it
->w
))
2729 it
->last_visible_x
-= 1;
2731 it
->last_visible_y
= window_text_bottom_y (w
);
2733 /* For mode lines and alike, arrange for the first glyph having a
2734 left box line if the face specifies a box. */
2735 if (base_face_id
!= DEFAULT_FACE_ID
)
2739 it
->face_id
= remapped_base_face_id
;
2741 /* If we have a boxed mode line, make the first character appear
2742 with a left box line. */
2743 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
2744 if (face
->box
!= FACE_NO_BOX
)
2745 it
->start_of_box_run_p
= 1;
2748 /* If a buffer position was specified, set the iterator there,
2749 getting overlays and face properties from that position. */
2750 if (charpos
>= BUF_BEG (current_buffer
))
2752 it
->end_charpos
= ZV
;
2754 IT_CHARPOS (*it
) = charpos
;
2756 /* Compute byte position if not specified. */
2757 if (bytepos
< charpos
)
2758 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (charpos
);
2760 IT_BYTEPOS (*it
) = bytepos
;
2762 it
->start
= it
->current
;
2763 /* Do we need to reorder bidirectional text? Not if this is a
2764 unibyte buffer: by definition, none of the single-byte
2765 characters are strong R2L, so no reordering is needed. And
2766 bidi.c doesn't support unibyte buffers anyway. Also, don't
2767 reorder while we are loading loadup.el, since the tables of
2768 character properties needed for reordering are not yet
2772 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
2775 /* If we are to reorder bidirectional text, init the bidi
2779 /* Note the paragraph direction that this buffer wants to
2781 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2783 it
->paragraph_embedding
= L2R
;
2784 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
2786 it
->paragraph_embedding
= R2L
;
2788 it
->paragraph_embedding
= NEUTRAL_DIR
;
2789 bidi_unshelve_cache (NULL
, 0);
2790 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
2794 /* Compute faces etc. */
2795 reseat (it
, it
->current
.pos
, 1);
2802 /* Initialize IT for the display of window W with window start POS. */
2805 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
2807 struct glyph_row
*row
;
2808 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
2810 row
= w
->desired_matrix
->rows
+ first_vpos
;
2811 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
2812 it
->first_vpos
= first_vpos
;
2814 /* Don't reseat to previous visible line start if current start
2815 position is in a string or image. */
2816 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
2818 int start_at_line_beg_p
;
2819 int first_y
= it
->current_y
;
2821 /* If window start is not at a line start, skip forward to POS to
2822 get the correct continuation lines width. */
2823 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
2824 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
2825 if (!start_at_line_beg_p
)
2829 reseat_at_previous_visible_line_start (it
);
2830 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
2832 new_x
= it
->current_x
+ it
->pixel_width
;
2834 /* If lines are continued, this line may end in the middle
2835 of a multi-glyph character (e.g. a control character
2836 displayed as \003, or in the middle of an overlay
2837 string). In this case move_it_to above will not have
2838 taken us to the start of the continuation line but to the
2839 end of the continued line. */
2840 if (it
->current_x
> 0
2841 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
2842 && (/* And glyph doesn't fit on the line. */
2843 new_x
> it
->last_visible_x
2844 /* Or it fits exactly and we're on a window
2846 || (new_x
== it
->last_visible_x
2847 && FRAME_WINDOW_P (it
->f
))))
2849 if (it
->current
.dpvec_index
>= 0
2850 || it
->current
.overlay_string_index
>= 0)
2852 set_iterator_to_next (it
, 1);
2853 move_it_in_display_line_to (it
, -1, -1, 0);
2856 it
->continuation_lines_width
+= it
->current_x
;
2858 /* If the character at POS is displayed via a display
2859 vector, move_it_to above stops at the final glyph of
2860 IT->dpvec. To make the caller redisplay that character
2861 again (a.k.a. start at POS), we need to reset the
2862 dpvec_index to the beginning of IT->dpvec. */
2863 else if (it
->current
.dpvec_index
>= 0)
2864 it
->current
.dpvec_index
= 0;
2866 /* We're starting a new display line, not affected by the
2867 height of the continued line, so clear the appropriate
2868 fields in the iterator structure. */
2869 it
->max_ascent
= it
->max_descent
= 0;
2870 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
2872 it
->current_y
= first_y
;
2874 it
->current_x
= it
->hpos
= 0;
2880 /* Return 1 if POS is a position in ellipses displayed for invisible
2881 text. W is the window we display, for text property lookup. */
2884 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
2886 Lisp_Object prop
, window
;
2888 EMACS_INT charpos
= CHARPOS (pos
->pos
);
2890 /* If POS specifies a position in a display vector, this might
2891 be for an ellipsis displayed for invisible text. We won't
2892 get the iterator set up for delivering that ellipsis unless
2893 we make sure that it gets aware of the invisible text. */
2894 if (pos
->dpvec_index
>= 0
2895 && pos
->overlay_string_index
< 0
2896 && CHARPOS (pos
->string_pos
) < 0
2898 && (XSETWINDOW (window
, w
),
2899 prop
= Fget_char_property (make_number (charpos
),
2900 Qinvisible
, window
),
2901 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
2903 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
2905 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
2912 /* Initialize IT for stepping through current_buffer in window W,
2913 starting at position POS that includes overlay string and display
2914 vector/ control character translation position information. Value
2915 is zero if there are overlay strings with newlines at POS. */
2918 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
2920 EMACS_INT charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
2921 int i
, overlay_strings_with_newlines
= 0;
2923 /* If POS specifies a position in a display vector, this might
2924 be for an ellipsis displayed for invisible text. We won't
2925 get the iterator set up for delivering that ellipsis unless
2926 we make sure that it gets aware of the invisible text. */
2927 if (in_ellipses_for_invisible_text_p (pos
, w
))
2933 /* Keep in mind: the call to reseat in init_iterator skips invisible
2934 text, so we might end up at a position different from POS. This
2935 is only a problem when POS is a row start after a newline and an
2936 overlay starts there with an after-string, and the overlay has an
2937 invisible property. Since we don't skip invisible text in
2938 display_line and elsewhere immediately after consuming the
2939 newline before the row start, such a POS will not be in a string,
2940 but the call to init_iterator below will move us to the
2942 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
2944 /* This only scans the current chunk -- it should scan all chunks.
2945 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
2946 to 16 in 22.1 to make this a lesser problem. */
2947 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
2949 const char *s
= SSDATA (it
->overlay_strings
[i
]);
2950 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
2952 while (s
< e
&& *s
!= '\n')
2957 overlay_strings_with_newlines
= 1;
2962 /* If position is within an overlay string, set up IT to the right
2964 if (pos
->overlay_string_index
>= 0)
2968 /* If the first overlay string happens to have a `display'
2969 property for an image, the iterator will be set up for that
2970 image, and we have to undo that setup first before we can
2971 correct the overlay string index. */
2972 if (it
->method
== GET_FROM_IMAGE
)
2975 /* We already have the first chunk of overlay strings in
2976 IT->overlay_strings. Load more until the one for
2977 pos->overlay_string_index is in IT->overlay_strings. */
2978 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
2980 int n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
2981 it
->current
.overlay_string_index
= 0;
2984 load_overlay_strings (it
, 0);
2985 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
2989 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
2990 relative_index
= (it
->current
.overlay_string_index
2991 % OVERLAY_STRING_CHUNK_SIZE
);
2992 it
->string
= it
->overlay_strings
[relative_index
];
2993 xassert (STRINGP (it
->string
));
2994 it
->current
.string_pos
= pos
->string_pos
;
2995 it
->method
= GET_FROM_STRING
;
2998 if (CHARPOS (pos
->string_pos
) >= 0)
3000 /* Recorded position is not in an overlay string, but in another
3001 string. This can only be a string from a `display' property.
3002 IT should already be filled with that string. */
3003 it
->current
.string_pos
= pos
->string_pos
;
3004 xassert (STRINGP (it
->string
));
3007 /* Restore position in display vector translations, control
3008 character translations or ellipses. */
3009 if (pos
->dpvec_index
>= 0)
3011 if (it
->dpvec
== NULL
)
3012 get_next_display_element (it
);
3013 xassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3014 it
->current
.dpvec_index
= pos
->dpvec_index
;
3018 return !overlay_strings_with_newlines
;
3022 /* Initialize IT for stepping through current_buffer in window W
3023 starting at ROW->start. */
3026 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3028 init_from_display_pos (it
, w
, &row
->start
);
3029 it
->start
= row
->start
;
3030 it
->continuation_lines_width
= row
->continuation_lines_width
;
3035 /* Initialize IT for stepping through current_buffer in window W
3036 starting in the line following ROW, i.e. starting at ROW->end.
3037 Value is zero if there are overlay strings with newlines at ROW's
3041 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3045 if (init_from_display_pos (it
, w
, &row
->end
))
3047 if (row
->continued_p
)
3048 it
->continuation_lines_width
3049 = row
->continuation_lines_width
+ row
->pixel_width
;
3060 /***********************************************************************
3062 ***********************************************************************/
3064 /* Called when IT reaches IT->stop_charpos. Handle text property and
3065 overlay changes. Set IT->stop_charpos to the next position where
3069 handle_stop (struct it
*it
)
3071 enum prop_handled handled
;
3072 int handle_overlay_change_p
;
3076 it
->current
.dpvec_index
= -1;
3077 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3078 it
->ignore_overlay_strings_at_pos_p
= 0;
3081 /* Use face of preceding text for ellipsis (if invisible) */
3082 if (it
->selective_display_ellipsis_p
)
3083 it
->saved_face_id
= it
->face_id
;
3087 handled
= HANDLED_NORMALLY
;
3089 /* Call text property handlers. */
3090 for (p
= it_props
; p
->handler
; ++p
)
3092 handled
= p
->handler (it
);
3094 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3096 else if (handled
== HANDLED_RETURN
)
3098 /* We still want to show before and after strings from
3099 overlays even if the actual buffer text is replaced. */
3100 if (!handle_overlay_change_p
3102 || !get_overlay_strings_1 (it
, 0, 0))
3105 setup_for_ellipsis (it
, 0);
3106 /* When handling a display spec, we might load an
3107 empty string. In that case, discard it here. We
3108 used to discard it in handle_single_display_spec,
3109 but that causes get_overlay_strings_1, above, to
3110 ignore overlay strings that we must check. */
3111 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3115 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3119 it
->ignore_overlay_strings_at_pos_p
= 1;
3120 it
->string_from_display_prop_p
= 0;
3121 it
->from_disp_prop_p
= 0;
3122 handle_overlay_change_p
= 0;
3124 handled
= HANDLED_RECOMPUTE_PROPS
;
3127 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3128 handle_overlay_change_p
= 0;
3131 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3133 /* Don't check for overlay strings below when set to deliver
3134 characters from a display vector. */
3135 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3136 handle_overlay_change_p
= 0;
3138 /* Handle overlay changes.
3139 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3140 if it finds overlays. */
3141 if (handle_overlay_change_p
)
3142 handled
= handle_overlay_change (it
);
3147 setup_for_ellipsis (it
, 0);
3151 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3153 /* Determine where to stop next. */
3154 if (handled
== HANDLED_NORMALLY
)
3155 compute_stop_pos (it
);
3159 /* Compute IT->stop_charpos from text property and overlay change
3160 information for IT's current position. */
3163 compute_stop_pos (struct it
*it
)
3165 register INTERVAL iv
, next_iv
;
3166 Lisp_Object object
, limit
, position
;
3167 EMACS_INT charpos
, bytepos
;
3169 if (STRINGP (it
->string
))
3171 /* Strings are usually short, so don't limit the search for
3173 it
->stop_charpos
= it
->end_charpos
;
3174 object
= it
->string
;
3176 charpos
= IT_STRING_CHARPOS (*it
);
3177 bytepos
= IT_STRING_BYTEPOS (*it
);
3183 /* If end_charpos is out of range for some reason, such as a
3184 misbehaving display function, rationalize it (Bug#5984). */
3185 if (it
->end_charpos
> ZV
)
3186 it
->end_charpos
= ZV
;
3187 it
->stop_charpos
= it
->end_charpos
;
3189 /* If next overlay change is in front of the current stop pos
3190 (which is IT->end_charpos), stop there. Note: value of
3191 next_overlay_change is point-max if no overlay change
3193 charpos
= IT_CHARPOS (*it
);
3194 bytepos
= IT_BYTEPOS (*it
);
3195 pos
= next_overlay_change (charpos
);
3196 if (pos
< it
->stop_charpos
)
3197 it
->stop_charpos
= pos
;
3199 /* If showing the region, we have to stop at the region
3200 start or end because the face might change there. */
3201 if (it
->region_beg_charpos
> 0)
3203 if (IT_CHARPOS (*it
) < it
->region_beg_charpos
)
3204 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_beg_charpos
);
3205 else if (IT_CHARPOS (*it
) < it
->region_end_charpos
)
3206 it
->stop_charpos
= min (it
->stop_charpos
, it
->region_end_charpos
);
3209 /* Set up variables for computing the stop position from text
3210 property changes. */
3211 XSETBUFFER (object
, current_buffer
);
3212 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3215 /* Get the interval containing IT's position. Value is a null
3216 interval if there isn't such an interval. */
3217 position
= make_number (charpos
);
3218 iv
= validate_interval_range (object
, &position
, &position
, 0);
3219 if (!NULL_INTERVAL_P (iv
))
3221 Lisp_Object values_here
[LAST_PROP_IDX
];
3224 /* Get properties here. */
3225 for (p
= it_props
; p
->handler
; ++p
)
3226 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3228 /* Look for an interval following iv that has different
3230 for (next_iv
= next_interval (iv
);
3231 (!NULL_INTERVAL_P (next_iv
)
3233 || XFASTINT (limit
) > next_iv
->position
));
3234 next_iv
= next_interval (next_iv
))
3236 for (p
= it_props
; p
->handler
; ++p
)
3238 Lisp_Object new_value
;
3240 new_value
= textget (next_iv
->plist
, *p
->name
);
3241 if (!EQ (values_here
[p
->idx
], new_value
))
3249 if (!NULL_INTERVAL_P (next_iv
))
3251 if (INTEGERP (limit
)
3252 && next_iv
->position
>= XFASTINT (limit
))
3253 /* No text property change up to limit. */
3254 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3256 /* Text properties change in next_iv. */
3257 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3261 if (it
->cmp_it
.id
< 0)
3263 EMACS_INT stoppos
= it
->end_charpos
;
3265 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3267 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3268 stoppos
, it
->string
);
3271 xassert (STRINGP (it
->string
)
3272 || (it
->stop_charpos
>= BEGV
3273 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3277 /* Return the position of the next overlay change after POS in
3278 current_buffer. Value is point-max if no overlay change
3279 follows. This is like `next-overlay-change' but doesn't use
3283 next_overlay_change (EMACS_INT pos
)
3285 ptrdiff_t i
, noverlays
;
3287 Lisp_Object
*overlays
;
3289 /* Get all overlays at the given position. */
3290 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3292 /* If any of these overlays ends before endpos,
3293 use its ending point instead. */
3294 for (i
= 0; i
< noverlays
; ++i
)
3299 oend
= OVERLAY_END (overlays
[i
]);
3300 oendpos
= OVERLAY_POSITION (oend
);
3301 endpos
= min (endpos
, oendpos
);
3307 /* How many characters forward to search for a display property or
3308 display string. Searching too far forward makes the bidi display
3309 sluggish, especially in small windows. */
3310 #define MAX_DISP_SCAN 250
3312 /* Return the character position of a display string at or after
3313 position specified by POSITION. If no display string exists at or
3314 after POSITION, return ZV. A display string is either an overlay
3315 with `display' property whose value is a string, or a `display'
3316 text property whose value is a string. STRING is data about the
3317 string to iterate; if STRING->lstring is nil, we are iterating a
3318 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3319 on a GUI frame. DISP_PROP is set to zero if we searched
3320 MAX_DISP_SCAN characters forward without finding any display
3321 strings, non-zero otherwise. It is set to 2 if the display string
3322 uses any kind of `(space ...)' spec that will produce a stretch of
3323 white space in the text area. */
3325 compute_display_string_pos (struct text_pos
*position
,
3326 struct bidi_string_data
*string
,
3327 int frame_window_p
, int *disp_prop
)
3329 /* OBJECT = nil means current buffer. */
3330 Lisp_Object object
=
3331 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3332 Lisp_Object pos
, spec
, limpos
;
3333 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3334 EMACS_INT eob
= string_p
? string
->schars
: ZV
;
3335 EMACS_INT begb
= string_p
? 0 : BEGV
;
3336 EMACS_INT bufpos
, charpos
= CHARPOS (*position
);
3338 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3339 struct text_pos tpos
;
3345 /* We don't support display properties whose values are strings
3346 that have display string properties. */
3347 || string
->from_disp_str
3348 /* C strings cannot have display properties. */
3349 || (string
->s
&& !STRINGP (object
)))
3355 /* If the character at CHARPOS is where the display string begins,
3357 pos
= make_number (charpos
);
3358 if (STRINGP (object
))
3359 bufpos
= string
->bufpos
;
3363 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3365 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3368 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3376 /* Look forward for the first character with a `display' property
3377 that will replace the underlying text when displayed. */
3378 limpos
= make_number (lim
);
3380 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, limpos
);
3381 CHARPOS (tpos
) = XFASTINT (pos
);
3382 if (CHARPOS (tpos
) >= lim
)
3387 if (STRINGP (object
))
3388 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3390 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3391 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3392 if (!STRINGP (object
))
3393 bufpos
= CHARPOS (tpos
);
3394 } while (NILP (spec
)
3395 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3396 bufpos
, frame_window_p
)));
3400 return CHARPOS (tpos
);
3403 /* Return the character position of the end of the display string that
3404 started at CHARPOS. If there's no display string at CHARPOS,
3405 return -1. A display string is either an overlay with `display'
3406 property whose value is a string or a `display' text property whose
3407 value is a string. */
3409 compute_display_string_end (EMACS_INT charpos
, struct bidi_string_data
*string
)
3411 /* OBJECT = nil means current buffer. */
3412 Lisp_Object object
=
3413 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3414 Lisp_Object pos
= make_number (charpos
);
3416 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3418 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3421 /* It could happen that the display property or overlay was removed
3422 since we found it in compute_display_string_pos above. One way
3423 this can happen is if JIT font-lock was called (through
3424 handle_fontified_prop), and jit-lock-functions remove text
3425 properties or overlays from the portion of buffer that includes
3426 CHARPOS. Muse mode is known to do that, for example. In this
3427 case, we return -1 to the caller, to signal that no display
3428 string is actually present at CHARPOS. See bidi_fetch_char for
3429 how this is handled.
3431 An alternative would be to never look for display properties past
3432 it->stop_charpos. But neither compute_display_string_pos nor
3433 bidi_fetch_char that calls it know or care where the next
3435 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3438 /* Look forward for the first character where the `display' property
3440 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3442 return XFASTINT (pos
);
3447 /***********************************************************************
3449 ***********************************************************************/
3451 /* Handle changes in the `fontified' property of the current buffer by
3452 calling hook functions from Qfontification_functions to fontify
3455 static enum prop_handled
3456 handle_fontified_prop (struct it
*it
)
3458 Lisp_Object prop
, pos
;
3459 enum prop_handled handled
= HANDLED_NORMALLY
;
3461 if (!NILP (Vmemory_full
))
3464 /* Get the value of the `fontified' property at IT's current buffer
3465 position. (The `fontified' property doesn't have a special
3466 meaning in strings.) If the value is nil, call functions from
3467 Qfontification_functions. */
3468 if (!STRINGP (it
->string
)
3470 && !NILP (Vfontification_functions
)
3471 && !NILP (Vrun_hooks
)
3472 && (pos
= make_number (IT_CHARPOS (*it
)),
3473 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3474 /* Ignore the special cased nil value always present at EOB since
3475 no amount of fontifying will be able to change it. */
3476 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3478 int count
= SPECPDL_INDEX ();
3480 struct buffer
*obuf
= current_buffer
;
3481 int begv
= BEGV
, zv
= ZV
;
3482 int old_clip_changed
= current_buffer
->clip_changed
;
3484 val
= Vfontification_functions
;
3485 specbind (Qfontification_functions
, Qnil
);
3487 xassert (it
->end_charpos
== ZV
);
3489 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3490 safe_call1 (val
, pos
);
3493 Lisp_Object fns
, fn
;
3494 struct gcpro gcpro1
, gcpro2
;
3499 for (; CONSP (val
); val
= XCDR (val
))
3505 /* A value of t indicates this hook has a local
3506 binding; it means to run the global binding too.
3507 In a global value, t should not occur. If it
3508 does, we must ignore it to avoid an endless
3510 for (fns
= Fdefault_value (Qfontification_functions
);
3516 safe_call1 (fn
, pos
);
3520 safe_call1 (fn
, pos
);
3526 unbind_to (count
, Qnil
);
3528 /* Fontification functions routinely call `save-restriction'.
3529 Normally, this tags clip_changed, which can confuse redisplay
3530 (see discussion in Bug#6671). Since we don't perform any
3531 special handling of fontification changes in the case where
3532 `save-restriction' isn't called, there's no point doing so in
3533 this case either. So, if the buffer's restrictions are
3534 actually left unchanged, reset clip_changed. */
3535 if (obuf
== current_buffer
)
3537 if (begv
== BEGV
&& zv
== ZV
)
3538 current_buffer
->clip_changed
= old_clip_changed
;
3540 /* There isn't much we can reasonably do to protect against
3541 misbehaving fontification, but here's a fig leaf. */
3542 else if (!NILP (BVAR (obuf
, name
)))
3543 set_buffer_internal_1 (obuf
);
3545 /* The fontification code may have added/removed text.
3546 It could do even a lot worse, but let's at least protect against
3547 the most obvious case where only the text past `pos' gets changed',
3548 as is/was done in grep.el where some escapes sequences are turned
3549 into face properties (bug#7876). */
3550 it
->end_charpos
= ZV
;
3552 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3553 something. This avoids an endless loop if they failed to
3554 fontify the text for which reason ever. */
3555 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3556 handled
= HANDLED_RECOMPUTE_PROPS
;
3564 /***********************************************************************
3566 ***********************************************************************/
3568 /* Set up iterator IT from face properties at its current position.
3569 Called from handle_stop. */
3571 static enum prop_handled
3572 handle_face_prop (struct it
*it
)
3575 EMACS_INT next_stop
;
3577 if (!STRINGP (it
->string
))
3580 = face_at_buffer_position (it
->w
,
3582 it
->region_beg_charpos
,
3583 it
->region_end_charpos
,
3586 + TEXT_PROP_DISTANCE_LIMIT
),
3587 0, it
->base_face_id
);
3589 /* Is this a start of a run of characters with box face?
3590 Caveat: this can be called for a freshly initialized
3591 iterator; face_id is -1 in this case. We know that the new
3592 face will not change until limit, i.e. if the new face has a
3593 box, all characters up to limit will have one. But, as
3594 usual, we don't know whether limit is really the end. */
3595 if (new_face_id
!= it
->face_id
)
3597 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3599 /* If new face has a box but old face has not, this is
3600 the start of a run of characters with box, i.e. it has
3601 a shadow on the left side. The value of face_id of the
3602 iterator will be -1 if this is the initial call that gets
3603 the face. In this case, we have to look in front of IT's
3604 position and see whether there is a face != new_face_id. */
3605 it
->start_of_box_run_p
3606 = (new_face
->box
!= FACE_NO_BOX
3607 && (it
->face_id
>= 0
3608 || IT_CHARPOS (*it
) == BEG
3609 || new_face_id
!= face_before_it_pos (it
)));
3610 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3618 Lisp_Object from_overlay
3619 = (it
->current
.overlay_string_index
>= 0
3620 ? it
->string_overlays
[it
->current
.overlay_string_index
]
3623 /* See if we got to this string directly or indirectly from
3624 an overlay property. That includes the before-string or
3625 after-string of an overlay, strings in display properties
3626 provided by an overlay, their text properties, etc.
3628 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3629 if (! NILP (from_overlay
))
3630 for (i
= it
->sp
- 1; i
>= 0; i
--)
3632 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3634 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
];
3635 else if (! NILP (it
->stack
[i
].from_overlay
))
3636 from_overlay
= it
->stack
[i
].from_overlay
;
3638 if (!NILP (from_overlay
))
3642 if (! NILP (from_overlay
))
3644 bufpos
= IT_CHARPOS (*it
);
3645 /* For a string from an overlay, the base face depends
3646 only on text properties and ignores overlays. */
3648 = face_for_overlay_string (it
->w
,
3650 it
->region_beg_charpos
,
3651 it
->region_end_charpos
,
3654 + TEXT_PROP_DISTANCE_LIMIT
),
3662 /* For strings from a `display' property, use the face at
3663 IT's current buffer position as the base face to merge
3664 with, so that overlay strings appear in the same face as
3665 surrounding text, unless they specify their own
3667 base_face_id
= underlying_face_id (it
);
3670 new_face_id
= face_at_string_position (it
->w
,
3672 IT_STRING_CHARPOS (*it
),
3674 it
->region_beg_charpos
,
3675 it
->region_end_charpos
,
3679 /* Is this a start of a run of characters with box? Caveat:
3680 this can be called for a freshly allocated iterator; face_id
3681 is -1 is this case. We know that the new face will not
3682 change until the next check pos, i.e. if the new face has a
3683 box, all characters up to that position will have a
3684 box. But, as usual, we don't know whether that position
3685 is really the end. */
3686 if (new_face_id
!= it
->face_id
)
3688 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3689 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3691 /* If new face has a box but old face hasn't, this is the
3692 start of a run of characters with box, i.e. it has a
3693 shadow on the left side. */
3694 it
->start_of_box_run_p
3695 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
3696 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3700 it
->face_id
= new_face_id
;
3701 return HANDLED_NORMALLY
;
3705 /* Return the ID of the face ``underlying'' IT's current position,
3706 which is in a string. If the iterator is associated with a
3707 buffer, return the face at IT's current buffer position.
3708 Otherwise, use the iterator's base_face_id. */
3711 underlying_face_id (struct it
*it
)
3713 int face_id
= it
->base_face_id
, i
;
3715 xassert (STRINGP (it
->string
));
3717 for (i
= it
->sp
- 1; i
>= 0; --i
)
3718 if (NILP (it
->stack
[i
].string
))
3719 face_id
= it
->stack
[i
].face_id
;
3725 /* Compute the face one character before or after the current position
3726 of IT, in the visual order. BEFORE_P non-zero means get the face
3727 in front (to the left in L2R paragraphs, to the right in R2L
3728 paragraphs) of IT's screen position. Value is the ID of the face. */
3731 face_before_or_after_it_pos (struct it
*it
, int before_p
)
3734 EMACS_INT next_check_charpos
;
3736 void *it_copy_data
= NULL
;
3738 xassert (it
->s
== NULL
);
3740 if (STRINGP (it
->string
))
3742 EMACS_INT bufpos
, charpos
;
3745 /* No face change past the end of the string (for the case
3746 we are padding with spaces). No face change before the
3748 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
3749 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
3754 /* Set charpos to the position before or after IT's current
3755 position, in the logical order, which in the non-bidi
3756 case is the same as the visual order. */
3758 charpos
= IT_STRING_CHARPOS (*it
) - 1;
3759 else if (it
->what
== IT_COMPOSITION
)
3760 /* For composition, we must check the character after the
3762 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
3764 charpos
= IT_STRING_CHARPOS (*it
) + 1;
3770 /* With bidi iteration, the character before the current
3771 in the visual order cannot be found by simple
3772 iteration, because "reverse" reordering is not
3773 supported. Instead, we need to use the move_it_*
3774 family of functions. */
3775 /* Ignore face changes before the first visible
3776 character on this display line. */
3777 if (it
->current_x
<= it
->first_visible_x
)
3779 SAVE_IT (it_copy
, *it
, it_copy_data
);
3780 /* Implementation note: Since move_it_in_display_line
3781 works in the iterator geometry, and thinks the first
3782 character is always the leftmost, even in R2L lines,
3783 we don't need to distinguish between the R2L and L2R
3785 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
3786 it_copy
.current_x
- 1, MOVE_TO_X
);
3787 charpos
= IT_STRING_CHARPOS (it_copy
);
3788 RESTORE_IT (it
, it
, it_copy_data
);
3792 /* Set charpos to the string position of the character
3793 that comes after IT's current position in the visual
3795 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3799 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3801 charpos
= it_copy
.bidi_it
.charpos
;
3804 xassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
3806 if (it
->current
.overlay_string_index
>= 0)
3807 bufpos
= IT_CHARPOS (*it
);
3811 base_face_id
= underlying_face_id (it
);
3813 /* Get the face for ASCII, or unibyte. */
3814 face_id
= face_at_string_position (it
->w
,
3818 it
->region_beg_charpos
,
3819 it
->region_end_charpos
,
3820 &next_check_charpos
,
3823 /* Correct the face for charsets different from ASCII. Do it
3824 for the multibyte case only. The face returned above is
3825 suitable for unibyte text if IT->string is unibyte. */
3826 if (STRING_MULTIBYTE (it
->string
))
3828 struct text_pos pos1
= string_pos (charpos
, it
->string
);
3829 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
3831 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3833 c
= string_char_and_length (p
, &len
);
3834 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
3839 struct text_pos pos
;
3841 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
3842 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
3845 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
3846 pos
= it
->current
.pos
;
3851 DEC_TEXT_POS (pos
, it
->multibyte_p
);
3854 if (it
->what
== IT_COMPOSITION
)
3856 /* For composition, we must check the position after
3858 pos
.charpos
+= it
->cmp_it
.nchars
;
3859 pos
.bytepos
+= it
->len
;
3862 INC_TEXT_POS (pos
, it
->multibyte_p
);
3869 /* With bidi iteration, the character before the current
3870 in the visual order cannot be found by simple
3871 iteration, because "reverse" reordering is not
3872 supported. Instead, we need to use the move_it_*
3873 family of functions. */
3874 /* Ignore face changes before the first visible
3875 character on this display line. */
3876 if (it
->current_x
<= it
->first_visible_x
)
3878 SAVE_IT (it_copy
, *it
, it_copy_data
);
3879 /* Implementation note: Since move_it_in_display_line
3880 works in the iterator geometry, and thinks the first
3881 character is always the leftmost, even in R2L lines,
3882 we don't need to distinguish between the R2L and L2R
3884 move_it_in_display_line (&it_copy
, ZV
,
3885 it_copy
.current_x
- 1, MOVE_TO_X
);
3886 pos
= it_copy
.current
.pos
;
3887 RESTORE_IT (it
, it
, it_copy_data
);
3891 /* Set charpos to the buffer position of the character
3892 that comes after IT's current position in the visual
3894 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
3898 bidi_move_to_visually_next (&it_copy
.bidi_it
);
3901 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
3904 xassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
3906 /* Determine face for CHARSET_ASCII, or unibyte. */
3907 face_id
= face_at_buffer_position (it
->w
,
3909 it
->region_beg_charpos
,
3910 it
->region_end_charpos
,
3911 &next_check_charpos
,
3914 /* Correct the face for charsets different from ASCII. Do it
3915 for the multibyte case only. The face returned above is
3916 suitable for unibyte text if current_buffer is unibyte. */
3917 if (it
->multibyte_p
)
3919 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
3920 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
3921 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
3930 /***********************************************************************
3932 ***********************************************************************/
3934 /* Set up iterator IT from invisible properties at its current
3935 position. Called from handle_stop. */
3937 static enum prop_handled
3938 handle_invisible_prop (struct it
*it
)
3940 enum prop_handled handled
= HANDLED_NORMALLY
;
3942 if (STRINGP (it
->string
))
3944 Lisp_Object prop
, end_charpos
, limit
, charpos
;
3946 /* Get the value of the invisible text property at the
3947 current position. Value will be nil if there is no such
3949 charpos
= make_number (IT_STRING_CHARPOS (*it
));
3950 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
3953 && IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
3957 handled
= HANDLED_RECOMPUTE_PROPS
;
3959 /* Get the position at which the next change of the
3960 invisible text property can be found in IT->string.
3961 Value will be nil if the property value is the same for
3962 all the rest of IT->string. */
3963 XSETINT (limit
, SCHARS (it
->string
));
3964 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
3967 /* Text at current position is invisible. The next
3968 change in the property is at position end_charpos.
3969 Move IT's current position to that position. */
3970 if (INTEGERP (end_charpos
)
3971 && (endpos
= XFASTINT (end_charpos
)) < XFASTINT (limit
))
3973 struct text_pos old
;
3976 old
= it
->current
.string_pos
;
3977 oldpos
= CHARPOS (old
);
3980 if (it
->bidi_it
.first_elt
3981 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
3982 bidi_paragraph_init (it
->paragraph_embedding
,
3984 /* Bidi-iterate out of the invisible text. */
3987 bidi_move_to_visually_next (&it
->bidi_it
);
3989 while (oldpos
<= it
->bidi_it
.charpos
3990 && it
->bidi_it
.charpos
< endpos
);
3992 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
3993 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
3994 if (IT_CHARPOS (*it
) >= endpos
)
3995 it
->prev_stop
= endpos
;
3999 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4000 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4005 /* The rest of the string is invisible. If this is an
4006 overlay string, proceed with the next overlay string
4007 or whatever comes and return a character from there. */
4008 if (it
->current
.overlay_string_index
>= 0)
4010 next_overlay_string (it
);
4011 /* Don't check for overlay strings when we just
4012 finished processing them. */
4013 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4017 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4018 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4026 EMACS_INT newpos
, next_stop
, start_charpos
, tem
;
4027 Lisp_Object pos
, prop
, overlay
;
4029 /* First of all, is there invisible text at this position? */
4030 tem
= start_charpos
= IT_CHARPOS (*it
);
4031 pos
= make_number (tem
);
4032 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4034 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4036 /* If we are on invisible text, skip over it. */
4037 if (invis_p
&& start_charpos
< it
->end_charpos
)
4039 /* Record whether we have to display an ellipsis for the
4041 int display_ellipsis_p
= invis_p
== 2;
4043 handled
= HANDLED_RECOMPUTE_PROPS
;
4045 /* Loop skipping over invisible text. The loop is left at
4046 ZV or with IT on the first char being visible again. */
4049 /* Try to skip some invisible text. Return value is the
4050 position reached which can be equal to where we start
4051 if there is nothing invisible there. This skips both
4052 over invisible text properties and overlays with
4053 invisible property. */
4054 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4056 /* If we skipped nothing at all we weren't at invisible
4057 text in the first place. If everything to the end of
4058 the buffer was skipped, end the loop. */
4059 if (newpos
== tem
|| newpos
>= ZV
)
4063 /* We skipped some characters but not necessarily
4064 all there are. Check if we ended up on visible
4065 text. Fget_char_property returns the property of
4066 the char before the given position, i.e. if we
4067 get invis_p = 0, this means that the char at
4068 newpos is visible. */
4069 pos
= make_number (newpos
);
4070 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4071 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4074 /* If we ended up on invisible text, proceed to
4075 skip starting with next_stop. */
4079 /* If there are adjacent invisible texts, don't lose the
4080 second one's ellipsis. */
4082 display_ellipsis_p
= 1;
4086 /* The position newpos is now either ZV or on visible text. */
4087 if (it
->bidi_p
&& newpos
< ZV
)
4089 EMACS_INT bpos
= CHAR_TO_BYTE (newpos
);
4091 if (FETCH_BYTE (bpos
) == '\n'
4092 || (newpos
> BEGV
&& FETCH_BYTE (bpos
- 1) == '\n'))
4094 /* If the invisible text ends on a newline or the
4095 character after a newline, we can avoid the
4096 costly, character by character, bidi iteration to
4097 newpos, and instead simply reseat the iterator
4098 there. That's because all bidi reordering
4099 information is tossed at the newline. This is a
4100 big win for modes that hide complete lines, like
4101 Outline, Org, etc. (Implementation note: the
4102 call to reseat_1 is necessary, because it signals
4103 to the bidi iterator that it needs to reinit its
4104 internal information when the next element for
4105 display is requested. */
4106 struct text_pos tpos
;
4108 SET_TEXT_POS (tpos
, newpos
, bpos
);
4109 reseat_1 (it
, tpos
, 0);
4111 else /* Must use the slow method. */
4113 /* With bidi iteration, the region of invisible text
4114 could start and/or end in the middle of a
4115 non-base embedding level. Therefore, we need to
4116 skip invisible text using the bidi iterator,
4117 starting at IT's current position, until we find
4118 ourselves outside the invisible text. Skipping
4119 invisible text _after_ bidi iteration avoids
4120 affecting the visual order of the displayed text
4121 when invisible properties are added or
4123 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4125 /* If we were `reseat'ed to a new paragraph,
4126 determine the paragraph base direction. We
4127 need to do it now because
4128 next_element_from_buffer may not have a
4129 chance to do it, if we are going to skip any
4130 text at the beginning, which resets the
4132 bidi_paragraph_init (it
->paragraph_embedding
,
4137 bidi_move_to_visually_next (&it
->bidi_it
);
4139 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4140 && it
->bidi_it
.charpos
< newpos
);
4141 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4142 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4143 /* If we overstepped NEWPOS, record its position in
4144 the iterator, so that we skip invisible text if
4145 later the bidi iteration lands us in the
4146 invisible region again. */
4147 if (IT_CHARPOS (*it
) >= newpos
)
4148 it
->prev_stop
= newpos
;
4153 IT_CHARPOS (*it
) = newpos
;
4154 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4157 /* If there are before-strings at the start of invisible
4158 text, and the text is invisible because of a text
4159 property, arrange to show before-strings because 20.x did
4160 it that way. (If the text is invisible because of an
4161 overlay property instead of a text property, this is
4162 already handled in the overlay code.) */
4164 && get_overlay_strings (it
, it
->stop_charpos
))
4166 handled
= HANDLED_RECOMPUTE_PROPS
;
4167 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4169 else if (display_ellipsis_p
)
4171 /* Make sure that the glyphs of the ellipsis will get
4172 correct `charpos' values. If we would not update
4173 it->position here, the glyphs would belong to the
4174 last visible character _before_ the invisible
4175 text, which confuses `set_cursor_from_row'.
4177 We use the last invisible position instead of the
4178 first because this way the cursor is always drawn on
4179 the first "." of the ellipsis, whenever PT is inside
4180 the invisible text. Otherwise the cursor would be
4181 placed _after_ the ellipsis when the point is after the
4182 first invisible character. */
4183 if (!STRINGP (it
->object
))
4185 it
->position
.charpos
= newpos
- 1;
4186 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4189 /* Let the ellipsis display before
4190 considering any properties of the following char.
4191 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4192 handled
= HANDLED_RETURN
;
4201 /* Make iterator IT return `...' next.
4202 Replaces LEN characters from buffer. */
4205 setup_for_ellipsis (struct it
*it
, int len
)
4207 /* Use the display table definition for `...'. Invalid glyphs
4208 will be handled by the method returning elements from dpvec. */
4209 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4211 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4212 it
->dpvec
= v
->contents
;
4213 it
->dpend
= v
->contents
+ v
->header
.size
;
4217 /* Default `...'. */
4218 it
->dpvec
= default_invis_vector
;
4219 it
->dpend
= default_invis_vector
+ 3;
4222 it
->dpvec_char_len
= len
;
4223 it
->current
.dpvec_index
= 0;
4224 it
->dpvec_face_id
= -1;
4226 /* Remember the current face id in case glyphs specify faces.
4227 IT's face is restored in set_iterator_to_next.
4228 saved_face_id was set to preceding char's face in handle_stop. */
4229 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4230 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4232 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4238 /***********************************************************************
4240 ***********************************************************************/
4242 /* Set up iterator IT from `display' property at its current position.
4243 Called from handle_stop.
4244 We return HANDLED_RETURN if some part of the display property
4245 overrides the display of the buffer text itself.
4246 Otherwise we return HANDLED_NORMALLY. */
4248 static enum prop_handled
4249 handle_display_prop (struct it
*it
)
4251 Lisp_Object propval
, object
, overlay
;
4252 struct text_pos
*position
;
4254 /* Nonzero if some property replaces the display of the text itself. */
4255 int display_replaced_p
= 0;
4257 if (STRINGP (it
->string
))
4259 object
= it
->string
;
4260 position
= &it
->current
.string_pos
;
4261 bufpos
= CHARPOS (it
->current
.pos
);
4265 XSETWINDOW (object
, it
->w
);
4266 position
= &it
->current
.pos
;
4267 bufpos
= CHARPOS (*position
);
4270 /* Reset those iterator values set from display property values. */
4271 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4272 it
->space_width
= Qnil
;
4273 it
->font_height
= Qnil
;
4276 /* We don't support recursive `display' properties, i.e. string
4277 values that have a string `display' property, that have a string
4278 `display' property etc. */
4279 if (!it
->string_from_display_prop_p
)
4280 it
->area
= TEXT_AREA
;
4282 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4283 Qdisplay
, object
, &overlay
);
4285 return HANDLED_NORMALLY
;
4286 /* Now OVERLAY is the overlay that gave us this property, or nil
4287 if it was a text property. */
4289 if (!STRINGP (it
->string
))
4290 object
= it
->w
->buffer
;
4292 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4294 FRAME_WINDOW_P (it
->f
));
4296 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4299 /* Subroutine of handle_display_prop. Returns non-zero if the display
4300 specification in SPEC is a replacing specification, i.e. it would
4301 replace the text covered by `display' property with something else,
4302 such as an image or a display string. If SPEC includes any kind or
4303 `(space ...) specification, the value is 2; this is used by
4304 compute_display_string_pos, which see.
4306 See handle_single_display_spec for documentation of arguments.
4307 frame_window_p is non-zero if the window being redisplayed is on a
4308 GUI frame; this argument is used only if IT is NULL, see below.
4310 IT can be NULL, if this is called by the bidi reordering code
4311 through compute_display_string_pos, which see. In that case, this
4312 function only examines SPEC, but does not otherwise "handle" it, in
4313 the sense that it doesn't set up members of IT from the display
4316 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4317 Lisp_Object overlay
, struct text_pos
*position
,
4318 EMACS_INT bufpos
, int frame_window_p
)
4320 int replacing_p
= 0;
4324 /* Simple specerties. */
4325 && !EQ (XCAR (spec
), Qimage
)
4326 && !EQ (XCAR (spec
), Qspace
)
4327 && !EQ (XCAR (spec
), Qwhen
)
4328 && !EQ (XCAR (spec
), Qslice
)
4329 && !EQ (XCAR (spec
), Qspace_width
)
4330 && !EQ (XCAR (spec
), Qheight
)
4331 && !EQ (XCAR (spec
), Qraise
)
4332 /* Marginal area specifications. */
4333 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4334 && !EQ (XCAR (spec
), Qleft_fringe
)
4335 && !EQ (XCAR (spec
), Qright_fringe
)
4336 && !NILP (XCAR (spec
)))
4338 for (; CONSP (spec
); spec
= XCDR (spec
))
4340 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4341 overlay
, position
, bufpos
,
4342 replacing_p
, frame_window_p
)))
4345 /* If some text in a string is replaced, `position' no
4346 longer points to the position of `object'. */
4347 if (!it
|| STRINGP (object
))
4352 else if (VECTORP (spec
))
4355 for (i
= 0; i
< ASIZE (spec
); ++i
)
4356 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4357 overlay
, position
, bufpos
,
4358 replacing_p
, frame_window_p
)))
4361 /* If some text in a string is replaced, `position' no
4362 longer points to the position of `object'. */
4363 if (!it
|| STRINGP (object
))
4369 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4370 position
, bufpos
, 0,
4378 /* Value is the position of the end of the `display' property starting
4379 at START_POS in OBJECT. */
4381 static struct text_pos
4382 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4385 struct text_pos end_pos
;
4387 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4388 Qdisplay
, object
, Qnil
);
4389 CHARPOS (end_pos
) = XFASTINT (end
);
4390 if (STRINGP (object
))
4391 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4393 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4399 /* Set up IT from a single `display' property specification SPEC. OBJECT
4400 is the object in which the `display' property was found. *POSITION
4401 is the position in OBJECT at which the `display' property was found.
4402 BUFPOS is the buffer position of OBJECT (different from POSITION if
4403 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4404 previously saw a display specification which already replaced text
4405 display with something else, for example an image; we ignore such
4406 properties after the first one has been processed.
4408 OVERLAY is the overlay this `display' property came from,
4409 or nil if it was a text property.
4411 If SPEC is a `space' or `image' specification, and in some other
4412 cases too, set *POSITION to the position where the `display'
4415 If IT is NULL, only examine the property specification in SPEC, but
4416 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4417 is intended to be displayed in a window on a GUI frame.
4419 Value is non-zero if something was found which replaces the display
4420 of buffer or string text. */
4423 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4424 Lisp_Object overlay
, struct text_pos
*position
,
4425 EMACS_INT bufpos
, int display_replaced_p
,
4429 Lisp_Object location
, value
;
4430 struct text_pos start_pos
= *position
;
4433 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4434 If the result is non-nil, use VALUE instead of SPEC. */
4436 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4445 if (!NILP (form
) && !EQ (form
, Qt
))
4447 int count
= SPECPDL_INDEX ();
4448 struct gcpro gcpro1
;
4450 /* Bind `object' to the object having the `display' property, a
4451 buffer or string. Bind `position' to the position in the
4452 object where the property was found, and `buffer-position'
4453 to the current position in the buffer. */
4456 XSETBUFFER (object
, current_buffer
);
4457 specbind (Qobject
, object
);
4458 specbind (Qposition
, make_number (CHARPOS (*position
)));
4459 specbind (Qbuffer_position
, make_number (bufpos
));
4461 form
= safe_eval (form
);
4463 unbind_to (count
, Qnil
);
4469 /* Handle `(height HEIGHT)' specifications. */
4471 && EQ (XCAR (spec
), Qheight
)
4472 && CONSP (XCDR (spec
)))
4476 if (!FRAME_WINDOW_P (it
->f
))
4479 it
->font_height
= XCAR (XCDR (spec
));
4480 if (!NILP (it
->font_height
))
4482 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4483 int new_height
= -1;
4485 if (CONSP (it
->font_height
)
4486 && (EQ (XCAR (it
->font_height
), Qplus
)
4487 || EQ (XCAR (it
->font_height
), Qminus
))
4488 && CONSP (XCDR (it
->font_height
))
4489 && INTEGERP (XCAR (XCDR (it
->font_height
))))
4491 /* `(+ N)' or `(- N)' where N is an integer. */
4492 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4493 if (EQ (XCAR (it
->font_height
), Qplus
))
4495 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4497 else if (FUNCTIONP (it
->font_height
))
4499 /* Call function with current height as argument.
4500 Value is the new height. */
4502 height
= safe_call1 (it
->font_height
,
4503 face
->lface
[LFACE_HEIGHT_INDEX
]);
4504 if (NUMBERP (height
))
4505 new_height
= XFLOATINT (height
);
4507 else if (NUMBERP (it
->font_height
))
4509 /* Value is a multiple of the canonical char height. */
4512 f
= FACE_FROM_ID (it
->f
,
4513 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4514 new_height
= (XFLOATINT (it
->font_height
)
4515 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4519 /* Evaluate IT->font_height with `height' bound to the
4520 current specified height to get the new height. */
4521 int count
= SPECPDL_INDEX ();
4523 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4524 value
= safe_eval (it
->font_height
);
4525 unbind_to (count
, Qnil
);
4527 if (NUMBERP (value
))
4528 new_height
= XFLOATINT (value
);
4532 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4539 /* Handle `(space-width WIDTH)'. */
4541 && EQ (XCAR (spec
), Qspace_width
)
4542 && CONSP (XCDR (spec
)))
4546 if (!FRAME_WINDOW_P (it
->f
))
4549 value
= XCAR (XCDR (spec
));
4550 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4551 it
->space_width
= value
;
4557 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4559 && EQ (XCAR (spec
), Qslice
))
4565 if (!FRAME_WINDOW_P (it
->f
))
4568 if (tem
= XCDR (spec
), CONSP (tem
))
4570 it
->slice
.x
= XCAR (tem
);
4571 if (tem
= XCDR (tem
), CONSP (tem
))
4573 it
->slice
.y
= XCAR (tem
);
4574 if (tem
= XCDR (tem
), CONSP (tem
))
4576 it
->slice
.width
= XCAR (tem
);
4577 if (tem
= XCDR (tem
), CONSP (tem
))
4578 it
->slice
.height
= XCAR (tem
);
4587 /* Handle `(raise FACTOR)'. */
4589 && EQ (XCAR (spec
), Qraise
)
4590 && CONSP (XCDR (spec
)))
4594 if (!FRAME_WINDOW_P (it
->f
))
4597 #ifdef HAVE_WINDOW_SYSTEM
4598 value
= XCAR (XCDR (spec
));
4599 if (NUMBERP (value
))
4601 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4602 it
->voffset
= - (XFLOATINT (value
)
4603 * (FONT_HEIGHT (face
->font
)));
4605 #endif /* HAVE_WINDOW_SYSTEM */
4611 /* Don't handle the other kinds of display specifications
4612 inside a string that we got from a `display' property. */
4613 if (it
&& it
->string_from_display_prop_p
)
4616 /* Characters having this form of property are not displayed, so
4617 we have to find the end of the property. */
4620 start_pos
= *position
;
4621 *position
= display_prop_end (it
, object
, start_pos
);
4625 /* Stop the scan at that end position--we assume that all
4626 text properties change there. */
4628 it
->stop_charpos
= position
->charpos
;
4630 /* Handle `(left-fringe BITMAP [FACE])'
4631 and `(right-fringe BITMAP [FACE])'. */
4633 && (EQ (XCAR (spec
), Qleft_fringe
)
4634 || EQ (XCAR (spec
), Qright_fringe
))
4635 && CONSP (XCDR (spec
)))
4641 if (!FRAME_WINDOW_P (it
->f
))
4642 /* If we return here, POSITION has been advanced
4643 across the text with this property. */
4646 else if (!frame_window_p
)
4649 #ifdef HAVE_WINDOW_SYSTEM
4650 value
= XCAR (XCDR (spec
));
4651 if (!SYMBOLP (value
)
4652 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
4653 /* If we return here, POSITION has been advanced
4654 across the text with this property. */
4659 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
4661 if (CONSP (XCDR (XCDR (spec
))))
4663 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
4664 int face_id2
= lookup_derived_face (it
->f
, face_name
,
4670 /* Save current settings of IT so that we can restore them
4671 when we are finished with the glyph property value. */
4672 push_it (it
, position
);
4674 it
->area
= TEXT_AREA
;
4675 it
->what
= IT_IMAGE
;
4676 it
->image_id
= -1; /* no image */
4677 it
->position
= start_pos
;
4678 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4679 it
->method
= GET_FROM_IMAGE
;
4680 it
->from_overlay
= Qnil
;
4681 it
->face_id
= face_id
;
4682 it
->from_disp_prop_p
= 1;
4684 /* Say that we haven't consumed the characters with
4685 `display' property yet. The call to pop_it in
4686 set_iterator_to_next will clean this up. */
4687 *position
= start_pos
;
4689 if (EQ (XCAR (spec
), Qleft_fringe
))
4691 it
->left_user_fringe_bitmap
= fringe_bitmap
;
4692 it
->left_user_fringe_face_id
= face_id
;
4696 it
->right_user_fringe_bitmap
= fringe_bitmap
;
4697 it
->right_user_fringe_face_id
= face_id
;
4700 #endif /* HAVE_WINDOW_SYSTEM */
4704 /* Prepare to handle `((margin left-margin) ...)',
4705 `((margin right-margin) ...)' and `((margin nil) ...)'
4706 prefixes for display specifications. */
4707 location
= Qunbound
;
4708 if (CONSP (spec
) && CONSP (XCAR (spec
)))
4712 value
= XCDR (spec
);
4714 value
= XCAR (value
);
4717 if (EQ (XCAR (tem
), Qmargin
)
4718 && (tem
= XCDR (tem
),
4719 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
4721 || EQ (tem
, Qleft_margin
)
4722 || EQ (tem
, Qright_margin
))))
4726 if (EQ (location
, Qunbound
))
4732 /* After this point, VALUE is the property after any
4733 margin prefix has been stripped. It must be a string,
4734 an image specification, or `(space ...)'.
4736 LOCATION specifies where to display: `left-margin',
4737 `right-margin' or nil. */
4739 valid_p
= (STRINGP (value
)
4740 #ifdef HAVE_WINDOW_SYSTEM
4741 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
4742 && valid_image_p (value
))
4743 #endif /* not HAVE_WINDOW_SYSTEM */
4744 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
4746 if (valid_p
&& !display_replaced_p
)
4752 /* Callers need to know whether the display spec is any kind
4753 of `(space ...)' spec that is about to affect text-area
4755 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
4760 /* Save current settings of IT so that we can restore them
4761 when we are finished with the glyph property value. */
4762 push_it (it
, position
);
4763 it
->from_overlay
= overlay
;
4764 it
->from_disp_prop_p
= 1;
4766 if (NILP (location
))
4767 it
->area
= TEXT_AREA
;
4768 else if (EQ (location
, Qleft_margin
))
4769 it
->area
= LEFT_MARGIN_AREA
;
4771 it
->area
= RIGHT_MARGIN_AREA
;
4773 if (STRINGP (value
))
4776 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
4777 it
->current
.overlay_string_index
= -1;
4778 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
4779 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
4780 it
->method
= GET_FROM_STRING
;
4781 it
->stop_charpos
= 0;
4783 it
->base_level_stop
= 0;
4784 it
->string_from_display_prop_p
= 1;
4785 /* Say that we haven't consumed the characters with
4786 `display' property yet. The call to pop_it in
4787 set_iterator_to_next will clean this up. */
4788 if (BUFFERP (object
))
4789 *position
= start_pos
;
4791 /* Force paragraph direction to be that of the parent
4792 object. If the parent object's paragraph direction is
4793 not yet determined, default to L2R. */
4794 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
4795 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
4797 it
->paragraph_embedding
= L2R
;
4799 /* Set up the bidi iterator for this display string. */
4802 it
->bidi_it
.string
.lstring
= it
->string
;
4803 it
->bidi_it
.string
.s
= NULL
;
4804 it
->bidi_it
.string
.schars
= it
->end_charpos
;
4805 it
->bidi_it
.string
.bufpos
= bufpos
;
4806 it
->bidi_it
.string
.from_disp_str
= 1;
4807 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
4808 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
4811 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
4813 it
->method
= GET_FROM_STRETCH
;
4815 *position
= it
->position
= start_pos
;
4816 retval
= 1 + (it
->area
== TEXT_AREA
);
4818 #ifdef HAVE_WINDOW_SYSTEM
4821 it
->what
= IT_IMAGE
;
4822 it
->image_id
= lookup_image (it
->f
, value
);
4823 it
->position
= start_pos
;
4824 it
->object
= NILP (object
) ? it
->w
->buffer
: object
;
4825 it
->method
= GET_FROM_IMAGE
;
4827 /* Say that we haven't consumed the characters with
4828 `display' property yet. The call to pop_it in
4829 set_iterator_to_next will clean this up. */
4830 *position
= start_pos
;
4832 #endif /* HAVE_WINDOW_SYSTEM */
4837 /* Invalid property or property not supported. Restore
4838 POSITION to what it was before. */
4839 *position
= start_pos
;
4843 /* Check if PROP is a display property value whose text should be
4844 treated as intangible. OVERLAY is the overlay from which PROP
4845 came, or nil if it came from a text property. CHARPOS and BYTEPOS
4846 specify the buffer position covered by PROP. */
4849 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
4850 EMACS_INT charpos
, EMACS_INT bytepos
)
4852 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
4853 struct text_pos position
;
4855 SET_TEXT_POS (position
, charpos
, bytepos
);
4856 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
4857 &position
, charpos
, frame_window_p
);
4861 /* Return 1 if PROP is a display sub-property value containing STRING.
4863 Implementation note: this and the following function are really
4864 special cases of handle_display_spec and
4865 handle_single_display_spec, and should ideally use the same code.
4866 Until they do, these two pairs must be consistent and must be
4867 modified in sync. */
4870 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
4872 if (EQ (string
, prop
))
4875 /* Skip over `when FORM'. */
4876 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
4881 /* Actually, the condition following `when' should be eval'ed,
4882 like handle_single_display_spec does, and we should return
4883 zero if it evaluates to nil. However, this function is
4884 called only when the buffer was already displayed and some
4885 glyph in the glyph matrix was found to come from a display
4886 string. Therefore, the condition was already evaluated, and
4887 the result was non-nil, otherwise the display string wouldn't
4888 have been displayed and we would have never been called for
4889 this property. Thus, we can skip the evaluation and assume
4890 its result is non-nil. */
4895 /* Skip over `margin LOCATION'. */
4896 if (EQ (XCAR (prop
), Qmargin
))
4907 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
4911 /* Return 1 if STRING appears in the `display' property PROP. */
4914 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
4917 && !EQ (XCAR (prop
), Qwhen
)
4918 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
4920 /* A list of sub-properties. */
4921 while (CONSP (prop
))
4923 if (single_display_spec_string_p (XCAR (prop
), string
))
4928 else if (VECTORP (prop
))
4930 /* A vector of sub-properties. */
4932 for (i
= 0; i
< ASIZE (prop
); ++i
)
4933 if (single_display_spec_string_p (AREF (prop
, i
), string
))
4937 return single_display_spec_string_p (prop
, string
);
4942 /* Look for STRING in overlays and text properties in the current
4943 buffer, between character positions FROM and TO (excluding TO).
4944 BACK_P non-zero means look back (in this case, TO is supposed to be
4946 Value is the first character position where STRING was found, or
4947 zero if it wasn't found before hitting TO.
4949 This function may only use code that doesn't eval because it is
4950 called asynchronously from note_mouse_highlight. */
4953 string_buffer_position_lim (Lisp_Object string
,
4954 EMACS_INT from
, EMACS_INT to
, int back_p
)
4956 Lisp_Object limit
, prop
, pos
;
4959 pos
= make_number (from
);
4961 if (!back_p
) /* looking forward */
4963 limit
= make_number (min (to
, ZV
));
4964 while (!found
&& !EQ (pos
, limit
))
4966 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4967 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4970 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
4974 else /* looking back */
4976 limit
= make_number (max (to
, BEGV
));
4977 while (!found
&& !EQ (pos
, limit
))
4979 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
4980 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
4983 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
4988 return found
? XINT (pos
) : 0;
4991 /* Determine which buffer position in current buffer STRING comes from.
4992 AROUND_CHARPOS is an approximate position where it could come from.
4993 Value is the buffer position or 0 if it couldn't be determined.
4995 This function is necessary because we don't record buffer positions
4996 in glyphs generated from strings (to keep struct glyph small).
4997 This function may only use code that doesn't eval because it is
4998 called asynchronously from note_mouse_highlight. */
5001 string_buffer_position (Lisp_Object string
, EMACS_INT around_charpos
)
5003 const int MAX_DISTANCE
= 1000;
5004 EMACS_INT found
= string_buffer_position_lim (string
, around_charpos
,
5005 around_charpos
+ MAX_DISTANCE
,
5009 found
= string_buffer_position_lim (string
, around_charpos
,
5010 around_charpos
- MAX_DISTANCE
, 1);
5016 /***********************************************************************
5017 `composition' property
5018 ***********************************************************************/
5020 /* Set up iterator IT from `composition' property at its current
5021 position. Called from handle_stop. */
5023 static enum prop_handled
5024 handle_composition_prop (struct it
*it
)
5026 Lisp_Object prop
, string
;
5027 EMACS_INT pos
, pos_byte
, start
, end
;
5029 if (STRINGP (it
->string
))
5033 pos
= IT_STRING_CHARPOS (*it
);
5034 pos_byte
= IT_STRING_BYTEPOS (*it
);
5035 string
= it
->string
;
5036 s
= SDATA (string
) + pos_byte
;
5037 it
->c
= STRING_CHAR (s
);
5041 pos
= IT_CHARPOS (*it
);
5042 pos_byte
= IT_BYTEPOS (*it
);
5044 it
->c
= FETCH_CHAR (pos_byte
);
5047 /* If there's a valid composition and point is not inside of the
5048 composition (in the case that the composition is from the current
5049 buffer), draw a glyph composed from the composition components. */
5050 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5051 && COMPOSITION_VALID_P (start
, end
, prop
)
5052 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5055 /* As we can't handle this situation (perhaps font-lock added
5056 a new composition), we just return here hoping that next
5057 redisplay will detect this composition much earlier. */
5058 return HANDLED_NORMALLY
;
5061 if (STRINGP (it
->string
))
5062 pos_byte
= string_char_to_byte (it
->string
, start
);
5064 pos_byte
= CHAR_TO_BYTE (start
);
5066 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5069 if (it
->cmp_it
.id
>= 0)
5072 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5073 it
->cmp_it
.nglyphs
= -1;
5077 return HANDLED_NORMALLY
;
5082 /***********************************************************************
5084 ***********************************************************************/
5086 /* The following structure is used to record overlay strings for
5087 later sorting in load_overlay_strings. */
5089 struct overlay_entry
5091 Lisp_Object overlay
;
5098 /* Set up iterator IT from overlay strings at its current position.
5099 Called from handle_stop. */
5101 static enum prop_handled
5102 handle_overlay_change (struct it
*it
)
5104 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5105 return HANDLED_RECOMPUTE_PROPS
;
5107 return HANDLED_NORMALLY
;
5111 /* Set up the next overlay string for delivery by IT, if there is an
5112 overlay string to deliver. Called by set_iterator_to_next when the
5113 end of the current overlay string is reached. If there are more
5114 overlay strings to display, IT->string and
5115 IT->current.overlay_string_index are set appropriately here.
5116 Otherwise IT->string is set to nil. */
5119 next_overlay_string (struct it
*it
)
5121 ++it
->current
.overlay_string_index
;
5122 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5124 /* No more overlay strings. Restore IT's settings to what
5125 they were before overlay strings were processed, and
5126 continue to deliver from current_buffer. */
5128 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5131 || (NILP (it
->string
)
5132 && it
->method
== GET_FROM_BUFFER
5133 && it
->stop_charpos
>= BEGV
5134 && it
->stop_charpos
<= it
->end_charpos
));
5135 it
->current
.overlay_string_index
= -1;
5136 it
->n_overlay_strings
= 0;
5137 it
->overlay_strings_charpos
= -1;
5139 /* If we're at the end of the buffer, record that we have
5140 processed the overlay strings there already, so that
5141 next_element_from_buffer doesn't try it again. */
5142 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5143 it
->overlay_strings_at_end_processed_p
= 1;
5147 /* There are more overlay strings to process. If
5148 IT->current.overlay_string_index has advanced to a position
5149 where we must load IT->overlay_strings with more strings, do
5150 it. We must load at the IT->overlay_strings_charpos where
5151 IT->n_overlay_strings was originally computed; when invisible
5152 text is present, this might not be IT_CHARPOS (Bug#7016). */
5153 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5155 if (it
->current
.overlay_string_index
&& i
== 0)
5156 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5158 /* Initialize IT to deliver display elements from the overlay
5160 it
->string
= it
->overlay_strings
[i
];
5161 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5162 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5163 it
->method
= GET_FROM_STRING
;
5164 it
->stop_charpos
= 0;
5165 if (it
->cmp_it
.stop_pos
>= 0)
5166 it
->cmp_it
.stop_pos
= 0;
5168 it
->base_level_stop
= 0;
5170 /* Set up the bidi iterator for this overlay string. */
5173 it
->bidi_it
.string
.lstring
= it
->string
;
5174 it
->bidi_it
.string
.s
= NULL
;
5175 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5176 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5177 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5178 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5179 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5187 /* Compare two overlay_entry structures E1 and E2. Used as a
5188 comparison function for qsort in load_overlay_strings. Overlay
5189 strings for the same position are sorted so that
5191 1. All after-strings come in front of before-strings, except
5192 when they come from the same overlay.
5194 2. Within after-strings, strings are sorted so that overlay strings
5195 from overlays with higher priorities come first.
5197 2. Within before-strings, strings are sorted so that overlay
5198 strings from overlays with higher priorities come last.
5200 Value is analogous to strcmp. */
5204 compare_overlay_entries (const void *e1
, const void *e2
)
5206 struct overlay_entry
*entry1
= (struct overlay_entry
*) e1
;
5207 struct overlay_entry
*entry2
= (struct overlay_entry
*) e2
;
5210 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5212 /* Let after-strings appear in front of before-strings if
5213 they come from different overlays. */
5214 if (EQ (entry1
->overlay
, entry2
->overlay
))
5215 result
= entry1
->after_string_p
? 1 : -1;
5217 result
= entry1
->after_string_p
? -1 : 1;
5219 else if (entry1
->after_string_p
)
5220 /* After-strings sorted in order of decreasing priority. */
5221 result
= entry2
->priority
- entry1
->priority
;
5223 /* Before-strings sorted in order of increasing priority. */
5224 result
= entry1
->priority
- entry2
->priority
;
5230 /* Load the vector IT->overlay_strings with overlay strings from IT's
5231 current buffer position, or from CHARPOS if that is > 0. Set
5232 IT->n_overlays to the total number of overlay strings found.
5234 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5235 a time. On entry into load_overlay_strings,
5236 IT->current.overlay_string_index gives the number of overlay
5237 strings that have already been loaded by previous calls to this
5240 IT->add_overlay_start contains an additional overlay start
5241 position to consider for taking overlay strings from, if non-zero.
5242 This position comes into play when the overlay has an `invisible'
5243 property, and both before and after-strings. When we've skipped to
5244 the end of the overlay, because of its `invisible' property, we
5245 nevertheless want its before-string to appear.
5246 IT->add_overlay_start will contain the overlay start position
5249 Overlay strings are sorted so that after-string strings come in
5250 front of before-string strings. Within before and after-strings,
5251 strings are sorted by overlay priority. See also function
5252 compare_overlay_entries. */
5255 load_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5257 Lisp_Object overlay
, window
, str
, invisible
;
5258 struct Lisp_Overlay
*ov
;
5259 EMACS_INT start
, end
;
5261 int n
= 0, i
, j
, invis_p
;
5262 struct overlay_entry
*entries
5263 = (struct overlay_entry
*) alloca (size
* sizeof *entries
);
5266 charpos
= IT_CHARPOS (*it
);
5268 /* Append the overlay string STRING of overlay OVERLAY to vector
5269 `entries' which has size `size' and currently contains `n'
5270 elements. AFTER_P non-zero means STRING is an after-string of
5272 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5275 Lisp_Object priority; \
5279 int new_size = 2 * size; \
5280 struct overlay_entry *old = entries; \
5282 (struct overlay_entry *) alloca (new_size \
5283 * sizeof *entries); \
5284 memcpy (entries, old, size * sizeof *entries); \
5288 entries[n].string = (STRING); \
5289 entries[n].overlay = (OVERLAY); \
5290 priority = Foverlay_get ((OVERLAY), Qpriority); \
5291 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5292 entries[n].after_string_p = (AFTER_P); \
5297 /* Process overlay before the overlay center. */
5298 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5300 XSETMISC (overlay
, ov
);
5301 xassert (OVERLAYP (overlay
));
5302 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5303 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5308 /* Skip this overlay if it doesn't start or end at IT's current
5310 if (end
!= charpos
&& start
!= charpos
)
5313 /* Skip this overlay if it doesn't apply to IT->w. */
5314 window
= Foverlay_get (overlay
, Qwindow
);
5315 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5318 /* If the text ``under'' the overlay is invisible, both before-
5319 and after-strings from this overlay are visible; start and
5320 end position are indistinguishable. */
5321 invisible
= Foverlay_get (overlay
, Qinvisible
);
5322 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5324 /* If overlay has a non-empty before-string, record it. */
5325 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5326 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5328 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5330 /* If overlay has a non-empty after-string, record it. */
5331 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5332 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5334 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5337 /* Process overlays after the overlay center. */
5338 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5340 XSETMISC (overlay
, ov
);
5341 xassert (OVERLAYP (overlay
));
5342 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5343 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5345 if (start
> charpos
)
5348 /* Skip this overlay if it doesn't start or end at IT's current
5350 if (end
!= charpos
&& start
!= charpos
)
5353 /* Skip this overlay if it doesn't apply to IT->w. */
5354 window
= Foverlay_get (overlay
, Qwindow
);
5355 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5358 /* If the text ``under'' the overlay is invisible, it has a zero
5359 dimension, and both before- and after-strings apply. */
5360 invisible
= Foverlay_get (overlay
, Qinvisible
);
5361 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5363 /* If overlay has a non-empty before-string, record it. */
5364 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5365 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5367 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5369 /* If overlay has a non-empty after-string, record it. */
5370 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5371 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5373 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5376 #undef RECORD_OVERLAY_STRING
5380 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5382 /* Record number of overlay strings, and where we computed it. */
5383 it
->n_overlay_strings
= n
;
5384 it
->overlay_strings_charpos
= charpos
;
5386 /* IT->current.overlay_string_index is the number of overlay strings
5387 that have already been consumed by IT. Copy some of the
5388 remaining overlay strings to IT->overlay_strings. */
5390 j
= it
->current
.overlay_string_index
;
5391 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5393 it
->overlay_strings
[i
] = entries
[j
].string
;
5394 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5401 /* Get the first chunk of overlay strings at IT's current buffer
5402 position, or at CHARPOS if that is > 0. Value is non-zero if at
5403 least one overlay string was found. */
5406 get_overlay_strings_1 (struct it
*it
, EMACS_INT charpos
, int compute_stop_p
)
5408 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5409 process. This fills IT->overlay_strings with strings, and sets
5410 IT->n_overlay_strings to the total number of strings to process.
5411 IT->pos.overlay_string_index has to be set temporarily to zero
5412 because load_overlay_strings needs this; it must be set to -1
5413 when no overlay strings are found because a zero value would
5414 indicate a position in the first overlay string. */
5415 it
->current
.overlay_string_index
= 0;
5416 load_overlay_strings (it
, charpos
);
5418 /* If we found overlay strings, set up IT to deliver display
5419 elements from the first one. Otherwise set up IT to deliver
5420 from current_buffer. */
5421 if (it
->n_overlay_strings
)
5423 /* Make sure we know settings in current_buffer, so that we can
5424 restore meaningful values when we're done with the overlay
5427 compute_stop_pos (it
);
5428 xassert (it
->face_id
>= 0);
5430 /* Save IT's settings. They are restored after all overlay
5431 strings have been processed. */
5432 xassert (!compute_stop_p
|| it
->sp
== 0);
5434 /* When called from handle_stop, there might be an empty display
5435 string loaded. In that case, don't bother saving it. */
5436 if (!STRINGP (it
->string
) || SCHARS (it
->string
))
5439 /* Set up IT to deliver display elements from the first overlay
5441 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5442 it
->string
= it
->overlay_strings
[0];
5443 it
->from_overlay
= Qnil
;
5444 it
->stop_charpos
= 0;
5445 xassert (STRINGP (it
->string
));
5446 it
->end_charpos
= SCHARS (it
->string
);
5448 it
->base_level_stop
= 0;
5449 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5450 it
->method
= GET_FROM_STRING
;
5451 it
->from_disp_prop_p
= 0;
5453 /* Force paragraph direction to be that of the parent
5455 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5456 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5458 it
->paragraph_embedding
= L2R
;
5460 /* Set up the bidi iterator for this overlay string. */
5463 EMACS_INT pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5465 it
->bidi_it
.string
.lstring
= it
->string
;
5466 it
->bidi_it
.string
.s
= NULL
;
5467 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5468 it
->bidi_it
.string
.bufpos
= pos
;
5469 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5470 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5471 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5476 it
->current
.overlay_string_index
= -1;
5481 get_overlay_strings (struct it
*it
, EMACS_INT charpos
)
5484 it
->method
= GET_FROM_BUFFER
;
5486 (void) get_overlay_strings_1 (it
, charpos
, 1);
5490 /* Value is non-zero if we found at least one overlay string. */
5491 return STRINGP (it
->string
);
5496 /***********************************************************************
5497 Saving and restoring state
5498 ***********************************************************************/
5500 /* Save current settings of IT on IT->stack. Called, for example,
5501 before setting up IT for an overlay string, to be able to restore
5502 IT's settings to what they were after the overlay string has been
5503 processed. If POSITION is non-NULL, it is the position to save on
5504 the stack instead of IT->position. */
5507 push_it (struct it
*it
, struct text_pos
*position
)
5509 struct iterator_stack_entry
*p
;
5511 xassert (it
->sp
< IT_STACK_SIZE
);
5512 p
= it
->stack
+ it
->sp
;
5514 p
->stop_charpos
= it
->stop_charpos
;
5515 p
->prev_stop
= it
->prev_stop
;
5516 p
->base_level_stop
= it
->base_level_stop
;
5517 p
->cmp_it
= it
->cmp_it
;
5518 xassert (it
->face_id
>= 0);
5519 p
->face_id
= it
->face_id
;
5520 p
->string
= it
->string
;
5521 p
->method
= it
->method
;
5522 p
->from_overlay
= it
->from_overlay
;
5525 case GET_FROM_IMAGE
:
5526 p
->u
.image
.object
= it
->object
;
5527 p
->u
.image
.image_id
= it
->image_id
;
5528 p
->u
.image
.slice
= it
->slice
;
5530 case GET_FROM_STRETCH
:
5531 p
->u
.stretch
.object
= it
->object
;
5534 p
->position
= position
? *position
: it
->position
;
5535 p
->current
= it
->current
;
5536 p
->end_charpos
= it
->end_charpos
;
5537 p
->string_nchars
= it
->string_nchars
;
5539 p
->multibyte_p
= it
->multibyte_p
;
5540 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5541 p
->space_width
= it
->space_width
;
5542 p
->font_height
= it
->font_height
;
5543 p
->voffset
= it
->voffset
;
5544 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5545 p
->display_ellipsis_p
= 0;
5546 p
->line_wrap
= it
->line_wrap
;
5547 p
->bidi_p
= it
->bidi_p
;
5548 p
->paragraph_embedding
= it
->paragraph_embedding
;
5549 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5552 /* Save the state of the bidi iterator as well. */
5554 bidi_push_it (&it
->bidi_it
);
5558 iterate_out_of_display_property (struct it
*it
)
5560 int buffer_p
= BUFFERP (it
->object
);
5561 EMACS_INT eob
= (buffer_p
? ZV
: it
->end_charpos
);
5562 EMACS_INT bob
= (buffer_p
? BEGV
: 0);
5564 xassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5566 /* Maybe initialize paragraph direction. If we are at the beginning
5567 of a new paragraph, next_element_from_buffer may not have a
5568 chance to do that. */
5569 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5570 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5571 /* prev_stop can be zero, so check against BEGV as well. */
5572 while (it
->bidi_it
.charpos
>= bob
5573 && it
->prev_stop
<= it
->bidi_it
.charpos
5574 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5575 && it
->bidi_it
.charpos
< eob
)
5576 bidi_move_to_visually_next (&it
->bidi_it
);
5577 /* Record the stop_pos we just crossed, for when we cross it
5579 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
5580 it
->prev_stop
= CHARPOS (it
->position
);
5581 /* If we ended up not where pop_it put us, resync IT's
5582 positional members with the bidi iterator. */
5583 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
5584 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
5586 it
->current
.pos
= it
->position
;
5588 it
->current
.string_pos
= it
->position
;
5591 /* Restore IT's settings from IT->stack. Called, for example, when no
5592 more overlay strings must be processed, and we return to delivering
5593 display elements from a buffer, or when the end of a string from a
5594 `display' property is reached and we return to delivering display
5595 elements from an overlay string, or from a buffer. */
5598 pop_it (struct it
*it
)
5600 struct iterator_stack_entry
*p
;
5601 int from_display_prop
= it
->from_disp_prop_p
;
5603 xassert (it
->sp
> 0);
5605 p
= it
->stack
+ it
->sp
;
5606 it
->stop_charpos
= p
->stop_charpos
;
5607 it
->prev_stop
= p
->prev_stop
;
5608 it
->base_level_stop
= p
->base_level_stop
;
5609 it
->cmp_it
= p
->cmp_it
;
5610 it
->face_id
= p
->face_id
;
5611 it
->current
= p
->current
;
5612 it
->position
= p
->position
;
5613 it
->string
= p
->string
;
5614 it
->from_overlay
= p
->from_overlay
;
5615 if (NILP (it
->string
))
5616 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
5617 it
->method
= p
->method
;
5620 case GET_FROM_IMAGE
:
5621 it
->image_id
= p
->u
.image
.image_id
;
5622 it
->object
= p
->u
.image
.object
;
5623 it
->slice
= p
->u
.image
.slice
;
5625 case GET_FROM_STRETCH
:
5626 it
->object
= p
->u
.stretch
.object
;
5628 case GET_FROM_BUFFER
:
5629 it
->object
= it
->w
->buffer
;
5631 case GET_FROM_STRING
:
5632 it
->object
= it
->string
;
5634 case GET_FROM_DISPLAY_VECTOR
:
5636 it
->method
= GET_FROM_C_STRING
;
5637 else if (STRINGP (it
->string
))
5638 it
->method
= GET_FROM_STRING
;
5641 it
->method
= GET_FROM_BUFFER
;
5642 it
->object
= it
->w
->buffer
;
5645 it
->end_charpos
= p
->end_charpos
;
5646 it
->string_nchars
= p
->string_nchars
;
5648 it
->multibyte_p
= p
->multibyte_p
;
5649 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
5650 it
->space_width
= p
->space_width
;
5651 it
->font_height
= p
->font_height
;
5652 it
->voffset
= p
->voffset
;
5653 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
5654 it
->line_wrap
= p
->line_wrap
;
5655 it
->bidi_p
= p
->bidi_p
;
5656 it
->paragraph_embedding
= p
->paragraph_embedding
;
5657 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
5660 bidi_pop_it (&it
->bidi_it
);
5661 /* Bidi-iterate until we get out of the portion of text, if any,
5662 covered by a `display' text property or by an overlay with
5663 `display' property. (We cannot just jump there, because the
5664 internal coherency of the bidi iterator state can not be
5665 preserved across such jumps.) We also must determine the
5666 paragraph base direction if the overlay we just processed is
5667 at the beginning of a new paragraph. */
5668 if (from_display_prop
5669 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
5670 iterate_out_of_display_property (it
);
5672 xassert ((BUFFERP (it
->object
)
5673 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
5674 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5675 || (STRINGP (it
->object
)
5676 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
5677 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
5678 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
5684 /***********************************************************************
5686 ***********************************************************************/
5688 /* Set IT's current position to the previous line start. */
5691 back_to_previous_line_start (struct it
*it
)
5693 IT_CHARPOS (*it
) = find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
5694 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (IT_CHARPOS (*it
));
5698 /* Move IT to the next line start.
5700 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
5701 we skipped over part of the text (as opposed to moving the iterator
5702 continuously over the text). Otherwise, don't change the value
5705 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
5706 iterator on the newline, if it was found.
5708 Newlines may come from buffer text, overlay strings, or strings
5709 displayed via the `display' property. That's the reason we can't
5710 simply use find_next_newline_no_quit.
5712 Note that this function may not skip over invisible text that is so
5713 because of text properties and immediately follows a newline. If
5714 it would, function reseat_at_next_visible_line_start, when called
5715 from set_iterator_to_next, would effectively make invisible
5716 characters following a newline part of the wrong glyph row, which
5717 leads to wrong cursor motion. */
5720 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
5721 struct bidi_it
*bidi_it_prev
)
5723 EMACS_INT old_selective
;
5724 int newline_found_p
, n
;
5725 const int MAX_NEWLINE_DISTANCE
= 500;
5727 /* If already on a newline, just consume it to avoid unintended
5728 skipping over invisible text below. */
5729 if (it
->what
== IT_CHARACTER
5731 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
5733 if (it
->bidi_p
&& bidi_it_prev
)
5734 *bidi_it_prev
= it
->bidi_it
;
5735 set_iterator_to_next (it
, 0);
5740 /* Don't handle selective display in the following. It's (a)
5741 unnecessary because it's done by the caller, and (b) leads to an
5742 infinite recursion because next_element_from_ellipsis indirectly
5743 calls this function. */
5744 old_selective
= it
->selective
;
5747 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
5748 from buffer text. */
5749 for (n
= newline_found_p
= 0;
5750 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
5751 n
+= STRINGP (it
->string
) ? 0 : 1)
5753 if (!get_next_display_element (it
))
5755 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
5756 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5757 *bidi_it_prev
= it
->bidi_it
;
5758 set_iterator_to_next (it
, 0);
5761 /* If we didn't find a newline near enough, see if we can use a
5763 if (!newline_found_p
)
5765 EMACS_INT start
= IT_CHARPOS (*it
);
5766 EMACS_INT limit
= find_next_newline_no_quit (start
, 1);
5769 xassert (!STRINGP (it
->string
));
5771 /* If there isn't any `display' property in sight, and no
5772 overlays, we can just use the position of the newline in
5774 if (it
->stop_charpos
>= limit
5775 || ((pos
= Fnext_single_property_change (make_number (start
),
5777 make_number (limit
)),
5779 && next_overlay_change (start
) == ZV
))
5783 IT_CHARPOS (*it
) = limit
;
5784 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (limit
);
5788 struct bidi_it bprev
;
5790 /* Help bidi.c avoid expensive searches for display
5791 properties and overlays, by telling it that there are
5792 none up to `limit'. */
5793 if (it
->bidi_it
.disp_pos
< limit
)
5795 it
->bidi_it
.disp_pos
= limit
;
5796 it
->bidi_it
.disp_prop
= 0;
5799 bprev
= it
->bidi_it
;
5800 bidi_move_to_visually_next (&it
->bidi_it
);
5801 } while (it
->bidi_it
.charpos
!= limit
);
5802 IT_CHARPOS (*it
) = limit
;
5803 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5805 *bidi_it_prev
= bprev
;
5807 *skipped_p
= newline_found_p
= 1;
5811 while (get_next_display_element (it
)
5812 && !newline_found_p
)
5814 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
5815 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
5816 *bidi_it_prev
= it
->bidi_it
;
5817 set_iterator_to_next (it
, 0);
5822 it
->selective
= old_selective
;
5823 return newline_found_p
;
5827 /* Set IT's current position to the previous visible line start. Skip
5828 invisible text that is so either due to text properties or due to
5829 selective display. Caution: this does not change IT->current_x and
5833 back_to_previous_visible_line_start (struct it
*it
)
5835 while (IT_CHARPOS (*it
) > BEGV
)
5837 back_to_previous_line_start (it
);
5839 if (IT_CHARPOS (*it
) <= BEGV
)
5842 /* If selective > 0, then lines indented more than its value are
5844 if (it
->selective
> 0
5845 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5849 /* Check the newline before point for invisibility. */
5852 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
5853 Qinvisible
, it
->window
);
5854 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
5858 if (IT_CHARPOS (*it
) <= BEGV
)
5863 void *it2data
= NULL
;
5866 Lisp_Object val
, overlay
;
5868 SAVE_IT (it2
, *it
, it2data
);
5870 /* If newline is part of a composition, continue from start of composition */
5871 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
5872 && beg
< IT_CHARPOS (*it
))
5875 /* If newline is replaced by a display property, find start of overlay
5876 or interval and continue search from that point. */
5877 pos
= --IT_CHARPOS (it2
);
5880 bidi_unshelve_cache (NULL
, 0);
5881 it2
.string_from_display_prop_p
= 0;
5882 it2
.from_disp_prop_p
= 0;
5883 if (handle_display_prop (&it2
) == HANDLED_RETURN
5884 && !NILP (val
= get_char_property_and_overlay
5885 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
5886 && (OVERLAYP (overlay
)
5887 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
5888 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
5890 RESTORE_IT (it
, it
, it2data
);
5894 /* Newline is not replaced by anything -- so we are done. */
5895 RESTORE_IT (it
, it
, it2data
);
5901 IT_CHARPOS (*it
) = beg
;
5902 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
5906 it
->continuation_lines_width
= 0;
5908 xassert (IT_CHARPOS (*it
) >= BEGV
);
5909 xassert (IT_CHARPOS (*it
) == BEGV
5910 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5915 /* Reseat iterator IT at the previous visible line start. Skip
5916 invisible text that is so either due to text properties or due to
5917 selective display. At the end, update IT's overlay information,
5918 face information etc. */
5921 reseat_at_previous_visible_line_start (struct it
*it
)
5923 back_to_previous_visible_line_start (it
);
5924 reseat (it
, it
->current
.pos
, 1);
5929 /* Reseat iterator IT on the next visible line start in the current
5930 buffer. ON_NEWLINE_P non-zero means position IT on the newline
5931 preceding the line start. Skip over invisible text that is so
5932 because of selective display. Compute faces, overlays etc at the
5933 new position. Note that this function does not skip over text that
5934 is invisible because of text properties. */
5937 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
5939 int newline_found_p
, skipped_p
= 0;
5940 struct bidi_it bidi_it_prev
;
5942 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5944 /* Skip over lines that are invisible because they are indented
5945 more than the value of IT->selective. */
5946 if (it
->selective
> 0)
5947 while (IT_CHARPOS (*it
) < ZV
5948 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
5951 xassert (IT_BYTEPOS (*it
) == BEGV
5952 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
5954 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
5957 /* Position on the newline if that's what's requested. */
5958 if (on_newline_p
&& newline_found_p
)
5960 if (STRINGP (it
->string
))
5962 if (IT_STRING_CHARPOS (*it
) > 0)
5966 --IT_STRING_CHARPOS (*it
);
5967 --IT_STRING_BYTEPOS (*it
);
5971 /* We need to restore the bidi iterator to the state
5972 it had on the newline, and resync the IT's
5973 position with that. */
5974 it
->bidi_it
= bidi_it_prev
;
5975 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5976 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5980 else if (IT_CHARPOS (*it
) > BEGV
)
5989 /* We need to restore the bidi iterator to the state it
5990 had on the newline and resync IT with that. */
5991 it
->bidi_it
= bidi_it_prev
;
5992 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
5993 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
5995 reseat (it
, it
->current
.pos
, 0);
5999 reseat (it
, it
->current
.pos
, 0);
6006 /***********************************************************************
6007 Changing an iterator's position
6008 ***********************************************************************/
6010 /* Change IT's current position to POS in current_buffer. If FORCE_P
6011 is non-zero, always check for text properties at the new position.
6012 Otherwise, text properties are only looked up if POS >=
6013 IT->check_charpos of a property. */
6016 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6018 EMACS_INT original_pos
= IT_CHARPOS (*it
);
6020 reseat_1 (it
, pos
, 0);
6022 /* Determine where to check text properties. Avoid doing it
6023 where possible because text property lookup is very expensive. */
6025 || CHARPOS (pos
) > it
->stop_charpos
6026 || CHARPOS (pos
) < original_pos
)
6030 /* For bidi iteration, we need to prime prev_stop and
6031 base_level_stop with our best estimations. */
6032 /* Implementation note: Of course, POS is not necessarily a
6033 stop position, so assigning prev_pos to it is a lie; we
6034 should have called compute_stop_backwards. However, if
6035 the current buffer does not include any R2L characters,
6036 that call would be a waste of cycles, because the
6037 iterator will never move back, and thus never cross this
6038 "fake" stop position. So we delay that backward search
6039 until the time we really need it, in next_element_from_buffer. */
6040 if (CHARPOS (pos
) != it
->prev_stop
)
6041 it
->prev_stop
= CHARPOS (pos
);
6042 if (CHARPOS (pos
) < it
->base_level_stop
)
6043 it
->base_level_stop
= 0; /* meaning it's unknown */
6049 it
->prev_stop
= it
->base_level_stop
= 0;
6058 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6059 IT->stop_pos to POS, also. */
6062 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6064 /* Don't call this function when scanning a C string. */
6065 xassert (it
->s
== NULL
);
6067 /* POS must be a reasonable value. */
6068 xassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6070 it
->current
.pos
= it
->position
= pos
;
6071 it
->end_charpos
= ZV
;
6073 it
->current
.dpvec_index
= -1;
6074 it
->current
.overlay_string_index
= -1;
6075 IT_STRING_CHARPOS (*it
) = -1;
6076 IT_STRING_BYTEPOS (*it
) = -1;
6078 it
->method
= GET_FROM_BUFFER
;
6079 it
->object
= it
->w
->buffer
;
6080 it
->area
= TEXT_AREA
;
6081 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6083 it
->string_from_display_prop_p
= 0;
6084 it
->from_disp_prop_p
= 0;
6085 it
->face_before_selective_p
= 0;
6088 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6090 bidi_unshelve_cache (NULL
, 0);
6091 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6092 it
->bidi_it
.string
.s
= NULL
;
6093 it
->bidi_it
.string
.lstring
= Qnil
;
6094 it
->bidi_it
.string
.bufpos
= 0;
6095 it
->bidi_it
.string
.unibyte
= 0;
6100 it
->stop_charpos
= CHARPOS (pos
);
6101 it
->base_level_stop
= CHARPOS (pos
);
6106 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6107 If S is non-null, it is a C string to iterate over. Otherwise,
6108 STRING gives a Lisp string to iterate over.
6110 If PRECISION > 0, don't return more then PRECISION number of
6111 characters from the string.
6113 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6114 characters have been returned. FIELD_WIDTH < 0 means an infinite
6117 MULTIBYTE = 0 means disable processing of multibyte characters,
6118 MULTIBYTE > 0 means enable it,
6119 MULTIBYTE < 0 means use IT->multibyte_p.
6121 IT must be initialized via a prior call to init_iterator before
6122 calling this function. */
6125 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6126 EMACS_INT charpos
, EMACS_INT precision
, int field_width
,
6129 /* No region in strings. */
6130 it
->region_beg_charpos
= it
->region_end_charpos
= -1;
6132 /* No text property checks performed by default, but see below. */
6133 it
->stop_charpos
= -1;
6135 /* Set iterator position and end position. */
6136 memset (&it
->current
, 0, sizeof it
->current
);
6137 it
->current
.overlay_string_index
= -1;
6138 it
->current
.dpvec_index
= -1;
6139 xassert (charpos
>= 0);
6141 /* If STRING is specified, use its multibyteness, otherwise use the
6142 setting of MULTIBYTE, if specified. */
6144 it
->multibyte_p
= multibyte
> 0;
6146 /* Bidirectional reordering of strings is controlled by the default
6147 value of bidi-display-reordering. Don't try to reorder while
6148 loading loadup.el, as the necessary character property tables are
6149 not yet available. */
6152 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6156 xassert (STRINGP (string
));
6157 it
->string
= string
;
6159 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6160 it
->method
= GET_FROM_STRING
;
6161 it
->current
.string_pos
= string_pos (charpos
, string
);
6165 it
->bidi_it
.string
.lstring
= string
;
6166 it
->bidi_it
.string
.s
= NULL
;
6167 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6168 it
->bidi_it
.string
.bufpos
= 0;
6169 it
->bidi_it
.string
.from_disp_str
= 0;
6170 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6171 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6172 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6177 it
->s
= (const unsigned char *) s
;
6180 /* Note that we use IT->current.pos, not it->current.string_pos,
6181 for displaying C strings. */
6182 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6183 if (it
->multibyte_p
)
6185 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6186 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6190 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6191 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6196 it
->bidi_it
.string
.lstring
= Qnil
;
6197 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6198 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6199 it
->bidi_it
.string
.bufpos
= 0;
6200 it
->bidi_it
.string
.from_disp_str
= 0;
6201 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6202 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6205 it
->method
= GET_FROM_C_STRING
;
6208 /* PRECISION > 0 means don't return more than PRECISION characters
6210 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6212 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6214 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6217 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6218 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6219 FIELD_WIDTH < 0 means infinite field width. This is useful for
6220 padding with `-' at the end of a mode line. */
6221 if (field_width
< 0)
6222 field_width
= INFINITY
;
6223 /* Implementation note: We deliberately don't enlarge
6224 it->bidi_it.string.schars here to fit it->end_charpos, because
6225 the bidi iterator cannot produce characters out of thin air. */
6226 if (field_width
> it
->end_charpos
- charpos
)
6227 it
->end_charpos
= charpos
+ field_width
;
6229 /* Use the standard display table for displaying strings. */
6230 if (DISP_TABLE_P (Vstandard_display_table
))
6231 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6233 it
->stop_charpos
= charpos
;
6234 it
->prev_stop
= charpos
;
6235 it
->base_level_stop
= 0;
6238 it
->bidi_it
.first_elt
= 1;
6239 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6240 it
->bidi_it
.disp_pos
= -1;
6242 if (s
== NULL
&& it
->multibyte_p
)
6244 EMACS_INT endpos
= SCHARS (it
->string
);
6245 if (endpos
> it
->end_charpos
)
6246 endpos
= it
->end_charpos
;
6247 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6255 /***********************************************************************
6257 ***********************************************************************/
6259 /* Map enum it_method value to corresponding next_element_from_* function. */
6261 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6263 next_element_from_buffer
,
6264 next_element_from_display_vector
,
6265 next_element_from_string
,
6266 next_element_from_c_string
,
6267 next_element_from_image
,
6268 next_element_from_stretch
6271 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6274 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6275 (possibly with the following characters). */
6277 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6278 ((IT)->cmp_it.id >= 0 \
6279 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6280 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6281 END_CHARPOS, (IT)->w, \
6282 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6286 /* Lookup the char-table Vglyphless_char_display for character C (-1
6287 if we want information for no-font case), and return the display
6288 method symbol. By side-effect, update it->what and
6289 it->glyphless_method. This function is called from
6290 get_next_display_element for each character element, and from
6291 x_produce_glyphs when no suitable font was found. */
6294 lookup_glyphless_char_display (int c
, struct it
*it
)
6296 Lisp_Object glyphless_method
= Qnil
;
6298 if (CHAR_TABLE_P (Vglyphless_char_display
)
6299 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6303 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6304 if (CONSP (glyphless_method
))
6305 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6306 ? XCAR (glyphless_method
)
6307 : XCDR (glyphless_method
);
6310 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6314 if (NILP (glyphless_method
))
6317 /* The default is to display the character by a proper font. */
6319 /* The default for the no-font case is to display an empty box. */
6320 glyphless_method
= Qempty_box
;
6322 if (EQ (glyphless_method
, Qzero_width
))
6325 return glyphless_method
;
6326 /* This method can't be used for the no-font case. */
6327 glyphless_method
= Qempty_box
;
6329 if (EQ (glyphless_method
, Qthin_space
))
6330 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6331 else if (EQ (glyphless_method
, Qempty_box
))
6332 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6333 else if (EQ (glyphless_method
, Qhex_code
))
6334 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6335 else if (STRINGP (glyphless_method
))
6336 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6339 /* Invalid value. We use the default method. */
6340 glyphless_method
= Qnil
;
6343 it
->what
= IT_GLYPHLESS
;
6344 return glyphless_method
;
6347 /* Load IT's display element fields with information about the next
6348 display element from the current position of IT. Value is zero if
6349 end of buffer (or C string) is reached. */
6351 static struct frame
*last_escape_glyph_frame
= NULL
;
6352 static unsigned last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6353 static int last_escape_glyph_merged_face_id
= 0;
6355 struct frame
*last_glyphless_glyph_frame
= NULL
;
6356 unsigned last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6357 int last_glyphless_glyph_merged_face_id
= 0;
6360 get_next_display_element (struct it
*it
)
6362 /* Non-zero means that we found a display element. Zero means that
6363 we hit the end of what we iterate over. Performance note: the
6364 function pointer `method' used here turns out to be faster than
6365 using a sequence of if-statements. */
6369 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6371 if (it
->what
== IT_CHARACTER
)
6373 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6374 and only if (a) the resolved directionality of that character
6376 /* FIXME: Do we need an exception for characters from display
6378 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6379 it
->c
= bidi_mirror_char (it
->c
);
6380 /* Map via display table or translate control characters.
6381 IT->c, IT->len etc. have been set to the next character by
6382 the function call above. If we have a display table, and it
6383 contains an entry for IT->c, translate it. Don't do this if
6384 IT->c itself comes from a display table, otherwise we could
6385 end up in an infinite recursion. (An alternative could be to
6386 count the recursion depth of this function and signal an
6387 error when a certain maximum depth is reached.) Is it worth
6389 if (success_p
&& it
->dpvec
== NULL
)
6392 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6393 int nonascii_space_p
= 0;
6394 int nonascii_hyphen_p
= 0;
6395 int c
= it
->c
; /* This is the character to display. */
6397 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6399 xassert (SINGLE_BYTE_CHAR_P (c
));
6400 if (unibyte_display_via_language_environment
)
6402 c
= DECODE_CHAR (unibyte
, c
);
6404 c
= BYTE8_TO_CHAR (it
->c
);
6407 c
= BYTE8_TO_CHAR (it
->c
);
6411 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6414 struct Lisp_Vector
*v
= XVECTOR (dv
);
6416 /* Return the first character from the display table
6417 entry, if not empty. If empty, don't display the
6418 current character. */
6421 it
->dpvec_char_len
= it
->len
;
6422 it
->dpvec
= v
->contents
;
6423 it
->dpend
= v
->contents
+ v
->header
.size
;
6424 it
->current
.dpvec_index
= 0;
6425 it
->dpvec_face_id
= -1;
6426 it
->saved_face_id
= it
->face_id
;
6427 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6432 set_iterator_to_next (it
, 0);
6437 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6439 if (it
->what
== IT_GLYPHLESS
)
6441 /* Don't display this character. */
6442 set_iterator_to_next (it
, 0);
6446 /* If `nobreak-char-display' is non-nil, we display
6447 non-ASCII spaces and hyphens specially. */
6448 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6451 nonascii_space_p
= 1;
6452 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6453 nonascii_hyphen_p
= 1;
6456 /* Translate control characters into `\003' or `^C' form.
6457 Control characters coming from a display table entry are
6458 currently not translated because we use IT->dpvec to hold
6459 the translation. This could easily be changed but I
6460 don't believe that it is worth doing.
6462 The characters handled by `nobreak-char-display' must be
6465 Non-printable characters and raw-byte characters are also
6466 translated to octal form. */
6467 if (((c
< ' ' || c
== 127) /* ASCII control chars */
6468 ? (it
->area
!= TEXT_AREA
6469 /* In mode line, treat \n, \t like other crl chars. */
6472 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6473 || (c
!= '\n' && c
!= '\t'))
6475 || nonascii_hyphen_p
6477 || ! CHAR_PRINTABLE_P (c
))))
6479 /* C is a control character, non-ASCII space/hyphen,
6480 raw-byte, or a non-printable character which must be
6481 displayed either as '\003' or as `^C' where the '\\'
6482 and '^' can be defined in the display table. Fill
6483 IT->ctl_chars with glyphs for what we have to
6484 display. Then, set IT->dpvec to these glyphs. */
6488 EMACS_INT lface_id
= 0;
6491 /* Handle control characters with ^. */
6493 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6497 g
= '^'; /* default glyph for Control */
6498 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6500 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6501 && GLYPH_CODE_CHAR_VALID_P (gc
))
6503 g
= GLYPH_CODE_CHAR (gc
);
6504 lface_id
= GLYPH_CODE_FACE (gc
);
6508 face_id
= merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
);
6510 else if (it
->f
== last_escape_glyph_frame
6511 && it
->face_id
== last_escape_glyph_face_id
)
6513 face_id
= last_escape_glyph_merged_face_id
;
6517 /* Merge the escape-glyph face into the current face. */
6518 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6520 last_escape_glyph_frame
= it
->f
;
6521 last_escape_glyph_face_id
= it
->face_id
;
6522 last_escape_glyph_merged_face_id
= face_id
;
6525 XSETINT (it
->ctl_chars
[0], g
);
6526 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6528 goto display_control
;
6531 /* Handle non-ascii space in the mode where it only gets
6534 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
6536 /* Merge `nobreak-space' into the current face. */
6537 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
6539 XSETINT (it
->ctl_chars
[0], ' ');
6541 goto display_control
;
6544 /* Handle sequences that start with the "escape glyph". */
6546 /* the default escape glyph is \. */
6547 escape_glyph
= '\\';
6550 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
))
6551 && GLYPH_CODE_CHAR_VALID_P (gc
))
6553 escape_glyph
= GLYPH_CODE_CHAR (gc
);
6554 lface_id
= GLYPH_CODE_FACE (gc
);
6558 /* The display table specified a face.
6559 Merge it into face_id and also into escape_glyph. */
6560 face_id
= merge_faces (it
->f
, Qt
, lface_id
,
6563 else if (it
->f
== last_escape_glyph_frame
6564 && it
->face_id
== last_escape_glyph_face_id
)
6566 face_id
= last_escape_glyph_merged_face_id
;
6570 /* Merge the escape-glyph face into the current face. */
6571 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0,
6573 last_escape_glyph_frame
= it
->f
;
6574 last_escape_glyph_face_id
= it
->face_id
;
6575 last_escape_glyph_merged_face_id
= face_id
;
6578 /* Draw non-ASCII hyphen with just highlighting: */
6580 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
6582 XSETINT (it
->ctl_chars
[0], '-');
6584 goto display_control
;
6587 /* Draw non-ASCII space/hyphen with escape glyph: */
6589 if (nonascii_space_p
|| nonascii_hyphen_p
)
6591 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6592 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
6594 goto display_control
;
6601 if (CHAR_BYTE8_P (c
))
6602 /* Display \200 instead of \17777600. */
6603 c
= CHAR_TO_BYTE8 (c
);
6604 len
= sprintf (str
, "%03o", c
);
6606 XSETINT (it
->ctl_chars
[0], escape_glyph
);
6607 for (i
= 0; i
< len
; i
++)
6608 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
6613 /* Set up IT->dpvec and return first character from it. */
6614 it
->dpvec_char_len
= it
->len
;
6615 it
->dpvec
= it
->ctl_chars
;
6616 it
->dpend
= it
->dpvec
+ ctl_len
;
6617 it
->current
.dpvec_index
= 0;
6618 it
->dpvec_face_id
= face_id
;
6619 it
->saved_face_id
= it
->face_id
;
6620 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6624 it
->char_to_display
= c
;
6628 it
->char_to_display
= it
->c
;
6632 /* Adjust face id for a multibyte character. There are no multibyte
6633 character in unibyte text. */
6634 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
6637 && FRAME_WINDOW_P (it
->f
))
6639 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6641 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
6643 /* Automatic composition with glyph-string. */
6644 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
6646 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
6650 EMACS_INT pos
= (it
->s
? -1
6651 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
6652 : IT_CHARPOS (*it
));
6655 if (it
->what
== IT_CHARACTER
)
6656 c
= it
->char_to_display
;
6659 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
6663 for (i
= 0; i
< cmp
->glyph_len
; i
++)
6664 /* TAB in a composition means display glyphs with
6665 padding space on the left or right. */
6666 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
6669 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
6674 /* Is this character the last one of a run of characters with
6675 box? If yes, set IT->end_of_box_run_p to 1. */
6679 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
6681 int face_id
= underlying_face_id (it
);
6682 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
6686 if (face
->box
== FACE_NO_BOX
)
6688 /* If the box comes from face properties in a
6689 display string, check faces in that string. */
6690 int string_face_id
= face_after_it_pos (it
);
6691 it
->end_of_box_run_p
6692 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
6695 /* Otherwise, the box comes from the underlying face.
6696 If this is the last string character displayed, check
6697 the next buffer location. */
6698 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
6699 && (it
->current
.overlay_string_index
6700 == it
->n_overlay_strings
- 1))
6704 struct text_pos pos
= it
->current
.pos
;
6705 INC_TEXT_POS (pos
, it
->multibyte_p
);
6707 next_face_id
= face_at_buffer_position
6708 (it
->w
, CHARPOS (pos
), it
->region_beg_charpos
,
6709 it
->region_end_charpos
, &ignore
,
6710 (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
), 0,
6712 it
->end_of_box_run_p
6713 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
6720 int face_id
= face_after_it_pos (it
);
6721 it
->end_of_box_run_p
6722 = (face_id
!= it
->face_id
6723 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
6727 /* Value is 0 if end of buffer or string reached. */
6732 /* Move IT to the next display element.
6734 RESEAT_P non-zero means if called on a newline in buffer text,
6735 skip to the next visible line start.
6737 Functions get_next_display_element and set_iterator_to_next are
6738 separate because I find this arrangement easier to handle than a
6739 get_next_display_element function that also increments IT's
6740 position. The way it is we can first look at an iterator's current
6741 display element, decide whether it fits on a line, and if it does,
6742 increment the iterator position. The other way around we probably
6743 would either need a flag indicating whether the iterator has to be
6744 incremented the next time, or we would have to implement a
6745 decrement position function which would not be easy to write. */
6748 set_iterator_to_next (struct it
*it
, int reseat_p
)
6750 /* Reset flags indicating start and end of a sequence of characters
6751 with box. Reset them at the start of this function because
6752 moving the iterator to a new position might set them. */
6753 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
6757 case GET_FROM_BUFFER
:
6758 /* The current display element of IT is a character from
6759 current_buffer. Advance in the buffer, and maybe skip over
6760 invisible lines that are so because of selective display. */
6761 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
6762 reseat_at_next_visible_line_start (it
, 0);
6763 else if (it
->cmp_it
.id
>= 0)
6765 /* We are currently getting glyphs from a composition. */
6770 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6771 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6772 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6774 it
->cmp_it
.from
= it
->cmp_it
.to
;
6779 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6781 it
->end_charpos
, Qnil
);
6784 else if (! it
->cmp_it
.reversed_p
)
6786 /* Composition created while scanning forward. */
6787 /* Update IT's char/byte positions to point to the first
6788 character of the next grapheme cluster, or to the
6789 character visually after the current composition. */
6790 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6791 bidi_move_to_visually_next (&it
->bidi_it
);
6792 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6793 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6795 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6797 /* Proceed to the next grapheme cluster. */
6798 it
->cmp_it
.from
= it
->cmp_it
.to
;
6802 /* No more grapheme clusters in this composition.
6803 Find the next stop position. */
6804 EMACS_INT stop
= it
->end_charpos
;
6805 if (it
->bidi_it
.scan_dir
< 0)
6806 /* Now we are scanning backward and don't know
6809 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6810 IT_BYTEPOS (*it
), stop
, Qnil
);
6815 /* Composition created while scanning backward. */
6816 /* Update IT's char/byte positions to point to the last
6817 character of the previous grapheme cluster, or the
6818 character visually after the current composition. */
6819 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6820 bidi_move_to_visually_next (&it
->bidi_it
);
6821 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6822 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6823 if (it
->cmp_it
.from
> 0)
6825 /* Proceed to the previous grapheme cluster. */
6826 it
->cmp_it
.to
= it
->cmp_it
.from
;
6830 /* No more grapheme clusters in this composition.
6831 Find the next stop position. */
6832 EMACS_INT stop
= it
->end_charpos
;
6833 if (it
->bidi_it
.scan_dir
< 0)
6834 /* Now we are scanning backward and don't know
6837 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6838 IT_BYTEPOS (*it
), stop
, Qnil
);
6844 xassert (it
->len
!= 0);
6848 IT_BYTEPOS (*it
) += it
->len
;
6849 IT_CHARPOS (*it
) += 1;
6853 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
6854 /* If this is a new paragraph, determine its base
6855 direction (a.k.a. its base embedding level). */
6856 if (it
->bidi_it
.new_paragraph
)
6857 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
6858 bidi_move_to_visually_next (&it
->bidi_it
);
6859 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6860 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6861 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
6863 /* As the scan direction was changed, we must
6864 re-compute the stop position for composition. */
6865 EMACS_INT stop
= it
->end_charpos
;
6866 if (it
->bidi_it
.scan_dir
< 0)
6868 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
6869 IT_BYTEPOS (*it
), stop
, Qnil
);
6872 xassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
6876 case GET_FROM_C_STRING
:
6877 /* Current display element of IT is from a C string. */
6879 /* If the string position is beyond string's end, it means
6880 next_element_from_c_string is padding the string with
6881 blanks, in which case we bypass the bidi iterator,
6882 because it cannot deal with such virtual characters. */
6883 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
6885 IT_BYTEPOS (*it
) += it
->len
;
6886 IT_CHARPOS (*it
) += 1;
6890 bidi_move_to_visually_next (&it
->bidi_it
);
6891 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6892 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6896 case GET_FROM_DISPLAY_VECTOR
:
6897 /* Current display element of IT is from a display table entry.
6898 Advance in the display table definition. Reset it to null if
6899 end reached, and continue with characters from buffers/
6901 ++it
->current
.dpvec_index
;
6903 /* Restore face of the iterator to what they were before the
6904 display vector entry (these entries may contain faces). */
6905 it
->face_id
= it
->saved_face_id
;
6907 if (it
->dpvec
+ it
->current
.dpvec_index
== it
->dpend
)
6909 int recheck_faces
= it
->ellipsis_p
;
6912 it
->method
= GET_FROM_C_STRING
;
6913 else if (STRINGP (it
->string
))
6914 it
->method
= GET_FROM_STRING
;
6917 it
->method
= GET_FROM_BUFFER
;
6918 it
->object
= it
->w
->buffer
;
6922 it
->current
.dpvec_index
= -1;
6924 /* Skip over characters which were displayed via IT->dpvec. */
6925 if (it
->dpvec_char_len
< 0)
6926 reseat_at_next_visible_line_start (it
, 1);
6927 else if (it
->dpvec_char_len
> 0)
6929 if (it
->method
== GET_FROM_STRING
6930 && it
->n_overlay_strings
> 0)
6931 it
->ignore_overlay_strings_at_pos_p
= 1;
6932 it
->len
= it
->dpvec_char_len
;
6933 set_iterator_to_next (it
, reseat_p
);
6936 /* Maybe recheck faces after display vector */
6938 it
->stop_charpos
= IT_CHARPOS (*it
);
6942 case GET_FROM_STRING
:
6943 /* Current display element is a character from a Lisp string. */
6944 xassert (it
->s
== NULL
&& STRINGP (it
->string
));
6945 if (it
->cmp_it
.id
>= 0)
6951 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
6952 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
6953 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6954 it
->cmp_it
.from
= it
->cmp_it
.to
;
6958 composition_compute_stop_pos (&it
->cmp_it
,
6959 IT_STRING_CHARPOS (*it
),
6960 IT_STRING_BYTEPOS (*it
),
6961 it
->end_charpos
, it
->string
);
6964 else if (! it
->cmp_it
.reversed_p
)
6966 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6967 bidi_move_to_visually_next (&it
->bidi_it
);
6968 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6969 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6971 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
6972 it
->cmp_it
.from
= it
->cmp_it
.to
;
6975 EMACS_INT stop
= it
->end_charpos
;
6976 if (it
->bidi_it
.scan_dir
< 0)
6978 composition_compute_stop_pos (&it
->cmp_it
,
6979 IT_STRING_CHARPOS (*it
),
6980 IT_STRING_BYTEPOS (*it
), stop
,
6986 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
6987 bidi_move_to_visually_next (&it
->bidi_it
);
6988 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6989 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6990 if (it
->cmp_it
.from
> 0)
6991 it
->cmp_it
.to
= it
->cmp_it
.from
;
6994 EMACS_INT stop
= it
->end_charpos
;
6995 if (it
->bidi_it
.scan_dir
< 0)
6997 composition_compute_stop_pos (&it
->cmp_it
,
6998 IT_STRING_CHARPOS (*it
),
6999 IT_STRING_BYTEPOS (*it
), stop
,
7007 /* If the string position is beyond string's end, it
7008 means next_element_from_string is padding the string
7009 with blanks, in which case we bypass the bidi
7010 iterator, because it cannot deal with such virtual
7012 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7014 IT_STRING_BYTEPOS (*it
) += it
->len
;
7015 IT_STRING_CHARPOS (*it
) += 1;
7019 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7021 bidi_move_to_visually_next (&it
->bidi_it
);
7022 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7023 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7024 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7026 EMACS_INT stop
= it
->end_charpos
;
7028 if (it
->bidi_it
.scan_dir
< 0)
7030 composition_compute_stop_pos (&it
->cmp_it
,
7031 IT_STRING_CHARPOS (*it
),
7032 IT_STRING_BYTEPOS (*it
), stop
,
7038 consider_string_end
:
7040 if (it
->current
.overlay_string_index
>= 0)
7042 /* IT->string is an overlay string. Advance to the
7043 next, if there is one. */
7044 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7047 next_overlay_string (it
);
7049 setup_for_ellipsis (it
, 0);
7054 /* IT->string is not an overlay string. If we reached
7055 its end, and there is something on IT->stack, proceed
7056 with what is on the stack. This can be either another
7057 string, this time an overlay string, or a buffer. */
7058 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7062 if (it
->method
== GET_FROM_STRING
)
7063 goto consider_string_end
;
7068 case GET_FROM_IMAGE
:
7069 case GET_FROM_STRETCH
:
7070 /* The position etc with which we have to proceed are on
7071 the stack. The position may be at the end of a string,
7072 if the `display' property takes up the whole string. */
7073 xassert (it
->sp
> 0);
7075 if (it
->method
== GET_FROM_STRING
)
7076 goto consider_string_end
;
7080 /* There are no other methods defined, so this should be a bug. */
7084 xassert (it
->method
!= GET_FROM_STRING
7085 || (STRINGP (it
->string
)
7086 && IT_STRING_CHARPOS (*it
) >= 0));
7089 /* Load IT's display element fields with information about the next
7090 display element which comes from a display table entry or from the
7091 result of translating a control character to one of the forms `^C'
7094 IT->dpvec holds the glyphs to return as characters.
7095 IT->saved_face_id holds the face id before the display vector--it
7096 is restored into IT->face_id in set_iterator_to_next. */
7099 next_element_from_display_vector (struct it
*it
)
7104 xassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7106 it
->face_id
= it
->saved_face_id
;
7108 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7109 That seemed totally bogus - so I changed it... */
7110 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7112 if (GLYPH_CODE_P (gc
) && GLYPH_CODE_CHAR_VALID_P (gc
))
7114 it
->c
= GLYPH_CODE_CHAR (gc
);
7115 it
->len
= CHAR_BYTES (it
->c
);
7117 /* The entry may contain a face id to use. Such a face id is
7118 the id of a Lisp face, not a realized face. A face id of
7119 zero means no face is specified. */
7120 if (it
->dpvec_face_id
>= 0)
7121 it
->face_id
= it
->dpvec_face_id
;
7124 EMACS_INT lface_id
= GLYPH_CODE_FACE (gc
);
7126 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7131 /* Display table entry is invalid. Return a space. */
7132 it
->c
= ' ', it
->len
= 1;
7134 /* Don't change position and object of the iterator here. They are
7135 still the values of the character that had this display table
7136 entry or was translated, and that's what we want. */
7137 it
->what
= IT_CHARACTER
;
7141 /* Get the first element of string/buffer in the visual order, after
7142 being reseated to a new position in a string or a buffer. */
7144 get_visually_first_element (struct it
*it
)
7146 int string_p
= STRINGP (it
->string
) || it
->s
;
7147 EMACS_INT eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7148 EMACS_INT bob
= (string_p
? 0 : BEGV
);
7150 if (STRINGP (it
->string
))
7152 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7153 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7157 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7158 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7161 if (it
->bidi_it
.charpos
== eob
)
7163 /* Nothing to do, but reset the FIRST_ELT flag, like
7164 bidi_paragraph_init does, because we are not going to
7166 it
->bidi_it
.first_elt
= 0;
7168 else if (it
->bidi_it
.charpos
== bob
7170 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7171 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7173 /* If we are at the beginning of a line/string, we can produce
7174 the next element right away. */
7175 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7176 bidi_move_to_visually_next (&it
->bidi_it
);
7180 EMACS_INT orig_bytepos
= it
->bidi_it
.bytepos
;
7182 /* We need to prime the bidi iterator starting at the line's or
7183 string's beginning, before we will be able to produce the
7186 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7189 it
->bidi_it
.charpos
= find_next_newline_no_quit (IT_CHARPOS (*it
),
7191 it
->bidi_it
.bytepos
= CHAR_TO_BYTE (it
->bidi_it
.charpos
);
7193 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7196 /* Now return to buffer/string position where we were asked
7197 to get the next display element, and produce that. */
7198 bidi_move_to_visually_next (&it
->bidi_it
);
7200 while (it
->bidi_it
.bytepos
!= orig_bytepos
7201 && it
->bidi_it
.charpos
< eob
);
7204 /* Adjust IT's position information to where we ended up. */
7205 if (STRINGP (it
->string
))
7207 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7208 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7212 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7213 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7216 if (STRINGP (it
->string
) || !it
->s
)
7218 EMACS_INT stop
, charpos
, bytepos
;
7220 if (STRINGP (it
->string
))
7223 stop
= SCHARS (it
->string
);
7224 if (stop
> it
->end_charpos
)
7225 stop
= it
->end_charpos
;
7226 charpos
= IT_STRING_CHARPOS (*it
);
7227 bytepos
= IT_STRING_BYTEPOS (*it
);
7231 stop
= it
->end_charpos
;
7232 charpos
= IT_CHARPOS (*it
);
7233 bytepos
= IT_BYTEPOS (*it
);
7235 if (it
->bidi_it
.scan_dir
< 0)
7237 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7242 /* Load IT with the next display element from Lisp string IT->string.
7243 IT->current.string_pos is the current position within the string.
7244 If IT->current.overlay_string_index >= 0, the Lisp string is an
7248 next_element_from_string (struct it
*it
)
7250 struct text_pos position
;
7252 xassert (STRINGP (it
->string
));
7253 xassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7254 xassert (IT_STRING_CHARPOS (*it
) >= 0);
7255 position
= it
->current
.string_pos
;
7257 /* With bidi reordering, the character to display might not be the
7258 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7259 that we were reseat()ed to a new string, whose paragraph
7260 direction is not known. */
7261 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7263 get_visually_first_element (it
);
7264 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7267 /* Time to check for invisible text? */
7268 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7270 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7273 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7274 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7276 /* With bidi non-linear iteration, we could find
7277 ourselves far beyond the last computed stop_charpos,
7278 with several other stop positions in between that we
7279 missed. Scan them all now, in buffer's logical
7280 order, until we find and handle the last stop_charpos
7281 that precedes our current position. */
7282 handle_stop_backwards (it
, it
->stop_charpos
);
7283 return GET_NEXT_DISPLAY_ELEMENT (it
);
7289 /* Take note of the stop position we just moved
7290 across, for when we will move back across it. */
7291 it
->prev_stop
= it
->stop_charpos
;
7292 /* If we are at base paragraph embedding level, take
7293 note of the last stop position seen at this
7295 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7296 it
->base_level_stop
= it
->stop_charpos
;
7300 /* Since a handler may have changed IT->method, we must
7302 return GET_NEXT_DISPLAY_ELEMENT (it
);
7306 /* If we are before prev_stop, we may have overstepped
7307 on our way backwards a stop_pos, and if so, we need
7308 to handle that stop_pos. */
7309 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7310 /* We can sometimes back up for reasons that have nothing
7311 to do with bidi reordering. E.g., compositions. The
7312 code below is only needed when we are above the base
7313 embedding level, so test for that explicitly. */
7314 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7316 /* If we lost track of base_level_stop, we have no better
7317 place for handle_stop_backwards to start from than string
7318 beginning. This happens, e.g., when we were reseated to
7319 the previous screenful of text by vertical-motion. */
7320 if (it
->base_level_stop
<= 0
7321 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7322 it
->base_level_stop
= 0;
7323 handle_stop_backwards (it
, it
->base_level_stop
);
7324 return GET_NEXT_DISPLAY_ELEMENT (it
);
7328 if (it
->current
.overlay_string_index
>= 0)
7330 /* Get the next character from an overlay string. In overlay
7331 strings, There is no field width or padding with spaces to
7333 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7338 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7339 IT_STRING_BYTEPOS (*it
),
7340 it
->bidi_it
.scan_dir
< 0
7342 : SCHARS (it
->string
))
7343 && next_element_from_composition (it
))
7347 else if (STRING_MULTIBYTE (it
->string
))
7349 const unsigned char *s
= (SDATA (it
->string
)
7350 + IT_STRING_BYTEPOS (*it
));
7351 it
->c
= string_char_and_length (s
, &it
->len
);
7355 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7361 /* Get the next character from a Lisp string that is not an
7362 overlay string. Such strings come from the mode line, for
7363 example. We may have to pad with spaces, or truncate the
7364 string. See also next_element_from_c_string. */
7365 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7370 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7372 /* Pad with spaces. */
7373 it
->c
= ' ', it
->len
= 1;
7374 CHARPOS (position
) = BYTEPOS (position
) = -1;
7376 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7377 IT_STRING_BYTEPOS (*it
),
7378 it
->bidi_it
.scan_dir
< 0
7380 : it
->string_nchars
)
7381 && next_element_from_composition (it
))
7385 else if (STRING_MULTIBYTE (it
->string
))
7387 const unsigned char *s
= (SDATA (it
->string
)
7388 + IT_STRING_BYTEPOS (*it
));
7389 it
->c
= string_char_and_length (s
, &it
->len
);
7393 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7398 /* Record what we have and where it came from. */
7399 it
->what
= IT_CHARACTER
;
7400 it
->object
= it
->string
;
7401 it
->position
= position
;
7406 /* Load IT with next display element from C string IT->s.
7407 IT->string_nchars is the maximum number of characters to return
7408 from the string. IT->end_charpos may be greater than
7409 IT->string_nchars when this function is called, in which case we
7410 may have to return padding spaces. Value is zero if end of string
7411 reached, including padding spaces. */
7414 next_element_from_c_string (struct it
*it
)
7419 xassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7420 it
->what
= IT_CHARACTER
;
7421 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7424 /* With bidi reordering, the character to display might not be the
7425 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7426 we were reseated to a new string, whose paragraph direction is
7428 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7429 get_visually_first_element (it
);
7431 /* IT's position can be greater than IT->string_nchars in case a
7432 field width or precision has been specified when the iterator was
7434 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7436 /* End of the game. */
7440 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7442 /* Pad with spaces. */
7443 it
->c
= ' ', it
->len
= 1;
7444 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7446 else if (it
->multibyte_p
)
7447 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7449 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7455 /* Set up IT to return characters from an ellipsis, if appropriate.
7456 The definition of the ellipsis glyphs may come from a display table
7457 entry. This function fills IT with the first glyph from the
7458 ellipsis if an ellipsis is to be displayed. */
7461 next_element_from_ellipsis (struct it
*it
)
7463 if (it
->selective_display_ellipsis_p
)
7464 setup_for_ellipsis (it
, it
->len
);
7467 /* The face at the current position may be different from the
7468 face we find after the invisible text. Remember what it
7469 was in IT->saved_face_id, and signal that it's there by
7470 setting face_before_selective_p. */
7471 it
->saved_face_id
= it
->face_id
;
7472 it
->method
= GET_FROM_BUFFER
;
7473 it
->object
= it
->w
->buffer
;
7474 reseat_at_next_visible_line_start (it
, 1);
7475 it
->face_before_selective_p
= 1;
7478 return GET_NEXT_DISPLAY_ELEMENT (it
);
7482 /* Deliver an image display element. The iterator IT is already
7483 filled with image information (done in handle_display_prop). Value
7488 next_element_from_image (struct it
*it
)
7490 it
->what
= IT_IMAGE
;
7491 it
->ignore_overlay_strings_at_pos_p
= 0;
7496 /* Fill iterator IT with next display element from a stretch glyph
7497 property. IT->object is the value of the text property. Value is
7501 next_element_from_stretch (struct it
*it
)
7503 it
->what
= IT_STRETCH
;
7507 /* Scan backwards from IT's current position until we find a stop
7508 position, or until BEGV. This is called when we find ourself
7509 before both the last known prev_stop and base_level_stop while
7510 reordering bidirectional text. */
7513 compute_stop_pos_backwards (struct it
*it
)
7515 const int SCAN_BACK_LIMIT
= 1000;
7516 struct text_pos pos
;
7517 struct display_pos save_current
= it
->current
;
7518 struct text_pos save_position
= it
->position
;
7519 EMACS_INT charpos
= IT_CHARPOS (*it
);
7520 EMACS_INT where_we_are
= charpos
;
7521 EMACS_INT save_stop_pos
= it
->stop_charpos
;
7522 EMACS_INT save_end_pos
= it
->end_charpos
;
7524 xassert (NILP (it
->string
) && !it
->s
);
7525 xassert (it
->bidi_p
);
7529 it
->end_charpos
= min (charpos
+ 1, ZV
);
7530 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
7531 SET_TEXT_POS (pos
, charpos
, BYTE_TO_CHAR (charpos
));
7532 reseat_1 (it
, pos
, 0);
7533 compute_stop_pos (it
);
7534 /* We must advance forward, right? */
7535 if (it
->stop_charpos
<= charpos
)
7538 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
7540 if (it
->stop_charpos
<= where_we_are
)
7541 it
->prev_stop
= it
->stop_charpos
;
7543 it
->prev_stop
= BEGV
;
7545 it
->current
= save_current
;
7546 it
->position
= save_position
;
7547 it
->stop_charpos
= save_stop_pos
;
7548 it
->end_charpos
= save_end_pos
;
7551 /* Scan forward from CHARPOS in the current buffer/string, until we
7552 find a stop position > current IT's position. Then handle the stop
7553 position before that. This is called when we bump into a stop
7554 position while reordering bidirectional text. CHARPOS should be
7555 the last previously processed stop_pos (or BEGV/0, if none were
7556 processed yet) whose position is less that IT's current
7560 handle_stop_backwards (struct it
*it
, EMACS_INT charpos
)
7562 int bufp
= !STRINGP (it
->string
);
7563 EMACS_INT where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
7564 struct display_pos save_current
= it
->current
;
7565 struct text_pos save_position
= it
->position
;
7566 struct text_pos pos1
;
7567 EMACS_INT next_stop
;
7569 /* Scan in strict logical order. */
7570 xassert (it
->bidi_p
);
7574 it
->prev_stop
= charpos
;
7577 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
7578 reseat_1 (it
, pos1
, 0);
7581 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
7582 compute_stop_pos (it
);
7583 /* We must advance forward, right? */
7584 if (it
->stop_charpos
<= it
->prev_stop
)
7586 charpos
= it
->stop_charpos
;
7588 while (charpos
<= where_we_are
);
7591 it
->current
= save_current
;
7592 it
->position
= save_position
;
7593 next_stop
= it
->stop_charpos
;
7594 it
->stop_charpos
= it
->prev_stop
;
7596 it
->stop_charpos
= next_stop
;
7599 /* Load IT with the next display element from current_buffer. Value
7600 is zero if end of buffer reached. IT->stop_charpos is the next
7601 position at which to stop and check for text properties or buffer
7605 next_element_from_buffer (struct it
*it
)
7609 xassert (IT_CHARPOS (*it
) >= BEGV
);
7610 xassert (NILP (it
->string
) && !it
->s
);
7611 xassert (!it
->bidi_p
7612 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
7613 && it
->bidi_it
.string
.s
== NULL
));
7615 /* With bidi reordering, the character to display might not be the
7616 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7617 we were reseat()ed to a new buffer position, which is potentially
7618 a different paragraph. */
7619 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7621 get_visually_first_element (it
);
7622 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7625 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
7627 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7629 int overlay_strings_follow_p
;
7631 /* End of the game, except when overlay strings follow that
7632 haven't been returned yet. */
7633 if (it
->overlay_strings_at_end_processed_p
)
7634 overlay_strings_follow_p
= 0;
7637 it
->overlay_strings_at_end_processed_p
= 1;
7638 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
7641 if (overlay_strings_follow_p
)
7642 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
7646 it
->position
= it
->current
.pos
;
7650 else if (!(!it
->bidi_p
7651 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7652 || IT_CHARPOS (*it
) == it
->stop_charpos
))
7654 /* With bidi non-linear iteration, we could find ourselves
7655 far beyond the last computed stop_charpos, with several
7656 other stop positions in between that we missed. Scan
7657 them all now, in buffer's logical order, until we find
7658 and handle the last stop_charpos that precedes our
7659 current position. */
7660 handle_stop_backwards (it
, it
->stop_charpos
);
7661 return GET_NEXT_DISPLAY_ELEMENT (it
);
7667 /* Take note of the stop position we just moved across,
7668 for when we will move back across it. */
7669 it
->prev_stop
= it
->stop_charpos
;
7670 /* If we are at base paragraph embedding level, take
7671 note of the last stop position seen at this
7673 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7674 it
->base_level_stop
= it
->stop_charpos
;
7677 return GET_NEXT_DISPLAY_ELEMENT (it
);
7681 /* If we are before prev_stop, we may have overstepped on
7682 our way backwards a stop_pos, and if so, we need to
7683 handle that stop_pos. */
7684 && IT_CHARPOS (*it
) < it
->prev_stop
7685 /* We can sometimes back up for reasons that have nothing
7686 to do with bidi reordering. E.g., compositions. The
7687 code below is only needed when we are above the base
7688 embedding level, so test for that explicitly. */
7689 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7691 if (it
->base_level_stop
<= 0
7692 || IT_CHARPOS (*it
) < it
->base_level_stop
)
7694 /* If we lost track of base_level_stop, we need to find
7695 prev_stop by looking backwards. This happens, e.g., when
7696 we were reseated to the previous screenful of text by
7698 it
->base_level_stop
= BEGV
;
7699 compute_stop_pos_backwards (it
);
7700 handle_stop_backwards (it
, it
->prev_stop
);
7703 handle_stop_backwards (it
, it
->base_level_stop
);
7704 return GET_NEXT_DISPLAY_ELEMENT (it
);
7708 /* No face changes, overlays etc. in sight, so just return a
7709 character from current_buffer. */
7713 /* Maybe run the redisplay end trigger hook. Performance note:
7714 This doesn't seem to cost measurable time. */
7715 if (it
->redisplay_end_trigger_charpos
7717 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
7718 run_redisplay_end_trigger_hook (it
);
7720 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
7721 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
7723 && next_element_from_composition (it
))
7728 /* Get the next character, maybe multibyte. */
7729 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
7730 if (it
->multibyte_p
&& !ASCII_BYTE_P (*p
))
7731 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
7733 it
->c
= *p
, it
->len
= 1;
7735 /* Record what we have and where it came from. */
7736 it
->what
= IT_CHARACTER
;
7737 it
->object
= it
->w
->buffer
;
7738 it
->position
= it
->current
.pos
;
7740 /* Normally we return the character found above, except when we
7741 really want to return an ellipsis for selective display. */
7746 /* A value of selective > 0 means hide lines indented more
7747 than that number of columns. */
7748 if (it
->selective
> 0
7749 && IT_CHARPOS (*it
) + 1 < ZV
7750 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
7751 IT_BYTEPOS (*it
) + 1,
7754 success_p
= next_element_from_ellipsis (it
);
7755 it
->dpvec_char_len
= -1;
7758 else if (it
->c
== '\r' && it
->selective
== -1)
7760 /* A value of selective == -1 means that everything from the
7761 CR to the end of the line is invisible, with maybe an
7762 ellipsis displayed for it. */
7763 success_p
= next_element_from_ellipsis (it
);
7764 it
->dpvec_char_len
= -1;
7769 /* Value is zero if end of buffer reached. */
7770 xassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
7775 /* Run the redisplay end trigger hook for IT. */
7778 run_redisplay_end_trigger_hook (struct it
*it
)
7780 Lisp_Object args
[3];
7782 /* IT->glyph_row should be non-null, i.e. we should be actually
7783 displaying something, or otherwise we should not run the hook. */
7784 xassert (it
->glyph_row
);
7786 /* Set up hook arguments. */
7787 args
[0] = Qredisplay_end_trigger_functions
;
7788 args
[1] = it
->window
;
7789 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
7790 it
->redisplay_end_trigger_charpos
= 0;
7792 /* Since we are *trying* to run these functions, don't try to run
7793 them again, even if they get an error. */
7794 it
->w
->redisplay_end_trigger
= Qnil
;
7795 Frun_hook_with_args (3, args
);
7797 /* Notice if it changed the face of the character we are on. */
7798 handle_face_prop (it
);
7802 /* Deliver a composition display element. Unlike the other
7803 next_element_from_XXX, this function is not registered in the array
7804 get_next_element[]. It is called from next_element_from_buffer and
7805 next_element_from_string when necessary. */
7808 next_element_from_composition (struct it
*it
)
7810 it
->what
= IT_COMPOSITION
;
7811 it
->len
= it
->cmp_it
.nbytes
;
7812 if (STRINGP (it
->string
))
7816 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7817 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7820 it
->position
= it
->current
.string_pos
;
7821 it
->object
= it
->string
;
7822 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
7823 IT_STRING_BYTEPOS (*it
), it
->string
);
7829 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7830 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7833 if (it
->bidi_it
.new_paragraph
)
7834 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7835 /* Resync the bidi iterator with IT's new position.
7836 FIXME: this doesn't support bidirectional text. */
7837 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
7838 bidi_move_to_visually_next (&it
->bidi_it
);
7842 it
->position
= it
->current
.pos
;
7843 it
->object
= it
->w
->buffer
;
7844 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
7845 IT_BYTEPOS (*it
), Qnil
);
7852 /***********************************************************************
7853 Moving an iterator without producing glyphs
7854 ***********************************************************************/
7856 /* Check if iterator is at a position corresponding to a valid buffer
7857 position after some move_it_ call. */
7859 #define IT_POS_VALID_AFTER_MOVE_P(it) \
7860 ((it)->method == GET_FROM_STRING \
7861 ? IT_STRING_CHARPOS (*it) == 0 \
7865 /* Move iterator IT to a specified buffer or X position within one
7866 line on the display without producing glyphs.
7868 OP should be a bit mask including some or all of these bits:
7869 MOVE_TO_X: Stop upon reaching x-position TO_X.
7870 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
7871 Regardless of OP's value, stop upon reaching the end of the display line.
7873 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
7874 This means, in particular, that TO_X includes window's horizontal
7877 The return value has several possible values that
7878 say what condition caused the scan to stop:
7880 MOVE_POS_MATCH_OR_ZV
7881 - when TO_POS or ZV was reached.
7884 -when TO_X was reached before TO_POS or ZV were reached.
7887 - when we reached the end of the display area and the line must
7891 - when we reached the end of the display area and the line is
7895 - when we stopped at a line end, i.e. a newline or a CR and selective
7898 static enum move_it_result
7899 move_it_in_display_line_to (struct it
*it
,
7900 EMACS_INT to_charpos
, int to_x
,
7901 enum move_operation_enum op
)
7903 enum move_it_result result
= MOVE_UNDEFINED
;
7904 struct glyph_row
*saved_glyph_row
;
7905 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
7906 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
7907 void *ppos_data
= NULL
;
7909 enum it_method prev_method
= it
->method
;
7910 EMACS_INT prev_pos
= IT_CHARPOS (*it
);
7911 int saw_smaller_pos
= prev_pos
< to_charpos
;
7913 /* Don't produce glyphs in produce_glyphs. */
7914 saved_glyph_row
= it
->glyph_row
;
7915 it
->glyph_row
= NULL
;
7917 /* Use wrap_it to save a copy of IT wherever a word wrap could
7918 occur. Use atpos_it to save a copy of IT at the desired buffer
7919 position, if found, so that we can scan ahead and check if the
7920 word later overshoots the window edge. Use atx_it similarly, for
7926 /* Use ppos_it under bidi reordering to save a copy of IT for the
7927 position > CHARPOS that is the closest to CHARPOS. We restore
7928 that position in IT when we have scanned the entire display line
7929 without finding a match for CHARPOS and all the character
7930 positions are greater than CHARPOS. */
7933 SAVE_IT (ppos_it
, *it
, ppos_data
);
7934 SET_TEXT_POS (ppos_it
.current
.pos
, ZV
, ZV_BYTE
);
7935 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
7936 SAVE_IT (ppos_it
, *it
, ppos_data
);
7939 #define BUFFER_POS_REACHED_P() \
7940 ((op & MOVE_TO_POS) != 0 \
7941 && BUFFERP (it->object) \
7942 && (IT_CHARPOS (*it) == to_charpos \
7944 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
7945 && IT_CHARPOS (*it) > to_charpos) \
7946 || (it->what == IT_COMPOSITION \
7947 && ((IT_CHARPOS (*it) > to_charpos \
7948 && to_charpos >= it->cmp_it.charpos) \
7949 || (IT_CHARPOS (*it) < to_charpos \
7950 && to_charpos <= it->cmp_it.charpos)))) \
7951 && (it->method == GET_FROM_BUFFER \
7952 || (it->method == GET_FROM_DISPLAY_VECTOR \
7953 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
7955 /* If there's a line-/wrap-prefix, handle it. */
7956 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
7957 && it
->current_y
< it
->last_visible_y
)
7958 handle_line_prefix (it
);
7960 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
7961 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
7965 int x
, i
, ascent
= 0, descent
= 0;
7967 /* Utility macro to reset an iterator with x, ascent, and descent. */
7968 #define IT_RESET_X_ASCENT_DESCENT(IT) \
7969 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
7970 (IT)->max_descent = descent)
7972 /* Stop if we move beyond TO_CHARPOS (after an image or a
7973 display string or stretch glyph). */
7974 if ((op
& MOVE_TO_POS
) != 0
7975 && BUFFERP (it
->object
)
7976 && it
->method
== GET_FROM_BUFFER
7978 /* When the iterator is at base embedding level, we
7979 are guaranteed that characters are delivered for
7980 display in strictly increasing order of their
7981 buffer positions. */
7982 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7983 && IT_CHARPOS (*it
) > to_charpos
)
7985 && (prev_method
== GET_FROM_IMAGE
7986 || prev_method
== GET_FROM_STRETCH
7987 || prev_method
== GET_FROM_STRING
)
7988 /* Passed TO_CHARPOS from left to right. */
7989 && ((prev_pos
< to_charpos
7990 && IT_CHARPOS (*it
) > to_charpos
)
7991 /* Passed TO_CHARPOS from right to left. */
7992 || (prev_pos
> to_charpos
7993 && IT_CHARPOS (*it
) < to_charpos
)))))
7995 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
7997 result
= MOVE_POS_MATCH_OR_ZV
;
8000 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8001 /* If wrap_it is valid, the current position might be in a
8002 word that is wrapped. So, save the iterator in
8003 atpos_it and continue to see if wrapping happens. */
8004 SAVE_IT (atpos_it
, *it
, atpos_data
);
8007 /* Stop when ZV reached.
8008 We used to stop here when TO_CHARPOS reached as well, but that is
8009 too soon if this glyph does not fit on this line. So we handle it
8010 explicitly below. */
8011 if (!get_next_display_element (it
))
8013 result
= MOVE_POS_MATCH_OR_ZV
;
8017 if (it
->line_wrap
== TRUNCATE
)
8019 if (BUFFER_POS_REACHED_P ())
8021 result
= MOVE_POS_MATCH_OR_ZV
;
8027 if (it
->line_wrap
== WORD_WRAP
)
8029 if (IT_DISPLAYING_WHITESPACE (it
))
8033 /* We have reached a glyph that follows one or more
8034 whitespace characters. If the position is
8035 already found, we are done. */
8036 if (atpos_it
.sp
>= 0)
8038 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8039 result
= MOVE_POS_MATCH_OR_ZV
;
8044 RESTORE_IT (it
, &atx_it
, atx_data
);
8045 result
= MOVE_X_REACHED
;
8048 /* Otherwise, we can wrap here. */
8049 SAVE_IT (wrap_it
, *it
, wrap_data
);
8055 /* Remember the line height for the current line, in case
8056 the next element doesn't fit on the line. */
8057 ascent
= it
->max_ascent
;
8058 descent
= it
->max_descent
;
8060 /* The call to produce_glyphs will get the metrics of the
8061 display element IT is loaded with. Record the x-position
8062 before this display element, in case it doesn't fit on the
8066 PRODUCE_GLYPHS (it
);
8068 if (it
->area
!= TEXT_AREA
)
8070 prev_method
= it
->method
;
8071 if (it
->method
== GET_FROM_BUFFER
)
8072 prev_pos
= IT_CHARPOS (*it
);
8073 set_iterator_to_next (it
, 1);
8074 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8075 SET_TEXT_POS (this_line_min_pos
,
8076 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8078 && (op
& MOVE_TO_POS
)
8079 && IT_CHARPOS (*it
) > to_charpos
8080 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8081 SAVE_IT (ppos_it
, *it
, ppos_data
);
8085 /* The number of glyphs we get back in IT->nglyphs will normally
8086 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8087 character on a terminal frame, or (iii) a line end. For the
8088 second case, IT->nglyphs - 1 padding glyphs will be present.
8089 (On X frames, there is only one glyph produced for a
8090 composite character.)
8092 The behavior implemented below means, for continuation lines,
8093 that as many spaces of a TAB as fit on the current line are
8094 displayed there. For terminal frames, as many glyphs of a
8095 multi-glyph character are displayed in the current line, too.
8096 This is what the old redisplay code did, and we keep it that
8097 way. Under X, the whole shape of a complex character must
8098 fit on the line or it will be completely displayed in the
8101 Note that both for tabs and padding glyphs, all glyphs have
8105 /* More than one glyph or glyph doesn't fit on line. All
8106 glyphs have the same width. */
8107 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8109 int x_before_this_char
= x
;
8110 int hpos_before_this_char
= it
->hpos
;
8112 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8114 new_x
= x
+ single_glyph_width
;
8116 /* We want to leave anything reaching TO_X to the caller. */
8117 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8119 if (BUFFER_POS_REACHED_P ())
8121 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8122 goto buffer_pos_reached
;
8123 if (atpos_it
.sp
< 0)
8125 SAVE_IT (atpos_it
, *it
, atpos_data
);
8126 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8131 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8134 result
= MOVE_X_REACHED
;
8139 SAVE_IT (atx_it
, *it
, atx_data
);
8140 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8145 if (/* Lines are continued. */
8146 it
->line_wrap
!= TRUNCATE
8147 && (/* And glyph doesn't fit on the line. */
8148 new_x
> it
->last_visible_x
8149 /* Or it fits exactly and we're on a window
8151 || (new_x
== it
->last_visible_x
8152 && FRAME_WINDOW_P (it
->f
))))
8154 if (/* IT->hpos == 0 means the very first glyph
8155 doesn't fit on the line, e.g. a wide image. */
8157 || (new_x
== it
->last_visible_x
8158 && FRAME_WINDOW_P (it
->f
)))
8161 it
->current_x
= new_x
;
8163 /* The character's last glyph just barely fits
8165 if (i
== it
->nglyphs
- 1)
8167 /* If this is the destination position,
8168 return a position *before* it in this row,
8169 now that we know it fits in this row. */
8170 if (BUFFER_POS_REACHED_P ())
8172 if (it
->line_wrap
!= WORD_WRAP
8175 it
->hpos
= hpos_before_this_char
;
8176 it
->current_x
= x_before_this_char
;
8177 result
= MOVE_POS_MATCH_OR_ZV
;
8180 if (it
->line_wrap
== WORD_WRAP
8183 SAVE_IT (atpos_it
, *it
, atpos_data
);
8184 atpos_it
.current_x
= x_before_this_char
;
8185 atpos_it
.hpos
= hpos_before_this_char
;
8189 prev_method
= it
->method
;
8190 if (it
->method
== GET_FROM_BUFFER
)
8191 prev_pos
= IT_CHARPOS (*it
);
8192 set_iterator_to_next (it
, 1);
8193 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8194 SET_TEXT_POS (this_line_min_pos
,
8195 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8196 /* On graphical terminals, newlines may
8197 "overflow" into the fringe if
8198 overflow-newline-into-fringe is non-nil.
8199 On text-only terminals, newlines may
8200 overflow into the last glyph on the
8202 if (!FRAME_WINDOW_P (it
->f
)
8203 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8205 if (!get_next_display_element (it
))
8207 result
= MOVE_POS_MATCH_OR_ZV
;
8210 if (BUFFER_POS_REACHED_P ())
8212 if (ITERATOR_AT_END_OF_LINE_P (it
))
8213 result
= MOVE_POS_MATCH_OR_ZV
;
8215 result
= MOVE_LINE_CONTINUED
;
8218 if (ITERATOR_AT_END_OF_LINE_P (it
))
8220 result
= MOVE_NEWLINE_OR_CR
;
8227 IT_RESET_X_ASCENT_DESCENT (it
);
8229 if (wrap_it
.sp
>= 0)
8231 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8236 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8238 result
= MOVE_LINE_CONTINUED
;
8242 if (BUFFER_POS_REACHED_P ())
8244 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8245 goto buffer_pos_reached
;
8246 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8248 SAVE_IT (atpos_it
, *it
, atpos_data
);
8249 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8253 if (new_x
> it
->first_visible_x
)
8255 /* Glyph is visible. Increment number of glyphs that
8256 would be displayed. */
8261 if (result
!= MOVE_UNDEFINED
)
8264 else if (BUFFER_POS_REACHED_P ())
8267 IT_RESET_X_ASCENT_DESCENT (it
);
8268 result
= MOVE_POS_MATCH_OR_ZV
;
8271 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8273 /* Stop when TO_X specified and reached. This check is
8274 necessary here because of lines consisting of a line end,
8275 only. The line end will not produce any glyphs and we
8276 would never get MOVE_X_REACHED. */
8277 xassert (it
->nglyphs
== 0);
8278 result
= MOVE_X_REACHED
;
8282 /* Is this a line end? If yes, we're done. */
8283 if (ITERATOR_AT_END_OF_LINE_P (it
))
8285 /* If we are past TO_CHARPOS, but never saw any character
8286 positions smaller than TO_CHARPOS, return
8287 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8289 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8291 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8293 if (IT_CHARPOS (ppos_it
) < ZV
)
8295 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8296 result
= MOVE_POS_MATCH_OR_ZV
;
8299 goto buffer_pos_reached
;
8301 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8302 && IT_CHARPOS (*it
) > to_charpos
)
8303 goto buffer_pos_reached
;
8305 result
= MOVE_NEWLINE_OR_CR
;
8308 result
= MOVE_NEWLINE_OR_CR
;
8312 prev_method
= it
->method
;
8313 if (it
->method
== GET_FROM_BUFFER
)
8314 prev_pos
= IT_CHARPOS (*it
);
8315 /* The current display element has been consumed. Advance
8317 set_iterator_to_next (it
, 1);
8318 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8319 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8320 if (IT_CHARPOS (*it
) < to_charpos
)
8321 saw_smaller_pos
= 1;
8323 && (op
& MOVE_TO_POS
)
8324 && IT_CHARPOS (*it
) >= to_charpos
8325 && IT_CHARPOS (*it
) < IT_CHARPOS (ppos_it
))
8326 SAVE_IT (ppos_it
, *it
, ppos_data
);
8328 /* Stop if lines are truncated and IT's current x-position is
8329 past the right edge of the window now. */
8330 if (it
->line_wrap
== TRUNCATE
8331 && it
->current_x
>= it
->last_visible_x
)
8333 if (!FRAME_WINDOW_P (it
->f
)
8334 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8338 if ((at_eob_p
= !get_next_display_element (it
))
8339 || BUFFER_POS_REACHED_P ()
8340 /* If we are past TO_CHARPOS, but never saw any
8341 character positions smaller than TO_CHARPOS,
8342 return MOVE_POS_MATCH_OR_ZV, like the
8343 unidirectional display did. */
8344 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8346 && IT_CHARPOS (*it
) > to_charpos
))
8349 && !at_eob_p
&& IT_CHARPOS (ppos_it
) < ZV
)
8350 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8351 result
= MOVE_POS_MATCH_OR_ZV
;
8354 if (ITERATOR_AT_END_OF_LINE_P (it
))
8356 result
= MOVE_NEWLINE_OR_CR
;
8360 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8362 && IT_CHARPOS (*it
) > to_charpos
)
8364 if (IT_CHARPOS (ppos_it
) < ZV
)
8365 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8366 result
= MOVE_POS_MATCH_OR_ZV
;
8369 result
= MOVE_LINE_TRUNCATED
;
8372 #undef IT_RESET_X_ASCENT_DESCENT
8375 #undef BUFFER_POS_REACHED_P
8377 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8378 restore the saved iterator. */
8379 if (atpos_it
.sp
>= 0)
8380 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8381 else if (atx_it
.sp
>= 0)
8382 RESTORE_IT (it
, &atx_it
, atx_data
);
8387 bidi_unshelve_cache (atpos_data
, 1);
8389 bidi_unshelve_cache (atx_data
, 1);
8391 bidi_unshelve_cache (wrap_data
, 1);
8393 bidi_unshelve_cache (ppos_data
, 1);
8395 /* Restore the iterator settings altered at the beginning of this
8397 it
->glyph_row
= saved_glyph_row
;
8401 /* For external use. */
8403 move_it_in_display_line (struct it
*it
,
8404 EMACS_INT to_charpos
, int to_x
,
8405 enum move_operation_enum op
)
8407 if (it
->line_wrap
== WORD_WRAP
8408 && (op
& MOVE_TO_X
))
8411 void *save_data
= NULL
;
8414 SAVE_IT (save_it
, *it
, save_data
);
8415 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8416 /* When word-wrap is on, TO_X may lie past the end
8417 of a wrapped line. Then it->current is the
8418 character on the next line, so backtrack to the
8419 space before the wrap point. */
8420 if (skip
== MOVE_LINE_CONTINUED
)
8422 int prev_x
= max (it
->current_x
- 1, 0);
8423 RESTORE_IT (it
, &save_it
, save_data
);
8424 move_it_in_display_line_to
8425 (it
, -1, prev_x
, MOVE_TO_X
);
8428 bidi_unshelve_cache (save_data
, 1);
8431 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8435 /* Move IT forward until it satisfies one or more of the criteria in
8436 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
8438 OP is a bit-mask that specifies where to stop, and in particular,
8439 which of those four position arguments makes a difference. See the
8440 description of enum move_operation_enum.
8442 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
8443 screen line, this function will set IT to the next position that is
8444 displayed to the right of TO_CHARPOS on the screen. */
8447 move_it_to (struct it
*it
, EMACS_INT to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
8449 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
8450 int line_height
, line_start_x
= 0, reached
= 0;
8451 void *backup_data
= NULL
;
8455 if (op
& MOVE_TO_VPOS
)
8457 /* If no TO_CHARPOS and no TO_X specified, stop at the
8458 start of the line TO_VPOS. */
8459 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
8461 if (it
->vpos
== to_vpos
)
8467 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
8471 /* TO_VPOS >= 0 means stop at TO_X in the line at
8472 TO_VPOS, or at TO_POS, whichever comes first. */
8473 if (it
->vpos
== to_vpos
)
8479 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8481 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
8486 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
8488 /* We have reached TO_X but not in the line we want. */
8489 skip
= move_it_in_display_line_to (it
, to_charpos
,
8491 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8499 else if (op
& MOVE_TO_Y
)
8501 struct it it_backup
;
8503 if (it
->line_wrap
== WORD_WRAP
)
8504 SAVE_IT (it_backup
, *it
, backup_data
);
8506 /* TO_Y specified means stop at TO_X in the line containing
8507 TO_Y---or at TO_CHARPOS if this is reached first. The
8508 problem is that we can't really tell whether the line
8509 contains TO_Y before we have completely scanned it, and
8510 this may skip past TO_X. What we do is to first scan to
8513 If TO_X is not specified, use a TO_X of zero. The reason
8514 is to make the outcome of this function more predictable.
8515 If we didn't use TO_X == 0, we would stop at the end of
8516 the line which is probably not what a caller would expect
8518 skip
= move_it_in_display_line_to
8519 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
8520 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
8522 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
8523 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8525 else if (skip
== MOVE_X_REACHED
)
8527 /* If TO_X was reached, we want to know whether TO_Y is
8528 in the line. We know this is the case if the already
8529 scanned glyphs make the line tall enough. Otherwise,
8530 we must check by scanning the rest of the line. */
8531 line_height
= it
->max_ascent
+ it
->max_descent
;
8532 if (to_y
>= it
->current_y
8533 && to_y
< it
->current_y
+ line_height
)
8538 SAVE_IT (it_backup
, *it
, backup_data
);
8539 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
8540 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
8542 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
8543 line_height
= it
->max_ascent
+ it
->max_descent
;
8544 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8546 if (to_y
>= it
->current_y
8547 && to_y
< it
->current_y
+ line_height
)
8549 /* If TO_Y is in this line and TO_X was reached
8550 above, we scanned too far. We have to restore
8551 IT's settings to the ones before skipping. */
8552 RESTORE_IT (it
, &it_backup
, backup_data
);
8558 if (skip
== MOVE_POS_MATCH_OR_ZV
)
8564 /* Check whether TO_Y is in this line. */
8565 line_height
= it
->max_ascent
+ it
->max_descent
;
8566 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
8568 if (to_y
>= it
->current_y
8569 && to_y
< it
->current_y
+ line_height
)
8571 /* When word-wrap is on, TO_X may lie past the end
8572 of a wrapped line. Then it->current is the
8573 character on the next line, so backtrack to the
8574 space before the wrap point. */
8575 if (skip
== MOVE_LINE_CONTINUED
8576 && it
->line_wrap
== WORD_WRAP
)
8578 int prev_x
= max (it
->current_x
- 1, 0);
8579 RESTORE_IT (it
, &it_backup
, backup_data
);
8580 skip
= move_it_in_display_line_to
8581 (it
, -1, prev_x
, MOVE_TO_X
);
8590 else if (BUFFERP (it
->object
)
8591 && (it
->method
== GET_FROM_BUFFER
8592 || it
->method
== GET_FROM_STRETCH
)
8593 && IT_CHARPOS (*it
) >= to_charpos
8594 /* Under bidi iteration, a call to set_iterator_to_next
8595 can scan far beyond to_charpos if the initial
8596 portion of the next line needs to be reordered. In
8597 that case, give move_it_in_display_line_to another
8600 && it
->bidi_it
.scan_dir
== -1))
8601 skip
= MOVE_POS_MATCH_OR_ZV
;
8603 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
8607 case MOVE_POS_MATCH_OR_ZV
:
8611 case MOVE_NEWLINE_OR_CR
:
8612 set_iterator_to_next (it
, 1);
8613 it
->continuation_lines_width
= 0;
8616 case MOVE_LINE_TRUNCATED
:
8617 it
->continuation_lines_width
= 0;
8618 reseat_at_next_visible_line_start (it
, 0);
8619 if ((op
& MOVE_TO_POS
) != 0
8620 && IT_CHARPOS (*it
) > to_charpos
)
8627 case MOVE_LINE_CONTINUED
:
8628 /* For continued lines ending in a tab, some of the glyphs
8629 associated with the tab are displayed on the current
8630 line. Since it->current_x does not include these glyphs,
8631 we use it->last_visible_x instead. */
8634 it
->continuation_lines_width
+= it
->last_visible_x
;
8635 /* When moving by vpos, ensure that the iterator really
8636 advances to the next line (bug#847, bug#969). Fixme:
8637 do we need to do this in other circumstances? */
8638 if (it
->current_x
!= it
->last_visible_x
8639 && (op
& MOVE_TO_VPOS
)
8640 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
8642 line_start_x
= it
->current_x
+ it
->pixel_width
8643 - it
->last_visible_x
;
8644 set_iterator_to_next (it
, 0);
8648 it
->continuation_lines_width
+= it
->current_x
;
8655 /* Reset/increment for the next run. */
8656 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
8657 it
->current_x
= line_start_x
;
8660 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8662 last_height
= it
->max_ascent
+ it
->max_descent
;
8663 last_max_ascent
= it
->max_ascent
;
8664 it
->max_ascent
= it
->max_descent
= 0;
8669 /* On text terminals, we may stop at the end of a line in the middle
8670 of a multi-character glyph. If the glyph itself is continued,
8671 i.e. it is actually displayed on the next line, don't treat this
8672 stopping point as valid; move to the next line instead (unless
8673 that brings us offscreen). */
8674 if (!FRAME_WINDOW_P (it
->f
)
8676 && IT_CHARPOS (*it
) == to_charpos
8677 && it
->what
== IT_CHARACTER
8679 && it
->line_wrap
== WINDOW_WRAP
8680 && it
->current_x
== it
->last_visible_x
- 1
8683 && it
->vpos
< XFASTINT (it
->w
->window_end_vpos
))
8685 it
->continuation_lines_width
+= it
->current_x
;
8686 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
8687 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
8689 last_height
= it
->max_ascent
+ it
->max_descent
;
8690 last_max_ascent
= it
->max_ascent
;
8694 bidi_unshelve_cache (backup_data
, 1);
8696 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
8700 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
8702 If DY > 0, move IT backward at least that many pixels. DY = 0
8703 means move IT backward to the preceding line start or BEGV. This
8704 function may move over more than DY pixels if IT->current_y - DY
8705 ends up in the middle of a line; in this case IT->current_y will be
8706 set to the top of the line moved to. */
8709 move_it_vertically_backward (struct it
*it
, int dy
)
8713 void *it2data
= NULL
, *it3data
= NULL
;
8714 EMACS_INT start_pos
;
8719 start_pos
= IT_CHARPOS (*it
);
8721 /* Estimate how many newlines we must move back. */
8722 nlines
= max (1, dy
/ FRAME_LINE_HEIGHT (it
->f
));
8724 /* Set the iterator's position that many lines back. */
8725 while (nlines
-- && IT_CHARPOS (*it
) > BEGV
)
8726 back_to_previous_visible_line_start (it
);
8728 /* Reseat the iterator here. When moving backward, we don't want
8729 reseat to skip forward over invisible text, set up the iterator
8730 to deliver from overlay strings at the new position etc. So,
8731 use reseat_1 here. */
8732 reseat_1 (it
, it
->current
.pos
, 1);
8734 /* We are now surely at a line start. */
8735 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
8736 reordering is in effect. */
8737 it
->continuation_lines_width
= 0;
8739 /* Move forward and see what y-distance we moved. First move to the
8740 start of the next line so that we get its height. We need this
8741 height to be able to tell whether we reached the specified
8743 SAVE_IT (it2
, *it
, it2data
);
8744 it2
.max_ascent
= it2
.max_descent
= 0;
8747 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
8748 MOVE_TO_POS
| MOVE_TO_VPOS
);
8750 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
8751 /* If we are in a display string which starts at START_POS,
8752 and that display string includes a newline, and we are
8753 right after that newline (i.e. at the beginning of a
8754 display line), exit the loop, because otherwise we will
8755 infloop, since move_it_to will see that it is already at
8756 START_POS and will not move. */
8757 || (it2
.method
== GET_FROM_STRING
8758 && IT_CHARPOS (it2
) == start_pos
8759 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
8760 xassert (IT_CHARPOS (*it
) >= BEGV
);
8761 SAVE_IT (it3
, it2
, it3data
);
8763 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
8764 xassert (IT_CHARPOS (*it
) >= BEGV
);
8765 /* H is the actual vertical distance from the position in *IT
8766 and the starting position. */
8767 h
= it2
.current_y
- it
->current_y
;
8768 /* NLINES is the distance in number of lines. */
8769 nlines
= it2
.vpos
- it
->vpos
;
8771 /* Correct IT's y and vpos position
8772 so that they are relative to the starting point. */
8778 /* DY == 0 means move to the start of the screen line. The
8779 value of nlines is > 0 if continuation lines were involved,
8780 or if the original IT position was at start of a line. */
8781 RESTORE_IT (it
, it
, it2data
);
8783 move_it_by_lines (it
, nlines
);
8784 /* The above code moves us to some position NLINES down,
8785 usually to its first glyph (leftmost in an L2R line), but
8786 that's not necessarily the start of the line, under bidi
8787 reordering. We want to get to the character position
8788 that is immediately after the newline of the previous
8791 && !it
->continuation_lines_width
8792 && !STRINGP (it
->string
)
8793 && IT_CHARPOS (*it
) > BEGV
8794 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8797 find_next_newline_no_quit (IT_CHARPOS (*it
) - 1, -1);
8799 move_it_to (it
, nl_pos
, -1, -1, -1, MOVE_TO_POS
);
8801 bidi_unshelve_cache (it3data
, 1);
8805 /* The y-position we try to reach, relative to *IT.
8806 Note that H has been subtracted in front of the if-statement. */
8807 int target_y
= it
->current_y
+ h
- dy
;
8808 int y0
= it3
.current_y
;
8812 RESTORE_IT (&it3
, &it3
, it3data
);
8813 y1
= line_bottom_y (&it3
);
8814 line_height
= y1
- y0
;
8815 RESTORE_IT (it
, it
, it2data
);
8816 /* If we did not reach target_y, try to move further backward if
8817 we can. If we moved too far backward, try to move forward. */
8818 if (target_y
< it
->current_y
8819 /* This is heuristic. In a window that's 3 lines high, with
8820 a line height of 13 pixels each, recentering with point
8821 on the bottom line will try to move -39/2 = 19 pixels
8822 backward. Try to avoid moving into the first line. */
8823 && (it
->current_y
- target_y
8824 > min (window_box_height (it
->w
), line_height
* 2 / 3))
8825 && IT_CHARPOS (*it
) > BEGV
)
8827 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
8828 target_y
- it
->current_y
));
8829 dy
= it
->current_y
- target_y
;
8830 goto move_further_back
;
8832 else if (target_y
>= it
->current_y
+ line_height
8833 && IT_CHARPOS (*it
) < ZV
)
8835 /* Should move forward by at least one line, maybe more.
8837 Note: Calling move_it_by_lines can be expensive on
8838 terminal frames, where compute_motion is used (via
8839 vmotion) to do the job, when there are very long lines
8840 and truncate-lines is nil. That's the reason for
8841 treating terminal frames specially here. */
8843 if (!FRAME_WINDOW_P (it
->f
))
8844 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
8849 move_it_by_lines (it
, 1);
8851 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
8858 /* Move IT by a specified amount of pixel lines DY. DY negative means
8859 move backwards. DY = 0 means move to start of screen line. At the
8860 end, IT will be on the start of a screen line. */
8863 move_it_vertically (struct it
*it
, int dy
)
8866 move_it_vertically_backward (it
, -dy
);
8869 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
8870 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
8871 MOVE_TO_POS
| MOVE_TO_Y
);
8872 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
8874 /* If buffer ends in ZV without a newline, move to the start of
8875 the line to satisfy the post-condition. */
8876 if (IT_CHARPOS (*it
) == ZV
8878 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
8879 move_it_by_lines (it
, 0);
8884 /* Move iterator IT past the end of the text line it is in. */
8887 move_it_past_eol (struct it
*it
)
8889 enum move_it_result rc
;
8891 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
8892 if (rc
== MOVE_NEWLINE_OR_CR
)
8893 set_iterator_to_next (it
, 0);
8897 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
8898 negative means move up. DVPOS == 0 means move to the start of the
8901 Optimization idea: If we would know that IT->f doesn't use
8902 a face with proportional font, we could be faster for
8903 truncate-lines nil. */
8906 move_it_by_lines (struct it
*it
, int dvpos
)
8909 /* The commented-out optimization uses vmotion on terminals. This
8910 gives bad results, because elements like it->what, on which
8911 callers such as pos_visible_p rely, aren't updated. */
8912 /* struct position pos;
8913 if (!FRAME_WINDOW_P (it->f))
8915 struct text_pos textpos;
8917 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
8918 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
8919 reseat (it, textpos, 1);
8920 it->vpos += pos.vpos;
8921 it->current_y += pos.vpos;
8927 /* DVPOS == 0 means move to the start of the screen line. */
8928 move_it_vertically_backward (it
, 0);
8929 xassert (it
->current_x
== 0 && it
->hpos
== 0);
8930 /* Let next call to line_bottom_y calculate real line height */
8935 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
8936 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
8937 move_it_to (it
, IT_CHARPOS (*it
) + 1, -1, -1, -1, MOVE_TO_POS
);
8942 void *it2data
= NULL
;
8943 EMACS_INT start_charpos
, i
;
8945 /* Start at the beginning of the screen line containing IT's
8946 position. This may actually move vertically backwards,
8947 in case of overlays, so adjust dvpos accordingly. */
8949 move_it_vertically_backward (it
, 0);
8952 /* Go back -DVPOS visible lines and reseat the iterator there. */
8953 start_charpos
= IT_CHARPOS (*it
);
8954 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > BEGV
; --i
)
8955 back_to_previous_visible_line_start (it
);
8956 reseat (it
, it
->current
.pos
, 1);
8958 /* Move further back if we end up in a string or an image. */
8959 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
8961 /* First try to move to start of display line. */
8963 move_it_vertically_backward (it
, 0);
8965 if (IT_POS_VALID_AFTER_MOVE_P (it
))
8967 /* If start of line is still in string or image,
8968 move further back. */
8969 back_to_previous_visible_line_start (it
);
8970 reseat (it
, it
->current
.pos
, 1);
8974 it
->current_x
= it
->hpos
= 0;
8976 /* Above call may have moved too far if continuation lines
8977 are involved. Scan forward and see if it did. */
8978 SAVE_IT (it2
, *it
, it2data
);
8979 it2
.vpos
= it2
.current_y
= 0;
8980 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
8981 it
->vpos
-= it2
.vpos
;
8982 it
->current_y
-= it2
.current_y
;
8983 it
->current_x
= it
->hpos
= 0;
8985 /* If we moved too far back, move IT some lines forward. */
8986 if (it2
.vpos
> -dvpos
)
8988 int delta
= it2
.vpos
+ dvpos
;
8990 RESTORE_IT (&it2
, &it2
, it2data
);
8991 SAVE_IT (it2
, *it
, it2data
);
8992 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
8993 /* Move back again if we got too far ahead. */
8994 if (IT_CHARPOS (*it
) >= start_charpos
)
8995 RESTORE_IT (it
, &it2
, it2data
);
8997 bidi_unshelve_cache (it2data
, 1);
9000 RESTORE_IT (it
, it
, it2data
);
9004 /* Return 1 if IT points into the middle of a display vector. */
9007 in_display_vector_p (struct it
*it
)
9009 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9010 && it
->current
.dpvec_index
> 0
9011 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9015 /***********************************************************************
9017 ***********************************************************************/
9020 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9024 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9026 Lisp_Object args
[3];
9027 Lisp_Object msg
, fmt
;
9030 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9033 /* Do nothing if called asynchronously. Inserting text into
9034 a buffer may call after-change-functions and alike and
9035 that would means running Lisp asynchronously. */
9036 if (handling_signal
)
9040 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9042 args
[0] = fmt
= build_string (format
);
9045 msg
= Fformat (3, args
);
9047 len
= SBYTES (msg
) + 1;
9048 SAFE_ALLOCA (buffer
, char *, len
);
9049 memcpy (buffer
, SDATA (msg
), len
);
9051 message_dolog (buffer
, len
- 1, 1, 0);
9058 /* Output a newline in the *Messages* buffer if "needs" one. */
9061 message_log_maybe_newline (void)
9063 if (message_log_need_newline
)
9064 message_dolog ("", 0, 1, 0);
9068 /* Add a string M of length NBYTES to the message log, optionally
9069 terminated with a newline when NLFLAG is non-zero. MULTIBYTE, if
9070 nonzero, means interpret the contents of M as multibyte. This
9071 function calls low-level routines in order to bypass text property
9072 hooks, etc. which might not be safe to run.
9074 This may GC (insert may run before/after change hooks),
9075 so the buffer M must NOT point to a Lisp string. */
9078 message_dolog (const char *m
, EMACS_INT nbytes
, int nlflag
, int multibyte
)
9080 const unsigned char *msg
= (const unsigned char *) m
;
9082 if (!NILP (Vmemory_full
))
9085 if (!NILP (Vmessage_log_max
))
9087 struct buffer
*oldbuf
;
9088 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9089 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9090 EMACS_INT point_at_end
= 0;
9091 EMACS_INT zv_at_end
= 0;
9092 Lisp_Object old_deactivate_mark
, tem
;
9093 struct gcpro gcpro1
;
9095 old_deactivate_mark
= Vdeactivate_mark
;
9096 oldbuf
= current_buffer
;
9097 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9098 BVAR (current_buffer
, undo_list
) = Qt
;
9100 oldpoint
= message_dolog_marker1
;
9101 set_marker_restricted (oldpoint
, make_number (PT
), Qnil
);
9102 oldbegv
= message_dolog_marker2
;
9103 set_marker_restricted (oldbegv
, make_number (BEGV
), Qnil
);
9104 oldzv
= message_dolog_marker3
;
9105 set_marker_restricted (oldzv
, make_number (ZV
), Qnil
);
9106 GCPRO1 (old_deactivate_mark
);
9114 BEGV_BYTE
= BEG_BYTE
;
9117 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9119 /* Insert the string--maybe converting multibyte to single byte
9120 or vice versa, so that all the text fits the buffer. */
9122 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9128 /* Convert a multibyte string to single-byte
9129 for the *Message* buffer. */
9130 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9132 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9133 work
[0] = (ASCII_CHAR_P (c
)
9135 : multibyte_char_to_unibyte (c
));
9136 insert_1_both (work
, 1, 1, 1, 0, 0);
9139 else if (! multibyte
9140 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9144 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9145 /* Convert a single-byte string to multibyte
9146 for the *Message* buffer. */
9147 for (i
= 0; i
< nbytes
; i
++)
9150 MAKE_CHAR_MULTIBYTE (c
);
9151 char_bytes
= CHAR_STRING (c
, str
);
9152 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9156 insert_1 (m
, nbytes
, 1, 0, 0);
9160 EMACS_INT this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9162 insert_1 ("\n", 1, 1, 0, 0);
9164 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9166 this_bol_byte
= PT_BYTE
;
9168 /* See if this line duplicates the previous one.
9169 If so, combine duplicates. */
9172 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9174 prev_bol_byte
= PT_BYTE
;
9176 dups
= message_log_check_duplicate (prev_bol_byte
,
9180 del_range_both (prev_bol
, prev_bol_byte
,
9181 this_bol
, this_bol_byte
, 0);
9184 char dupstr
[sizeof " [ times]"
9185 + INT_STRLEN_BOUND (printmax_t
)];
9188 /* If you change this format, don't forget to also
9189 change message_log_check_duplicate. */
9190 sprintf (dupstr
, " [%"pMd
" times]", dups
);
9191 duplen
= strlen (dupstr
);
9192 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9193 insert_1 (dupstr
, duplen
, 1, 0, 1);
9198 /* If we have more than the desired maximum number of lines
9199 in the *Messages* buffer now, delete the oldest ones.
9200 This is safe because we don't have undo in this buffer. */
9202 if (NATNUMP (Vmessage_log_max
))
9204 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
9205 -XFASTINT (Vmessage_log_max
) - 1, 0);
9206 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
9209 BEGV
= XMARKER (oldbegv
)->charpos
;
9210 BEGV_BYTE
= marker_byte_position (oldbegv
);
9219 ZV
= XMARKER (oldzv
)->charpos
;
9220 ZV_BYTE
= marker_byte_position (oldzv
);
9224 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9226 /* We can't do Fgoto_char (oldpoint) because it will run some
9228 TEMP_SET_PT_BOTH (XMARKER (oldpoint
)->charpos
,
9229 XMARKER (oldpoint
)->bytepos
);
9232 unchain_marker (XMARKER (oldpoint
));
9233 unchain_marker (XMARKER (oldbegv
));
9234 unchain_marker (XMARKER (oldzv
));
9236 tem
= Fget_buffer_window (Fcurrent_buffer (), Qt
);
9237 set_buffer_internal (oldbuf
);
9239 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
9240 message_log_need_newline
= !nlflag
;
9241 Vdeactivate_mark
= old_deactivate_mark
;
9246 /* We are at the end of the buffer after just having inserted a newline.
9247 (Note: We depend on the fact we won't be crossing the gap.)
9248 Check to see if the most recent message looks a lot like the previous one.
9249 Return 0 if different, 1 if the new one should just replace it, or a
9250 value N > 1 if we should also append " [N times]". */
9253 message_log_check_duplicate (EMACS_INT prev_bol_byte
, EMACS_INT this_bol_byte
)
9256 EMACS_INT len
= Z_BYTE
- 1 - this_bol_byte
;
9258 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
9259 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
9261 for (i
= 0; i
< len
; i
++)
9263 if (i
>= 3 && p1
[i
-3] == '.' && p1
[i
-2] == '.' && p1
[i
-1] == '.')
9271 if (*p1
++ == ' ' && *p1
++ == '[')
9274 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
9275 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
9282 /* Display an echo area message M with a specified length of NBYTES
9283 bytes. The string may include null characters. If M is 0, clear
9284 out any existing message, and let the mini-buffer text show
9287 This may GC, so the buffer M must NOT point to a Lisp string. */
9290 message2 (const char *m
, EMACS_INT nbytes
, int multibyte
)
9292 /* First flush out any partial line written with print. */
9293 message_log_maybe_newline ();
9295 message_dolog (m
, nbytes
, 1, multibyte
);
9296 message2_nolog (m
, nbytes
, multibyte
);
9300 /* The non-logging counterpart of message2. */
9303 message2_nolog (const char *m
, EMACS_INT nbytes
, int multibyte
)
9305 struct frame
*sf
= SELECTED_FRAME ();
9306 message_enable_multibyte
= multibyte
;
9308 if (FRAME_INITIAL_P (sf
))
9310 if (noninteractive_need_newline
)
9311 putc ('\n', stderr
);
9312 noninteractive_need_newline
= 0;
9314 fwrite (m
, nbytes
, 1, stderr
);
9315 if (cursor_in_echo_area
== 0)
9316 fprintf (stderr
, "\n");
9319 /* A null message buffer means that the frame hasn't really been
9320 initialized yet. Error messages get reported properly by
9321 cmd_error, so this must be just an informative message; toss it. */
9322 else if (INTERACTIVE
9323 && sf
->glyphs_initialized_p
9324 && FRAME_MESSAGE_BUF (sf
))
9326 Lisp_Object mini_window
;
9329 /* Get the frame containing the mini-buffer
9330 that the selected frame is using. */
9331 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9332 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9334 FRAME_SAMPLE_VISIBILITY (f
);
9335 if (FRAME_VISIBLE_P (sf
)
9336 && ! FRAME_VISIBLE_P (f
))
9337 Fmake_frame_visible (WINDOW_FRAME (XWINDOW (mini_window
)));
9341 set_message (m
, Qnil
, nbytes
, multibyte
);
9342 if (minibuffer_auto_raise
)
9343 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9346 clear_message (1, 1);
9348 do_pending_window_change (0);
9349 echo_area_display (1);
9350 do_pending_window_change (0);
9351 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9352 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9357 /* Display an echo area message M with a specified length of NBYTES
9358 bytes. The string may include null characters. If M is not a
9359 string, clear out any existing message, and let the mini-buffer
9362 This function cancels echoing. */
9365 message3 (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9367 struct gcpro gcpro1
;
9370 clear_message (1,1);
9373 /* First flush out any partial line written with print. */
9374 message_log_maybe_newline ();
9380 SAFE_ALLOCA (buffer
, char *, nbytes
);
9381 memcpy (buffer
, SDATA (m
), nbytes
);
9382 message_dolog (buffer
, nbytes
, 1, multibyte
);
9385 message3_nolog (m
, nbytes
, multibyte
);
9391 /* The non-logging version of message3.
9392 This does not cancel echoing, because it is used for echoing.
9393 Perhaps we need to make a separate function for echoing
9394 and make this cancel echoing. */
9397 message3_nolog (Lisp_Object m
, EMACS_INT nbytes
, int multibyte
)
9399 struct frame
*sf
= SELECTED_FRAME ();
9400 message_enable_multibyte
= multibyte
;
9402 if (FRAME_INITIAL_P (sf
))
9404 if (noninteractive_need_newline
)
9405 putc ('\n', stderr
);
9406 noninteractive_need_newline
= 0;
9408 fwrite (SDATA (m
), nbytes
, 1, stderr
);
9409 if (cursor_in_echo_area
== 0)
9410 fprintf (stderr
, "\n");
9413 /* A null message buffer means that the frame hasn't really been
9414 initialized yet. Error messages get reported properly by
9415 cmd_error, so this must be just an informative message; toss it. */
9416 else if (INTERACTIVE
9417 && sf
->glyphs_initialized_p
9418 && FRAME_MESSAGE_BUF (sf
))
9420 Lisp_Object mini_window
;
9424 /* Get the frame containing the mini-buffer
9425 that the selected frame is using. */
9426 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9427 frame
= XWINDOW (mini_window
)->frame
;
9430 FRAME_SAMPLE_VISIBILITY (f
);
9431 if (FRAME_VISIBLE_P (sf
)
9432 && !FRAME_VISIBLE_P (f
))
9433 Fmake_frame_visible (frame
);
9435 if (STRINGP (m
) && SCHARS (m
) > 0)
9437 set_message (NULL
, m
, nbytes
, multibyte
);
9438 if (minibuffer_auto_raise
)
9439 Fraise_frame (frame
);
9440 /* Assume we are not echoing.
9441 (If we are, echo_now will override this.) */
9442 echo_message_buffer
= Qnil
;
9445 clear_message (1, 1);
9447 do_pending_window_change (0);
9448 echo_area_display (1);
9449 do_pending_window_change (0);
9450 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
!= 0 && ! gc_in_progress
)
9451 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
9456 /* Display a null-terminated echo area message M. If M is 0, clear
9457 out any existing message, and let the mini-buffer text show through.
9459 The buffer M must continue to exist until after the echo area gets
9460 cleared or some other message gets displayed there. Do not pass
9461 text that is stored in a Lisp string. Do not pass text in a buffer
9462 that was alloca'd. */
9465 message1 (const char *m
)
9467 message2 (m
, (m
? strlen (m
) : 0), 0);
9471 /* The non-logging counterpart of message1. */
9474 message1_nolog (const char *m
)
9476 message2_nolog (m
, (m
? strlen (m
) : 0), 0);
9479 /* Display a message M which contains a single %s
9480 which gets replaced with STRING. */
9483 message_with_string (const char *m
, Lisp_Object string
, int log
)
9485 CHECK_STRING (string
);
9491 if (noninteractive_need_newline
)
9492 putc ('\n', stderr
);
9493 noninteractive_need_newline
= 0;
9494 fprintf (stderr
, m
, SDATA (string
));
9495 if (!cursor_in_echo_area
)
9496 fprintf (stderr
, "\n");
9500 else if (INTERACTIVE
)
9502 /* The frame whose minibuffer we're going to display the message on.
9503 It may be larger than the selected frame, so we need
9504 to use its buffer, not the selected frame's buffer. */
9505 Lisp_Object mini_window
;
9506 struct frame
*f
, *sf
= SELECTED_FRAME ();
9508 /* Get the frame containing the minibuffer
9509 that the selected frame is using. */
9510 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9511 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9513 /* A null message buffer means that the frame hasn't really been
9514 initialized yet. Error messages get reported properly by
9515 cmd_error, so this must be just an informative message; toss it. */
9516 if (FRAME_MESSAGE_BUF (f
))
9518 Lisp_Object args
[2], msg
;
9519 struct gcpro gcpro1
, gcpro2
;
9521 args
[0] = build_string (m
);
9522 args
[1] = msg
= string
;
9523 GCPRO2 (args
[0], msg
);
9526 msg
= Fformat (2, args
);
9529 message3 (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9531 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
9535 /* Print should start at the beginning of the message
9536 buffer next time. */
9537 message_buf_print
= 0;
9543 /* Dump an informative message to the minibuf. If M is 0, clear out
9544 any existing message, and let the mini-buffer text show through. */
9547 vmessage (const char *m
, va_list ap
)
9553 if (noninteractive_need_newline
)
9554 putc ('\n', stderr
);
9555 noninteractive_need_newline
= 0;
9556 vfprintf (stderr
, m
, ap
);
9557 if (cursor_in_echo_area
== 0)
9558 fprintf (stderr
, "\n");
9562 else if (INTERACTIVE
)
9564 /* The frame whose mini-buffer we're going to display the message
9565 on. It may be larger than the selected frame, so we need to
9566 use its buffer, not the selected frame's buffer. */
9567 Lisp_Object mini_window
;
9568 struct frame
*f
, *sf
= SELECTED_FRAME ();
9570 /* Get the frame containing the mini-buffer
9571 that the selected frame is using. */
9572 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9573 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
9575 /* A null message buffer means that the frame hasn't really been
9576 initialized yet. Error messages get reported properly by
9577 cmd_error, so this must be just an informative message; toss
9579 if (FRAME_MESSAGE_BUF (f
))
9585 len
= doprnt (FRAME_MESSAGE_BUF (f
),
9586 FRAME_MESSAGE_BUF_SIZE (f
), m
, (char *)0, ap
);
9588 message2 (FRAME_MESSAGE_BUF (f
), len
, 0);
9593 /* Print should start at the beginning of the message
9594 buffer next time. */
9595 message_buf_print
= 0;
9601 message (const char *m
, ...)
9611 /* The non-logging version of message. */
9614 message_nolog (const char *m
, ...)
9616 Lisp_Object old_log_max
;
9619 old_log_max
= Vmessage_log_max
;
9620 Vmessage_log_max
= Qnil
;
9622 Vmessage_log_max
= old_log_max
;
9628 /* Display the current message in the current mini-buffer. This is
9629 only called from error handlers in process.c, and is not time
9633 update_echo_area (void)
9635 if (!NILP (echo_area_buffer
[0]))
9638 string
= Fcurrent_message ();
9639 message3 (string
, SBYTES (string
),
9640 !NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
9645 /* Make sure echo area buffers in `echo_buffers' are live.
9646 If they aren't, make new ones. */
9649 ensure_echo_area_buffers (void)
9653 for (i
= 0; i
< 2; ++i
)
9654 if (!BUFFERP (echo_buffer
[i
])
9655 || NILP (BVAR (XBUFFER (echo_buffer
[i
]), name
)))
9658 Lisp_Object old_buffer
;
9661 old_buffer
= echo_buffer
[i
];
9662 sprintf (name
, " *Echo Area %d*", i
);
9663 echo_buffer
[i
] = Fget_buffer_create (build_string (name
));
9664 BVAR (XBUFFER (echo_buffer
[i
]), truncate_lines
) = Qnil
;
9665 /* to force word wrap in echo area -
9666 it was decided to postpone this*/
9667 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
9669 for (j
= 0; j
< 2; ++j
)
9670 if (EQ (old_buffer
, echo_area_buffer
[j
]))
9671 echo_area_buffer
[j
] = echo_buffer
[i
];
9676 /* Call FN with args A1..A4 with either the current or last displayed
9677 echo_area_buffer as current buffer.
9679 WHICH zero means use the current message buffer
9680 echo_area_buffer[0]. If that is nil, choose a suitable buffer
9681 from echo_buffer[] and clear it.
9683 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
9684 suitable buffer from echo_buffer[] and clear it.
9686 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
9687 that the current message becomes the last displayed one, make
9688 choose a suitable buffer for echo_area_buffer[0], and clear it.
9690 Value is what FN returns. */
9693 with_echo_area_buffer (struct window
*w
, int which
,
9694 int (*fn
) (EMACS_INT
, Lisp_Object
, EMACS_INT
, EMACS_INT
),
9695 EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9698 int this_one
, the_other
, clear_buffer_p
, rc
;
9699 int count
= SPECPDL_INDEX ();
9701 /* If buffers aren't live, make new ones. */
9702 ensure_echo_area_buffers ();
9707 this_one
= 0, the_other
= 1;
9709 this_one
= 1, the_other
= 0;
9712 this_one
= 0, the_other
= 1;
9715 /* We need a fresh one in case the current echo buffer equals
9716 the one containing the last displayed echo area message. */
9717 if (!NILP (echo_area_buffer
[this_one
])
9718 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
9719 echo_area_buffer
[this_one
] = Qnil
;
9722 /* Choose a suitable buffer from echo_buffer[] is we don't
9724 if (NILP (echo_area_buffer
[this_one
]))
9726 echo_area_buffer
[this_one
]
9727 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
9728 ? echo_buffer
[the_other
]
9729 : echo_buffer
[this_one
]);
9733 buffer
= echo_area_buffer
[this_one
];
9735 /* Don't get confused by reusing the buffer used for echoing
9736 for a different purpose. */
9737 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
9740 record_unwind_protect (unwind_with_echo_area_buffer
,
9741 with_echo_area_buffer_unwind_data (w
));
9743 /* Make the echo area buffer current. Note that for display
9744 purposes, it is not necessary that the displayed window's buffer
9745 == current_buffer, except for text property lookup. So, let's
9746 only set that buffer temporarily here without doing a full
9747 Fset_window_buffer. We must also change w->pointm, though,
9748 because otherwise an assertions in unshow_buffer fails, and Emacs
9750 set_buffer_internal_1 (XBUFFER (buffer
));
9754 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
9757 BVAR (current_buffer
, undo_list
) = Qt
;
9758 BVAR (current_buffer
, read_only
) = Qnil
;
9759 specbind (Qinhibit_read_only
, Qt
);
9760 specbind (Qinhibit_modification_hooks
, Qt
);
9762 if (clear_buffer_p
&& Z
> BEG
)
9765 xassert (BEGV
>= BEG
);
9766 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9768 rc
= fn (a1
, a2
, a3
, a4
);
9770 xassert (BEGV
>= BEG
);
9771 xassert (ZV
<= Z
&& ZV
>= BEGV
);
9773 unbind_to (count
, Qnil
);
9778 /* Save state that should be preserved around the call to the function
9779 FN called in with_echo_area_buffer. */
9782 with_echo_area_buffer_unwind_data (struct window
*w
)
9785 Lisp_Object vector
, tmp
;
9787 /* Reduce consing by keeping one vector in
9788 Vwith_echo_area_save_vector. */
9789 vector
= Vwith_echo_area_save_vector
;
9790 Vwith_echo_area_save_vector
= Qnil
;
9793 vector
= Fmake_vector (make_number (7), Qnil
);
9795 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
9796 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
9797 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
9801 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
9802 ASET (vector
, i
, w
->buffer
); ++i
;
9803 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->charpos
)); ++i
;
9804 ASET (vector
, i
, make_number (XMARKER (w
->pointm
)->bytepos
)); ++i
;
9809 for (; i
< end
; ++i
)
9810 ASET (vector
, i
, Qnil
);
9813 xassert (i
== ASIZE (vector
));
9818 /* Restore global state from VECTOR which was created by
9819 with_echo_area_buffer_unwind_data. */
9822 unwind_with_echo_area_buffer (Lisp_Object vector
)
9824 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
9825 Vdeactivate_mark
= AREF (vector
, 1);
9826 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
9828 if (WINDOWP (AREF (vector
, 3)))
9831 Lisp_Object buffer
, charpos
, bytepos
;
9833 w
= XWINDOW (AREF (vector
, 3));
9834 buffer
= AREF (vector
, 4);
9835 charpos
= AREF (vector
, 5);
9836 bytepos
= AREF (vector
, 6);
9839 set_marker_both (w
->pointm
, buffer
,
9840 XFASTINT (charpos
), XFASTINT (bytepos
));
9843 Vwith_echo_area_save_vector
= vector
;
9848 /* Set up the echo area for use by print functions. MULTIBYTE_P
9849 non-zero means we will print multibyte. */
9852 setup_echo_area_for_printing (int multibyte_p
)
9854 /* If we can't find an echo area any more, exit. */
9855 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9858 ensure_echo_area_buffers ();
9860 if (!message_buf_print
)
9862 /* A message has been output since the last time we printed.
9863 Choose a fresh echo area buffer. */
9864 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9865 echo_area_buffer
[0] = echo_buffer
[1];
9867 echo_area_buffer
[0] = echo_buffer
[0];
9869 /* Switch to that buffer and clear it. */
9870 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9871 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9875 int count
= SPECPDL_INDEX ();
9876 specbind (Qinhibit_read_only
, Qt
);
9877 /* Note that undo recording is always disabled. */
9879 unbind_to (count
, Qnil
);
9881 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
9883 /* Set up the buffer for the multibyteness we need. */
9885 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9886 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
9888 /* Raise the frame containing the echo area. */
9889 if (minibuffer_auto_raise
)
9891 struct frame
*sf
= SELECTED_FRAME ();
9892 Lisp_Object mini_window
;
9893 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
9894 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
9897 message_log_maybe_newline ();
9898 message_buf_print
= 1;
9902 if (NILP (echo_area_buffer
[0]))
9904 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
9905 echo_area_buffer
[0] = echo_buffer
[1];
9907 echo_area_buffer
[0] = echo_buffer
[0];
9910 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
9912 /* Someone switched buffers between print requests. */
9913 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
9914 BVAR (current_buffer
, truncate_lines
) = Qnil
;
9920 /* Display an echo area message in window W. Value is non-zero if W's
9921 height is changed. If display_last_displayed_message_p is
9922 non-zero, display the message that was last displayed, otherwise
9923 display the current message. */
9926 display_echo_area (struct window
*w
)
9928 int i
, no_message_p
, window_height_changed_p
, count
;
9930 /* Temporarily disable garbage collections while displaying the echo
9931 area. This is done because a GC can print a message itself.
9932 That message would modify the echo area buffer's contents while a
9933 redisplay of the buffer is going on, and seriously confuse
9935 count
= inhibit_garbage_collection ();
9937 /* If there is no message, we must call display_echo_area_1
9938 nevertheless because it resizes the window. But we will have to
9939 reset the echo_area_buffer in question to nil at the end because
9940 with_echo_area_buffer will sets it to an empty buffer. */
9941 i
= display_last_displayed_message_p
? 1 : 0;
9942 no_message_p
= NILP (echo_area_buffer
[i
]);
9944 window_height_changed_p
9945 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
9946 display_echo_area_1
,
9947 (intptr_t) w
, Qnil
, 0, 0);
9950 echo_area_buffer
[i
] = Qnil
;
9952 unbind_to (count
, Qnil
);
9953 return window_height_changed_p
;
9957 /* Helper for display_echo_area. Display the current buffer which
9958 contains the current echo area message in window W, a mini-window,
9959 a pointer to which is passed in A1. A2..A4 are currently not used.
9960 Change the height of W so that all of the message is displayed.
9961 Value is non-zero if height of W was changed. */
9964 display_echo_area_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
9967 struct window
*w
= (struct window
*) i1
;
9969 struct text_pos start
;
9970 int window_height_changed_p
= 0;
9972 /* Do this before displaying, so that we have a large enough glyph
9973 matrix for the display. If we can't get enough space for the
9974 whole text, display the last N lines. That works by setting w->start. */
9975 window_height_changed_p
= resize_mini_window (w
, 0);
9977 /* Use the starting position chosen by resize_mini_window. */
9978 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
9981 clear_glyph_matrix (w
->desired_matrix
);
9982 XSETWINDOW (window
, w
);
9983 try_window (window
, start
, 0);
9985 return window_height_changed_p
;
9989 /* Resize the echo area window to exactly the size needed for the
9990 currently displayed message, if there is one. If a mini-buffer
9991 is active, don't shrink it. */
9994 resize_echo_area_exactly (void)
9996 if (BUFFERP (echo_area_buffer
[0])
9997 && WINDOWP (echo_area_window
))
9999 struct window
*w
= XWINDOW (echo_area_window
);
10001 Lisp_Object resize_exactly
;
10003 if (minibuf_level
== 0)
10004 resize_exactly
= Qt
;
10006 resize_exactly
= Qnil
;
10008 resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10009 (intptr_t) w
, resize_exactly
,
10013 ++windows_or_buffers_changed
;
10014 ++update_mode_lines
;
10015 redisplay_internal ();
10021 /* Callback function for with_echo_area_buffer, when used from
10022 resize_echo_area_exactly. A1 contains a pointer to the window to
10023 resize, EXACTLY non-nil means resize the mini-window exactly to the
10024 size of the text displayed. A3 and A4 are not used. Value is what
10025 resize_mini_window returns. */
10028 resize_mini_window_1 (EMACS_INT a1
, Lisp_Object exactly
, EMACS_INT a3
, EMACS_INT a4
)
10031 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10035 /* Resize mini-window W to fit the size of its contents. EXACT_P
10036 means size the window exactly to the size needed. Otherwise, it's
10037 only enlarged until W's buffer is empty.
10039 Set W->start to the right place to begin display. If the whole
10040 contents fit, start at the beginning. Otherwise, start so as
10041 to make the end of the contents appear. This is particularly
10042 important for y-or-n-p, but seems desirable generally.
10044 Value is non-zero if the window height has been changed. */
10047 resize_mini_window (struct window
*w
, int exact_p
)
10049 struct frame
*f
= XFRAME (w
->frame
);
10050 int window_height_changed_p
= 0;
10052 xassert (MINI_WINDOW_P (w
));
10054 /* By default, start display at the beginning. */
10055 set_marker_both (w
->start
, w
->buffer
,
10056 BUF_BEGV (XBUFFER (w
->buffer
)),
10057 BUF_BEGV_BYTE (XBUFFER (w
->buffer
)));
10059 /* Don't resize windows while redisplaying a window; it would
10060 confuse redisplay functions when the size of the window they are
10061 displaying changes from under them. Such a resizing can happen,
10062 for instance, when which-func prints a long message while
10063 we are running fontification-functions. We're running these
10064 functions with safe_call which binds inhibit-redisplay to t. */
10065 if (!NILP (Vinhibit_redisplay
))
10068 /* Nil means don't try to resize. */
10069 if (NILP (Vresize_mini_windows
)
10070 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10073 if (!FRAME_MINIBUF_ONLY_P (f
))
10076 struct window
*root
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10077 int total_height
= WINDOW_TOTAL_LINES (root
) + WINDOW_TOTAL_LINES (w
);
10078 int height
, max_height
;
10079 int unit
= FRAME_LINE_HEIGHT (f
);
10080 struct text_pos start
;
10081 struct buffer
*old_current_buffer
= NULL
;
10083 if (current_buffer
!= XBUFFER (w
->buffer
))
10085 old_current_buffer
= current_buffer
;
10086 set_buffer_internal (XBUFFER (w
->buffer
));
10089 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10091 /* Compute the max. number of lines specified by the user. */
10092 if (FLOATP (Vmax_mini_window_height
))
10093 max_height
= XFLOATINT (Vmax_mini_window_height
) * FRAME_LINES (f
);
10094 else if (INTEGERP (Vmax_mini_window_height
))
10095 max_height
= XINT (Vmax_mini_window_height
);
10097 max_height
= total_height
/ 4;
10099 /* Correct that max. height if it's bogus. */
10100 max_height
= max (1, max_height
);
10101 max_height
= min (total_height
, max_height
);
10103 /* Find out the height of the text in the window. */
10104 if (it
.line_wrap
== TRUNCATE
)
10109 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10110 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10111 height
= it
.current_y
+ last_height
;
10113 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10114 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10115 height
= (height
+ unit
- 1) / unit
;
10118 /* Compute a suitable window start. */
10119 if (height
> max_height
)
10121 height
= max_height
;
10122 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10123 move_it_vertically_backward (&it
, (height
- 1) * unit
);
10124 start
= it
.current
.pos
;
10127 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10128 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10130 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10132 /* Let it grow only, until we display an empty message, in which
10133 case the window shrinks again. */
10134 if (height
> WINDOW_TOTAL_LINES (w
))
10136 int old_height
= WINDOW_TOTAL_LINES (w
);
10137 freeze_window_starts (f
, 1);
10138 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10139 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10141 else if (height
< WINDOW_TOTAL_LINES (w
)
10142 && (exact_p
|| BEGV
== ZV
))
10144 int old_height
= WINDOW_TOTAL_LINES (w
);
10145 freeze_window_starts (f
, 0);
10146 shrink_mini_window (w
);
10147 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10152 /* Always resize to exact size needed. */
10153 if (height
> WINDOW_TOTAL_LINES (w
))
10155 int old_height
= WINDOW_TOTAL_LINES (w
);
10156 freeze_window_starts (f
, 1);
10157 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10158 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10160 else if (height
< WINDOW_TOTAL_LINES (w
))
10162 int old_height
= WINDOW_TOTAL_LINES (w
);
10163 freeze_window_starts (f
, 0);
10164 shrink_mini_window (w
);
10168 freeze_window_starts (f
, 1);
10169 grow_mini_window (w
, height
- WINDOW_TOTAL_LINES (w
));
10172 window_height_changed_p
= WINDOW_TOTAL_LINES (w
) != old_height
;
10176 if (old_current_buffer
)
10177 set_buffer_internal (old_current_buffer
);
10180 return window_height_changed_p
;
10184 /* Value is the current message, a string, or nil if there is no
10185 current message. */
10188 current_message (void)
10192 if (!BUFFERP (echo_area_buffer
[0]))
10196 with_echo_area_buffer (0, 0, current_message_1
,
10197 (intptr_t) &msg
, Qnil
, 0, 0);
10199 echo_area_buffer
[0] = Qnil
;
10207 current_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10210 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10213 *msg
= make_buffer_string (BEG
, Z
, 1);
10220 /* Push the current message on Vmessage_stack for later restauration
10221 by restore_message. Value is non-zero if the current message isn't
10222 empty. This is a relatively infrequent operation, so it's not
10223 worth optimizing. */
10226 push_message (void)
10229 msg
= current_message ();
10230 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10231 return STRINGP (msg
);
10235 /* Restore message display from the top of Vmessage_stack. */
10238 restore_message (void)
10242 xassert (CONSP (Vmessage_stack
));
10243 msg
= XCAR (Vmessage_stack
);
10245 message3_nolog (msg
, SBYTES (msg
), STRING_MULTIBYTE (msg
));
10247 message3_nolog (msg
, 0, 0);
10251 /* Handler for record_unwind_protect calling pop_message. */
10254 pop_message_unwind (Lisp_Object dummy
)
10260 /* Pop the top-most entry off Vmessage_stack. */
10265 xassert (CONSP (Vmessage_stack
));
10266 Vmessage_stack
= XCDR (Vmessage_stack
);
10270 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10271 exits. If the stack is not empty, we have a missing pop_message
10275 check_message_stack (void)
10277 if (!NILP (Vmessage_stack
))
10282 /* Truncate to NCHARS what will be displayed in the echo area the next
10283 time we display it---but don't redisplay it now. */
10286 truncate_echo_area (EMACS_INT nchars
)
10289 echo_area_buffer
[0] = Qnil
;
10290 /* A null message buffer means that the frame hasn't really been
10291 initialized yet. Error messages get reported properly by
10292 cmd_error, so this must be just an informative message; toss it. */
10293 else if (!noninteractive
10295 && !NILP (echo_area_buffer
[0]))
10297 struct frame
*sf
= SELECTED_FRAME ();
10298 if (FRAME_MESSAGE_BUF (sf
))
10299 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
, 0, 0);
10304 /* Helper function for truncate_echo_area. Truncate the current
10305 message to at most NCHARS characters. */
10308 truncate_message_1 (EMACS_INT nchars
, Lisp_Object a2
, EMACS_INT a3
, EMACS_INT a4
)
10310 if (BEG
+ nchars
< Z
)
10311 del_range (BEG
+ nchars
, Z
);
10313 echo_area_buffer
[0] = Qnil
;
10318 /* Set the current message to a substring of S or STRING.
10320 If STRING is a Lisp string, set the message to the first NBYTES
10321 bytes from STRING. NBYTES zero means use the whole string. If
10322 STRING is multibyte, the message will be displayed multibyte.
10324 If S is not null, set the message to the first LEN bytes of S. LEN
10325 zero means use the whole string. MULTIBYTE_P non-zero means S is
10326 multibyte. Display the message multibyte in that case.
10328 Doesn't GC, as with_echo_area_buffer binds Qinhibit_modification_hooks
10329 to t before calling set_message_1 (which calls insert).
10333 set_message (const char *s
, Lisp_Object string
,
10334 EMACS_INT nbytes
, int multibyte_p
)
10336 message_enable_multibyte
10337 = ((s
&& multibyte_p
)
10338 || (STRINGP (string
) && STRING_MULTIBYTE (string
)));
10340 with_echo_area_buffer (0, -1, set_message_1
,
10341 (intptr_t) s
, string
, nbytes
, multibyte_p
);
10342 message_buf_print
= 0;
10343 help_echo_showing_p
= 0;
10347 /* Helper function for set_message. Arguments have the same meaning
10348 as there, with A1 corresponding to S and A2 corresponding to STRING
10349 This function is called with the echo area buffer being
10353 set_message_1 (EMACS_INT a1
, Lisp_Object a2
, EMACS_INT nbytes
, EMACS_INT multibyte_p
)
10356 const char *s
= (const char *) i1
;
10357 const unsigned char *msg
= (const unsigned char *) s
;
10358 Lisp_Object string
= a2
;
10360 /* Change multibyteness of the echo buffer appropriately. */
10361 if (message_enable_multibyte
10362 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10363 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
10365 BVAR (current_buffer
, truncate_lines
) = message_truncate_lines
? Qt
: Qnil
;
10366 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
10367 BVAR (current_buffer
, bidi_paragraph_direction
) = Qleft_to_right
;
10369 /* Insert new message at BEG. */
10370 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10372 if (STRINGP (string
))
10377 nbytes
= SBYTES (string
);
10378 nchars
= string_byte_to_char (string
, nbytes
);
10380 /* This function takes care of single/multibyte conversion. We
10381 just have to ensure that the echo area buffer has the right
10382 setting of enable_multibyte_characters. */
10383 insert_from_string (string
, 0, 0, nchars
, nbytes
, 1);
10388 nbytes
= strlen (s
);
10390 if (multibyte_p
&& NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10392 /* Convert from multi-byte to single-byte. */
10397 /* Convert a multibyte string to single-byte. */
10398 for (i
= 0; i
< nbytes
; i
+= n
)
10400 c
= string_char_and_length (msg
+ i
, &n
);
10401 work
[0] = (ASCII_CHAR_P (c
)
10403 : multibyte_char_to_unibyte (c
));
10404 insert_1_both (work
, 1, 1, 1, 0, 0);
10407 else if (!multibyte_p
10408 && !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10410 /* Convert from single-byte to multi-byte. */
10413 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10415 /* Convert a single-byte string to multibyte. */
10416 for (i
= 0; i
< nbytes
; i
++)
10419 MAKE_CHAR_MULTIBYTE (c
);
10420 n
= CHAR_STRING (c
, str
);
10421 insert_1_both ((char *) str
, 1, n
, 1, 0, 0);
10425 insert_1 (s
, nbytes
, 1, 0, 0);
10432 /* Clear messages. CURRENT_P non-zero means clear the current
10433 message. LAST_DISPLAYED_P non-zero means clear the message
10437 clear_message (int current_p
, int last_displayed_p
)
10441 echo_area_buffer
[0] = Qnil
;
10442 message_cleared_p
= 1;
10445 if (last_displayed_p
)
10446 echo_area_buffer
[1] = Qnil
;
10448 message_buf_print
= 0;
10451 /* Clear garbaged frames.
10453 This function is used where the old redisplay called
10454 redraw_garbaged_frames which in turn called redraw_frame which in
10455 turn called clear_frame. The call to clear_frame was a source of
10456 flickering. I believe a clear_frame is not necessary. It should
10457 suffice in the new redisplay to invalidate all current matrices,
10458 and ensure a complete redisplay of all windows. */
10461 clear_garbaged_frames (void)
10463 if (frame_garbaged
)
10465 Lisp_Object tail
, frame
;
10466 int changed_count
= 0;
10468 FOR_EACH_FRAME (tail
, frame
)
10470 struct frame
*f
= XFRAME (frame
);
10472 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
10476 Fredraw_frame (frame
);
10477 f
->force_flush_display_p
= 1;
10479 clear_current_matrices (f
);
10486 frame_garbaged
= 0;
10488 ++windows_or_buffers_changed
;
10493 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
10494 is non-zero update selected_frame. Value is non-zero if the
10495 mini-windows height has been changed. */
10498 echo_area_display (int update_frame_p
)
10500 Lisp_Object mini_window
;
10503 int window_height_changed_p
= 0;
10504 struct frame
*sf
= SELECTED_FRAME ();
10506 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10507 w
= XWINDOW (mini_window
);
10508 f
= XFRAME (WINDOW_FRAME (w
));
10510 /* Don't display if frame is invisible or not yet initialized. */
10511 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
10514 #ifdef HAVE_WINDOW_SYSTEM
10515 /* When Emacs starts, selected_frame may be the initial terminal
10516 frame. If we let this through, a message would be displayed on
10518 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
10520 #endif /* HAVE_WINDOW_SYSTEM */
10522 /* Redraw garbaged frames. */
10523 if (frame_garbaged
)
10524 clear_garbaged_frames ();
10526 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
10528 echo_area_window
= mini_window
;
10529 window_height_changed_p
= display_echo_area (w
);
10530 w
->must_be_updated_p
= 1;
10532 /* Update the display, unless called from redisplay_internal.
10533 Also don't update the screen during redisplay itself. The
10534 update will happen at the end of redisplay, and an update
10535 here could cause confusion. */
10536 if (update_frame_p
&& !redisplaying_p
)
10540 /* If the display update has been interrupted by pending
10541 input, update mode lines in the frame. Due to the
10542 pending input, it might have been that redisplay hasn't
10543 been called, so that mode lines above the echo area are
10544 garbaged. This looks odd, so we prevent it here. */
10545 if (!display_completed
)
10546 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), 0);
10548 if (window_height_changed_p
10549 /* Don't do this if Emacs is shutting down. Redisplay
10550 needs to run hooks. */
10551 && !NILP (Vrun_hooks
))
10553 /* Must update other windows. Likewise as in other
10554 cases, don't let this update be interrupted by
10556 int count
= SPECPDL_INDEX ();
10557 specbind (Qredisplay_dont_pause
, Qt
);
10558 windows_or_buffers_changed
= 1;
10559 redisplay_internal ();
10560 unbind_to (count
, Qnil
);
10562 else if (FRAME_WINDOW_P (f
) && n
== 0)
10564 /* Window configuration is the same as before.
10565 Can do with a display update of the echo area,
10566 unless we displayed some mode lines. */
10567 update_single_window (w
, 1);
10568 FRAME_RIF (f
)->flush_display (f
);
10571 update_frame (f
, 1, 1);
10573 /* If cursor is in the echo area, make sure that the next
10574 redisplay displays the minibuffer, so that the cursor will
10575 be replaced with what the minibuffer wants. */
10576 if (cursor_in_echo_area
)
10577 ++windows_or_buffers_changed
;
10580 else if (!EQ (mini_window
, selected_window
))
10581 windows_or_buffers_changed
++;
10583 /* Last displayed message is now the current message. */
10584 echo_area_buffer
[1] = echo_area_buffer
[0];
10585 /* Inform read_char that we're not echoing. */
10586 echo_message_buffer
= Qnil
;
10588 /* Prevent redisplay optimization in redisplay_internal by resetting
10589 this_line_start_pos. This is done because the mini-buffer now
10590 displays the message instead of its buffer text. */
10591 if (EQ (mini_window
, selected_window
))
10592 CHARPOS (this_line_start_pos
) = 0;
10594 return window_height_changed_p
;
10599 /***********************************************************************
10600 Mode Lines and Frame Titles
10601 ***********************************************************************/
10603 /* A buffer for constructing non-propertized mode-line strings and
10604 frame titles in it; allocated from the heap in init_xdisp and
10605 resized as needed in store_mode_line_noprop_char. */
10607 static char *mode_line_noprop_buf
;
10609 /* The buffer's end, and a current output position in it. */
10611 static char *mode_line_noprop_buf_end
;
10612 static char *mode_line_noprop_ptr
;
10614 #define MODE_LINE_NOPROP_LEN(start) \
10615 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
10618 MODE_LINE_DISPLAY
= 0,
10622 } mode_line_target
;
10624 /* Alist that caches the results of :propertize.
10625 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
10626 static Lisp_Object mode_line_proptrans_alist
;
10628 /* List of strings making up the mode-line. */
10629 static Lisp_Object mode_line_string_list
;
10631 /* Base face property when building propertized mode line string. */
10632 static Lisp_Object mode_line_string_face
;
10633 static Lisp_Object mode_line_string_face_prop
;
10636 /* Unwind data for mode line strings */
10638 static Lisp_Object Vmode_line_unwind_vector
;
10641 format_mode_line_unwind_data (struct buffer
*obuf
,
10643 int save_proptrans
)
10645 Lisp_Object vector
, tmp
;
10647 /* Reduce consing by keeping one vector in
10648 Vwith_echo_area_save_vector. */
10649 vector
= Vmode_line_unwind_vector
;
10650 Vmode_line_unwind_vector
= Qnil
;
10653 vector
= Fmake_vector (make_number (8), Qnil
);
10655 ASET (vector
, 0, make_number (mode_line_target
));
10656 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
10657 ASET (vector
, 2, mode_line_string_list
);
10658 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
10659 ASET (vector
, 4, mode_line_string_face
);
10660 ASET (vector
, 5, mode_line_string_face_prop
);
10663 XSETBUFFER (tmp
, obuf
);
10666 ASET (vector
, 6, tmp
);
10667 ASET (vector
, 7, owin
);
10673 unwind_format_mode_line (Lisp_Object vector
)
10675 mode_line_target
= XINT (AREF (vector
, 0));
10676 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
10677 mode_line_string_list
= AREF (vector
, 2);
10678 if (! EQ (AREF (vector
, 3), Qt
))
10679 mode_line_proptrans_alist
= AREF (vector
, 3);
10680 mode_line_string_face
= AREF (vector
, 4);
10681 mode_line_string_face_prop
= AREF (vector
, 5);
10683 if (!NILP (AREF (vector
, 7)))
10684 /* Select window before buffer, since it may change the buffer. */
10685 Fselect_window (AREF (vector
, 7), Qt
);
10687 if (!NILP (AREF (vector
, 6)))
10689 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
10690 ASET (vector
, 6, Qnil
);
10693 Vmode_line_unwind_vector
= vector
;
10698 /* Store a single character C for the frame title in mode_line_noprop_buf.
10699 Re-allocate mode_line_noprop_buf if necessary. */
10702 store_mode_line_noprop_char (char c
)
10704 /* If output position has reached the end of the allocated buffer,
10705 increase the buffer's size. */
10706 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
10708 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
10709 ptrdiff_t size
= len
;
10710 mode_line_noprop_buf
=
10711 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
10712 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
10713 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
10716 *mode_line_noprop_ptr
++ = c
;
10720 /* Store part of a frame title in mode_line_noprop_buf, beginning at
10721 mode_line_noprop_ptr. STRING is the string to store. Do not copy
10722 characters that yield more columns than PRECISION; PRECISION <= 0
10723 means copy the whole string. Pad with spaces until FIELD_WIDTH
10724 number of characters have been copied; FIELD_WIDTH <= 0 means don't
10725 pad. Called from display_mode_element when it is used to build a
10729 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
10731 const unsigned char *str
= (const unsigned char *) string
;
10733 EMACS_INT dummy
, nbytes
;
10735 /* Copy at most PRECISION chars from STR. */
10736 nbytes
= strlen (string
);
10737 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
10739 store_mode_line_noprop_char (*str
++);
10741 /* Fill up with spaces until FIELD_WIDTH reached. */
10742 while (field_width
> 0
10743 && n
< field_width
)
10745 store_mode_line_noprop_char (' ');
10752 /***********************************************************************
10754 ***********************************************************************/
10756 #ifdef HAVE_WINDOW_SYSTEM
10758 /* Set the title of FRAME, if it has changed. The title format is
10759 Vicon_title_format if FRAME is iconified, otherwise it is
10760 frame_title_format. */
10763 x_consider_frame_title (Lisp_Object frame
)
10765 struct frame
*f
= XFRAME (frame
);
10767 if (FRAME_WINDOW_P (f
)
10768 || FRAME_MINIBUF_ONLY_P (f
)
10769 || f
->explicit_name
)
10771 /* Do we have more than one visible frame on this X display? */
10774 ptrdiff_t title_start
;
10778 int count
= SPECPDL_INDEX ();
10780 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCDR (tail
))
10782 Lisp_Object other_frame
= XCAR (tail
);
10783 struct frame
*tf
= XFRAME (other_frame
);
10786 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
10787 && !FRAME_MINIBUF_ONLY_P (tf
)
10788 && !EQ (other_frame
, tip_frame
)
10789 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
10793 /* Set global variable indicating that multiple frames exist. */
10794 multiple_frames
= CONSP (tail
);
10796 /* Switch to the buffer of selected window of the frame. Set up
10797 mode_line_target so that display_mode_element will output into
10798 mode_line_noprop_buf; then display the title. */
10799 record_unwind_protect (unwind_format_mode_line
,
10800 format_mode_line_unwind_data
10801 (current_buffer
, selected_window
, 0));
10803 Fselect_window (f
->selected_window
, Qt
);
10804 set_buffer_internal_1 (XBUFFER (XWINDOW (f
->selected_window
)->buffer
));
10805 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
10807 mode_line_target
= MODE_LINE_TITLE
;
10808 title_start
= MODE_LINE_NOPROP_LEN (0);
10809 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
10810 NULL
, DEFAULT_FACE_ID
);
10811 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
10812 len
= MODE_LINE_NOPROP_LEN (title_start
);
10813 title
= mode_line_noprop_buf
+ title_start
;
10814 unbind_to (count
, Qnil
);
10816 /* Set the title only if it's changed. This avoids consing in
10817 the common case where it hasn't. (If it turns out that we've
10818 already wasted too much time by walking through the list with
10819 display_mode_element, then we might need to optimize at a
10820 higher level than this.) */
10821 if (! STRINGP (f
->name
)
10822 || SBYTES (f
->name
) != len
10823 || memcmp (title
, SDATA (f
->name
), len
) != 0)
10824 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
10828 #endif /* not HAVE_WINDOW_SYSTEM */
10833 /***********************************************************************
10835 ***********************************************************************/
10838 /* Prepare for redisplay by updating menu-bar item lists when
10839 appropriate. This can call eval. */
10842 prepare_menu_bars (void)
10845 struct gcpro gcpro1
, gcpro2
;
10847 Lisp_Object tooltip_frame
;
10849 #ifdef HAVE_WINDOW_SYSTEM
10850 tooltip_frame
= tip_frame
;
10852 tooltip_frame
= Qnil
;
10855 /* Update all frame titles based on their buffer names, etc. We do
10856 this before the menu bars so that the buffer-menu will show the
10857 up-to-date frame titles. */
10858 #ifdef HAVE_WINDOW_SYSTEM
10859 if (windows_or_buffers_changed
|| update_mode_lines
)
10861 Lisp_Object tail
, frame
;
10863 FOR_EACH_FRAME (tail
, frame
)
10865 f
= XFRAME (frame
);
10866 if (!EQ (frame
, tooltip_frame
)
10867 && (FRAME_VISIBLE_P (f
) || FRAME_ICONIFIED_P (f
)))
10868 x_consider_frame_title (frame
);
10871 #endif /* HAVE_WINDOW_SYSTEM */
10873 /* Update the menu bar item lists, if appropriate. This has to be
10874 done before any actual redisplay or generation of display lines. */
10875 all_windows
= (update_mode_lines
10876 || buffer_shared
> 1
10877 || windows_or_buffers_changed
);
10880 Lisp_Object tail
, frame
;
10881 int count
= SPECPDL_INDEX ();
10882 /* 1 means that update_menu_bar has run its hooks
10883 so any further calls to update_menu_bar shouldn't do so again. */
10884 int menu_bar_hooks_run
= 0;
10886 record_unwind_save_match_data ();
10888 FOR_EACH_FRAME (tail
, frame
)
10890 f
= XFRAME (frame
);
10892 /* Ignore tooltip frame. */
10893 if (EQ (frame
, tooltip_frame
))
10896 /* If a window on this frame changed size, report that to
10897 the user and clear the size-change flag. */
10898 if (FRAME_WINDOW_SIZES_CHANGED (f
))
10900 Lisp_Object functions
;
10902 /* Clear flag first in case we get an error below. */
10903 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
10904 functions
= Vwindow_size_change_functions
;
10905 GCPRO2 (tail
, functions
);
10907 while (CONSP (functions
))
10909 if (!EQ (XCAR (functions
), Qt
))
10910 call1 (XCAR (functions
), frame
);
10911 functions
= XCDR (functions
);
10917 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
10918 #ifdef HAVE_WINDOW_SYSTEM
10919 update_tool_bar (f
, 0);
10922 if (windows_or_buffers_changed
10924 ns_set_doc_edited (f
, Fbuffer_modified_p
10925 (XWINDOW (f
->selected_window
)->buffer
));
10930 unbind_to (count
, Qnil
);
10934 struct frame
*sf
= SELECTED_FRAME ();
10935 update_menu_bar (sf
, 1, 0);
10936 #ifdef HAVE_WINDOW_SYSTEM
10937 update_tool_bar (sf
, 1);
10943 /* Update the menu bar item list for frame F. This has to be done
10944 before we start to fill in any display lines, because it can call
10947 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
10949 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
10950 already ran the menu bar hooks for this redisplay, so there
10951 is no need to run them again. The return value is the
10952 updated value of this flag, to pass to the next call. */
10955 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
10957 Lisp_Object window
;
10958 register struct window
*w
;
10960 /* If called recursively during a menu update, do nothing. This can
10961 happen when, for instance, an activate-menubar-hook causes a
10963 if (inhibit_menubar_update
)
10966 window
= FRAME_SELECTED_WINDOW (f
);
10967 w
= XWINDOW (window
);
10969 if (FRAME_WINDOW_P (f
)
10971 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
10972 || defined (HAVE_NS) || defined (USE_GTK)
10973 FRAME_EXTERNAL_MENU_BAR (f
)
10975 FRAME_MENU_BAR_LINES (f
) > 0
10977 : FRAME_MENU_BAR_LINES (f
) > 0)
10979 /* If the user has switched buffers or windows, we need to
10980 recompute to reflect the new bindings. But we'll
10981 recompute when update_mode_lines is set too; that means
10982 that people can use force-mode-line-update to request
10983 that the menu bar be recomputed. The adverse effect on
10984 the rest of the redisplay algorithm is about the same as
10985 windows_or_buffers_changed anyway. */
10986 if (windows_or_buffers_changed
10987 /* This used to test w->update_mode_line, but we believe
10988 there is no need to recompute the menu in that case. */
10989 || update_mode_lines
10990 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
10991 < BUF_MODIFF (XBUFFER (w
->buffer
)))
10992 != !NILP (w
->last_had_star
))
10993 || ((!NILP (Vtransient_mark_mode
)
10994 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
10995 != !NILP (w
->region_showing
)))
10997 struct buffer
*prev
= current_buffer
;
10998 int count
= SPECPDL_INDEX ();
11000 specbind (Qinhibit_menubar_update
, Qt
);
11002 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11003 if (save_match_data
)
11004 record_unwind_save_match_data ();
11005 if (NILP (Voverriding_local_map_menu_flag
))
11007 specbind (Qoverriding_terminal_local_map
, Qnil
);
11008 specbind (Qoverriding_local_map
, Qnil
);
11013 /* Run the Lucid hook. */
11014 safe_run_hooks (Qactivate_menubar_hook
);
11016 /* If it has changed current-menubar from previous value,
11017 really recompute the menu-bar from the value. */
11018 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11019 call0 (Qrecompute_lucid_menubar
);
11021 safe_run_hooks (Qmenu_bar_update_hook
);
11026 XSETFRAME (Vmenu_updating_frame
, f
);
11027 FRAME_MENU_BAR_ITEMS (f
) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f
));
11029 /* Redisplay the menu bar in case we changed it. */
11030 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11031 || defined (HAVE_NS) || defined (USE_GTK)
11032 if (FRAME_WINDOW_P (f
))
11034 #if defined (HAVE_NS)
11035 /* All frames on Mac OS share the same menubar. So only
11036 the selected frame should be allowed to set it. */
11037 if (f
== SELECTED_FRAME ())
11039 set_frame_menubar (f
, 0, 0);
11042 /* On a terminal screen, the menu bar is an ordinary screen
11043 line, and this makes it get updated. */
11044 w
->update_mode_line
= Qt
;
11045 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11046 /* In the non-toolkit version, the menu bar is an ordinary screen
11047 line, and this makes it get updated. */
11048 w
->update_mode_line
= Qt
;
11049 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11051 unbind_to (count
, Qnil
);
11052 set_buffer_internal_1 (prev
);
11061 /***********************************************************************
11063 ***********************************************************************/
11065 #ifdef HAVE_WINDOW_SYSTEM
11068 Nominal cursor position -- where to draw output.
11069 HPOS and VPOS are window relative glyph matrix coordinates.
11070 X and Y are window relative pixel coordinates. */
11072 struct cursor_pos output_cursor
;
11076 Set the global variable output_cursor to CURSOR. All cursor
11077 positions are relative to updated_window. */
11080 set_output_cursor (struct cursor_pos
*cursor
)
11082 output_cursor
.hpos
= cursor
->hpos
;
11083 output_cursor
.vpos
= cursor
->vpos
;
11084 output_cursor
.x
= cursor
->x
;
11085 output_cursor
.y
= cursor
->y
;
11090 Set a nominal cursor position.
11092 HPOS and VPOS are column/row positions in a window glyph matrix. X
11093 and Y are window text area relative pixel positions.
11095 If this is done during an update, updated_window will contain the
11096 window that is being updated and the position is the future output
11097 cursor position for that window. If updated_window is null, use
11098 selected_window and display the cursor at the given position. */
11101 x_cursor_to (int vpos
, int hpos
, int y
, int x
)
11105 /* If updated_window is not set, work on selected_window. */
11106 if (updated_window
)
11107 w
= updated_window
;
11109 w
= XWINDOW (selected_window
);
11111 /* Set the output cursor. */
11112 output_cursor
.hpos
= hpos
;
11113 output_cursor
.vpos
= vpos
;
11114 output_cursor
.x
= x
;
11115 output_cursor
.y
= y
;
11117 /* If not called as part of an update, really display the cursor.
11118 This will also set the cursor position of W. */
11119 if (updated_window
== NULL
)
11122 display_and_set_cursor (w
, 1, hpos
, vpos
, x
, y
);
11123 if (FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
11124 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (SELECTED_FRAME ());
11129 #endif /* HAVE_WINDOW_SYSTEM */
11132 /***********************************************************************
11134 ***********************************************************************/
11136 #ifdef HAVE_WINDOW_SYSTEM
11138 /* Where the mouse was last time we reported a mouse event. */
11140 FRAME_PTR last_mouse_frame
;
11142 /* Tool-bar item index of the item on which a mouse button was pressed
11145 int last_tool_bar_item
;
11149 update_tool_bar_unwind (Lisp_Object frame
)
11151 selected_frame
= frame
;
11155 /* Update the tool-bar item list for frame F. This has to be done
11156 before we start to fill in any display lines. Called from
11157 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11158 and restore it here. */
11161 update_tool_bar (struct frame
*f
, int save_match_data
)
11163 #if defined (USE_GTK) || defined (HAVE_NS)
11164 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11166 int do_update
= WINDOWP (f
->tool_bar_window
)
11167 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0;
11172 Lisp_Object window
;
11175 window
= FRAME_SELECTED_WINDOW (f
);
11176 w
= XWINDOW (window
);
11178 /* If the user has switched buffers or windows, we need to
11179 recompute to reflect the new bindings. But we'll
11180 recompute when update_mode_lines is set too; that means
11181 that people can use force-mode-line-update to request
11182 that the menu bar be recomputed. The adverse effect on
11183 the rest of the redisplay algorithm is about the same as
11184 windows_or_buffers_changed anyway. */
11185 if (windows_or_buffers_changed
11186 || !NILP (w
->update_mode_line
)
11187 || update_mode_lines
11188 || ((BUF_SAVE_MODIFF (XBUFFER (w
->buffer
))
11189 < BUF_MODIFF (XBUFFER (w
->buffer
)))
11190 != !NILP (w
->last_had_star
))
11191 || ((!NILP (Vtransient_mark_mode
)
11192 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
11193 != !NILP (w
->region_showing
)))
11195 struct buffer
*prev
= current_buffer
;
11196 int count
= SPECPDL_INDEX ();
11197 Lisp_Object frame
, new_tool_bar
;
11198 int new_n_tool_bar
;
11199 struct gcpro gcpro1
;
11201 /* Set current_buffer to the buffer of the selected
11202 window of the frame, so that we get the right local
11204 set_buffer_internal_1 (XBUFFER (w
->buffer
));
11206 /* Save match data, if we must. */
11207 if (save_match_data
)
11208 record_unwind_save_match_data ();
11210 /* Make sure that we don't accidentally use bogus keymaps. */
11211 if (NILP (Voverriding_local_map_menu_flag
))
11213 specbind (Qoverriding_terminal_local_map
, Qnil
);
11214 specbind (Qoverriding_local_map
, Qnil
);
11217 GCPRO1 (new_tool_bar
);
11219 /* We must temporarily set the selected frame to this frame
11220 before calling tool_bar_items, because the calculation of
11221 the tool-bar keymap uses the selected frame (see
11222 `tool-bar-make-keymap' in tool-bar.el). */
11223 record_unwind_protect (update_tool_bar_unwind
, selected_frame
);
11224 XSETFRAME (frame
, f
);
11225 selected_frame
= frame
;
11227 /* Build desired tool-bar items from keymaps. */
11228 new_tool_bar
= tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11231 /* Redisplay the tool-bar if we changed it. */
11232 if (new_n_tool_bar
!= f
->n_tool_bar_items
11233 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11235 /* Redisplay that happens asynchronously due to an expose event
11236 may access f->tool_bar_items. Make sure we update both
11237 variables within BLOCK_INPUT so no such event interrupts. */
11239 f
->tool_bar_items
= new_tool_bar
;
11240 f
->n_tool_bar_items
= new_n_tool_bar
;
11241 w
->update_mode_line
= Qt
;
11247 unbind_to (count
, Qnil
);
11248 set_buffer_internal_1 (prev
);
11254 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11255 F's desired tool-bar contents. F->tool_bar_items must have
11256 been set up previously by calling prepare_menu_bars. */
11259 build_desired_tool_bar_string (struct frame
*f
)
11261 int i
, size
, size_needed
;
11262 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11263 Lisp_Object image
, plist
, props
;
11265 image
= plist
= props
= Qnil
;
11266 GCPRO3 (image
, plist
, props
);
11268 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11269 Otherwise, make a new string. */
11271 /* The size of the string we might be able to reuse. */
11272 size
= (STRINGP (f
->desired_tool_bar_string
)
11273 ? SCHARS (f
->desired_tool_bar_string
)
11276 /* We need one space in the string for each image. */
11277 size_needed
= f
->n_tool_bar_items
;
11279 /* Reuse f->desired_tool_bar_string, if possible. */
11280 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11281 f
->desired_tool_bar_string
= Fmake_string (make_number (size_needed
),
11282 make_number (' '));
11285 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11286 Fremove_text_properties (make_number (0), make_number (size
),
11287 props
, f
->desired_tool_bar_string
);
11290 /* Put a `display' property on the string for the images to display,
11291 put a `menu_item' property on tool-bar items with a value that
11292 is the index of the item in F's tool-bar item vector. */
11293 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11295 #define PROP(IDX) AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11297 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11298 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11299 int hmargin
, vmargin
, relief
, idx
, end
;
11301 /* If image is a vector, choose the image according to the
11303 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11304 if (VECTORP (image
))
11308 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11309 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11312 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11313 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11315 xassert (ASIZE (image
) >= idx
);
11316 image
= AREF (image
, idx
);
11321 /* Ignore invalid image specifications. */
11322 if (!valid_image_p (image
))
11325 /* Display the tool-bar button pressed, or depressed. */
11326 plist
= Fcopy_sequence (XCDR (image
));
11328 /* Compute margin and relief to draw. */
11329 relief
= (tool_bar_button_relief
>= 0
11330 ? tool_bar_button_relief
11331 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
11332 hmargin
= vmargin
= relief
;
11334 if (INTEGERP (Vtool_bar_button_margin
)
11335 && XINT (Vtool_bar_button_margin
) > 0)
11337 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
11338 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
11340 else if (CONSP (Vtool_bar_button_margin
))
11342 if (INTEGERP (XCAR (Vtool_bar_button_margin
))
11343 && XINT (XCAR (Vtool_bar_button_margin
)) > 0)
11344 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
11346 if (INTEGERP (XCDR (Vtool_bar_button_margin
))
11347 && XINT (XCDR (Vtool_bar_button_margin
)) > 0)
11348 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
11351 if (auto_raise_tool_bar_buttons_p
)
11353 /* Add a `:relief' property to the image spec if the item is
11357 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
11364 /* If image is selected, display it pressed, i.e. with a
11365 negative relief. If it's not selected, display it with a
11367 plist
= Fplist_put (plist
, QCrelief
,
11369 ? make_number (-relief
)
11370 : make_number (relief
)));
11375 /* Put a margin around the image. */
11376 if (hmargin
|| vmargin
)
11378 if (hmargin
== vmargin
)
11379 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
11381 plist
= Fplist_put (plist
, QCmargin
,
11382 Fcons (make_number (hmargin
),
11383 make_number (vmargin
)));
11386 /* If button is not enabled, and we don't have special images
11387 for the disabled state, make the image appear disabled by
11388 applying an appropriate algorithm to it. */
11389 if (!enabled_p
&& idx
< 0)
11390 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
11392 /* Put a `display' text property on the string for the image to
11393 display. Put a `menu-item' property on the string that gives
11394 the start of this item's properties in the tool-bar items
11396 image
= Fcons (Qimage
, plist
);
11397 props
= list4 (Qdisplay
, image
,
11398 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
11400 /* Let the last image hide all remaining spaces in the tool bar
11401 string. The string can be longer than needed when we reuse a
11402 previous string. */
11403 if (i
+ 1 == f
->n_tool_bar_items
)
11404 end
= SCHARS (f
->desired_tool_bar_string
);
11407 Fadd_text_properties (make_number (i
), make_number (end
),
11408 props
, f
->desired_tool_bar_string
);
11416 /* Display one line of the tool-bar of frame IT->f.
11418 HEIGHT specifies the desired height of the tool-bar line.
11419 If the actual height of the glyph row is less than HEIGHT, the
11420 row's height is increased to HEIGHT, and the icons are centered
11421 vertically in the new height.
11423 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
11424 count a final empty row in case the tool-bar width exactly matches
11429 display_tool_bar_line (struct it
*it
, int height
)
11431 struct glyph_row
*row
= it
->glyph_row
;
11432 int max_x
= it
->last_visible_x
;
11433 struct glyph
*last
;
11435 prepare_desired_row (row
);
11436 row
->y
= it
->current_y
;
11438 /* Note that this isn't made use of if the face hasn't a box,
11439 so there's no need to check the face here. */
11440 it
->start_of_box_run_p
= 1;
11442 while (it
->current_x
< max_x
)
11444 int x
, n_glyphs_before
, i
, nglyphs
;
11445 struct it it_before
;
11447 /* Get the next display element. */
11448 if (!get_next_display_element (it
))
11450 /* Don't count empty row if we are counting needed tool-bar lines. */
11451 if (height
< 0 && !it
->hpos
)
11456 /* Produce glyphs. */
11457 n_glyphs_before
= row
->used
[TEXT_AREA
];
11460 PRODUCE_GLYPHS (it
);
11462 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
11464 x
= it_before
.current_x
;
11465 while (i
< nglyphs
)
11467 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
11469 if (x
+ glyph
->pixel_width
> max_x
)
11471 /* Glyph doesn't fit on line. Backtrack. */
11472 row
->used
[TEXT_AREA
] = n_glyphs_before
;
11474 /* If this is the only glyph on this line, it will never fit on the
11475 tool-bar, so skip it. But ensure there is at least one glyph,
11476 so we don't accidentally disable the tool-bar. */
11477 if (n_glyphs_before
== 0
11478 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
11484 x
+= glyph
->pixel_width
;
11488 /* Stop at line end. */
11489 if (ITERATOR_AT_END_OF_LINE_P (it
))
11492 set_iterator_to_next (it
, 1);
11497 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
11499 /* Use default face for the border below the tool bar.
11501 FIXME: When auto-resize-tool-bars is grow-only, there is
11502 no additional border below the possibly empty tool-bar lines.
11503 So to make the extra empty lines look "normal", we have to
11504 use the tool-bar face for the border too. */
11505 if (!row
->displays_text_p
&& !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
11506 it
->face_id
= DEFAULT_FACE_ID
;
11508 extend_face_to_end_of_line (it
);
11509 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
11510 last
->right_box_line_p
= 1;
11511 if (last
== row
->glyphs
[TEXT_AREA
])
11512 last
->left_box_line_p
= 1;
11514 /* Make line the desired height and center it vertically. */
11515 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
11517 /* Don't add more than one line height. */
11518 height
%= FRAME_LINE_HEIGHT (it
->f
);
11519 it
->max_ascent
+= height
/ 2;
11520 it
->max_descent
+= (height
+ 1) / 2;
11523 compute_line_metrics (it
);
11525 /* If line is empty, make it occupy the rest of the tool-bar. */
11526 if (!row
->displays_text_p
)
11528 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
11529 row
->visible_height
= row
->height
;
11530 row
->ascent
= row
->phys_ascent
= 0;
11531 row
->extra_line_spacing
= 0;
11534 row
->full_width_p
= 1;
11535 row
->continued_p
= 0;
11536 row
->truncated_on_left_p
= 0;
11537 row
->truncated_on_right_p
= 0;
11539 it
->current_x
= it
->hpos
= 0;
11540 it
->current_y
+= row
->height
;
11546 /* Max tool-bar height. */
11548 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
11549 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
11551 /* Value is the number of screen lines needed to make all tool-bar
11552 items of frame F visible. The number of actual rows needed is
11553 returned in *N_ROWS if non-NULL. */
11556 tool_bar_lines_needed (struct frame
*f
, int *n_rows
)
11558 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11560 /* tool_bar_lines_needed is called from redisplay_tool_bar after building
11561 the desired matrix, so use (unused) mode-line row as temporary row to
11562 avoid destroying the first tool-bar row. */
11563 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
11565 /* Initialize an iterator for iteration over
11566 F->desired_tool_bar_string in the tool-bar window of frame F. */
11567 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
11568 it
.first_visible_x
= 0;
11569 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11570 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11571 it
.paragraph_embedding
= L2R
;
11573 while (!ITERATOR_AT_END_P (&it
))
11575 clear_glyph_row (temp_row
);
11576 it
.glyph_row
= temp_row
;
11577 display_tool_bar_line (&it
, -1);
11579 clear_glyph_row (temp_row
);
11581 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
11583 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
11585 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
11589 DEFUN ("tool-bar-lines-needed", Ftool_bar_lines_needed
, Stool_bar_lines_needed
,
11591 doc
: /* Return the number of lines occupied by the tool bar of FRAME. */)
11592 (Lisp_Object frame
)
11599 frame
= selected_frame
;
11601 CHECK_FRAME (frame
);
11602 f
= XFRAME (frame
);
11604 if (WINDOWP (f
->tool_bar_window
)
11605 && (w
= XWINDOW (f
->tool_bar_window
),
11606 WINDOW_TOTAL_LINES (w
) > 0))
11608 update_tool_bar (f
, 1);
11609 if (f
->n_tool_bar_items
)
11611 build_desired_tool_bar_string (f
);
11612 nlines
= tool_bar_lines_needed (f
, NULL
);
11616 return make_number (nlines
);
11620 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
11621 height should be changed. */
11624 redisplay_tool_bar (struct frame
*f
)
11628 struct glyph_row
*row
;
11630 #if defined (USE_GTK) || defined (HAVE_NS)
11631 if (FRAME_EXTERNAL_TOOL_BAR (f
))
11632 update_frame_tool_bar (f
);
11636 /* If frame hasn't a tool-bar window or if it is zero-height, don't
11637 do anything. This means you must start with tool-bar-lines
11638 non-zero to get the auto-sizing effect. Or in other words, you
11639 can turn off tool-bars by specifying tool-bar-lines zero. */
11640 if (!WINDOWP (f
->tool_bar_window
)
11641 || (w
= XWINDOW (f
->tool_bar_window
),
11642 WINDOW_TOTAL_LINES (w
) == 0))
11645 /* Set up an iterator for the tool-bar window. */
11646 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
11647 it
.first_visible_x
= 0;
11648 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
11649 row
= it
.glyph_row
;
11651 /* Build a string that represents the contents of the tool-bar. */
11652 build_desired_tool_bar_string (f
);
11653 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
11654 /* FIXME: This should be controlled by a user option. But it
11655 doesn't make sense to have an R2L tool bar if the menu bar cannot
11656 be drawn also R2L, and making the menu bar R2L is tricky due
11657 toolkit-specific code that implements it. If an R2L tool bar is
11658 ever supported, display_tool_bar_line should also be augmented to
11659 call unproduce_glyphs like display_line and display_string
11661 it
.paragraph_embedding
= L2R
;
11663 if (f
->n_tool_bar_rows
== 0)
11667 if ((nlines
= tool_bar_lines_needed (f
, &f
->n_tool_bar_rows
),
11668 nlines
!= WINDOW_TOTAL_LINES (w
)))
11671 int old_height
= WINDOW_TOTAL_LINES (w
);
11673 XSETFRAME (frame
, f
);
11674 Fmodify_frame_parameters (frame
,
11675 Fcons (Fcons (Qtool_bar_lines
,
11676 make_number (nlines
)),
11678 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11680 clear_glyph_matrix (w
->desired_matrix
);
11681 fonts_changed_p
= 1;
11687 /* Display as many lines as needed to display all tool-bar items. */
11689 if (f
->n_tool_bar_rows
> 0)
11691 int border
, rows
, height
, extra
;
11693 if (INTEGERP (Vtool_bar_border
))
11694 border
= XINT (Vtool_bar_border
);
11695 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
11696 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
11697 else if (EQ (Vtool_bar_border
, Qborder_width
))
11698 border
= f
->border_width
;
11704 rows
= f
->n_tool_bar_rows
;
11705 height
= max (1, (it
.last_visible_y
- border
) / rows
);
11706 extra
= it
.last_visible_y
- border
- height
* rows
;
11708 while (it
.current_y
< it
.last_visible_y
)
11711 if (extra
> 0 && rows
-- > 0)
11713 h
= (extra
+ rows
- 1) / rows
;
11716 display_tool_bar_line (&it
, height
+ h
);
11721 while (it
.current_y
< it
.last_visible_y
)
11722 display_tool_bar_line (&it
, 0);
11725 /* It doesn't make much sense to try scrolling in the tool-bar
11726 window, so don't do it. */
11727 w
->desired_matrix
->no_scrolling_p
= 1;
11728 w
->must_be_updated_p
= 1;
11730 if (!NILP (Vauto_resize_tool_bars
))
11732 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
11733 int change_height_p
= 0;
11735 /* If we couldn't display everything, change the tool-bar's
11736 height if there is room for more. */
11737 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
11738 && it
.current_y
< max_tool_bar_height
)
11739 change_height_p
= 1;
11741 row
= it
.glyph_row
- 1;
11743 /* If there are blank lines at the end, except for a partially
11744 visible blank line at the end that is smaller than
11745 FRAME_LINE_HEIGHT, change the tool-bar's height. */
11746 if (!row
->displays_text_p
11747 && row
->height
>= FRAME_LINE_HEIGHT (f
))
11748 change_height_p
= 1;
11750 /* If row displays tool-bar items, but is partially visible,
11751 change the tool-bar's height. */
11752 if (row
->displays_text_p
11753 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
11754 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
11755 change_height_p
= 1;
11757 /* Resize windows as needed by changing the `tool-bar-lines'
11758 frame parameter. */
11759 if (change_height_p
)
11762 int old_height
= WINDOW_TOTAL_LINES (w
);
11764 int nlines
= tool_bar_lines_needed (f
, &nrows
);
11766 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
11767 && !f
->minimize_tool_bar_window_p
)
11768 ? (nlines
> old_height
)
11769 : (nlines
!= old_height
));
11770 f
->minimize_tool_bar_window_p
= 0;
11772 if (change_height_p
)
11774 XSETFRAME (frame
, f
);
11775 Fmodify_frame_parameters (frame
,
11776 Fcons (Fcons (Qtool_bar_lines
,
11777 make_number (nlines
)),
11779 if (WINDOW_TOTAL_LINES (w
) != old_height
)
11781 clear_glyph_matrix (w
->desired_matrix
);
11782 f
->n_tool_bar_rows
= nrows
;
11783 fonts_changed_p
= 1;
11790 f
->minimize_tool_bar_window_p
= 0;
11795 /* Get information about the tool-bar item which is displayed in GLYPH
11796 on frame F. Return in *PROP_IDX the index where tool-bar item
11797 properties start in F->tool_bar_items. Value is zero if
11798 GLYPH doesn't display a tool-bar item. */
11801 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
11807 /* This function can be called asynchronously, which means we must
11808 exclude any possibility that Fget_text_property signals an
11810 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
11811 charpos
= max (0, charpos
);
11813 /* Get the text property `menu-item' at pos. The value of that
11814 property is the start index of this item's properties in
11815 F->tool_bar_items. */
11816 prop
= Fget_text_property (make_number (charpos
),
11817 Qmenu_item
, f
->current_tool_bar_string
);
11818 if (INTEGERP (prop
))
11820 *prop_idx
= XINT (prop
);
11830 /* Get information about the tool-bar item at position X/Y on frame F.
11831 Return in *GLYPH a pointer to the glyph of the tool-bar item in
11832 the current matrix of the tool-bar window of F, or NULL if not
11833 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
11834 item in F->tool_bar_items. Value is
11836 -1 if X/Y is not on a tool-bar item
11837 0 if X/Y is on the same item that was highlighted before.
11841 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
11842 int *hpos
, int *vpos
, int *prop_idx
)
11844 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11845 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11848 /* Find the glyph under X/Y. */
11849 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
11850 if (*glyph
== NULL
)
11853 /* Get the start of this tool-bar item's properties in
11854 f->tool_bar_items. */
11855 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
11858 /* Is mouse on the highlighted item? */
11859 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
11860 && *vpos
>= hlinfo
->mouse_face_beg_row
11861 && *vpos
<= hlinfo
->mouse_face_end_row
11862 && (*vpos
> hlinfo
->mouse_face_beg_row
11863 || *hpos
>= hlinfo
->mouse_face_beg_col
)
11864 && (*vpos
< hlinfo
->mouse_face_end_row
11865 || *hpos
< hlinfo
->mouse_face_end_col
11866 || hlinfo
->mouse_face_past_end
))
11874 Handle mouse button event on the tool-bar of frame F, at
11875 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
11876 0 for button release. MODIFIERS is event modifiers for button
11880 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
11881 unsigned int modifiers
)
11883 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11884 struct window
*w
= XWINDOW (f
->tool_bar_window
);
11885 int hpos
, vpos
, prop_idx
;
11886 struct glyph
*glyph
;
11887 Lisp_Object enabled_p
;
11889 /* If not on the highlighted tool-bar item, return. */
11890 frame_to_window_pixel_xy (w
, &x
, &y
);
11891 if (get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
) != 0)
11894 /* If item is disabled, do nothing. */
11895 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11896 if (NILP (enabled_p
))
11901 /* Show item in pressed state. */
11902 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
11903 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_SUNKEN
;
11904 last_tool_bar_item
= prop_idx
;
11908 Lisp_Object key
, frame
;
11909 struct input_event event
;
11910 EVENT_INIT (event
);
11912 /* Show item in released state. */
11913 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
11914 hlinfo
->mouse_face_image_state
= DRAW_IMAGE_RAISED
;
11916 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
11918 XSETFRAME (frame
, f
);
11919 event
.kind
= TOOL_BAR_EVENT
;
11920 event
.frame_or_window
= frame
;
11922 kbd_buffer_store_event (&event
);
11924 event
.kind
= TOOL_BAR_EVENT
;
11925 event
.frame_or_window
= frame
;
11927 event
.modifiers
= modifiers
;
11928 kbd_buffer_store_event (&event
);
11929 last_tool_bar_item
= -1;
11934 /* Possibly highlight a tool-bar item on frame F when mouse moves to
11935 tool-bar window-relative coordinates X/Y. Called from
11936 note_mouse_highlight. */
11939 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
11941 Lisp_Object window
= f
->tool_bar_window
;
11942 struct window
*w
= XWINDOW (window
);
11943 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
11944 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
11946 struct glyph
*glyph
;
11947 struct glyph_row
*row
;
11949 Lisp_Object enabled_p
;
11951 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
11952 int mouse_down_p
, rc
;
11954 /* Function note_mouse_highlight is called with negative X/Y
11955 values when mouse moves outside of the frame. */
11956 if (x
<= 0 || y
<= 0)
11958 clear_mouse_face (hlinfo
);
11962 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
11965 /* Not on tool-bar item. */
11966 clear_mouse_face (hlinfo
);
11970 /* On same tool-bar item as before. */
11971 goto set_help_echo
;
11973 clear_mouse_face (hlinfo
);
11975 /* Mouse is down, but on different tool-bar item? */
11976 mouse_down_p
= (dpyinfo
->grabbed
11977 && f
== last_mouse_frame
11978 && FRAME_LIVE_P (f
));
11980 && last_tool_bar_item
!= prop_idx
)
11983 hlinfo
->mouse_face_image_state
= DRAW_NORMAL_TEXT
;
11984 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
11986 /* If tool-bar item is not enabled, don't highlight it. */
11987 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
11988 if (!NILP (enabled_p
))
11990 /* Compute the x-position of the glyph. In front and past the
11991 image is a space. We include this in the highlighted area. */
11992 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
11993 for (i
= x
= 0; i
< hpos
; ++i
)
11994 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
11996 /* Record this as the current active region. */
11997 hlinfo
->mouse_face_beg_col
= hpos
;
11998 hlinfo
->mouse_face_beg_row
= vpos
;
11999 hlinfo
->mouse_face_beg_x
= x
;
12000 hlinfo
->mouse_face_beg_y
= row
->y
;
12001 hlinfo
->mouse_face_past_end
= 0;
12003 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12004 hlinfo
->mouse_face_end_row
= vpos
;
12005 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12006 hlinfo
->mouse_face_end_y
= row
->y
;
12007 hlinfo
->mouse_face_window
= window
;
12008 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12010 /* Display it as active. */
12011 show_mouse_face (hlinfo
, draw
);
12012 hlinfo
->mouse_face_image_state
= draw
;
12017 /* Set help_echo_string to a help string to display for this tool-bar item.
12018 XTread_socket does the rest. */
12019 help_echo_object
= help_echo_window
= Qnil
;
12020 help_echo_pos
= -1;
12021 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12022 if (NILP (help_echo_string
))
12023 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12026 #endif /* HAVE_WINDOW_SYSTEM */
12030 /************************************************************************
12031 Horizontal scrolling
12032 ************************************************************************/
12034 static int hscroll_window_tree (Lisp_Object
);
12035 static int hscroll_windows (Lisp_Object
);
12037 /* For all leaf windows in the window tree rooted at WINDOW, set their
12038 hscroll value so that PT is (i) visible in the window, and (ii) so
12039 that it is not within a certain margin at the window's left and
12040 right border. Value is non-zero if any window's hscroll has been
12044 hscroll_window_tree (Lisp_Object window
)
12046 int hscrolled_p
= 0;
12047 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12048 int hscroll_step_abs
= 0;
12049 double hscroll_step_rel
= 0;
12051 if (hscroll_relative_p
)
12053 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12054 if (hscroll_step_rel
< 0)
12056 hscroll_relative_p
= 0;
12057 hscroll_step_abs
= 0;
12060 else if (INTEGERP (Vhscroll_step
))
12062 hscroll_step_abs
= XINT (Vhscroll_step
);
12063 if (hscroll_step_abs
< 0)
12064 hscroll_step_abs
= 0;
12067 hscroll_step_abs
= 0;
12069 while (WINDOWP (window
))
12071 struct window
*w
= XWINDOW (window
);
12073 if (WINDOWP (w
->hchild
))
12074 hscrolled_p
|= hscroll_window_tree (w
->hchild
);
12075 else if (WINDOWP (w
->vchild
))
12076 hscrolled_p
|= hscroll_window_tree (w
->vchild
);
12077 else if (w
->cursor
.vpos
>= 0)
12080 int text_area_width
;
12081 struct glyph_row
*current_cursor_row
12082 = MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12083 struct glyph_row
*desired_cursor_row
12084 = MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12085 struct glyph_row
*cursor_row
12086 = (desired_cursor_row
->enabled_p
12087 ? desired_cursor_row
12088 : current_cursor_row
);
12089 int row_r2l_p
= cursor_row
->reversed_p
;
12091 text_area_width
= window_box_width (w
, TEXT_AREA
);
12093 /* Scroll when cursor is inside this scroll margin. */
12094 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12096 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->buffer
))
12097 /* For left-to-right rows, hscroll when cursor is either
12098 (i) inside the right hscroll margin, or (ii) if it is
12099 inside the left margin and the window is already
12102 && ((XFASTINT (w
->hscroll
)
12103 && w
->cursor
.x
<= h_margin
)
12104 || (cursor_row
->enabled_p
12105 && cursor_row
->truncated_on_right_p
12106 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12107 /* For right-to-left rows, the logic is similar,
12108 except that rules for scrolling to left and right
12109 are reversed. E.g., if cursor.x <= h_margin, we
12110 need to hscroll "to the right" unconditionally,
12111 and that will scroll the screen to the left so as
12112 to reveal the next portion of the row. */
12114 && ((cursor_row
->enabled_p
12115 /* FIXME: It is confusing to set the
12116 truncated_on_right_p flag when R2L rows
12117 are actually truncated on the left. */
12118 && cursor_row
->truncated_on_right_p
12119 && w
->cursor
.x
<= h_margin
)
12120 || (XFASTINT (w
->hscroll
)
12121 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12125 struct buffer
*saved_current_buffer
;
12129 /* Find point in a display of infinite width. */
12130 saved_current_buffer
= current_buffer
;
12131 current_buffer
= XBUFFER (w
->buffer
);
12133 if (w
== XWINDOW (selected_window
))
12137 pt
= marker_position (w
->pointm
);
12138 pt
= max (BEGV
, pt
);
12142 /* Move iterator to pt starting at cursor_row->start in
12143 a line with infinite width. */
12144 init_to_row_start (&it
, w
, cursor_row
);
12145 it
.last_visible_x
= INFINITY
;
12146 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12147 current_buffer
= saved_current_buffer
;
12149 /* Position cursor in window. */
12150 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12151 hscroll
= max (0, (it
.current_x
12152 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12153 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12154 : (text_area_width
/ 2))))
12155 / FRAME_COLUMN_WIDTH (it
.f
);
12156 else if ((!row_r2l_p
12157 && w
->cursor
.x
>= text_area_width
- h_margin
)
12158 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12160 if (hscroll_relative_p
)
12161 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12164 wanted_x
= text_area_width
12165 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12168 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12172 if (hscroll_relative_p
)
12173 wanted_x
= text_area_width
* hscroll_step_rel
12176 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12179 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12181 hscroll
= max (hscroll
, XFASTINT (w
->min_hscroll
));
12183 /* Don't prevent redisplay optimizations if hscroll
12184 hasn't changed, as it will unnecessarily slow down
12186 if (XFASTINT (w
->hscroll
) != hscroll
)
12188 XBUFFER (w
->buffer
)->prevent_redisplay_optimizations_p
= 1;
12189 w
->hscroll
= make_number (hscroll
);
12198 /* Value is non-zero if hscroll of any leaf window has been changed. */
12199 return hscrolled_p
;
12203 /* Set hscroll so that cursor is visible and not inside horizontal
12204 scroll margins for all windows in the tree rooted at WINDOW. See
12205 also hscroll_window_tree above. Value is non-zero if any window's
12206 hscroll has been changed. If it has, desired matrices on the frame
12207 of WINDOW are cleared. */
12210 hscroll_windows (Lisp_Object window
)
12212 int hscrolled_p
= hscroll_window_tree (window
);
12214 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12215 return hscrolled_p
;
12220 /************************************************************************
12222 ************************************************************************/
12224 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12225 to a non-zero value. This is sometimes handy to have in a debugger
12230 /* First and last unchanged row for try_window_id. */
12232 static int debug_first_unchanged_at_end_vpos
;
12233 static int debug_last_unchanged_at_beg_vpos
;
12235 /* Delta vpos and y. */
12237 static int debug_dvpos
, debug_dy
;
12239 /* Delta in characters and bytes for try_window_id. */
12241 static EMACS_INT debug_delta
, debug_delta_bytes
;
12243 /* Values of window_end_pos and window_end_vpos at the end of
12246 static EMACS_INT debug_end_vpos
;
12248 /* Append a string to W->desired_matrix->method. FMT is a printf
12249 format string. If trace_redisplay_p is non-zero also printf the
12250 resulting string to stderr. */
12252 static void debug_method_add (struct window
*, char const *, ...)
12253 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12256 debug_method_add (struct window
*w
, char const *fmt
, ...)
12259 char *method
= w
->desired_matrix
->method
;
12260 int len
= strlen (method
);
12261 int size
= sizeof w
->desired_matrix
->method
;
12262 int remaining
= size
- len
- 1;
12265 va_start (ap
, fmt
);
12266 vsprintf (buffer
, fmt
, ap
);
12268 if (len
&& remaining
)
12271 --remaining
, ++len
;
12274 strncpy (method
+ len
, buffer
, remaining
);
12276 if (trace_redisplay_p
)
12277 fprintf (stderr
, "%p (%s): %s\n",
12279 ((BUFFERP (w
->buffer
)
12280 && STRINGP (BVAR (XBUFFER (w
->buffer
), name
)))
12281 ? SSDATA (BVAR (XBUFFER (w
->buffer
), name
))
12286 #endif /* GLYPH_DEBUG */
12289 /* Value is non-zero if all changes in window W, which displays
12290 current_buffer, are in the text between START and END. START is a
12291 buffer position, END is given as a distance from Z. Used in
12292 redisplay_internal for display optimization. */
12295 text_outside_line_unchanged_p (struct window
*w
,
12296 EMACS_INT start
, EMACS_INT end
)
12298 int unchanged_p
= 1;
12300 /* If text or overlays have changed, see where. */
12301 if (XFASTINT (w
->last_modified
) < MODIFF
12302 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12304 /* Gap in the line? */
12305 if (GPT
< start
|| Z
- GPT
< end
)
12308 /* Changes start in front of the line, or end after it? */
12310 && (BEG_UNCHANGED
< start
- 1
12311 || END_UNCHANGED
< end
))
12314 /* If selective display, can't optimize if changes start at the
12315 beginning of the line. */
12317 && INTEGERP (BVAR (current_buffer
, selective_display
))
12318 && XINT (BVAR (current_buffer
, selective_display
)) > 0
12319 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
12322 /* If there are overlays at the start or end of the line, these
12323 may have overlay strings with newlines in them. A change at
12324 START, for instance, may actually concern the display of such
12325 overlay strings as well, and they are displayed on different
12326 lines. So, quickly rule out this case. (For the future, it
12327 might be desirable to implement something more telling than
12328 just BEG/END_UNCHANGED.) */
12331 if (BEG
+ BEG_UNCHANGED
== start
12332 && overlay_touches_p (start
))
12334 if (END_UNCHANGED
== end
12335 && overlay_touches_p (Z
- end
))
12339 /* Under bidi reordering, adding or deleting a character in the
12340 beginning of a paragraph, before the first strong directional
12341 character, can change the base direction of the paragraph (unless
12342 the buffer specifies a fixed paragraph direction), which will
12343 require to redisplay the whole paragraph. It might be worthwhile
12344 to find the paragraph limits and widen the range of redisplayed
12345 lines to that, but for now just give up this optimization. */
12346 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
12347 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
12351 return unchanged_p
;
12355 /* Do a frame update, taking possible shortcuts into account. This is
12356 the main external entry point for redisplay.
12358 If the last redisplay displayed an echo area message and that message
12359 is no longer requested, we clear the echo area or bring back the
12360 mini-buffer if that is in use. */
12365 redisplay_internal ();
12370 overlay_arrow_string_or_property (Lisp_Object var
)
12374 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
12377 return Voverlay_arrow_string
;
12380 /* Return 1 if there are any overlay-arrows in current_buffer. */
12382 overlay_arrow_in_current_buffer_p (void)
12386 for (vlist
= Voverlay_arrow_variable_list
;
12388 vlist
= XCDR (vlist
))
12390 Lisp_Object var
= XCAR (vlist
);
12393 if (!SYMBOLP (var
))
12395 val
= find_symbol_value (var
);
12397 && current_buffer
== XMARKER (val
)->buffer
)
12404 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
12408 overlay_arrows_changed_p (void)
12412 for (vlist
= Voverlay_arrow_variable_list
;
12414 vlist
= XCDR (vlist
))
12416 Lisp_Object var
= XCAR (vlist
);
12417 Lisp_Object val
, pstr
;
12419 if (!SYMBOLP (var
))
12421 val
= find_symbol_value (var
);
12422 if (!MARKERP (val
))
12424 if (! EQ (COERCE_MARKER (val
),
12425 Fget (var
, Qlast_arrow_position
))
12426 || ! (pstr
= overlay_arrow_string_or_property (var
),
12427 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
12433 /* Mark overlay arrows to be updated on next redisplay. */
12436 update_overlay_arrows (int up_to_date
)
12440 for (vlist
= Voverlay_arrow_variable_list
;
12442 vlist
= XCDR (vlist
))
12444 Lisp_Object var
= XCAR (vlist
);
12446 if (!SYMBOLP (var
))
12449 if (up_to_date
> 0)
12451 Lisp_Object val
= find_symbol_value (var
);
12452 Fput (var
, Qlast_arrow_position
,
12453 COERCE_MARKER (val
));
12454 Fput (var
, Qlast_arrow_string
,
12455 overlay_arrow_string_or_property (var
));
12457 else if (up_to_date
< 0
12458 || !NILP (Fget (var
, Qlast_arrow_position
)))
12460 Fput (var
, Qlast_arrow_position
, Qt
);
12461 Fput (var
, Qlast_arrow_string
, Qt
);
12467 /* Return overlay arrow string to display at row.
12468 Return integer (bitmap number) for arrow bitmap in left fringe.
12469 Return nil if no overlay arrow. */
12472 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
12476 for (vlist
= Voverlay_arrow_variable_list
;
12478 vlist
= XCDR (vlist
))
12480 Lisp_Object var
= XCAR (vlist
);
12483 if (!SYMBOLP (var
))
12486 val
= find_symbol_value (var
);
12489 && current_buffer
== XMARKER (val
)->buffer
12490 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
12492 if (FRAME_WINDOW_P (it
->f
)
12493 /* FIXME: if ROW->reversed_p is set, this should test
12494 the right fringe, not the left one. */
12495 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
12497 #ifdef HAVE_WINDOW_SYSTEM
12498 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
12501 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
12502 return make_number (fringe_bitmap
);
12505 return make_number (-1); /* Use default arrow bitmap */
12507 return overlay_arrow_string_or_property (var
);
12514 /* Return 1 if point moved out of or into a composition. Otherwise
12515 return 0. PREV_BUF and PREV_PT are the last point buffer and
12516 position. BUF and PT are the current point buffer and position. */
12519 check_point_in_composition (struct buffer
*prev_buf
, EMACS_INT prev_pt
,
12520 struct buffer
*buf
, EMACS_INT pt
)
12522 EMACS_INT start
, end
;
12524 Lisp_Object buffer
;
12526 XSETBUFFER (buffer
, buf
);
12527 /* Check a composition at the last point if point moved within the
12529 if (prev_buf
== buf
)
12532 /* Point didn't move. */
12535 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
12536 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
12537 && COMPOSITION_VALID_P (start
, end
, prop
)
12538 && start
< prev_pt
&& end
> prev_pt
)
12539 /* The last point was within the composition. Return 1 iff
12540 point moved out of the composition. */
12541 return (pt
<= start
|| pt
>= end
);
12544 /* Check a composition at the current point. */
12545 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
12546 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
12547 && COMPOSITION_VALID_P (start
, end
, prop
)
12548 && start
< pt
&& end
> pt
);
12552 /* Reconsider the setting of B->clip_changed which is displayed
12556 reconsider_clip_changes (struct window
*w
, struct buffer
*b
)
12558 if (b
->clip_changed
12559 && !NILP (w
->window_end_valid
)
12560 && w
->current_matrix
->buffer
== b
12561 && w
->current_matrix
->zv
== BUF_ZV (b
)
12562 && w
->current_matrix
->begv
== BUF_BEGV (b
))
12563 b
->clip_changed
= 0;
12565 /* If display wasn't paused, and W is not a tool bar window, see if
12566 point has been moved into or out of a composition. In that case,
12567 we set b->clip_changed to 1 to force updating the screen. If
12568 b->clip_changed has already been set to 1, we can skip this
12570 if (!b
->clip_changed
12571 && BUFFERP (w
->buffer
) && !NILP (w
->window_end_valid
))
12575 if (w
== XWINDOW (selected_window
))
12578 pt
= marker_position (w
->pointm
);
12580 if ((w
->current_matrix
->buffer
!= XBUFFER (w
->buffer
)
12581 || pt
!= XINT (w
->last_point
))
12582 && check_point_in_composition (w
->current_matrix
->buffer
,
12583 XINT (w
->last_point
),
12584 XBUFFER (w
->buffer
), pt
))
12585 b
->clip_changed
= 1;
12590 /* Select FRAME to forward the values of frame-local variables into C
12591 variables so that the redisplay routines can access those values
12595 select_frame_for_redisplay (Lisp_Object frame
)
12597 Lisp_Object tail
, tem
;
12598 Lisp_Object old
= selected_frame
;
12599 struct Lisp_Symbol
*sym
;
12601 xassert (FRAMEP (frame
) && FRAME_LIVE_P (XFRAME (frame
)));
12603 selected_frame
= frame
;
12606 for (tail
= XFRAME (frame
)->param_alist
; CONSP (tail
); tail
= XCDR (tail
))
12607 if (CONSP (XCAR (tail
))
12608 && (tem
= XCAR (XCAR (tail
)),
12610 && (sym
= indirect_variable (XSYMBOL (tem
)),
12611 sym
->redirect
== SYMBOL_LOCALIZED
)
12612 && sym
->val
.blv
->frame_local
)
12613 /* Use find_symbol_value rather than Fsymbol_value
12614 to avoid an error if it is void. */
12615 find_symbol_value (tem
);
12616 } while (!EQ (frame
, old
) && (frame
= old
, 1));
12620 #define STOP_POLLING \
12621 do { if (! polling_stopped_here) stop_polling (); \
12622 polling_stopped_here = 1; } while (0)
12624 #define RESUME_POLLING \
12625 do { if (polling_stopped_here) start_polling (); \
12626 polling_stopped_here = 0; } while (0)
12629 /* Perhaps in the future avoid recentering windows if it
12630 is not necessary; currently that causes some problems. */
12633 redisplay_internal (void)
12635 struct window
*w
= XWINDOW (selected_window
);
12639 int must_finish
= 0;
12640 struct text_pos tlbufpos
, tlendpos
;
12641 int number_of_visible_frames
;
12644 int polling_stopped_here
= 0;
12645 Lisp_Object old_frame
= selected_frame
;
12647 /* Non-zero means redisplay has to consider all windows on all
12648 frames. Zero means, only selected_window is considered. */
12649 int consider_all_windows_p
;
12651 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
12653 /* No redisplay if running in batch mode or frame is not yet fully
12654 initialized, or redisplay is explicitly turned off by setting
12655 Vinhibit_redisplay. */
12656 if (FRAME_INITIAL_P (SELECTED_FRAME ())
12657 || !NILP (Vinhibit_redisplay
))
12660 /* Don't examine these until after testing Vinhibit_redisplay.
12661 When Emacs is shutting down, perhaps because its connection to
12662 X has dropped, we should not look at them at all. */
12663 fr
= XFRAME (w
->frame
);
12664 sf
= SELECTED_FRAME ();
12666 if (!fr
->glyphs_initialized_p
)
12669 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
12670 if (popup_activated ())
12674 /* I don't think this happens but let's be paranoid. */
12675 if (redisplaying_p
)
12678 /* Record a function that resets redisplaying_p to its old value
12679 when we leave this function. */
12680 count
= SPECPDL_INDEX ();
12681 record_unwind_protect (unwind_redisplay
,
12682 Fcons (make_number (redisplaying_p
), selected_frame
));
12684 specbind (Qinhibit_free_realized_faces
, Qnil
);
12687 Lisp_Object tail
, frame
;
12689 FOR_EACH_FRAME (tail
, frame
)
12691 struct frame
*f
= XFRAME (frame
);
12692 f
->already_hscrolled_p
= 0;
12697 /* Remember the currently selected window. */
12700 if (!EQ (old_frame
, selected_frame
)
12701 && FRAME_LIVE_P (XFRAME (old_frame
)))
12702 /* When running redisplay, we play a bit fast-and-loose and allow e.g.
12703 selected_frame and selected_window to be temporarily out-of-sync so
12704 when we come back here via `goto retry', we need to resync because we
12705 may need to run Elisp code (via prepare_menu_bars). */
12706 select_frame_for_redisplay (old_frame
);
12709 reconsider_clip_changes (w
, current_buffer
);
12710 last_escape_glyph_frame
= NULL
;
12711 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
12712 last_glyphless_glyph_frame
= NULL
;
12713 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
12715 /* If new fonts have been loaded that make a glyph matrix adjustment
12716 necessary, do it. */
12717 if (fonts_changed_p
)
12719 adjust_glyphs (NULL
);
12720 ++windows_or_buffers_changed
;
12721 fonts_changed_p
= 0;
12724 /* If face_change_count is non-zero, init_iterator will free all
12725 realized faces, which includes the faces referenced from current
12726 matrices. So, we can't reuse current matrices in this case. */
12727 if (face_change_count
)
12728 ++windows_or_buffers_changed
;
12730 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
12731 && FRAME_TTY (sf
)->previous_frame
!= sf
)
12733 /* Since frames on a single ASCII terminal share the same
12734 display area, displaying a different frame means redisplay
12735 the whole thing. */
12736 windows_or_buffers_changed
++;
12737 SET_FRAME_GARBAGED (sf
);
12739 set_tty_color_mode (FRAME_TTY (sf
), sf
);
12741 FRAME_TTY (sf
)->previous_frame
= sf
;
12744 /* Set the visible flags for all frames. Do this before checking
12745 for resized or garbaged frames; they want to know if their frames
12746 are visible. See the comment in frame.h for
12747 FRAME_SAMPLE_VISIBILITY. */
12749 Lisp_Object tail
, frame
;
12751 number_of_visible_frames
= 0;
12753 FOR_EACH_FRAME (tail
, frame
)
12755 struct frame
*f
= XFRAME (frame
);
12757 FRAME_SAMPLE_VISIBILITY (f
);
12758 if (FRAME_VISIBLE_P (f
))
12759 ++number_of_visible_frames
;
12760 clear_desired_matrices (f
);
12764 /* Notice any pending interrupt request to change frame size. */
12765 do_pending_window_change (1);
12767 /* do_pending_window_change could change the selected_window due to
12768 frame resizing which makes the selected window too small. */
12769 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
12772 reconsider_clip_changes (w
, current_buffer
);
12775 /* Clear frames marked as garbaged. */
12776 if (frame_garbaged
)
12777 clear_garbaged_frames ();
12779 /* Build menubar and tool-bar items. */
12780 if (NILP (Vmemory_full
))
12781 prepare_menu_bars ();
12783 if (windows_or_buffers_changed
)
12784 update_mode_lines
++;
12786 /* Detect case that we need to write or remove a star in the mode line. */
12787 if ((SAVE_MODIFF
< MODIFF
) != !NILP (w
->last_had_star
))
12789 w
->update_mode_line
= Qt
;
12790 if (buffer_shared
> 1)
12791 update_mode_lines
++;
12794 /* Avoid invocation of point motion hooks by `current_column' below. */
12795 count1
= SPECPDL_INDEX ();
12796 specbind (Qinhibit_point_motion_hooks
, Qt
);
12798 /* If %c is in the mode line, update it if needed. */
12799 if (!NILP (w
->column_number_displayed
)
12800 /* This alternative quickly identifies a common case
12801 where no change is needed. */
12802 && !(PT
== XFASTINT (w
->last_point
)
12803 && XFASTINT (w
->last_modified
) >= MODIFF
12804 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
12805 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
12806 w
->update_mode_line
= Qt
;
12808 unbind_to (count1
, Qnil
);
12810 FRAME_SCROLL_BOTTOM_VPOS (XFRAME (w
->frame
)) = -1;
12812 /* The variable buffer_shared is set in redisplay_window and
12813 indicates that we redisplay a buffer in different windows. See
12815 consider_all_windows_p
= (update_mode_lines
|| buffer_shared
> 1
12816 || cursor_type_changed
);
12818 /* If specs for an arrow have changed, do thorough redisplay
12819 to ensure we remove any arrow that should no longer exist. */
12820 if (overlay_arrows_changed_p ())
12821 consider_all_windows_p
= windows_or_buffers_changed
= 1;
12823 /* Normally the message* functions will have already displayed and
12824 updated the echo area, but the frame may have been trashed, or
12825 the update may have been preempted, so display the echo area
12826 again here. Checking message_cleared_p captures the case that
12827 the echo area should be cleared. */
12828 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
12829 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
12830 || (message_cleared_p
12831 && minibuf_level
== 0
12832 /* If the mini-window is currently selected, this means the
12833 echo-area doesn't show through. */
12834 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
12836 int window_height_changed_p
= echo_area_display (0);
12839 /* If we don't display the current message, don't clear the
12840 message_cleared_p flag, because, if we did, we wouldn't clear
12841 the echo area in the next redisplay which doesn't preserve
12843 if (!display_last_displayed_message_p
)
12844 message_cleared_p
= 0;
12846 if (fonts_changed_p
)
12848 else if (window_height_changed_p
)
12850 consider_all_windows_p
= 1;
12851 ++update_mode_lines
;
12852 ++windows_or_buffers_changed
;
12854 /* If window configuration was changed, frames may have been
12855 marked garbaged. Clear them or we will experience
12856 surprises wrt scrolling. */
12857 if (frame_garbaged
)
12858 clear_garbaged_frames ();
12861 else if (EQ (selected_window
, minibuf_window
)
12862 && (current_buffer
->clip_changed
12863 || XFASTINT (w
->last_modified
) < MODIFF
12864 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
)
12865 && resize_mini_window (w
, 0))
12867 /* Resized active mini-window to fit the size of what it is
12868 showing if its contents might have changed. */
12870 /* FIXME: this causes all frames to be updated, which seems unnecessary
12871 since only the current frame needs to be considered. This function needs
12872 to be rewritten with two variables, consider_all_windows and
12873 consider_all_frames. */
12874 consider_all_windows_p
= 1;
12875 ++windows_or_buffers_changed
;
12876 ++update_mode_lines
;
12878 /* If window configuration was changed, frames may have been
12879 marked garbaged. Clear them or we will experience
12880 surprises wrt scrolling. */
12881 if (frame_garbaged
)
12882 clear_garbaged_frames ();
12886 /* If showing the region, and mark has changed, we must redisplay
12887 the whole window. The assignment to this_line_start_pos prevents
12888 the optimization directly below this if-statement. */
12889 if (((!NILP (Vtransient_mark_mode
)
12890 && !NILP (BVAR (XBUFFER (w
->buffer
), mark_active
)))
12891 != !NILP (w
->region_showing
))
12892 || (!NILP (w
->region_showing
)
12893 && !EQ (w
->region_showing
,
12894 Fmarker_position (BVAR (XBUFFER (w
->buffer
), mark
)))))
12895 CHARPOS (this_line_start_pos
) = 0;
12897 /* Optimize the case that only the line containing the cursor in the
12898 selected window has changed. Variables starting with this_ are
12899 set in display_line and record information about the line
12900 containing the cursor. */
12901 tlbufpos
= this_line_start_pos
;
12902 tlendpos
= this_line_end_pos
;
12903 if (!consider_all_windows_p
12904 && CHARPOS (tlbufpos
) > 0
12905 && NILP (w
->update_mode_line
)
12906 && !current_buffer
->clip_changed
12907 && !current_buffer
->prevent_redisplay_optimizations_p
12908 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
12909 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
12910 /* Make sure recorded data applies to current buffer, etc. */
12911 && this_line_buffer
== current_buffer
12912 && current_buffer
== XBUFFER (w
->buffer
)
12913 && NILP (w
->force_start
)
12914 && NILP (w
->optional_new_start
)
12915 /* Point must be on the line that we have info recorded about. */
12916 && PT
>= CHARPOS (tlbufpos
)
12917 && PT
<= Z
- CHARPOS (tlendpos
)
12918 /* All text outside that line, including its final newline,
12919 must be unchanged. */
12920 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
12921 CHARPOS (tlendpos
)))
12923 if (CHARPOS (tlbufpos
) > BEGV
12924 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
12925 && (CHARPOS (tlbufpos
) == ZV
12926 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
12927 /* Former continuation line has disappeared by becoming empty. */
12929 else if (XFASTINT (w
->last_modified
) < MODIFF
12930 || XFASTINT (w
->last_overlay_modified
) < OVERLAY_MODIFF
12931 || MINI_WINDOW_P (w
))
12933 /* We have to handle the case of continuation around a
12934 wide-column character (see the comment in indent.c around
12937 For instance, in the following case:
12939 -------- Insert --------
12940 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
12941 J_I_ ==> J_I_ `^^' are cursors.
12945 As we have to redraw the line above, we cannot use this
12949 int line_height_before
= this_line_pixel_height
;
12951 /* Note that start_display will handle the case that the
12952 line starting at tlbufpos is a continuation line. */
12953 start_display (&it
, w
, tlbufpos
);
12955 /* Implementation note: It this still necessary? */
12956 if (it
.current_x
!= this_line_start_x
)
12959 TRACE ((stderr
, "trying display optimization 1\n"));
12960 w
->cursor
.vpos
= -1;
12961 overlay_arrow_seen
= 0;
12962 it
.vpos
= this_line_vpos
;
12963 it
.current_y
= this_line_y
;
12964 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
12965 display_line (&it
);
12967 /* If line contains point, is not continued,
12968 and ends at same distance from eob as before, we win. */
12969 if (w
->cursor
.vpos
>= 0
12970 /* Line is not continued, otherwise this_line_start_pos
12971 would have been set to 0 in display_line. */
12972 && CHARPOS (this_line_start_pos
)
12973 /* Line ends as before. */
12974 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
12975 /* Line has same height as before. Otherwise other lines
12976 would have to be shifted up or down. */
12977 && this_line_pixel_height
== line_height_before
)
12979 /* If this is not the window's last line, we must adjust
12980 the charstarts of the lines below. */
12981 if (it
.current_y
< it
.last_visible_y
)
12983 struct glyph_row
*row
12984 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
12985 EMACS_INT delta
, delta_bytes
;
12987 /* We used to distinguish between two cases here,
12988 conditioned by Z - CHARPOS (tlendpos) == ZV, for
12989 when the line ends in a newline or the end of the
12990 buffer's accessible portion. But both cases did
12991 the same, so they were collapsed. */
12993 - CHARPOS (tlendpos
)
12994 - MATRIX_ROW_START_CHARPOS (row
));
12995 delta_bytes
= (Z_BYTE
12996 - BYTEPOS (tlendpos
)
12997 - MATRIX_ROW_START_BYTEPOS (row
));
12999 increment_matrix_positions (w
->current_matrix
,
13000 this_line_vpos
+ 1,
13001 w
->current_matrix
->nrows
,
13002 delta
, delta_bytes
);
13005 /* If this row displays text now but previously didn't,
13006 or vice versa, w->window_end_vpos may have to be
13008 if ((it
.glyph_row
- 1)->displays_text_p
)
13010 if (XFASTINT (w
->window_end_vpos
) < this_line_vpos
)
13011 XSETINT (w
->window_end_vpos
, this_line_vpos
);
13013 else if (XFASTINT (w
->window_end_vpos
) == this_line_vpos
13014 && this_line_vpos
> 0)
13015 XSETINT (w
->window_end_vpos
, this_line_vpos
- 1);
13016 w
->window_end_valid
= Qnil
;
13018 /* Update hint: No need to try to scroll in update_window. */
13019 w
->desired_matrix
->no_scrolling_p
= 1;
13022 *w
->desired_matrix
->method
= 0;
13023 debug_method_add (w
, "optimization 1");
13025 #ifdef HAVE_WINDOW_SYSTEM
13026 update_window_fringes (w
, 0);
13033 else if (/* Cursor position hasn't changed. */
13034 PT
== XFASTINT (w
->last_point
)
13035 /* Make sure the cursor was last displayed
13036 in this window. Otherwise we have to reposition it. */
13037 && 0 <= w
->cursor
.vpos
13038 && WINDOW_TOTAL_LINES (w
) > w
->cursor
.vpos
)
13042 do_pending_window_change (1);
13043 /* If selected_window changed, redisplay again. */
13044 if (WINDOWP (selected_window
)
13045 && (w
= XWINDOW (selected_window
)) != sw
)
13048 /* We used to always goto end_of_redisplay here, but this
13049 isn't enough if we have a blinking cursor. */
13050 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13051 goto end_of_redisplay
;
13055 /* If highlighting the region, or if the cursor is in the echo area,
13056 then we can't just move the cursor. */
13057 else if (! (!NILP (Vtransient_mark_mode
)
13058 && !NILP (BVAR (current_buffer
, mark_active
)))
13059 && (EQ (selected_window
, BVAR (current_buffer
, last_selected_window
))
13060 || highlight_nonselected_windows
)
13061 && NILP (w
->region_showing
)
13062 && NILP (Vshow_trailing_whitespace
)
13063 && !cursor_in_echo_area
)
13066 struct glyph_row
*row
;
13068 /* Skip from tlbufpos to PT and see where it is. Note that
13069 PT may be in invisible text. If so, we will end at the
13070 next visible position. */
13071 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13072 NULL
, DEFAULT_FACE_ID
);
13073 it
.current_x
= this_line_start_x
;
13074 it
.current_y
= this_line_y
;
13075 it
.vpos
= this_line_vpos
;
13077 /* The call to move_it_to stops in front of PT, but
13078 moves over before-strings. */
13079 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13081 if (it
.vpos
== this_line_vpos
13082 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13085 xassert (this_line_vpos
== it
.vpos
);
13086 xassert (this_line_y
== it
.current_y
);
13087 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13089 *w
->desired_matrix
->method
= 0;
13090 debug_method_add (w
, "optimization 3");
13099 /* Text changed drastically or point moved off of line. */
13100 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, 0);
13103 CHARPOS (this_line_start_pos
) = 0;
13104 consider_all_windows_p
|= buffer_shared
> 1;
13105 ++clear_face_cache_count
;
13106 #ifdef HAVE_WINDOW_SYSTEM
13107 ++clear_image_cache_count
;
13110 /* Build desired matrices, and update the display. If
13111 consider_all_windows_p is non-zero, do it for all windows on all
13112 frames. Otherwise do it for selected_window, only. */
13114 if (consider_all_windows_p
)
13116 Lisp_Object tail
, frame
;
13118 FOR_EACH_FRAME (tail
, frame
)
13119 XFRAME (frame
)->updated_p
= 0;
13121 /* Recompute # windows showing selected buffer. This will be
13122 incremented each time such a window is displayed. */
13125 FOR_EACH_FRAME (tail
, frame
)
13127 struct frame
*f
= XFRAME (frame
);
13129 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13131 if (! EQ (frame
, selected_frame
))
13132 /* Select the frame, for the sake of frame-local
13134 select_frame_for_redisplay (frame
);
13136 /* Mark all the scroll bars to be removed; we'll redeem
13137 the ones we want when we redisplay their windows. */
13138 if (FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13139 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13141 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13142 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13144 /* The X error handler may have deleted that frame. */
13145 if (!FRAME_LIVE_P (f
))
13148 /* Any scroll bars which redisplay_windows should have
13149 nuked should now go away. */
13150 if (FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13151 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13153 /* If fonts changed, display again. */
13154 /* ??? rms: I suspect it is a mistake to jump all the way
13155 back to retry here. It should just retry this frame. */
13156 if (fonts_changed_p
)
13159 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13161 /* See if we have to hscroll. */
13162 if (!f
->already_hscrolled_p
)
13164 f
->already_hscrolled_p
= 1;
13165 if (hscroll_windows (f
->root_window
))
13169 /* Prevent various kinds of signals during display
13170 update. stdio is not robust about handling
13171 signals, which can cause an apparent I/O
13173 if (interrupt_input
)
13174 unrequest_sigio ();
13177 /* Update the display. */
13178 set_window_update_flags (XWINDOW (f
->root_window
), 1);
13179 pending
|= update_frame (f
, 0, 0);
13185 if (!EQ (old_frame
, selected_frame
)
13186 && FRAME_LIVE_P (XFRAME (old_frame
)))
13187 /* We played a bit fast-and-loose above and allowed selected_frame
13188 and selected_window to be temporarily out-of-sync but let's make
13189 sure this stays contained. */
13190 select_frame_for_redisplay (old_frame
);
13191 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13195 /* Do the mark_window_display_accurate after all windows have
13196 been redisplayed because this call resets flags in buffers
13197 which are needed for proper redisplay. */
13198 FOR_EACH_FRAME (tail
, frame
)
13200 struct frame
*f
= XFRAME (frame
);
13203 mark_window_display_accurate (f
->root_window
, 1);
13204 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13205 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13210 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13212 Lisp_Object mini_window
;
13213 struct frame
*mini_frame
;
13215 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->buffer
);
13216 /* Use list_of_error, not Qerror, so that
13217 we catch only errors and don't run the debugger. */
13218 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13220 redisplay_window_error
);
13222 /* Compare desired and current matrices, perform output. */
13225 /* If fonts changed, display again. */
13226 if (fonts_changed_p
)
13229 /* Prevent various kinds of signals during display update.
13230 stdio is not robust about handling signals,
13231 which can cause an apparent I/O error. */
13232 if (interrupt_input
)
13233 unrequest_sigio ();
13236 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13238 if (hscroll_windows (selected_window
))
13241 XWINDOW (selected_window
)->must_be_updated_p
= 1;
13242 pending
= update_frame (sf
, 0, 0);
13245 /* We may have called echo_area_display at the top of this
13246 function. If the echo area is on another frame, that may
13247 have put text on a frame other than the selected one, so the
13248 above call to update_frame would not have caught it. Catch
13250 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13251 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13253 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13255 XWINDOW (mini_window
)->must_be_updated_p
= 1;
13256 pending
|= update_frame (mini_frame
, 0, 0);
13257 if (!pending
&& hscroll_windows (mini_window
))
13262 /* If display was paused because of pending input, make sure we do a
13263 thorough update the next time. */
13266 /* Prevent the optimization at the beginning of
13267 redisplay_internal that tries a single-line update of the
13268 line containing the cursor in the selected window. */
13269 CHARPOS (this_line_start_pos
) = 0;
13271 /* Let the overlay arrow be updated the next time. */
13272 update_overlay_arrows (0);
13274 /* If we pause after scrolling, some rows in the current
13275 matrices of some windows are not valid. */
13276 if (!WINDOW_FULL_WIDTH_P (w
)
13277 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13278 update_mode_lines
= 1;
13282 if (!consider_all_windows_p
)
13284 /* This has already been done above if
13285 consider_all_windows_p is set. */
13286 mark_window_display_accurate_1 (w
, 1);
13288 /* Say overlay arrows are up to date. */
13289 update_overlay_arrows (1);
13291 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13292 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13295 update_mode_lines
= 0;
13296 windows_or_buffers_changed
= 0;
13297 cursor_type_changed
= 0;
13300 /* Start SIGIO interrupts coming again. Having them off during the
13301 code above makes it less likely one will discard output, but not
13302 impossible, since there might be stuff in the system buffer here.
13303 But it is much hairier to try to do anything about that. */
13304 if (interrupt_input
)
13308 /* If a frame has become visible which was not before, redisplay
13309 again, so that we display it. Expose events for such a frame
13310 (which it gets when becoming visible) don't call the parts of
13311 redisplay constructing glyphs, so simply exposing a frame won't
13312 display anything in this case. So, we have to display these
13313 frames here explicitly. */
13316 Lisp_Object tail
, frame
;
13319 FOR_EACH_FRAME (tail
, frame
)
13321 int this_is_visible
= 0;
13323 if (XFRAME (frame
)->visible
)
13324 this_is_visible
= 1;
13325 FRAME_SAMPLE_VISIBILITY (XFRAME (frame
));
13326 if (XFRAME (frame
)->visible
)
13327 this_is_visible
= 1;
13329 if (this_is_visible
)
13333 if (new_count
!= number_of_visible_frames
)
13334 windows_or_buffers_changed
++;
13337 /* Change frame size now if a change is pending. */
13338 do_pending_window_change (1);
13340 /* If we just did a pending size change, or have additional
13341 visible frames, or selected_window changed, redisplay again. */
13342 if ((windows_or_buffers_changed
&& !pending
)
13343 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13346 /* Clear the face and image caches.
13348 We used to do this only if consider_all_windows_p. But the cache
13349 needs to be cleared if a timer creates images in the current
13350 buffer (e.g. the test case in Bug#6230). */
13352 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13354 clear_face_cache (0);
13355 clear_face_cache_count
= 0;
13358 #ifdef HAVE_WINDOW_SYSTEM
13359 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13361 clear_image_caches (Qnil
);
13362 clear_image_cache_count
= 0;
13364 #endif /* HAVE_WINDOW_SYSTEM */
13367 unbind_to (count
, Qnil
);
13372 /* Redisplay, but leave alone any recent echo area message unless
13373 another message has been requested in its place.
13375 This is useful in situations where you need to redisplay but no
13376 user action has occurred, making it inappropriate for the message
13377 area to be cleared. See tracking_off and
13378 wait_reading_process_output for examples of these situations.
13380 FROM_WHERE is an integer saying from where this function was
13381 called. This is useful for debugging. */
13384 redisplay_preserve_echo_area (int from_where
)
13386 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
13388 if (!NILP (echo_area_buffer
[1]))
13390 /* We have a previously displayed message, but no current
13391 message. Redisplay the previous message. */
13392 display_last_displayed_message_p
= 1;
13393 redisplay_internal ();
13394 display_last_displayed_message_p
= 0;
13397 redisplay_internal ();
13399 if (FRAME_RIF (SELECTED_FRAME ()) != NULL
13400 && FRAME_RIF (SELECTED_FRAME ())->flush_display_optional
)
13401 FRAME_RIF (SELECTED_FRAME ())->flush_display_optional (NULL
);
13405 /* Function registered with record_unwind_protect in
13406 redisplay_internal. Reset redisplaying_p to the value it had
13407 before redisplay_internal was called, and clear
13408 prevent_freeing_realized_faces_p. It also selects the previously
13409 selected frame, unless it has been deleted (by an X connection
13410 failure during redisplay, for example). */
13413 unwind_redisplay (Lisp_Object val
)
13415 Lisp_Object old_redisplaying_p
, old_frame
;
13417 old_redisplaying_p
= XCAR (val
);
13418 redisplaying_p
= XFASTINT (old_redisplaying_p
);
13419 old_frame
= XCDR (val
);
13420 if (! EQ (old_frame
, selected_frame
)
13421 && FRAME_LIVE_P (XFRAME (old_frame
)))
13422 select_frame_for_redisplay (old_frame
);
13427 /* Mark the display of window W as accurate or inaccurate. If
13428 ACCURATE_P is non-zero mark display of W as accurate. If
13429 ACCURATE_P is zero, arrange for W to be redisplayed the next time
13430 redisplay_internal is called. */
13433 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
13435 if (BUFFERP (w
->buffer
))
13437 struct buffer
*b
= XBUFFER (w
->buffer
);
13440 = make_number (accurate_p
? BUF_MODIFF (b
) : 0);
13441 w
->last_overlay_modified
13442 = make_number (accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0);
13444 = BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
) ? Qt
: Qnil
;
13448 b
->clip_changed
= 0;
13449 b
->prevent_redisplay_optimizations_p
= 0;
13451 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
13452 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
13453 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
13454 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
13456 w
->current_matrix
->buffer
= b
;
13457 w
->current_matrix
->begv
= BUF_BEGV (b
);
13458 w
->current_matrix
->zv
= BUF_ZV (b
);
13460 w
->last_cursor
= w
->cursor
;
13461 w
->last_cursor_off_p
= w
->cursor_off_p
;
13463 if (w
== XWINDOW (selected_window
))
13464 w
->last_point
= make_number (BUF_PT (b
));
13466 w
->last_point
= make_number (XMARKER (w
->pointm
)->charpos
);
13472 w
->window_end_valid
= w
->buffer
;
13473 w
->update_mode_line
= Qnil
;
13478 /* Mark the display of windows in the window tree rooted at WINDOW as
13479 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
13480 windows as accurate. If ACCURATE_P is zero, arrange for windows to
13481 be redisplayed the next time redisplay_internal is called. */
13484 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
13488 for (; !NILP (window
); window
= w
->next
)
13490 w
= XWINDOW (window
);
13491 mark_window_display_accurate_1 (w
, accurate_p
);
13493 if (!NILP (w
->vchild
))
13494 mark_window_display_accurate (w
->vchild
, accurate_p
);
13495 if (!NILP (w
->hchild
))
13496 mark_window_display_accurate (w
->hchild
, accurate_p
);
13501 update_overlay_arrows (1);
13505 /* Force a thorough redisplay the next time by setting
13506 last_arrow_position and last_arrow_string to t, which is
13507 unequal to any useful value of Voverlay_arrow_... */
13508 update_overlay_arrows (-1);
13513 /* Return value in display table DP (Lisp_Char_Table *) for character
13514 C. Since a display table doesn't have any parent, we don't have to
13515 follow parent. Do not call this function directly but use the
13516 macro DISP_CHAR_VECTOR. */
13519 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
13523 if (ASCII_CHAR_P (c
))
13526 if (SUB_CHAR_TABLE_P (val
))
13527 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
13533 XSETCHAR_TABLE (table
, dp
);
13534 val
= char_table_ref (table
, c
);
13543 /***********************************************************************
13545 ***********************************************************************/
13547 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
13550 redisplay_windows (Lisp_Object window
)
13552 while (!NILP (window
))
13554 struct window
*w
= XWINDOW (window
);
13556 if (!NILP (w
->hchild
))
13557 redisplay_windows (w
->hchild
);
13558 else if (!NILP (w
->vchild
))
13559 redisplay_windows (w
->vchild
);
13560 else if (!NILP (w
->buffer
))
13562 displayed_buffer
= XBUFFER (w
->buffer
);
13563 /* Use list_of_error, not Qerror, so that
13564 we catch only errors and don't run the debugger. */
13565 internal_condition_case_1 (redisplay_window_0
, window
,
13567 redisplay_window_error
);
13575 redisplay_window_error (Lisp_Object ignore
)
13577 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
13582 redisplay_window_0 (Lisp_Object window
)
13584 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13585 redisplay_window (window
, 0);
13590 redisplay_window_1 (Lisp_Object window
)
13592 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
13593 redisplay_window (window
, 1);
13598 /* Set cursor position of W. PT is assumed to be displayed in ROW.
13599 DELTA and DELTA_BYTES are the numbers of characters and bytes by
13600 which positions recorded in ROW differ from current buffer
13603 Return 0 if cursor is not on this row, 1 otherwise. */
13606 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
13607 struct glyph_matrix
*matrix
,
13608 EMACS_INT delta
, EMACS_INT delta_bytes
,
13611 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
13612 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
13613 struct glyph
*cursor
= NULL
;
13614 /* The last known character position in row. */
13615 EMACS_INT last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13617 EMACS_INT pt_old
= PT
- delta
;
13618 EMACS_INT pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
13619 EMACS_INT pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13620 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
13621 /* A glyph beyond the edge of TEXT_AREA which we should never
13623 struct glyph
*glyphs_end
= end
;
13624 /* Non-zero means we've found a match for cursor position, but that
13625 glyph has the avoid_cursor_p flag set. */
13626 int match_with_avoid_cursor
= 0;
13627 /* Non-zero means we've seen at least one glyph that came from a
13629 int string_seen
= 0;
13630 /* Largest and smalles buffer positions seen so far during scan of
13632 EMACS_INT bpos_max
= pos_before
;
13633 EMACS_INT bpos_min
= pos_after
;
13634 /* Last buffer position covered by an overlay string with an integer
13635 `cursor' property. */
13636 EMACS_INT bpos_covered
= 0;
13637 /* Non-zero means the display string on which to display the cursor
13638 comes from a text property, not from an overlay. */
13639 int string_from_text_prop
= 0;
13641 /* Skip over glyphs not having an object at the start and the end of
13642 the row. These are special glyphs like truncation marks on
13643 terminal frames. */
13644 if (row
->displays_text_p
)
13646 if (!row
->reversed_p
)
13649 && INTEGERP (glyph
->object
)
13650 && glyph
->charpos
< 0)
13652 x
+= glyph
->pixel_width
;
13656 && INTEGERP ((end
- 1)->object
)
13657 /* CHARPOS is zero for blanks and stretch glyphs
13658 inserted by extend_face_to_end_of_line. */
13659 && (end
- 1)->charpos
<= 0)
13661 glyph_before
= glyph
- 1;
13668 /* If the glyph row is reversed, we need to process it from back
13669 to front, so swap the edge pointers. */
13670 glyphs_end
= end
= glyph
- 1;
13671 glyph
+= row
->used
[TEXT_AREA
] - 1;
13673 while (glyph
> end
+ 1
13674 && INTEGERP (glyph
->object
)
13675 && glyph
->charpos
< 0)
13678 x
-= glyph
->pixel_width
;
13680 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
13682 /* By default, in reversed rows we put the cursor on the
13683 rightmost (first in the reading order) glyph. */
13684 for (g
= end
+ 1; g
< glyph
; g
++)
13685 x
+= g
->pixel_width
;
13687 && INTEGERP ((end
+ 1)->object
)
13688 && (end
+ 1)->charpos
<= 0)
13690 glyph_before
= glyph
+ 1;
13694 else if (row
->reversed_p
)
13696 /* In R2L rows that don't display text, put the cursor on the
13697 rightmost glyph. Case in point: an empty last line that is
13698 part of an R2L paragraph. */
13700 /* Avoid placing the cursor on the last glyph of the row, where
13701 on terminal frames we hold the vertical border between
13702 adjacent windows. */
13703 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
13704 && !WINDOW_RIGHTMOST_P (w
)
13705 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
13707 x
= -1; /* will be computed below, at label compute_x */
13710 /* Step 1: Try to find the glyph whose character position
13711 corresponds to point. If that's not possible, find 2 glyphs
13712 whose character positions are the closest to point, one before
13713 point, the other after it. */
13714 if (!row
->reversed_p
)
13715 while (/* not marched to end of glyph row */
13717 /* glyph was not inserted by redisplay for internal purposes */
13718 && !INTEGERP (glyph
->object
))
13720 if (BUFFERP (glyph
->object
))
13722 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13724 if (glyph
->charpos
> bpos_max
)
13725 bpos_max
= glyph
->charpos
;
13726 if (glyph
->charpos
< bpos_min
)
13727 bpos_min
= glyph
->charpos
;
13728 if (!glyph
->avoid_cursor_p
)
13730 /* If we hit point, we've found the glyph on which to
13731 display the cursor. */
13734 match_with_avoid_cursor
= 0;
13737 /* See if we've found a better approximation to
13738 POS_BEFORE or to POS_AFTER. Note that we want the
13739 first (leftmost) glyph of all those that are the
13740 closest from below, and the last (rightmost) of all
13741 those from above. */
13742 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13744 pos_before
= glyph
->charpos
;
13745 glyph_before
= glyph
;
13747 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13749 pos_after
= glyph
->charpos
;
13750 glyph_after
= glyph
;
13753 else if (dpos
== 0)
13754 match_with_avoid_cursor
= 1;
13756 else if (STRINGP (glyph
->object
))
13758 Lisp_Object chprop
;
13759 EMACS_INT glyph_pos
= glyph
->charpos
;
13761 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13763 if (INTEGERP (chprop
))
13765 bpos_covered
= bpos_max
+ XINT (chprop
);
13766 /* If the `cursor' property covers buffer positions up
13767 to and including point, we should display cursor on
13768 this glyph. Note that overlays and text properties
13769 with string values stop bidi reordering, so every
13770 buffer position to the left of the string is always
13771 smaller than any position to the right of the
13772 string. Therefore, if a `cursor' property on one
13773 of the string's characters has an integer value, we
13774 will break out of the loop below _before_ we get to
13775 the position match above. IOW, integer values of
13776 the `cursor' property override the "exact match for
13777 point" strategy of positioning the cursor. */
13778 /* Implementation note: bpos_max == pt_old when, e.g.,
13779 we are in an empty line, where bpos_max is set to
13780 MATRIX_ROW_START_CHARPOS, see above. */
13781 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13790 x
+= glyph
->pixel_width
;
13793 else if (glyph
> end
) /* row is reversed */
13794 while (!INTEGERP (glyph
->object
))
13796 if (BUFFERP (glyph
->object
))
13798 EMACS_INT dpos
= glyph
->charpos
- pt_old
;
13800 if (glyph
->charpos
> bpos_max
)
13801 bpos_max
= glyph
->charpos
;
13802 if (glyph
->charpos
< bpos_min
)
13803 bpos_min
= glyph
->charpos
;
13804 if (!glyph
->avoid_cursor_p
)
13808 match_with_avoid_cursor
= 0;
13811 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
13813 pos_before
= glyph
->charpos
;
13814 glyph_before
= glyph
;
13816 else if (0 < dpos
&& dpos
<= pos_after
- pt_old
)
13818 pos_after
= glyph
->charpos
;
13819 glyph_after
= glyph
;
13822 else if (dpos
== 0)
13823 match_with_avoid_cursor
= 1;
13825 else if (STRINGP (glyph
->object
))
13827 Lisp_Object chprop
;
13828 EMACS_INT glyph_pos
= glyph
->charpos
;
13830 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
13832 if (INTEGERP (chprop
))
13834 bpos_covered
= bpos_max
+ XINT (chprop
);
13835 /* If the `cursor' property covers buffer positions up
13836 to and including point, we should display cursor on
13838 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
13847 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
13849 x
--; /* can't use any pixel_width */
13852 x
-= glyph
->pixel_width
;
13855 /* Step 2: If we didn't find an exact match for point, we need to
13856 look for a proper place to put the cursor among glyphs between
13857 GLYPH_BEFORE and GLYPH_AFTER. */
13858 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13859 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
13860 && bpos_covered
< pt_old
)
13862 /* An empty line has a single glyph whose OBJECT is zero and
13863 whose CHARPOS is the position of a newline on that line.
13864 Note that on a TTY, there are more glyphs after that, which
13865 were produced by extend_face_to_end_of_line, but their
13866 CHARPOS is zero or negative. */
13868 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
13869 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0;
13871 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
13873 EMACS_INT ellipsis_pos
;
13875 /* Scan back over the ellipsis glyphs. */
13876 if (!row
->reversed_p
)
13878 ellipsis_pos
= (glyph
- 1)->charpos
;
13879 while (glyph
> row
->glyphs
[TEXT_AREA
]
13880 && (glyph
- 1)->charpos
== ellipsis_pos
)
13881 glyph
--, x
-= glyph
->pixel_width
;
13882 /* That loop always goes one position too far, including
13883 the glyph before the ellipsis. So scan forward over
13885 x
+= glyph
->pixel_width
;
13888 else /* row is reversed */
13890 ellipsis_pos
= (glyph
+ 1)->charpos
;
13891 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
13892 && (glyph
+ 1)->charpos
== ellipsis_pos
)
13893 glyph
++, x
+= glyph
->pixel_width
;
13894 x
-= glyph
->pixel_width
;
13898 else if (match_with_avoid_cursor
)
13900 cursor
= glyph_after
;
13903 else if (string_seen
)
13905 int incr
= row
->reversed_p
? -1 : +1;
13907 /* Need to find the glyph that came out of a string which is
13908 present at point. That glyph is somewhere between
13909 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
13910 positioned between POS_BEFORE and POS_AFTER in the
13912 struct glyph
*start
, *stop
;
13913 EMACS_INT pos
= pos_before
;
13917 /* If the row ends in a newline from a display string,
13918 reordering could have moved the glyphs belonging to the
13919 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
13920 in this case we extend the search to the last glyph in
13921 the row that was not inserted by redisplay. */
13922 if (row
->ends_in_newline_from_string_p
)
13925 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
13928 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
13929 correspond to POS_BEFORE and POS_AFTER, respectively. We
13930 need START and STOP in the order that corresponds to the
13931 row's direction as given by its reversed_p flag. If the
13932 directionality of characters between POS_BEFORE and
13933 POS_AFTER is the opposite of the row's base direction,
13934 these characters will have been reordered for display,
13935 and we need to reverse START and STOP. */
13936 if (!row
->reversed_p
)
13938 start
= min (glyph_before
, glyph_after
);
13939 stop
= max (glyph_before
, glyph_after
);
13943 start
= max (glyph_before
, glyph_after
);
13944 stop
= min (glyph_before
, glyph_after
);
13946 for (glyph
= start
+ incr
;
13947 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
13950 /* Any glyphs that come from the buffer are here because
13951 of bidi reordering. Skip them, and only pay
13952 attention to glyphs that came from some string. */
13953 if (STRINGP (glyph
->object
))
13957 /* If the display property covers the newline, we
13958 need to search for it one position farther. */
13959 EMACS_INT lim
= pos_after
13960 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
13962 string_from_text_prop
= 0;
13963 str
= glyph
->object
;
13964 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
13965 if (tem
== 0 /* from overlay */
13968 /* If the string from which this glyph came is
13969 found in the buffer at point, then we've
13970 found the glyph we've been looking for. If
13971 it comes from an overlay (tem == 0), and it
13972 has the `cursor' property on one of its
13973 glyphs, record that glyph as a candidate for
13974 displaying the cursor. (As in the
13975 unidirectional version, we will display the
13976 cursor on the last candidate we find.) */
13977 if (tem
== 0 || tem
== pt_old
)
13979 /* The glyphs from this string could have
13980 been reordered. Find the one with the
13981 smallest string position. Or there could
13982 be a character in the string with the
13983 `cursor' property, which means display
13984 cursor on that character's glyph. */
13985 EMACS_INT strpos
= glyph
->charpos
;
13990 string_from_text_prop
= 1;
13993 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
13994 && EQ (glyph
->object
, str
);
13998 EMACS_INT gpos
= glyph
->charpos
;
14000 cprop
= Fget_char_property (make_number (gpos
),
14008 if (tem
&& glyph
->charpos
< strpos
)
14010 strpos
= glyph
->charpos
;
14019 pos
= tem
+ 1; /* don't find previous instances */
14021 /* This string is not what we want; skip all of the
14022 glyphs that came from it. */
14023 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14024 && EQ (glyph
->object
, str
))
14031 /* If we reached the end of the line, and END was from a string,
14032 the cursor is not on this line. */
14034 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14035 && STRINGP (end
->object
)
14036 && row
->continued_p
)
14039 /* A truncated row may not include PT among its character positions.
14040 Setting the cursor inside the scroll margin will trigger
14041 recalculation of hscroll in hscroll_window_tree. But if a
14042 display string covers point, defer to the string-handling
14043 code below to figure this out. */
14044 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14046 cursor
= glyph_before
;
14049 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14050 /* Zero-width characters produce no glyphs. */
14052 && (row
->reversed_p
14053 ? glyph_after
> glyphs_end
14054 : glyph_after
< glyphs_end
)))
14056 cursor
= glyph_after
;
14062 if (cursor
!= NULL
)
14068 /* Need to compute x that corresponds to GLYPH. */
14069 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14071 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14073 x
+= g
->pixel_width
;
14077 /* ROW could be part of a continued line, which, under bidi
14078 reordering, might have other rows whose start and end charpos
14079 occlude point. Only set w->cursor if we found a better
14080 approximation to the cursor position than we have from previously
14081 examined candidate rows belonging to the same continued line. */
14082 if (/* we already have a candidate row */
14083 w
->cursor
.vpos
>= 0
14084 /* that candidate is not the row we are processing */
14085 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14086 /* Make sure cursor.vpos specifies a row whose start and end
14087 charpos occlude point, and it is valid candidate for being a
14088 cursor-row. This is because some callers of this function
14089 leave cursor.vpos at the row where the cursor was displayed
14090 during the last redisplay cycle. */
14091 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14092 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14093 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14096 MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14098 /* Don't consider glyphs that are outside TEXT_AREA. */
14099 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14101 /* Keep the candidate whose buffer position is the closest to
14102 point or has the `cursor' property. */
14103 if (/* previous candidate is a glyph in TEXT_AREA of that row */
14104 w
->cursor
.hpos
>= 0
14105 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14106 && ((BUFFERP (g1
->object
)
14107 && (g1
->charpos
== pt_old
/* an exact match always wins */
14108 || (BUFFERP (glyph
->object
)
14109 && eabs (g1
->charpos
- pt_old
)
14110 < eabs (glyph
->charpos
- pt_old
))))
14111 /* previous candidate is a glyph from a string that has
14112 a non-nil `cursor' property */
14113 || (STRINGP (g1
->object
)
14114 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14115 Qcursor
, g1
->object
))
14116 /* previous candidate is from the same display
14117 string as this one, and the display string
14118 came from a text property */
14119 || (EQ (g1
->object
, glyph
->object
)
14120 && string_from_text_prop
)
14121 /* this candidate is from newline and its
14122 position is not an exact match */
14123 || (INTEGERP (glyph
->object
)
14124 && glyph
->charpos
!= pt_old
)))))
14126 /* If this candidate gives an exact match, use that. */
14127 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14128 /* If this candidate is a glyph created for the
14129 terminating newline of a line, and point is on that
14130 newline, it wins because it's an exact match. */
14131 || (!row
->continued_p
14132 && INTEGERP (glyph
->object
)
14133 && glyph
->charpos
== 0
14134 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14135 /* Otherwise, keep the candidate that comes from a row
14136 spanning less buffer positions. This may win when one or
14137 both candidate positions are on glyphs that came from
14138 display strings, for which we cannot compare buffer
14140 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14141 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14142 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14145 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14147 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14148 w
->cursor
.y
= row
->y
+ dy
;
14150 if (w
== XWINDOW (selected_window
))
14152 if (!row
->continued_p
14153 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14156 this_line_buffer
= XBUFFER (w
->buffer
);
14158 CHARPOS (this_line_start_pos
)
14159 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14160 BYTEPOS (this_line_start_pos
)
14161 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14163 CHARPOS (this_line_end_pos
)
14164 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14165 BYTEPOS (this_line_end_pos
)
14166 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14168 this_line_y
= w
->cursor
.y
;
14169 this_line_pixel_height
= row
->height
;
14170 this_line_vpos
= w
->cursor
.vpos
;
14171 this_line_start_x
= row
->x
;
14174 CHARPOS (this_line_start_pos
) = 0;
14181 /* Run window scroll functions, if any, for WINDOW with new window
14182 start STARTP. Sets the window start of WINDOW to that position.
14184 We assume that the window's buffer is really current. */
14186 static inline struct text_pos
14187 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14189 struct window
*w
= XWINDOW (window
);
14190 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14192 if (current_buffer
!= XBUFFER (w
->buffer
))
14195 if (!NILP (Vwindow_scroll_functions
))
14197 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14198 make_number (CHARPOS (startp
)));
14199 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14200 /* In case the hook functions switch buffers. */
14201 if (current_buffer
!= XBUFFER (w
->buffer
))
14202 set_buffer_internal_1 (XBUFFER (w
->buffer
));
14209 /* Make sure the line containing the cursor is fully visible.
14210 A value of 1 means there is nothing to be done.
14211 (Either the line is fully visible, or it cannot be made so,
14212 or we cannot tell.)
14214 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14215 is higher than window.
14217 A value of 0 means the caller should do scrolling
14218 as if point had gone off the screen. */
14221 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14223 struct glyph_matrix
*matrix
;
14224 struct glyph_row
*row
;
14227 if (!make_cursor_line_fully_visible_p
)
14230 /* It's not always possible to find the cursor, e.g, when a window
14231 is full of overlay strings. Don't do anything in that case. */
14232 if (w
->cursor
.vpos
< 0)
14235 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14236 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14238 /* If the cursor row is not partially visible, there's nothing to do. */
14239 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14242 /* If the row the cursor is in is taller than the window's height,
14243 it's not clear what to do, so do nothing. */
14244 window_height
= window_box_height (w
);
14245 if (row
->height
>= window_height
)
14247 if (!force_p
|| MINI_WINDOW_P (w
)
14248 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14255 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14256 non-zero means only WINDOW is redisplayed in redisplay_internal.
14257 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14258 in redisplay_window to bring a partially visible line into view in
14259 the case that only the cursor has moved.
14261 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14262 last screen line's vertical height extends past the end of the screen.
14266 1 if scrolling succeeded
14268 0 if scrolling didn't find point.
14270 -1 if new fonts have been loaded so that we must interrupt
14271 redisplay, adjust glyph matrices, and try again. */
14277 SCROLLING_NEED_LARGER_MATRICES
14280 /* If scroll-conservatively is more than this, never recenter.
14282 If you change this, don't forget to update the doc string of
14283 `scroll-conservatively' and the Emacs manual. */
14284 #define SCROLL_LIMIT 100
14287 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14288 EMACS_INT arg_scroll_conservatively
, EMACS_INT scroll_step
,
14289 int temp_scroll_step
, int last_line_misfit
)
14291 struct window
*w
= XWINDOW (window
);
14292 struct frame
*f
= XFRAME (w
->frame
);
14293 struct text_pos pos
, startp
;
14295 int this_scroll_margin
, scroll_max
, rc
, height
;
14296 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14297 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14298 Lisp_Object aggressive
;
14299 /* We will never try scrolling more than this number of lines. */
14300 int scroll_limit
= SCROLL_LIMIT
;
14303 debug_method_add (w
, "try_scrolling");
14306 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14308 /* Compute scroll margin height in pixels. We scroll when point is
14309 within this distance from the top or bottom of the window. */
14310 if (scroll_margin
> 0)
14311 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
14312 * FRAME_LINE_HEIGHT (f
);
14314 this_scroll_margin
= 0;
14316 /* Force arg_scroll_conservatively to have a reasonable value, to
14317 avoid scrolling too far away with slow move_it_* functions. Note
14318 that the user can supply scroll-conservatively equal to
14319 `most-positive-fixnum', which can be larger than INT_MAX. */
14320 if (arg_scroll_conservatively
> scroll_limit
)
14322 arg_scroll_conservatively
= scroll_limit
+ 1;
14323 scroll_max
= scroll_limit
* FRAME_LINE_HEIGHT (f
);
14325 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14326 /* Compute how much we should try to scroll maximally to bring
14327 point into view. */
14328 scroll_max
= (max (scroll_step
,
14329 max (arg_scroll_conservatively
, temp_scroll_step
))
14330 * FRAME_LINE_HEIGHT (f
));
14331 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14332 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14333 /* We're trying to scroll because of aggressive scrolling but no
14334 scroll_step is set. Choose an arbitrary one. */
14335 scroll_max
= 10 * FRAME_LINE_HEIGHT (f
);
14341 /* Decide whether to scroll down. */
14342 if (PT
> CHARPOS (startp
))
14344 int scroll_margin_y
;
14346 /* Compute the pixel ypos of the scroll margin, then move it to
14347 either that ypos or PT, whichever comes first. */
14348 start_display (&it
, w
, startp
);
14349 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
14350 - FRAME_LINE_HEIGHT (f
) * extra_scroll_margin_lines
;
14351 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
14352 (MOVE_TO_POS
| MOVE_TO_Y
));
14354 if (PT
> CHARPOS (it
.current
.pos
))
14356 int y0
= line_bottom_y (&it
);
14357 /* Compute how many pixels below window bottom to stop searching
14358 for PT. This avoids costly search for PT that is far away if
14359 the user limited scrolling by a small number of lines, but
14360 always finds PT if scroll_conservatively is set to a large
14361 number, such as most-positive-fixnum. */
14362 int slack
= max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
));
14363 int y_to_move
= it
.last_visible_y
+ slack
;
14365 /* Compute the distance from the scroll margin to PT or to
14366 the scroll limit, whichever comes first. This should
14367 include the height of the cursor line, to make that line
14369 move_it_to (&it
, PT
, -1, y_to_move
,
14370 -1, MOVE_TO_POS
| MOVE_TO_Y
);
14371 dy
= line_bottom_y (&it
) - y0
;
14373 if (dy
> scroll_max
)
14374 return SCROLLING_FAILED
;
14382 /* Point is in or below the bottom scroll margin, so move the
14383 window start down. If scrolling conservatively, move it just
14384 enough down to make point visible. If scroll_step is set,
14385 move it down by scroll_step. */
14386 if (arg_scroll_conservatively
)
14388 = min (max (dy
, FRAME_LINE_HEIGHT (f
)),
14389 FRAME_LINE_HEIGHT (f
) * arg_scroll_conservatively
);
14390 else if (scroll_step
|| temp_scroll_step
)
14391 amount_to_scroll
= scroll_max
;
14394 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
14395 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14396 if (NUMBERP (aggressive
))
14398 double float_amount
= XFLOATINT (aggressive
) * height
;
14399 amount_to_scroll
= float_amount
;
14400 if (amount_to_scroll
== 0 && float_amount
> 0)
14401 amount_to_scroll
= 1;
14402 /* Don't let point enter the scroll margin near top of
14404 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14405 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14409 if (amount_to_scroll
<= 0)
14410 return SCROLLING_FAILED
;
14412 start_display (&it
, w
, startp
);
14413 if (arg_scroll_conservatively
<= scroll_limit
)
14414 move_it_vertically (&it
, amount_to_scroll
);
14417 /* Extra precision for users who set scroll-conservatively
14418 to a large number: make sure the amount we scroll
14419 the window start is never less than amount_to_scroll,
14420 which was computed as distance from window bottom to
14421 point. This matters when lines at window top and lines
14422 below window bottom have different height. */
14424 void *it1data
= NULL
;
14425 /* We use a temporary it1 because line_bottom_y can modify
14426 its argument, if it moves one line down; see there. */
14429 SAVE_IT (it1
, it
, it1data
);
14430 start_y
= line_bottom_y (&it1
);
14432 RESTORE_IT (&it
, &it
, it1data
);
14433 move_it_by_lines (&it
, 1);
14434 SAVE_IT (it1
, it
, it1data
);
14435 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
14438 /* If STARTP is unchanged, move it down another screen line. */
14439 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
14440 move_it_by_lines (&it
, 1);
14441 startp
= it
.current
.pos
;
14445 struct text_pos scroll_margin_pos
= startp
;
14447 /* See if point is inside the scroll margin at the top of the
14449 if (this_scroll_margin
)
14451 start_display (&it
, w
, startp
);
14452 move_it_vertically (&it
, this_scroll_margin
);
14453 scroll_margin_pos
= it
.current
.pos
;
14456 if (PT
< CHARPOS (scroll_margin_pos
))
14458 /* Point is in the scroll margin at the top of the window or
14459 above what is displayed in the window. */
14462 /* Compute the vertical distance from PT to the scroll
14463 margin position. Move as far as scroll_max allows, or
14464 one screenful, or 10 screen lines, whichever is largest.
14465 Give up if distance is greater than scroll_max. */
14466 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
14467 start_display (&it
, w
, pos
);
14469 y_to_move
= max (it
.last_visible_y
,
14470 max (scroll_max
, 10 * FRAME_LINE_HEIGHT (f
)));
14471 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
14473 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
14474 dy
= it
.current_y
- y0
;
14475 if (dy
> scroll_max
)
14476 return SCROLLING_FAILED
;
14478 /* Compute new window start. */
14479 start_display (&it
, w
, startp
);
14481 if (arg_scroll_conservatively
)
14482 amount_to_scroll
= max (dy
, FRAME_LINE_HEIGHT (f
) *
14483 max (scroll_step
, temp_scroll_step
));
14484 else if (scroll_step
|| temp_scroll_step
)
14485 amount_to_scroll
= scroll_max
;
14488 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
14489 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
14490 if (NUMBERP (aggressive
))
14492 double float_amount
= XFLOATINT (aggressive
) * height
;
14493 amount_to_scroll
= float_amount
;
14494 if (amount_to_scroll
== 0 && float_amount
> 0)
14495 amount_to_scroll
= 1;
14496 amount_to_scroll
-=
14497 this_scroll_margin
- dy
- FRAME_LINE_HEIGHT (f
);
14498 /* Don't let point enter the scroll margin near
14499 bottom of the window. */
14500 if (amount_to_scroll
> height
- 2*this_scroll_margin
+ dy
)
14501 amount_to_scroll
= height
- 2*this_scroll_margin
+ dy
;
14505 if (amount_to_scroll
<= 0)
14506 return SCROLLING_FAILED
;
14508 move_it_vertically_backward (&it
, amount_to_scroll
);
14509 startp
= it
.current
.pos
;
14513 /* Run window scroll functions. */
14514 startp
= run_window_scroll_functions (window
, startp
);
14516 /* Display the window. Give up if new fonts are loaded, or if point
14518 if (!try_window (window
, startp
, 0))
14519 rc
= SCROLLING_NEED_LARGER_MATRICES
;
14520 else if (w
->cursor
.vpos
< 0)
14522 clear_glyph_matrix (w
->desired_matrix
);
14523 rc
= SCROLLING_FAILED
;
14527 /* Maybe forget recorded base line for line number display. */
14528 if (!just_this_one_p
14529 || current_buffer
->clip_changed
14530 || BEG_UNCHANGED
< CHARPOS (startp
))
14531 w
->base_line_number
= Qnil
;
14533 /* If cursor ends up on a partially visible line,
14534 treat that as being off the bottom of the screen. */
14535 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
14536 /* It's possible that the cursor is on the first line of the
14537 buffer, which is partially obscured due to a vscroll
14538 (Bug#7537). In that case, avoid looping forever . */
14539 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
14541 clear_glyph_matrix (w
->desired_matrix
);
14542 ++extra_scroll_margin_lines
;
14545 rc
= SCROLLING_SUCCESS
;
14552 /* Compute a suitable window start for window W if display of W starts
14553 on a continuation line. Value is non-zero if a new window start
14556 The new window start will be computed, based on W's width, starting
14557 from the start of the continued line. It is the start of the
14558 screen line with the minimum distance from the old start W->start. */
14561 compute_window_start_on_continuation_line (struct window
*w
)
14563 struct text_pos pos
, start_pos
;
14564 int window_start_changed_p
= 0;
14566 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
14568 /* If window start is on a continuation line... Window start may be
14569 < BEGV in case there's invisible text at the start of the
14570 buffer (M-x rmail, for example). */
14571 if (CHARPOS (start_pos
) > BEGV
14572 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
14575 struct glyph_row
*row
;
14577 /* Handle the case that the window start is out of range. */
14578 if (CHARPOS (start_pos
) < BEGV
)
14579 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
14580 else if (CHARPOS (start_pos
) > ZV
)
14581 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
14583 /* Find the start of the continued line. This should be fast
14584 because scan_buffer is fast (newline cache). */
14585 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
14586 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
14587 row
, DEFAULT_FACE_ID
);
14588 reseat_at_previous_visible_line_start (&it
);
14590 /* If the line start is "too far" away from the window start,
14591 say it takes too much time to compute a new window start. */
14592 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
14593 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
14595 int min_distance
, distance
;
14597 /* Move forward by display lines to find the new window
14598 start. If window width was enlarged, the new start can
14599 be expected to be > the old start. If window width was
14600 decreased, the new window start will be < the old start.
14601 So, we're looking for the display line start with the
14602 minimum distance from the old window start. */
14603 pos
= it
.current
.pos
;
14604 min_distance
= INFINITY
;
14605 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
14606 distance
< min_distance
)
14608 min_distance
= distance
;
14609 pos
= it
.current
.pos
;
14610 move_it_by_lines (&it
, 1);
14613 /* Set the window start there. */
14614 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
14615 window_start_changed_p
= 1;
14619 return window_start_changed_p
;
14623 /* Try cursor movement in case text has not changed in window WINDOW,
14624 with window start STARTP. Value is
14626 CURSOR_MOVEMENT_SUCCESS if successful
14628 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
14630 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
14631 display. *SCROLL_STEP is set to 1, under certain circumstances, if
14632 we want to scroll as if scroll-step were set to 1. See the code.
14634 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
14635 which case we have to abort this redisplay, and adjust matrices
14640 CURSOR_MOVEMENT_SUCCESS
,
14641 CURSOR_MOVEMENT_CANNOT_BE_USED
,
14642 CURSOR_MOVEMENT_MUST_SCROLL
,
14643 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
14647 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
14649 struct window
*w
= XWINDOW (window
);
14650 struct frame
*f
= XFRAME (w
->frame
);
14651 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
14654 if (inhibit_try_cursor_movement
)
14658 /* Handle case where text has not changed, only point, and it has
14659 not moved off the frame. */
14660 if (/* Point may be in this window. */
14661 PT
>= CHARPOS (startp
)
14662 /* Selective display hasn't changed. */
14663 && !current_buffer
->clip_changed
14664 /* Function force-mode-line-update is used to force a thorough
14665 redisplay. It sets either windows_or_buffers_changed or
14666 update_mode_lines. So don't take a shortcut here for these
14668 && !update_mode_lines
14669 && !windows_or_buffers_changed
14670 && !cursor_type_changed
14671 /* Can't use this case if highlighting a region. When a
14672 region exists, cursor movement has to do more than just
14674 && !(!NILP (Vtransient_mark_mode
)
14675 && !NILP (BVAR (current_buffer
, mark_active
)))
14676 && NILP (w
->region_showing
)
14677 && NILP (Vshow_trailing_whitespace
)
14678 /* Right after splitting windows, last_point may be nil. */
14679 && INTEGERP (w
->last_point
)
14680 /* This code is not used for mini-buffer for the sake of the case
14681 of redisplaying to replace an echo area message; since in
14682 that case the mini-buffer contents per se are usually
14683 unchanged. This code is of no real use in the mini-buffer
14684 since the handling of this_line_start_pos, etc., in redisplay
14685 handles the same cases. */
14686 && !EQ (window
, minibuf_window
)
14687 /* When splitting windows or for new windows, it happens that
14688 redisplay is called with a nil window_end_vpos or one being
14689 larger than the window. This should really be fixed in
14690 window.c. I don't have this on my list, now, so we do
14691 approximately the same as the old redisplay code. --gerd. */
14692 && INTEGERP (w
->window_end_vpos
)
14693 && XFASTINT (w
->window_end_vpos
) < w
->current_matrix
->nrows
14694 && (FRAME_WINDOW_P (f
)
14695 || !overlay_arrow_in_current_buffer_p ()))
14697 int this_scroll_margin
, top_scroll_margin
;
14698 struct glyph_row
*row
= NULL
;
14701 debug_method_add (w
, "cursor movement");
14704 /* Scroll if point within this distance from the top or bottom
14705 of the window. This is a pixel value. */
14706 if (scroll_margin
> 0)
14708 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
14709 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
14712 this_scroll_margin
= 0;
14714 top_scroll_margin
= this_scroll_margin
;
14715 if (WINDOW_WANTS_HEADER_LINE_P (w
))
14716 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
14718 /* Start with the row the cursor was displayed during the last
14719 not paused redisplay. Give up if that row is not valid. */
14720 if (w
->last_cursor
.vpos
< 0
14721 || w
->last_cursor
.vpos
>= w
->current_matrix
->nrows
)
14722 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14725 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor
.vpos
);
14726 if (row
->mode_line_p
)
14728 if (!row
->enabled_p
)
14729 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14732 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
14734 int scroll_p
= 0, must_scroll
= 0;
14735 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
14737 if (PT
> XFASTINT (w
->last_point
))
14739 /* Point has moved forward. */
14740 while (MATRIX_ROW_END_CHARPOS (row
) < PT
14741 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
14743 xassert (row
->enabled_p
);
14747 /* If the end position of a row equals the start
14748 position of the next row, and PT is at that position,
14749 we would rather display cursor in the next line. */
14750 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14751 && MATRIX_ROW_END_CHARPOS (row
) == PT
14752 && row
< w
->current_matrix
->rows
14753 + w
->current_matrix
->nrows
- 1
14754 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
14755 && !cursor_row_p (row
))
14758 /* If within the scroll margin, scroll. Note that
14759 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
14760 the next line would be drawn, and that
14761 this_scroll_margin can be zero. */
14762 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
14763 || PT
> MATRIX_ROW_END_CHARPOS (row
)
14764 /* Line is completely visible last line in window
14765 and PT is to be set in the next line. */
14766 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
14767 && PT
== MATRIX_ROW_END_CHARPOS (row
)
14768 && !row
->ends_at_zv_p
14769 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
14772 else if (PT
< XFASTINT (w
->last_point
))
14774 /* Cursor has to be moved backward. Note that PT >=
14775 CHARPOS (startp) because of the outer if-statement. */
14776 while (!row
->mode_line_p
14777 && (MATRIX_ROW_START_CHARPOS (row
) > PT
14778 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14779 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
14780 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
14781 row
> w
->current_matrix
->rows
14782 && (row
-1)->ends_in_newline_from_string_p
))))
14783 && (row
->y
> top_scroll_margin
14784 || CHARPOS (startp
) == BEGV
))
14786 xassert (row
->enabled_p
);
14790 /* Consider the following case: Window starts at BEGV,
14791 there is invisible, intangible text at BEGV, so that
14792 display starts at some point START > BEGV. It can
14793 happen that we are called with PT somewhere between
14794 BEGV and START. Try to handle that case. */
14795 if (row
< w
->current_matrix
->rows
14796 || row
->mode_line_p
)
14798 row
= w
->current_matrix
->rows
;
14799 if (row
->mode_line_p
)
14803 /* Due to newlines in overlay strings, we may have to
14804 skip forward over overlay strings. */
14805 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14806 && MATRIX_ROW_END_CHARPOS (row
) == PT
14807 && !cursor_row_p (row
))
14810 /* If within the scroll margin, scroll. */
14811 if (row
->y
< top_scroll_margin
14812 && CHARPOS (startp
) != BEGV
)
14817 /* Cursor did not move. So don't scroll even if cursor line
14818 is partially visible, as it was so before. */
14819 rc
= CURSOR_MOVEMENT_SUCCESS
;
14822 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
14823 || PT
> MATRIX_ROW_END_CHARPOS (row
))
14825 /* if PT is not in the glyph row, give up. */
14826 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14829 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14830 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14832 /* If rows are bidi-reordered and point moved, back up
14833 until we find a row that does not belong to a
14834 continuation line. This is because we must consider
14835 all rows of a continued line as candidates for the
14836 new cursor positioning, since row start and end
14837 positions change non-linearly with vertical position
14839 /* FIXME: Revisit this when glyph ``spilling'' in
14840 continuation lines' rows is implemented for
14841 bidi-reordered rows. */
14842 while (MATRIX_ROW_CONTINUATION_LINE_P (row
))
14844 /* If we hit the beginning of the displayed portion
14845 without finding the first row of a continued
14847 if (row
<= w
->current_matrix
->rows
)
14849 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14852 xassert (row
->enabled_p
);
14858 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14859 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
14860 && make_cursor_line_fully_visible_p
)
14862 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
14863 && !row
->ends_at_zv_p
14864 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
14865 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14866 else if (row
->height
> window_box_height (w
))
14868 /* If we end up in a partially visible line, let's
14869 make it fully visible, except when it's taller
14870 than the window, in which case we can't do much
14873 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14877 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
14878 if (!cursor_row_fully_visible_p (w
, 0, 1))
14879 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14881 rc
= CURSOR_MOVEMENT_SUCCESS
;
14885 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14886 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
14887 && !NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
14889 /* With bidi-reordered rows, there could be more than
14890 one candidate row whose start and end positions
14891 occlude point. We need to let set_cursor_from_row
14892 find the best candidate. */
14893 /* FIXME: Revisit this when glyph ``spilling'' in
14894 continuation lines' rows is implemented for
14895 bidi-reordered rows. */
14900 int at_zv_p
= 0, exact_match_p
= 0;
14902 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
14903 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
14904 && cursor_row_p (row
))
14905 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
14907 /* As soon as we've found the exact match for point,
14908 or the first suitable row whose ends_at_zv_p flag
14909 is set, we are done. */
14911 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
)->ends_at_zv_p
;
14913 && w
->cursor
.hpos
>= 0
14914 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
14917 struct glyph_row
*candidate
=
14918 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
14920 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
14921 EMACS_INT endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
14924 (BUFFERP (g
->object
) && g
->charpos
== PT
)
14925 || (INTEGERP (g
->object
)
14926 && (g
->charpos
== PT
14927 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
14929 if (rv
&& (at_zv_p
|| exact_match_p
))
14931 rc
= CURSOR_MOVEMENT_SUCCESS
;
14934 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
14938 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
14939 || row
->continued_p
)
14940 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
14941 || (MATRIX_ROW_START_CHARPOS (row
) == PT
14942 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
14943 /* If we didn't find any candidate rows, or exited the
14944 loop before all the candidates were examined, signal
14945 to the caller that this method failed. */
14946 if (rc
!= CURSOR_MOVEMENT_SUCCESS
14948 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14949 && !row
->continued_p
))
14950 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
14952 rc
= CURSOR_MOVEMENT_SUCCESS
;
14958 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
14960 rc
= CURSOR_MOVEMENT_SUCCESS
;
14965 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
14966 && MATRIX_ROW_START_CHARPOS (row
) == PT
14967 && cursor_row_p (row
));
14975 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
14979 set_vertical_scroll_bar (struct window
*w
)
14981 EMACS_INT start
, end
, whole
;
14983 /* Calculate the start and end positions for the current window.
14984 At some point, it would be nice to choose between scrollbars
14985 which reflect the whole buffer size, with special markers
14986 indicating narrowing, and scrollbars which reflect only the
14989 Note that mini-buffers sometimes aren't displaying any text. */
14990 if (!MINI_WINDOW_P (w
)
14991 || (w
== XWINDOW (minibuf_window
)
14992 && NILP (echo_area_buffer
[0])))
14994 struct buffer
*buf
= XBUFFER (w
->buffer
);
14995 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
14996 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
14997 /* I don't think this is guaranteed to be right. For the
14998 moment, we'll pretend it is. */
14999 end
= BUF_Z (buf
) - XFASTINT (w
->window_end_pos
) - BUF_BEGV (buf
);
15003 if (whole
< (end
- start
))
15004 whole
= end
- start
;
15007 start
= end
= whole
= 0;
15009 /* Indicate what this scroll bar ought to be displaying now. */
15010 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15011 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15012 (w
, end
- start
, whole
, start
);
15016 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15017 selected_window is redisplayed.
15019 We can return without actually redisplaying the window if
15020 fonts_changed_p is nonzero. In that case, redisplay_internal will
15024 redisplay_window (Lisp_Object window
, int just_this_one_p
)
15026 struct window
*w
= XWINDOW (window
);
15027 struct frame
*f
= XFRAME (w
->frame
);
15028 struct buffer
*buffer
= XBUFFER (w
->buffer
);
15029 struct buffer
*old
= current_buffer
;
15030 struct text_pos lpoint
, opoint
, startp
;
15031 int update_mode_line
;
15034 /* Record it now because it's overwritten. */
15035 int current_matrix_up_to_date_p
= 0;
15036 int used_current_matrix_p
= 0;
15037 /* This is less strict than current_matrix_up_to_date_p.
15038 It indicates that the buffer contents and narrowing are unchanged. */
15039 int buffer_unchanged_p
= 0;
15040 int temp_scroll_step
= 0;
15041 int count
= SPECPDL_INDEX ();
15043 int centering_position
= -1;
15044 int last_line_misfit
= 0;
15045 EMACS_INT beg_unchanged
, end_unchanged
;
15047 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15050 /* W must be a leaf window here. */
15051 xassert (!NILP (w
->buffer
));
15053 *w
->desired_matrix
->method
= 0;
15057 reconsider_clip_changes (w
, buffer
);
15059 /* Has the mode line to be updated? */
15060 update_mode_line
= (!NILP (w
->update_mode_line
)
15061 || update_mode_lines
15062 || buffer
->clip_changed
15063 || buffer
->prevent_redisplay_optimizations_p
);
15065 if (MINI_WINDOW_P (w
))
15067 if (w
== XWINDOW (echo_area_window
)
15068 && !NILP (echo_area_buffer
[0]))
15070 if (update_mode_line
)
15071 /* We may have to update a tty frame's menu bar or a
15072 tool-bar. Example `M-x C-h C-h C-g'. */
15073 goto finish_menu_bars
;
15075 /* We've already displayed the echo area glyphs in this window. */
15076 goto finish_scroll_bars
;
15078 else if ((w
!= XWINDOW (minibuf_window
)
15079 || minibuf_level
== 0)
15080 /* When buffer is nonempty, redisplay window normally. */
15081 && BUF_Z (XBUFFER (w
->buffer
)) == BUF_BEG (XBUFFER (w
->buffer
))
15082 /* Quail displays non-mini buffers in minibuffer window.
15083 In that case, redisplay the window normally. */
15084 && !NILP (Fmemq (w
->buffer
, Vminibuffer_list
)))
15086 /* W is a mini-buffer window, but it's not active, so clear
15088 int yb
= window_text_bottom_y (w
);
15089 struct glyph_row
*row
;
15092 for (y
= 0, row
= w
->desired_matrix
->rows
;
15094 y
+= row
->height
, ++row
)
15095 blank_row (w
, row
, y
);
15096 goto finish_scroll_bars
;
15099 clear_glyph_matrix (w
->desired_matrix
);
15102 /* Otherwise set up data on this window; select its buffer and point
15104 /* Really select the buffer, for the sake of buffer-local
15106 set_buffer_internal_1 (XBUFFER (w
->buffer
));
15108 current_matrix_up_to_date_p
15109 = (!NILP (w
->window_end_valid
)
15110 && !current_buffer
->clip_changed
15111 && !current_buffer
->prevent_redisplay_optimizations_p
15112 && XFASTINT (w
->last_modified
) >= MODIFF
15113 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15115 /* Run the window-bottom-change-functions
15116 if it is possible that the text on the screen has changed
15117 (either due to modification of the text, or any other reason). */
15118 if (!current_matrix_up_to_date_p
15119 && !NILP (Vwindow_text_change_functions
))
15121 safe_run_hooks (Qwindow_text_change_functions
);
15125 beg_unchanged
= BEG_UNCHANGED
;
15126 end_unchanged
= END_UNCHANGED
;
15128 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15130 specbind (Qinhibit_point_motion_hooks
, Qt
);
15133 = (!NILP (w
->window_end_valid
)
15134 && !current_buffer
->clip_changed
15135 && XFASTINT (w
->last_modified
) >= MODIFF
15136 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
);
15138 /* When windows_or_buffers_changed is non-zero, we can't rely on
15139 the window end being valid, so set it to nil there. */
15140 if (windows_or_buffers_changed
)
15142 /* If window starts on a continuation line, maybe adjust the
15143 window start in case the window's width changed. */
15144 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15145 compute_window_start_on_continuation_line (w
);
15147 w
->window_end_valid
= Qnil
;
15150 /* Some sanity checks. */
15151 CHECK_WINDOW_END (w
);
15152 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15154 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15157 /* If %c is in mode line, update it if needed. */
15158 if (!NILP (w
->column_number_displayed
)
15159 /* This alternative quickly identifies a common case
15160 where no change is needed. */
15161 && !(PT
== XFASTINT (w
->last_point
)
15162 && XFASTINT (w
->last_modified
) >= MODIFF
15163 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)
15164 && (XFASTINT (w
->column_number_displayed
) != current_column ()))
15165 update_mode_line
= 1;
15167 /* Count number of windows showing the selected buffer. An indirect
15168 buffer counts as its base buffer. */
15169 if (!just_this_one_p
)
15171 struct buffer
*current_base
, *window_base
;
15172 current_base
= current_buffer
;
15173 window_base
= XBUFFER (XWINDOW (selected_window
)->buffer
);
15174 if (current_base
->base_buffer
)
15175 current_base
= current_base
->base_buffer
;
15176 if (window_base
->base_buffer
)
15177 window_base
= window_base
->base_buffer
;
15178 if (current_base
== window_base
)
15182 /* Point refers normally to the selected window. For any other
15183 window, set up appropriate value. */
15184 if (!EQ (window
, selected_window
))
15186 EMACS_INT new_pt
= XMARKER (w
->pointm
)->charpos
;
15187 EMACS_INT new_pt_byte
= marker_byte_position (w
->pointm
);
15191 new_pt_byte
= BEGV_BYTE
;
15192 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15194 else if (new_pt
> (ZV
- 1))
15197 new_pt_byte
= ZV_BYTE
;
15198 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15201 /* We don't use SET_PT so that the point-motion hooks don't run. */
15202 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15205 /* If any of the character widths specified in the display table
15206 have changed, invalidate the width run cache. It's true that
15207 this may be a bit late to catch such changes, but the rest of
15208 redisplay goes (non-fatally) haywire when the display table is
15209 changed, so why should we worry about doing any better? */
15210 if (current_buffer
->width_run_cache
)
15212 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15214 if (! disptab_matches_widthtab (disptab
,
15215 XVECTOR (BVAR (current_buffer
, width_table
))))
15217 invalidate_region_cache (current_buffer
,
15218 current_buffer
->width_run_cache
,
15220 recompute_width_table (current_buffer
, disptab
);
15224 /* If window-start is screwed up, choose a new one. */
15225 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15228 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15230 /* If someone specified a new starting point but did not insist,
15231 check whether it can be used. */
15232 if (!NILP (w
->optional_new_start
)
15233 && CHARPOS (startp
) >= BEGV
15234 && CHARPOS (startp
) <= ZV
)
15236 w
->optional_new_start
= Qnil
;
15237 start_display (&it
, w
, startp
);
15238 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15239 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15240 if (IT_CHARPOS (it
) == PT
)
15241 w
->force_start
= Qt
;
15242 /* IT may overshoot PT if text at PT is invisible. */
15243 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15244 w
->force_start
= Qt
;
15249 /* Handle case where place to start displaying has been specified,
15250 unless the specified location is outside the accessible range. */
15251 if (!NILP (w
->force_start
)
15252 || w
->frozen_window_start_p
)
15254 /* We set this later on if we have to adjust point. */
15257 w
->force_start
= Qnil
;
15259 w
->window_end_valid
= Qnil
;
15261 /* Forget any recorded base line for line number display. */
15262 if (!buffer_unchanged_p
)
15263 w
->base_line_number
= Qnil
;
15265 /* Redisplay the mode line. Select the buffer properly for that.
15266 Also, run the hook window-scroll-functions
15267 because we have scrolled. */
15268 /* Note, we do this after clearing force_start because
15269 if there's an error, it is better to forget about force_start
15270 than to get into an infinite loop calling the hook functions
15271 and having them get more errors. */
15272 if (!update_mode_line
15273 || ! NILP (Vwindow_scroll_functions
))
15275 update_mode_line
= 1;
15276 w
->update_mode_line
= Qt
;
15277 startp
= run_window_scroll_functions (window
, startp
);
15280 w
->last_modified
= make_number (0);
15281 w
->last_overlay_modified
= make_number (0);
15282 if (CHARPOS (startp
) < BEGV
)
15283 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
15284 else if (CHARPOS (startp
) > ZV
)
15285 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
15287 /* Redisplay, then check if cursor has been set during the
15288 redisplay. Give up if new fonts were loaded. */
15289 /* We used to issue a CHECK_MARGINS argument to try_window here,
15290 but this causes scrolling to fail when point begins inside
15291 the scroll margin (bug#148) -- cyd */
15292 if (!try_window (window
, startp
, 0))
15294 w
->force_start
= Qt
;
15295 clear_glyph_matrix (w
->desired_matrix
);
15296 goto need_larger_matrices
;
15299 if (w
->cursor
.vpos
< 0 && !w
->frozen_window_start_p
)
15301 /* If point does not appear, try to move point so it does
15302 appear. The desired matrix has been built above, so we
15303 can use it here. */
15304 new_vpos
= window_box_height (w
) / 2;
15307 if (!cursor_row_fully_visible_p (w
, 0, 0))
15309 /* Point does appear, but on a line partly visible at end of window.
15310 Move it back to a fully-visible line. */
15311 new_vpos
= window_box_height (w
);
15314 /* If we need to move point for either of the above reasons,
15315 now actually do it. */
15318 struct glyph_row
*row
;
15320 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
15321 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
15324 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
15325 MATRIX_ROW_START_BYTEPOS (row
));
15327 if (w
!= XWINDOW (selected_window
))
15328 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
15329 else if (current_buffer
== old
)
15330 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15332 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
15334 /* If we are highlighting the region, then we just changed
15335 the region, so redisplay to show it. */
15336 if (!NILP (Vtransient_mark_mode
)
15337 && !NILP (BVAR (current_buffer
, mark_active
)))
15339 clear_glyph_matrix (w
->desired_matrix
);
15340 if (!try_window (window
, startp
, 0))
15341 goto need_larger_matrices
;
15346 debug_method_add (w
, "forced window start");
15351 /* Handle case where text has not changed, only point, and it has
15352 not moved off the frame, and we are not retrying after hscroll.
15353 (current_matrix_up_to_date_p is nonzero when retrying.) */
15354 if (current_matrix_up_to_date_p
15355 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
15356 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
15360 case CURSOR_MOVEMENT_SUCCESS
:
15361 used_current_matrix_p
= 1;
15364 case CURSOR_MOVEMENT_MUST_SCROLL
:
15365 goto try_to_scroll
;
15371 /* If current starting point was originally the beginning of a line
15372 but no longer is, find a new starting point. */
15373 else if (!NILP (w
->start_at_line_beg
)
15374 && !(CHARPOS (startp
) <= BEGV
15375 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
15378 debug_method_add (w
, "recenter 1");
15383 /* Try scrolling with try_window_id. Value is > 0 if update has
15384 been done, it is -1 if we know that the same window start will
15385 not work. It is 0 if unsuccessful for some other reason. */
15386 else if ((tem
= try_window_id (w
)) != 0)
15389 debug_method_add (w
, "try_window_id %d", tem
);
15392 if (fonts_changed_p
)
15393 goto need_larger_matrices
;
15397 /* Otherwise try_window_id has returned -1 which means that we
15398 don't want the alternative below this comment to execute. */
15400 else if (CHARPOS (startp
) >= BEGV
15401 && CHARPOS (startp
) <= ZV
15402 && PT
>= CHARPOS (startp
)
15403 && (CHARPOS (startp
) < ZV
15404 /* Avoid starting at end of buffer. */
15405 || CHARPOS (startp
) == BEGV
15406 || (XFASTINT (w
->last_modified
) >= MODIFF
15407 && XFASTINT (w
->last_overlay_modified
) >= OVERLAY_MODIFF
)))
15409 int d1
, d2
, d3
, d4
, d5
, d6
;
15411 /* If first window line is a continuation line, and window start
15412 is inside the modified region, but the first change is before
15413 current window start, we must select a new window start.
15415 However, if this is the result of a down-mouse event (e.g. by
15416 extending the mouse-drag-overlay), we don't want to select a
15417 new window start, since that would change the position under
15418 the mouse, resulting in an unwanted mouse-movement rather
15419 than a simple mouse-click. */
15420 if (NILP (w
->start_at_line_beg
)
15421 && NILP (do_mouse_tracking
)
15422 && CHARPOS (startp
) > BEGV
15423 && CHARPOS (startp
) > BEG
+ beg_unchanged
15424 && CHARPOS (startp
) <= Z
- end_unchanged
15425 /* Even if w->start_at_line_beg is nil, a new window may
15426 start at a line_beg, since that's how set_buffer_window
15427 sets it. So, we need to check the return value of
15428 compute_window_start_on_continuation_line. (See also
15430 && XMARKER (w
->start
)->buffer
== current_buffer
15431 && compute_window_start_on_continuation_line (w
)
15432 /* It doesn't make sense to force the window start like we
15433 do at label force_start if it is already known that point
15434 will not be visible in the resulting window, because
15435 doing so will move point from its correct position
15436 instead of scrolling the window to bring point into view.
15438 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
15440 w
->force_start
= Qt
;
15441 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15446 debug_method_add (w
, "same window start");
15449 /* Try to redisplay starting at same place as before.
15450 If point has not moved off frame, accept the results. */
15451 if (!current_matrix_up_to_date_p
15452 /* Don't use try_window_reusing_current_matrix in this case
15453 because a window scroll function can have changed the
15455 || !NILP (Vwindow_scroll_functions
)
15456 || MINI_WINDOW_P (w
)
15457 || !(used_current_matrix_p
15458 = try_window_reusing_current_matrix (w
)))
15460 IF_DEBUG (debug_method_add (w
, "1"));
15461 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
15462 /* -1 means we need to scroll.
15463 0 means we need new matrices, but fonts_changed_p
15464 is set in that case, so we will detect it below. */
15465 goto try_to_scroll
;
15468 if (fonts_changed_p
)
15469 goto need_larger_matrices
;
15471 if (w
->cursor
.vpos
>= 0)
15473 if (!just_this_one_p
15474 || current_buffer
->clip_changed
15475 || BEG_UNCHANGED
< CHARPOS (startp
))
15476 /* Forget any recorded base line for line number display. */
15477 w
->base_line_number
= Qnil
;
15479 if (!cursor_row_fully_visible_p (w
, 1, 0))
15481 clear_glyph_matrix (w
->desired_matrix
);
15482 last_line_misfit
= 1;
15484 /* Drop through and scroll. */
15489 clear_glyph_matrix (w
->desired_matrix
);
15494 w
->last_modified
= make_number (0);
15495 w
->last_overlay_modified
= make_number (0);
15497 /* Redisplay the mode line. Select the buffer properly for that. */
15498 if (!update_mode_line
)
15500 update_mode_line
= 1;
15501 w
->update_mode_line
= Qt
;
15504 /* Try to scroll by specified few lines. */
15505 if ((scroll_conservatively
15506 || emacs_scroll_step
15507 || temp_scroll_step
15508 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
15509 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
15510 && CHARPOS (startp
) >= BEGV
15511 && CHARPOS (startp
) <= ZV
)
15513 /* The function returns -1 if new fonts were loaded, 1 if
15514 successful, 0 if not successful. */
15515 int ss
= try_scrolling (window
, just_this_one_p
,
15516 scroll_conservatively
,
15518 temp_scroll_step
, last_line_misfit
);
15521 case SCROLLING_SUCCESS
:
15524 case SCROLLING_NEED_LARGER_MATRICES
:
15525 goto need_larger_matrices
;
15527 case SCROLLING_FAILED
:
15535 /* Finally, just choose a place to start which positions point
15536 according to user preferences. */
15541 debug_method_add (w
, "recenter");
15544 /* w->vscroll = 0; */
15546 /* Forget any previously recorded base line for line number display. */
15547 if (!buffer_unchanged_p
)
15548 w
->base_line_number
= Qnil
;
15550 /* Determine the window start relative to point. */
15551 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15552 it
.current_y
= it
.last_visible_y
;
15553 if (centering_position
< 0)
15557 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15559 EMACS_INT margin_pos
= CHARPOS (startp
);
15560 Lisp_Object aggressive
;
15563 /* If there is a scroll margin at the top of the window, find
15564 its character position. */
15566 /* Cannot call start_display if startp is not in the
15567 accessible region of the buffer. This can happen when we
15568 have just switched to a different buffer and/or changed
15569 its restriction. In that case, startp is initialized to
15570 the character position 1 (BEG) because we did not yet
15571 have chance to display the buffer even once. */
15572 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
15575 void *it1data
= NULL
;
15577 SAVE_IT (it1
, it
, it1data
);
15578 start_display (&it1
, w
, startp
);
15579 move_it_vertically (&it1
, margin
);
15580 margin_pos
= IT_CHARPOS (it1
);
15581 RESTORE_IT (&it
, &it
, it1data
);
15583 scrolling_up
= PT
> margin_pos
;
15586 ? BVAR (current_buffer
, scroll_up_aggressively
)
15587 : BVAR (current_buffer
, scroll_down_aggressively
);
15589 if (!MINI_WINDOW_P (w
)
15590 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
15594 /* Setting scroll-conservatively overrides
15595 scroll-*-aggressively. */
15596 if (!scroll_conservatively
&& NUMBERP (aggressive
))
15598 double float_amount
= XFLOATINT (aggressive
);
15600 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
15601 if (pt_offset
== 0 && float_amount
> 0)
15606 /* Compute how much to move the window start backward from
15607 point so that point will be displayed where the user
15611 centering_position
= it
.last_visible_y
;
15613 centering_position
-= pt_offset
;
15614 centering_position
-=
15615 FRAME_LINE_HEIGHT (f
) * (1 + margin
+ (last_line_misfit
!= 0))
15616 + WINDOW_HEADER_LINE_HEIGHT (w
);
15617 /* Don't let point enter the scroll margin near top of
15619 if (centering_position
< margin
* FRAME_LINE_HEIGHT (f
))
15620 centering_position
= margin
* FRAME_LINE_HEIGHT (f
);
15623 centering_position
= margin
* FRAME_LINE_HEIGHT (f
) + pt_offset
;
15626 /* Set the window start half the height of the window backward
15628 centering_position
= window_box_height (w
) / 2;
15630 move_it_vertically_backward (&it
, centering_position
);
15632 xassert (IT_CHARPOS (it
) >= BEGV
);
15634 /* The function move_it_vertically_backward may move over more
15635 than the specified y-distance. If it->w is small, e.g. a
15636 mini-buffer window, we may end up in front of the window's
15637 display area. Start displaying at the start of the line
15638 containing PT in this case. */
15639 if (it
.current_y
<= 0)
15641 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
15642 move_it_vertically_backward (&it
, 0);
15646 it
.current_x
= it
.hpos
= 0;
15648 /* Set the window start position here explicitly, to avoid an
15649 infinite loop in case the functions in window-scroll-functions
15651 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
15653 /* Run scroll hooks. */
15654 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
15656 /* Redisplay the window. */
15657 if (!current_matrix_up_to_date_p
15658 || windows_or_buffers_changed
15659 || cursor_type_changed
15660 /* Don't use try_window_reusing_current_matrix in this case
15661 because it can have changed the buffer. */
15662 || !NILP (Vwindow_scroll_functions
)
15663 || !just_this_one_p
15664 || MINI_WINDOW_P (w
)
15665 || !(used_current_matrix_p
15666 = try_window_reusing_current_matrix (w
)))
15667 try_window (window
, startp
, 0);
15669 /* If new fonts have been loaded (due to fontsets), give up. We
15670 have to start a new redisplay since we need to re-adjust glyph
15672 if (fonts_changed_p
)
15673 goto need_larger_matrices
;
15675 /* If cursor did not appear assume that the middle of the window is
15676 in the first line of the window. Do it again with the next line.
15677 (Imagine a window of height 100, displaying two lines of height
15678 60. Moving back 50 from it->last_visible_y will end in the first
15680 if (w
->cursor
.vpos
< 0)
15682 if (!NILP (w
->window_end_valid
)
15683 && PT
>= Z
- XFASTINT (w
->window_end_pos
))
15685 clear_glyph_matrix (w
->desired_matrix
);
15686 move_it_by_lines (&it
, 1);
15687 try_window (window
, it
.current
.pos
, 0);
15689 else if (PT
< IT_CHARPOS (it
))
15691 clear_glyph_matrix (w
->desired_matrix
);
15692 move_it_by_lines (&it
, -1);
15693 try_window (window
, it
.current
.pos
, 0);
15697 /* Not much we can do about it. */
15701 /* Consider the following case: Window starts at BEGV, there is
15702 invisible, intangible text at BEGV, so that display starts at
15703 some point START > BEGV. It can happen that we are called with
15704 PT somewhere between BEGV and START. Try to handle that case. */
15705 if (w
->cursor
.vpos
< 0)
15707 struct glyph_row
*row
= w
->current_matrix
->rows
;
15708 if (row
->mode_line_p
)
15710 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15713 if (!cursor_row_fully_visible_p (w
, 0, 0))
15715 /* If vscroll is enabled, disable it and try again. */
15719 clear_glyph_matrix (w
->desired_matrix
);
15723 /* Users who set scroll-conservatively to a large number want
15724 point just above/below the scroll margin. If we ended up
15725 with point's row partially visible, move the window start to
15726 make that row fully visible and out of the margin. */
15727 if (scroll_conservatively
> SCROLL_LIMIT
)
15731 ? min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4)
15733 int move_down
= w
->cursor
.vpos
>= WINDOW_TOTAL_LINES (w
) / 2;
15735 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
15736 clear_glyph_matrix (w
->desired_matrix
);
15737 if (1 == try_window (window
, it
.current
.pos
,
15738 TRY_WINDOW_CHECK_MARGINS
))
15742 /* If centering point failed to make the whole line visible,
15743 put point at the top instead. That has to make the whole line
15744 visible, if it can be done. */
15745 if (centering_position
== 0)
15748 clear_glyph_matrix (w
->desired_matrix
);
15749 centering_position
= 0;
15755 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15756 w
->start_at_line_beg
= ((CHARPOS (startp
) == BEGV
15757 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n')
15760 /* Display the mode line, if we must. */
15761 if ((update_mode_line
15762 /* If window not full width, must redo its mode line
15763 if (a) the window to its side is being redone and
15764 (b) we do a frame-based redisplay. This is a consequence
15765 of how inverted lines are drawn in frame-based redisplay. */
15766 || (!just_this_one_p
15767 && !FRAME_WINDOW_P (f
)
15768 && !WINDOW_FULL_WIDTH_P (w
))
15769 /* Line number to display. */
15770 || INTEGERP (w
->base_line_pos
)
15771 /* Column number is displayed and different from the one displayed. */
15772 || (!NILP (w
->column_number_displayed
)
15773 && (XFASTINT (w
->column_number_displayed
) != current_column ())))
15774 /* This means that the window has a mode line. */
15775 && (WINDOW_WANTS_MODELINE_P (w
)
15776 || WINDOW_WANTS_HEADER_LINE_P (w
)))
15778 display_mode_lines (w
);
15780 /* If mode line height has changed, arrange for a thorough
15781 immediate redisplay using the correct mode line height. */
15782 if (WINDOW_WANTS_MODELINE_P (w
)
15783 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
15785 fonts_changed_p
= 1;
15786 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
15787 = DESIRED_MODE_LINE_HEIGHT (w
);
15790 /* If header line height has changed, arrange for a thorough
15791 immediate redisplay using the correct header line height. */
15792 if (WINDOW_WANTS_HEADER_LINE_P (w
)
15793 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
15795 fonts_changed_p
= 1;
15796 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
15797 = DESIRED_HEADER_LINE_HEIGHT (w
);
15800 if (fonts_changed_p
)
15801 goto need_larger_matrices
;
15804 if (!line_number_displayed
15805 && !BUFFERP (w
->base_line_pos
))
15807 w
->base_line_pos
= Qnil
;
15808 w
->base_line_number
= Qnil
;
15813 /* When we reach a frame's selected window, redo the frame's menu bar. */
15814 if (update_mode_line
15815 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
15817 int redisplay_menu_p
= 0;
15819 if (FRAME_WINDOW_P (f
))
15821 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
15822 || defined (HAVE_NS) || defined (USE_GTK)
15823 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
15825 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15829 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
15831 if (redisplay_menu_p
)
15832 display_menu_bar (w
);
15834 #ifdef HAVE_WINDOW_SYSTEM
15835 if (FRAME_WINDOW_P (f
))
15837 #if defined (USE_GTK) || defined (HAVE_NS)
15838 if (FRAME_EXTERNAL_TOOL_BAR (f
))
15839 redisplay_tool_bar (f
);
15841 if (WINDOWP (f
->tool_bar_window
)
15842 && (FRAME_TOOL_BAR_LINES (f
) > 0
15843 || !NILP (Vauto_resize_tool_bars
))
15844 && redisplay_tool_bar (f
))
15845 ignore_mouse_drag_p
= 1;
15851 #ifdef HAVE_WINDOW_SYSTEM
15852 if (FRAME_WINDOW_P (f
)
15853 && update_window_fringes (w
, (just_this_one_p
15854 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
15855 || w
->pseudo_window_p
)))
15859 if (draw_window_fringes (w
, 1))
15860 x_draw_vertical_border (w
);
15864 #endif /* HAVE_WINDOW_SYSTEM */
15866 /* We go to this label, with fonts_changed_p nonzero,
15867 if it is necessary to try again using larger glyph matrices.
15868 We have to redeem the scroll bar even in this case,
15869 because the loop in redisplay_internal expects that. */
15870 need_larger_matrices
:
15872 finish_scroll_bars
:
15874 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
15876 /* Set the thumb's position and size. */
15877 set_vertical_scroll_bar (w
);
15879 /* Note that we actually used the scroll bar attached to this
15880 window, so it shouldn't be deleted at the end of redisplay. */
15881 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
15882 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
15885 /* Restore current_buffer and value of point in it. The window
15886 update may have changed the buffer, so first make sure `opoint'
15887 is still valid (Bug#6177). */
15888 if (CHARPOS (opoint
) < BEGV
)
15889 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
15890 else if (CHARPOS (opoint
) > ZV
)
15891 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
15893 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
15895 set_buffer_internal_1 (old
);
15896 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
15897 shorter. This can be caused by log truncation in *Messages*. */
15898 if (CHARPOS (lpoint
) <= ZV
)
15899 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
15901 unbind_to (count
, Qnil
);
15905 /* Build the complete desired matrix of WINDOW with a window start
15906 buffer position POS.
15908 Value is 1 if successful. It is zero if fonts were loaded during
15909 redisplay which makes re-adjusting glyph matrices necessary, and -1
15910 if point would appear in the scroll margins.
15911 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
15912 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
15916 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
15918 struct window
*w
= XWINDOW (window
);
15920 struct glyph_row
*last_text_row
= NULL
;
15921 struct frame
*f
= XFRAME (w
->frame
);
15923 /* Make POS the new window start. */
15924 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
15926 /* Mark cursor position as unknown. No overlay arrow seen. */
15927 w
->cursor
.vpos
= -1;
15928 overlay_arrow_seen
= 0;
15930 /* Initialize iterator and info to start at POS. */
15931 start_display (&it
, w
, pos
);
15933 /* Display all lines of W. */
15934 while (it
.current_y
< it
.last_visible_y
)
15936 if (display_line (&it
))
15937 last_text_row
= it
.glyph_row
- 1;
15938 if (fonts_changed_p
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
15942 /* Don't let the cursor end in the scroll margins. */
15943 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
15944 && !MINI_WINDOW_P (w
))
15946 int this_scroll_margin
;
15948 if (scroll_margin
> 0)
15950 this_scroll_margin
= min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4);
15951 this_scroll_margin
*= FRAME_LINE_HEIGHT (f
);
15954 this_scroll_margin
= 0;
15956 if ((w
->cursor
.y
>= 0 /* not vscrolled */
15957 && w
->cursor
.y
< this_scroll_margin
15958 && CHARPOS (pos
) > BEGV
15959 && IT_CHARPOS (it
) < ZV
)
15960 /* rms: considering make_cursor_line_fully_visible_p here
15961 seems to give wrong results. We don't want to recenter
15962 when the last line is partly visible, we want to allow
15963 that case to be handled in the usual way. */
15964 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
15966 w
->cursor
.vpos
= -1;
15967 clear_glyph_matrix (w
->desired_matrix
);
15972 /* If bottom moved off end of frame, change mode line percentage. */
15973 if (XFASTINT (w
->window_end_pos
) <= 0
15974 && Z
!= IT_CHARPOS (it
))
15975 w
->update_mode_line
= Qt
;
15977 /* Set window_end_pos to the offset of the last character displayed
15978 on the window from the end of current_buffer. Set
15979 window_end_vpos to its row number. */
15982 xassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
15983 w
->window_end_bytepos
15984 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
15986 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
15988 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
15989 xassert (MATRIX_ROW (w
->desired_matrix
, XFASTINT (w
->window_end_vpos
))
15990 ->displays_text_p
);
15994 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
15995 w
->window_end_pos
= make_number (Z
- ZV
);
15996 w
->window_end_vpos
= make_number (0);
15999 /* But that is not valid info until redisplay finishes. */
16000 w
->window_end_valid
= Qnil
;
16006 /************************************************************************
16007 Window redisplay reusing current matrix when buffer has not changed
16008 ************************************************************************/
16010 /* Try redisplay of window W showing an unchanged buffer with a
16011 different window start than the last time it was displayed by
16012 reusing its current matrix. Value is non-zero if successful.
16013 W->start is the new window start. */
16016 try_window_reusing_current_matrix (struct window
*w
)
16018 struct frame
*f
= XFRAME (w
->frame
);
16019 struct glyph_row
*bottom_row
;
16022 struct text_pos start
, new_start
;
16023 int nrows_scrolled
, i
;
16024 struct glyph_row
*last_text_row
;
16025 struct glyph_row
*last_reused_text_row
;
16026 struct glyph_row
*start_row
;
16027 int start_vpos
, min_y
, max_y
;
16030 if (inhibit_try_window_reusing
)
16034 if (/* This function doesn't handle terminal frames. */
16035 !FRAME_WINDOW_P (f
)
16036 /* Don't try to reuse the display if windows have been split
16038 || windows_or_buffers_changed
16039 || cursor_type_changed
)
16042 /* Can't do this if region may have changed. */
16043 if ((!NILP (Vtransient_mark_mode
)
16044 && !NILP (BVAR (current_buffer
, mark_active
)))
16045 || !NILP (w
->region_showing
)
16046 || !NILP (Vshow_trailing_whitespace
))
16049 /* If top-line visibility has changed, give up. */
16050 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16051 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16054 /* Give up if old or new display is scrolled vertically. We could
16055 make this function handle this, but right now it doesn't. */
16056 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16057 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16060 /* The variable new_start now holds the new window start. The old
16061 start `start' can be determined from the current matrix. */
16062 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16063 start
= start_row
->minpos
;
16064 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16066 /* Clear the desired matrix for the display below. */
16067 clear_glyph_matrix (w
->desired_matrix
);
16069 if (CHARPOS (new_start
) <= CHARPOS (start
))
16071 /* Don't use this method if the display starts with an ellipsis
16072 displayed for invisible text. It's not easy to handle that case
16073 below, and it's certainly not worth the effort since this is
16074 not a frequent case. */
16075 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16078 IF_DEBUG (debug_method_add (w
, "twu1"));
16080 /* Display up to a row that can be reused. The variable
16081 last_text_row is set to the last row displayed that displays
16082 text. Note that it.vpos == 0 if or if not there is a
16083 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16084 start_display (&it
, w
, new_start
);
16085 w
->cursor
.vpos
= -1;
16086 last_text_row
= last_reused_text_row
= NULL
;
16088 while (it
.current_y
< it
.last_visible_y
16089 && !fonts_changed_p
)
16091 /* If we have reached into the characters in the START row,
16092 that means the line boundaries have changed. So we
16093 can't start copying with the row START. Maybe it will
16094 work to start copying with the following row. */
16095 while (IT_CHARPOS (it
) > CHARPOS (start
))
16097 /* Advance to the next row as the "start". */
16099 start
= start_row
->minpos
;
16100 /* If there are no more rows to try, or just one, give up. */
16101 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16102 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16103 || CHARPOS (start
) == ZV
)
16105 clear_glyph_matrix (w
->desired_matrix
);
16109 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16111 /* If we have reached alignment, we can copy the rest of the
16113 if (IT_CHARPOS (it
) == CHARPOS (start
)
16114 /* Don't accept "alignment" inside a display vector,
16115 since start_row could have started in the middle of
16116 that same display vector (thus their character
16117 positions match), and we have no way of telling if
16118 that is the case. */
16119 && it
.current
.dpvec_index
< 0)
16122 if (display_line (&it
))
16123 last_text_row
= it
.glyph_row
- 1;
16127 /* A value of current_y < last_visible_y means that we stopped
16128 at the previous window start, which in turn means that we
16129 have at least one reusable row. */
16130 if (it
.current_y
< it
.last_visible_y
)
16132 struct glyph_row
*row
;
16134 /* IT.vpos always starts from 0; it counts text lines. */
16135 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16137 /* Find PT if not already found in the lines displayed. */
16138 if (w
->cursor
.vpos
< 0)
16140 int dy
= it
.current_y
- start_row
->y
;
16142 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16143 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16145 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16146 dy
, nrows_scrolled
);
16149 clear_glyph_matrix (w
->desired_matrix
);
16154 /* Scroll the display. Do it before the current matrix is
16155 changed. The problem here is that update has not yet
16156 run, i.e. part of the current matrix is not up to date.
16157 scroll_run_hook will clear the cursor, and use the
16158 current matrix to get the height of the row the cursor is
16160 run
.current_y
= start_row
->y
;
16161 run
.desired_y
= it
.current_y
;
16162 run
.height
= it
.last_visible_y
- it
.current_y
;
16164 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16167 FRAME_RIF (f
)->update_window_begin_hook (w
);
16168 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16169 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16170 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16174 /* Shift current matrix down by nrows_scrolled lines. */
16175 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16176 rotate_matrix (w
->current_matrix
,
16178 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16181 /* Disable lines that must be updated. */
16182 for (i
= 0; i
< nrows_scrolled
; ++i
)
16183 (start_row
+ i
)->enabled_p
= 0;
16185 /* Re-compute Y positions. */
16186 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16187 max_y
= it
.last_visible_y
;
16188 for (row
= start_row
+ nrows_scrolled
;
16192 row
->y
= it
.current_y
;
16193 row
->visible_height
= row
->height
;
16195 if (row
->y
< min_y
)
16196 row
->visible_height
-= min_y
- row
->y
;
16197 if (row
->y
+ row
->height
> max_y
)
16198 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16199 if (row
->fringe_bitmap_periodic_p
)
16200 row
->redraw_fringe_bitmaps_p
= 1;
16202 it
.current_y
+= row
->height
;
16204 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16205 last_reused_text_row
= row
;
16206 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
16210 /* Disable lines in the current matrix which are now
16211 below the window. */
16212 for (++row
; row
< bottom_row
; ++row
)
16213 row
->enabled_p
= row
->mode_line_p
= 0;
16216 /* Update window_end_pos etc.; last_reused_text_row is the last
16217 reused row from the current matrix containing text, if any.
16218 The value of last_text_row is the last displayed line
16219 containing text. */
16220 if (last_reused_text_row
)
16222 w
->window_end_bytepos
16223 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_reused_text_row
);
16225 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_reused_text_row
));
16227 = make_number (MATRIX_ROW_VPOS (last_reused_text_row
,
16228 w
->current_matrix
));
16230 else if (last_text_row
)
16232 w
->window_end_bytepos
16233 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16235 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16237 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16241 /* This window must be completely empty. */
16242 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16243 w
->window_end_pos
= make_number (Z
- ZV
);
16244 w
->window_end_vpos
= make_number (0);
16246 w
->window_end_valid
= Qnil
;
16248 /* Update hint: don't try scrolling again in update_window. */
16249 w
->desired_matrix
->no_scrolling_p
= 1;
16252 debug_method_add (w
, "try_window_reusing_current_matrix 1");
16256 else if (CHARPOS (new_start
) > CHARPOS (start
))
16258 struct glyph_row
*pt_row
, *row
;
16259 struct glyph_row
*first_reusable_row
;
16260 struct glyph_row
*first_row_to_display
;
16262 int yb
= window_text_bottom_y (w
);
16264 /* Find the row starting at new_start, if there is one. Don't
16265 reuse a partially visible line at the end. */
16266 first_reusable_row
= start_row
;
16267 while (first_reusable_row
->enabled_p
16268 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
16269 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16270 < CHARPOS (new_start
)))
16271 ++first_reusable_row
;
16273 /* Give up if there is no row to reuse. */
16274 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
16275 || !first_reusable_row
->enabled_p
16276 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
16277 != CHARPOS (new_start
)))
16280 /* We can reuse fully visible rows beginning with
16281 first_reusable_row to the end of the window. Set
16282 first_row_to_display to the first row that cannot be reused.
16283 Set pt_row to the row containing point, if there is any. */
16285 for (first_row_to_display
= first_reusable_row
;
16286 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
16287 ++first_row_to_display
)
16289 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
16290 && PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
))
16291 pt_row
= first_row_to_display
;
16294 /* Start displaying at the start of first_row_to_display. */
16295 xassert (first_row_to_display
->y
< yb
);
16296 init_to_row_start (&it
, w
, first_row_to_display
);
16298 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
16300 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
16302 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
16303 + WINDOW_HEADER_LINE_HEIGHT (w
));
16305 /* Display lines beginning with first_row_to_display in the
16306 desired matrix. Set last_text_row to the last row displayed
16307 that displays text. */
16308 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
16309 if (pt_row
== NULL
)
16310 w
->cursor
.vpos
= -1;
16311 last_text_row
= NULL
;
16312 while (it
.current_y
< it
.last_visible_y
&& !fonts_changed_p
)
16313 if (display_line (&it
))
16314 last_text_row
= it
.glyph_row
- 1;
16316 /* If point is in a reused row, adjust y and vpos of the cursor
16320 w
->cursor
.vpos
-= nrows_scrolled
;
16321 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
16324 /* Give up if point isn't in a row displayed or reused. (This
16325 also handles the case where w->cursor.vpos < nrows_scrolled
16326 after the calls to display_line, which can happen with scroll
16327 margins. See bug#1295.) */
16328 if (w
->cursor
.vpos
< 0)
16330 clear_glyph_matrix (w
->desired_matrix
);
16334 /* Scroll the display. */
16335 run
.current_y
= first_reusable_row
->y
;
16336 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16337 run
.height
= it
.last_visible_y
- run
.current_y
;
16338 dy
= run
.current_y
- run
.desired_y
;
16343 FRAME_RIF (f
)->update_window_begin_hook (w
);
16344 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16345 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16346 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16350 /* Adjust Y positions of reused rows. */
16351 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16352 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16353 max_y
= it
.last_visible_y
;
16354 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
16357 row
->visible_height
= row
->height
;
16358 if (row
->y
< min_y
)
16359 row
->visible_height
-= min_y
- row
->y
;
16360 if (row
->y
+ row
->height
> max_y
)
16361 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
16362 if (row
->fringe_bitmap_periodic_p
)
16363 row
->redraw_fringe_bitmaps_p
= 1;
16366 /* Scroll the current matrix. */
16367 xassert (nrows_scrolled
> 0);
16368 rotate_matrix (w
->current_matrix
,
16370 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16373 /* Disable rows not reused. */
16374 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
16375 row
->enabled_p
= 0;
16377 /* Point may have moved to a different line, so we cannot assume that
16378 the previous cursor position is valid; locate the correct row. */
16381 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
16382 row
< bottom_row
&& PT
>= MATRIX_ROW_END_CHARPOS (row
);
16386 w
->cursor
.y
= row
->y
;
16388 if (row
< bottom_row
)
16390 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
16391 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16393 /* Can't use this optimization with bidi-reordered glyph
16394 rows, unless cursor is already at point. */
16395 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
)))
16397 if (!(w
->cursor
.hpos
>= 0
16398 && w
->cursor
.hpos
< row
->used
[TEXT_AREA
]
16399 && BUFFERP (glyph
->object
)
16400 && glyph
->charpos
== PT
))
16405 && (!BUFFERP (glyph
->object
)
16406 || glyph
->charpos
< PT
);
16410 w
->cursor
.x
+= glyph
->pixel_width
;
16415 /* Adjust window end. A null value of last_text_row means that
16416 the window end is in reused rows which in turn means that
16417 only its vpos can have changed. */
16420 w
->window_end_bytepos
16421 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
16423 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
16425 = make_number (MATRIX_ROW_VPOS (last_text_row
, w
->desired_matrix
));
16430 = make_number (XFASTINT (w
->window_end_vpos
) - nrows_scrolled
);
16433 w
->window_end_valid
= Qnil
;
16434 w
->desired_matrix
->no_scrolling_p
= 1;
16437 debug_method_add (w
, "try_window_reusing_current_matrix 2");
16447 /************************************************************************
16448 Window redisplay reusing current matrix when buffer has changed
16449 ************************************************************************/
16451 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
16452 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
16453 EMACS_INT
*, EMACS_INT
*);
16454 static struct glyph_row
*
16455 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
16456 struct glyph_row
*);
16459 /* Return the last row in MATRIX displaying text. If row START is
16460 non-null, start searching with that row. IT gives the dimensions
16461 of the display. Value is null if matrix is empty; otherwise it is
16462 a pointer to the row found. */
16464 static struct glyph_row
*
16465 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
16466 struct glyph_row
*start
)
16468 struct glyph_row
*row
, *row_found
;
16470 /* Set row_found to the last row in IT->w's current matrix
16471 displaying text. The loop looks funny but think of partially
16474 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
16475 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16477 xassert (row
->enabled_p
);
16479 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
16488 /* Return the last row in the current matrix of W that is not affected
16489 by changes at the start of current_buffer that occurred since W's
16490 current matrix was built. Value is null if no such row exists.
16492 BEG_UNCHANGED us the number of characters unchanged at the start of
16493 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
16494 first changed character in current_buffer. Characters at positions <
16495 BEG + BEG_UNCHANGED are at the same buffer positions as they were
16496 when the current matrix was built. */
16498 static struct glyph_row
*
16499 find_last_unchanged_at_beg_row (struct window
*w
)
16501 EMACS_INT first_changed_pos
= BEG
+ BEG_UNCHANGED
;
16502 struct glyph_row
*row
;
16503 struct glyph_row
*row_found
= NULL
;
16504 int yb
= window_text_bottom_y (w
);
16506 /* Find the last row displaying unchanged text. */
16507 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16508 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16509 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
16512 if (/* If row ends before first_changed_pos, it is unchanged,
16513 except in some case. */
16514 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
16515 /* When row ends in ZV and we write at ZV it is not
16517 && !row
->ends_at_zv_p
16518 /* When first_changed_pos is the end of a continued line,
16519 row is not unchanged because it may be no longer
16521 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
16522 && (row
->continued_p
16523 || row
->exact_window_width_line_p
)))
16526 /* Stop if last visible row. */
16527 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
16535 /* Find the first glyph row in the current matrix of W that is not
16536 affected by changes at the end of current_buffer since the
16537 time W's current matrix was built.
16539 Return in *DELTA the number of chars by which buffer positions in
16540 unchanged text at the end of current_buffer must be adjusted.
16542 Return in *DELTA_BYTES the corresponding number of bytes.
16544 Value is null if no such row exists, i.e. all rows are affected by
16547 static struct glyph_row
*
16548 find_first_unchanged_at_end_row (struct window
*w
,
16549 EMACS_INT
*delta
, EMACS_INT
*delta_bytes
)
16551 struct glyph_row
*row
;
16552 struct glyph_row
*row_found
= NULL
;
16554 *delta
= *delta_bytes
= 0;
16556 /* Display must not have been paused, otherwise the current matrix
16557 is not up to date. */
16558 eassert (!NILP (w
->window_end_valid
));
16560 /* A value of window_end_pos >= END_UNCHANGED means that the window
16561 end is in the range of changed text. If so, there is no
16562 unchanged row at the end of W's current matrix. */
16563 if (XFASTINT (w
->window_end_pos
) >= END_UNCHANGED
)
16566 /* Set row to the last row in W's current matrix displaying text. */
16567 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16569 /* If matrix is entirely empty, no unchanged row exists. */
16570 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16572 /* The value of row is the last glyph row in the matrix having a
16573 meaningful buffer position in it. The end position of row
16574 corresponds to window_end_pos. This allows us to translate
16575 buffer positions in the current matrix to current buffer
16576 positions for characters not in changed text. */
16578 MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16579 EMACS_INT Z_BYTE_old
=
16580 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16581 EMACS_INT last_unchanged_pos
, last_unchanged_pos_old
;
16582 struct glyph_row
*first_text_row
16583 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16585 *delta
= Z
- Z_old
;
16586 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16588 /* Set last_unchanged_pos to the buffer position of the last
16589 character in the buffer that has not been changed. Z is the
16590 index + 1 of the last character in current_buffer, i.e. by
16591 subtracting END_UNCHANGED we get the index of the last
16592 unchanged character, and we have to add BEG to get its buffer
16594 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
16595 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
16597 /* Search backward from ROW for a row displaying a line that
16598 starts at a minimum position >= last_unchanged_pos_old. */
16599 for (; row
> first_text_row
; --row
)
16601 /* This used to abort, but it can happen.
16602 It is ok to just stop the search instead here. KFS. */
16603 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
16606 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
16611 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
16617 /* Make sure that glyph rows in the current matrix of window W
16618 reference the same glyph memory as corresponding rows in the
16619 frame's frame matrix. This function is called after scrolling W's
16620 current matrix on a terminal frame in try_window_id and
16621 try_window_reusing_current_matrix. */
16624 sync_frame_with_window_matrix_rows (struct window
*w
)
16626 struct frame
*f
= XFRAME (w
->frame
);
16627 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
16629 /* Preconditions: W must be a leaf window and full-width. Its frame
16630 must have a frame matrix. */
16631 xassert (NILP (w
->hchild
) && NILP (w
->vchild
));
16632 xassert (WINDOW_FULL_WIDTH_P (w
));
16633 xassert (!FRAME_WINDOW_P (f
));
16635 /* If W is a full-width window, glyph pointers in W's current matrix
16636 have, by definition, to be the same as glyph pointers in the
16637 corresponding frame matrix. Note that frame matrices have no
16638 marginal areas (see build_frame_matrix). */
16639 window_row
= w
->current_matrix
->rows
;
16640 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
16641 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
16642 while (window_row
< window_row_end
)
16644 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
16645 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
16647 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
16648 frame_row
->glyphs
[TEXT_AREA
] = start
;
16649 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
16650 frame_row
->glyphs
[LAST_AREA
] = end
;
16652 /* Disable frame rows whose corresponding window rows have
16653 been disabled in try_window_id. */
16654 if (!window_row
->enabled_p
)
16655 frame_row
->enabled_p
= 0;
16657 ++window_row
, ++frame_row
;
16662 /* Find the glyph row in window W containing CHARPOS. Consider all
16663 rows between START and END (not inclusive). END null means search
16664 all rows to the end of the display area of W. Value is the row
16665 containing CHARPOS or null. */
16668 row_containing_pos (struct window
*w
, EMACS_INT charpos
,
16669 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
16671 struct glyph_row
*row
= start
;
16672 struct glyph_row
*best_row
= NULL
;
16673 EMACS_INT mindif
= BUF_ZV (XBUFFER (w
->buffer
)) + 1;
16676 /* If we happen to start on a header-line, skip that. */
16677 if (row
->mode_line_p
)
16680 if ((end
&& row
>= end
) || !row
->enabled_p
)
16683 last_y
= window_text_bottom_y (w
) - dy
;
16687 /* Give up if we have gone too far. */
16688 if (end
&& row
>= end
)
16690 /* This formerly returned if they were equal.
16691 I think that both quantities are of a "last plus one" type;
16692 if so, when they are equal, the row is within the screen. -- rms. */
16693 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
16696 /* If it is in this row, return this row. */
16697 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
16698 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
16699 /* The end position of a row equals the start
16700 position of the next row. If CHARPOS is there, we
16701 would rather display it in the next line, except
16702 when this line ends in ZV. */
16703 && !row
->ends_at_zv_p
16704 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
16705 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
16709 if (NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16710 || (!best_row
&& !row
->continued_p
))
16712 /* In bidi-reordered rows, there could be several rows
16713 occluding point, all of them belonging to the same
16714 continued line. We need to find the row which fits
16715 CHARPOS the best. */
16716 for (g
= row
->glyphs
[TEXT_AREA
];
16717 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
16720 if (!STRINGP (g
->object
))
16722 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
16724 mindif
= eabs (g
->charpos
- charpos
);
16726 /* Exact match always wins. */
16733 else if (best_row
&& !row
->continued_p
)
16740 /* Try to redisplay window W by reusing its existing display. W's
16741 current matrix must be up to date when this function is called,
16742 i.e. window_end_valid must not be nil.
16746 1 if display has been updated
16747 0 if otherwise unsuccessful
16748 -1 if redisplay with same window start is known not to succeed
16750 The following steps are performed:
16752 1. Find the last row in the current matrix of W that is not
16753 affected by changes at the start of current_buffer. If no such row
16756 2. Find the first row in W's current matrix that is not affected by
16757 changes at the end of current_buffer. Maybe there is no such row.
16759 3. Display lines beginning with the row + 1 found in step 1 to the
16760 row found in step 2 or, if step 2 didn't find a row, to the end of
16763 4. If cursor is not known to appear on the window, give up.
16765 5. If display stopped at the row found in step 2, scroll the
16766 display and current matrix as needed.
16768 6. Maybe display some lines at the end of W, if we must. This can
16769 happen under various circumstances, like a partially visible line
16770 becoming fully visible, or because newly displayed lines are displayed
16771 in smaller font sizes.
16773 7. Update W's window end information. */
16776 try_window_id (struct window
*w
)
16778 struct frame
*f
= XFRAME (w
->frame
);
16779 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
16780 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
16781 struct glyph_row
*last_unchanged_at_beg_row
;
16782 struct glyph_row
*first_unchanged_at_end_row
;
16783 struct glyph_row
*row
;
16784 struct glyph_row
*bottom_row
;
16787 EMACS_INT delta
= 0, delta_bytes
= 0, stop_pos
;
16789 struct text_pos start_pos
;
16791 int first_unchanged_at_end_vpos
= 0;
16792 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
16793 struct text_pos start
;
16794 EMACS_INT first_changed_charpos
, last_changed_charpos
;
16797 if (inhibit_try_window_id
)
16801 /* This is handy for debugging. */
16803 #define GIVE_UP(X) \
16805 fprintf (stderr, "try_window_id give up %d\n", (X)); \
16809 #define GIVE_UP(X) return 0
16812 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
16814 /* Don't use this for mini-windows because these can show
16815 messages and mini-buffers, and we don't handle that here. */
16816 if (MINI_WINDOW_P (w
))
16819 /* This flag is used to prevent redisplay optimizations. */
16820 if (windows_or_buffers_changed
|| cursor_type_changed
)
16823 /* Verify that narrowing has not changed.
16824 Also verify that we were not told to prevent redisplay optimizations.
16825 It would be nice to further
16826 reduce the number of cases where this prevents try_window_id. */
16827 if (current_buffer
->clip_changed
16828 || current_buffer
->prevent_redisplay_optimizations_p
)
16831 /* Window must either use window-based redisplay or be full width. */
16832 if (!FRAME_WINDOW_P (f
)
16833 && (!FRAME_LINE_INS_DEL_OK (f
)
16834 || !WINDOW_FULL_WIDTH_P (w
)))
16837 /* Give up if point is known NOT to appear in W. */
16838 if (PT
< CHARPOS (start
))
16841 /* Another way to prevent redisplay optimizations. */
16842 if (XFASTINT (w
->last_modified
) == 0)
16845 /* Verify that window is not hscrolled. */
16846 if (XFASTINT (w
->hscroll
) != 0)
16849 /* Verify that display wasn't paused. */
16850 if (NILP (w
->window_end_valid
))
16853 /* Can't use this if highlighting a region because a cursor movement
16854 will do more than just set the cursor. */
16855 if (!NILP (Vtransient_mark_mode
)
16856 && !NILP (BVAR (current_buffer
, mark_active
)))
16859 /* Likewise if highlighting trailing whitespace. */
16860 if (!NILP (Vshow_trailing_whitespace
))
16863 /* Likewise if showing a region. */
16864 if (!NILP (w
->region_showing
))
16867 /* Can't use this if overlay arrow position and/or string have
16869 if (overlay_arrows_changed_p ())
16872 /* When word-wrap is on, adding a space to the first word of a
16873 wrapped line can change the wrap position, altering the line
16874 above it. It might be worthwhile to handle this more
16875 intelligently, but for now just redisplay from scratch. */
16876 if (!NILP (BVAR (XBUFFER (w
->buffer
), word_wrap
)))
16879 /* Under bidi reordering, adding or deleting a character in the
16880 beginning of a paragraph, before the first strong directional
16881 character, can change the base direction of the paragraph (unless
16882 the buffer specifies a fixed paragraph direction), which will
16883 require to redisplay the whole paragraph. It might be worthwhile
16884 to find the paragraph limits and widen the range of redisplayed
16885 lines to that, but for now just give up this optimization and
16886 redisplay from scratch. */
16887 if (!NILP (BVAR (XBUFFER (w
->buffer
), bidi_display_reordering
))
16888 && NILP (BVAR (XBUFFER (w
->buffer
), bidi_paragraph_direction
)))
16891 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
16892 only if buffer has really changed. The reason is that the gap is
16893 initially at Z for freshly visited files. The code below would
16894 set end_unchanged to 0 in that case. */
16895 if (MODIFF
> SAVE_MODIFF
16896 /* This seems to happen sometimes after saving a buffer. */
16897 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
16899 if (GPT
- BEG
< BEG_UNCHANGED
)
16900 BEG_UNCHANGED
= GPT
- BEG
;
16901 if (Z
- GPT
< END_UNCHANGED
)
16902 END_UNCHANGED
= Z
- GPT
;
16905 /* The position of the first and last character that has been changed. */
16906 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
16907 last_changed_charpos
= Z
- END_UNCHANGED
;
16909 /* If window starts after a line end, and the last change is in
16910 front of that newline, then changes don't affect the display.
16911 This case happens with stealth-fontification. Note that although
16912 the display is unchanged, glyph positions in the matrix have to
16913 be adjusted, of course. */
16914 row
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
16915 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
16916 && ((last_changed_charpos
< CHARPOS (start
)
16917 && CHARPOS (start
) == BEGV
)
16918 || (last_changed_charpos
< CHARPOS (start
) - 1
16919 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
16921 EMACS_INT Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
16922 struct glyph_row
*r0
;
16924 /* Compute how many chars/bytes have been added to or removed
16925 from the buffer. */
16926 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + XFASTINT (w
->window_end_pos
);
16927 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
16928 Z_delta
= Z
- Z_old
;
16929 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
16931 /* Give up if PT is not in the window. Note that it already has
16932 been checked at the start of try_window_id that PT is not in
16933 front of the window start. */
16934 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
16937 /* If window start is unchanged, we can reuse the whole matrix
16938 as is, after adjusting glyph positions. No need to compute
16939 the window end again, since its offset from Z hasn't changed. */
16940 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16941 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
16942 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
16943 /* PT must not be in a partially visible line. */
16944 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
16945 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16947 /* Adjust positions in the glyph matrix. */
16948 if (Z_delta
|| Z_delta_bytes
)
16950 struct glyph_row
*r1
16951 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
16952 increment_matrix_positions (w
->current_matrix
,
16953 MATRIX_ROW_VPOS (r0
, current_matrix
),
16954 MATRIX_ROW_VPOS (r1
, current_matrix
),
16955 Z_delta
, Z_delta_bytes
);
16958 /* Set the cursor. */
16959 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
16961 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
16968 /* Handle the case that changes are all below what is displayed in
16969 the window, and that PT is in the window. This shortcut cannot
16970 be taken if ZV is visible in the window, and text has been added
16971 there that is visible in the window. */
16972 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
16973 /* ZV is not visible in the window, or there are no
16974 changes at ZV, actually. */
16975 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
16976 || first_changed_charpos
== last_changed_charpos
))
16978 struct glyph_row
*r0
;
16980 /* Give up if PT is not in the window. Note that it already has
16981 been checked at the start of try_window_id that PT is not in
16982 front of the window start. */
16983 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
16986 /* If window start is unchanged, we can reuse the whole matrix
16987 as is, without changing glyph positions since no text has
16988 been added/removed in front of the window end. */
16989 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
16990 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
16991 /* PT must not be in a partially visible line. */
16992 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
16993 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
16995 /* We have to compute the window end anew since text
16996 could have been added/removed after it. */
16998 = make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
16999 w
->window_end_bytepos
17000 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17002 /* Set the cursor. */
17003 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17005 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17012 /* Give up if window start is in the changed area.
17014 The condition used to read
17016 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17018 but why that was tested escapes me at the moment. */
17019 if (CHARPOS (start
) >= first_changed_charpos
17020 && CHARPOS (start
) <= last_changed_charpos
)
17023 /* Check that window start agrees with the start of the first glyph
17024 row in its current matrix. Check this after we know the window
17025 start is not in changed text, otherwise positions would not be
17027 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17028 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17031 /* Give up if the window ends in strings. Overlay strings
17032 at the end are difficult to handle, so don't try. */
17033 row
= MATRIX_ROW (current_matrix
, XFASTINT (w
->window_end_vpos
));
17034 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17037 /* Compute the position at which we have to start displaying new
17038 lines. Some of the lines at the top of the window might be
17039 reusable because they are not displaying changed text. Find the
17040 last row in W's current matrix not affected by changes at the
17041 start of current_buffer. Value is null if changes start in the
17042 first line of window. */
17043 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17044 if (last_unchanged_at_beg_row
)
17046 /* Avoid starting to display in the middle of a character, a TAB
17047 for instance. This is easier than to set up the iterator
17048 exactly, and it's not a frequent case, so the additional
17049 effort wouldn't really pay off. */
17050 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17051 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17052 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17053 --last_unchanged_at_beg_row
;
17055 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17058 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17060 start_pos
= it
.current
.pos
;
17062 /* Start displaying new lines in the desired matrix at the same
17063 vpos we would use in the current matrix, i.e. below
17064 last_unchanged_at_beg_row. */
17065 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17067 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17068 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17070 xassert (it
.hpos
== 0 && it
.current_x
== 0);
17074 /* There are no reusable lines at the start of the window.
17075 Start displaying in the first text line. */
17076 start_display (&it
, w
, start
);
17077 it
.vpos
= it
.first_vpos
;
17078 start_pos
= it
.current
.pos
;
17081 /* Find the first row that is not affected by changes at the end of
17082 the buffer. Value will be null if there is no unchanged row, in
17083 which case we must redisplay to the end of the window. delta
17084 will be set to the value by which buffer positions beginning with
17085 first_unchanged_at_end_row have to be adjusted due to text
17087 first_unchanged_at_end_row
17088 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17089 IF_DEBUG (debug_delta
= delta
);
17090 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17092 /* Set stop_pos to the buffer position up to which we will have to
17093 display new lines. If first_unchanged_at_end_row != NULL, this
17094 is the buffer position of the start of the line displayed in that
17095 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17096 that we don't stop at a buffer position. */
17098 if (first_unchanged_at_end_row
)
17100 xassert (last_unchanged_at_beg_row
== NULL
17101 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17103 /* If this is a continuation line, move forward to the next one
17104 that isn't. Changes in lines above affect this line.
17105 Caution: this may move first_unchanged_at_end_row to a row
17106 not displaying text. */
17107 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17108 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17109 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17110 < it
.last_visible_y
))
17111 ++first_unchanged_at_end_row
;
17113 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17114 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17115 >= it
.last_visible_y
))
17116 first_unchanged_at_end_row
= NULL
;
17119 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17121 first_unchanged_at_end_vpos
17122 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17123 xassert (stop_pos
>= Z
- END_UNCHANGED
);
17126 else if (last_unchanged_at_beg_row
== NULL
)
17132 /* Either there is no unchanged row at the end, or the one we have
17133 now displays text. This is a necessary condition for the window
17134 end pos calculation at the end of this function. */
17135 xassert (first_unchanged_at_end_row
== NULL
17136 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17138 debug_last_unchanged_at_beg_vpos
17139 = (last_unchanged_at_beg_row
17140 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17142 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17144 #endif /* GLYPH_DEBUG != 0 */
17147 /* Display new lines. Set last_text_row to the last new line
17148 displayed which has text on it, i.e. might end up as being the
17149 line where the window_end_vpos is. */
17150 w
->cursor
.vpos
= -1;
17151 last_text_row
= NULL
;
17152 overlay_arrow_seen
= 0;
17153 while (it
.current_y
< it
.last_visible_y
17154 && !fonts_changed_p
17155 && (first_unchanged_at_end_row
== NULL
17156 || IT_CHARPOS (it
) < stop_pos
))
17158 if (display_line (&it
))
17159 last_text_row
= it
.glyph_row
- 1;
17162 if (fonts_changed_p
)
17166 /* Compute differences in buffer positions, y-positions etc. for
17167 lines reused at the bottom of the window. Compute what we can
17169 if (first_unchanged_at_end_row
17170 /* No lines reused because we displayed everything up to the
17171 bottom of the window. */
17172 && it
.current_y
< it
.last_visible_y
)
17175 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17177 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17178 run
.current_y
= first_unchanged_at_end_row
->y
;
17179 run
.desired_y
= run
.current_y
+ dy
;
17180 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17184 delta
= delta_bytes
= dvpos
= dy
17185 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17186 first_unchanged_at_end_row
= NULL
;
17188 IF_DEBUG (debug_dvpos
= dvpos
; debug_dy
= dy
);
17191 /* Find the cursor if not already found. We have to decide whether
17192 PT will appear on this window (it sometimes doesn't, but this is
17193 not a very frequent case.) This decision has to be made before
17194 the current matrix is altered. A value of cursor.vpos < 0 means
17195 that PT is either in one of the lines beginning at
17196 first_unchanged_at_end_row or below the window. Don't care for
17197 lines that might be displayed later at the window end; as
17198 mentioned, this is not a frequent case. */
17199 if (w
->cursor
.vpos
< 0)
17201 /* Cursor in unchanged rows at the top? */
17202 if (PT
< CHARPOS (start_pos
)
17203 && last_unchanged_at_beg_row
)
17205 row
= row_containing_pos (w
, PT
,
17206 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
17207 last_unchanged_at_beg_row
+ 1, 0);
17209 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
17212 /* Start from first_unchanged_at_end_row looking for PT. */
17213 else if (first_unchanged_at_end_row
)
17215 row
= row_containing_pos (w
, PT
- delta
,
17216 first_unchanged_at_end_row
, NULL
, 0);
17218 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
17219 delta_bytes
, dy
, dvpos
);
17222 /* Give up if cursor was not found. */
17223 if (w
->cursor
.vpos
< 0)
17225 clear_glyph_matrix (w
->desired_matrix
);
17230 /* Don't let the cursor end in the scroll margins. */
17232 int this_scroll_margin
, cursor_height
;
17234 this_scroll_margin
=
17235 max (0, min (scroll_margin
, WINDOW_TOTAL_LINES (w
) / 4));
17236 this_scroll_margin
*= FRAME_LINE_HEIGHT (it
.f
);
17237 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
17239 if ((w
->cursor
.y
< this_scroll_margin
17240 && CHARPOS (start
) > BEGV
)
17241 /* Old redisplay didn't take scroll margin into account at the bottom,
17242 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
17243 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
17244 ? cursor_height
+ this_scroll_margin
17245 : 1)) > it
.last_visible_y
)
17247 w
->cursor
.vpos
= -1;
17248 clear_glyph_matrix (w
->desired_matrix
);
17253 /* Scroll the display. Do it before changing the current matrix so
17254 that xterm.c doesn't get confused about where the cursor glyph is
17256 if (dy
&& run
.height
)
17260 if (FRAME_WINDOW_P (f
))
17262 FRAME_RIF (f
)->update_window_begin_hook (w
);
17263 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17264 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17265 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17269 /* Terminal frame. In this case, dvpos gives the number of
17270 lines to scroll by; dvpos < 0 means scroll up. */
17272 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
17273 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
17274 int end
= (WINDOW_TOP_EDGE_LINE (w
)
17275 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
17276 + window_internal_height (w
));
17278 #if defined (HAVE_GPM) || defined (MSDOS)
17279 x_clear_window_mouse_face (w
);
17281 /* Perform the operation on the screen. */
17284 /* Scroll last_unchanged_at_beg_row to the end of the
17285 window down dvpos lines. */
17286 set_terminal_window (f
, end
);
17288 /* On dumb terminals delete dvpos lines at the end
17289 before inserting dvpos empty lines. */
17290 if (!FRAME_SCROLL_REGION_OK (f
))
17291 ins_del_lines (f
, end
- dvpos
, -dvpos
);
17293 /* Insert dvpos empty lines in front of
17294 last_unchanged_at_beg_row. */
17295 ins_del_lines (f
, from
, dvpos
);
17297 else if (dvpos
< 0)
17299 /* Scroll up last_unchanged_at_beg_vpos to the end of
17300 the window to last_unchanged_at_beg_vpos - |dvpos|. */
17301 set_terminal_window (f
, end
);
17303 /* Delete dvpos lines in front of
17304 last_unchanged_at_beg_vpos. ins_del_lines will set
17305 the cursor to the given vpos and emit |dvpos| delete
17307 ins_del_lines (f
, from
+ dvpos
, dvpos
);
17309 /* On a dumb terminal insert dvpos empty lines at the
17311 if (!FRAME_SCROLL_REGION_OK (f
))
17312 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
17315 set_terminal_window (f
, 0);
17321 /* Shift reused rows of the current matrix to the right position.
17322 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
17324 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17325 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
17328 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
17329 bottom_vpos
, dvpos
);
17330 enable_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
17333 else if (dvpos
> 0)
17335 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
17336 bottom_vpos
, dvpos
);
17337 enable_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
17338 first_unchanged_at_end_vpos
+ dvpos
, 0);
17341 /* For frame-based redisplay, make sure that current frame and window
17342 matrix are in sync with respect to glyph memory. */
17343 if (!FRAME_WINDOW_P (f
))
17344 sync_frame_with_window_matrix_rows (w
);
17346 /* Adjust buffer positions in reused rows. */
17347 if (delta
|| delta_bytes
)
17348 increment_matrix_positions (current_matrix
,
17349 first_unchanged_at_end_vpos
+ dvpos
,
17350 bottom_vpos
, delta
, delta_bytes
);
17352 /* Adjust Y positions. */
17354 shift_glyph_matrix (w
, current_matrix
,
17355 first_unchanged_at_end_vpos
+ dvpos
,
17358 if (first_unchanged_at_end_row
)
17360 first_unchanged_at_end_row
+= dvpos
;
17361 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
17362 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
17363 first_unchanged_at_end_row
= NULL
;
17366 /* If scrolling up, there may be some lines to display at the end of
17368 last_text_row_at_end
= NULL
;
17371 /* Scrolling up can leave for example a partially visible line
17372 at the end of the window to be redisplayed. */
17373 /* Set last_row to the glyph row in the current matrix where the
17374 window end line is found. It has been moved up or down in
17375 the matrix by dvpos. */
17376 int last_vpos
= XFASTINT (w
->window_end_vpos
) + dvpos
;
17377 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
17379 /* If last_row is the window end line, it should display text. */
17380 xassert (last_row
->displays_text_p
);
17382 /* If window end line was partially visible before, begin
17383 displaying at that line. Otherwise begin displaying with the
17384 line following it. */
17385 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
17387 init_to_row_start (&it
, w
, last_row
);
17388 it
.vpos
= last_vpos
;
17389 it
.current_y
= last_row
->y
;
17393 init_to_row_end (&it
, w
, last_row
);
17394 it
.vpos
= 1 + last_vpos
;
17395 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
17399 /* We may start in a continuation line. If so, we have to
17400 get the right continuation_lines_width and current_x. */
17401 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
17402 it
.hpos
= it
.current_x
= 0;
17404 /* Display the rest of the lines at the window end. */
17405 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17406 while (it
.current_y
< it
.last_visible_y
17407 && !fonts_changed_p
)
17409 /* Is it always sure that the display agrees with lines in
17410 the current matrix? I don't think so, so we mark rows
17411 displayed invalid in the current matrix by setting their
17412 enabled_p flag to zero. */
17413 MATRIX_ROW (w
->current_matrix
, it
.vpos
)->enabled_p
= 0;
17414 if (display_line (&it
))
17415 last_text_row_at_end
= it
.glyph_row
- 1;
17419 /* Update window_end_pos and window_end_vpos. */
17420 if (first_unchanged_at_end_row
17421 && !last_text_row_at_end
)
17423 /* Window end line if one of the preserved rows from the current
17424 matrix. Set row to the last row displaying text in current
17425 matrix starting at first_unchanged_at_end_row, after
17427 xassert (first_unchanged_at_end_row
->displays_text_p
);
17428 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
17429 first_unchanged_at_end_row
);
17430 xassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
17432 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17433 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17435 = make_number (MATRIX_ROW_VPOS (row
, w
->current_matrix
));
17436 xassert (w
->window_end_bytepos
>= 0);
17437 IF_DEBUG (debug_method_add (w
, "A"));
17439 else if (last_text_row_at_end
)
17442 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row_at_end
));
17443 w
->window_end_bytepos
17444 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row_at_end
);
17446 = make_number (MATRIX_ROW_VPOS (last_text_row_at_end
, desired_matrix
));
17447 xassert (w
->window_end_bytepos
>= 0);
17448 IF_DEBUG (debug_method_add (w
, "B"));
17450 else if (last_text_row
)
17452 /* We have displayed either to the end of the window or at the
17453 end of the window, i.e. the last row with text is to be found
17454 in the desired matrix. */
17456 = make_number (Z
- MATRIX_ROW_END_CHARPOS (last_text_row
));
17457 w
->window_end_bytepos
17458 = Z_BYTE
- MATRIX_ROW_END_BYTEPOS (last_text_row
);
17460 = make_number (MATRIX_ROW_VPOS (last_text_row
, desired_matrix
));
17461 xassert (w
->window_end_bytepos
>= 0);
17463 else if (first_unchanged_at_end_row
== NULL
17464 && last_text_row
== NULL
17465 && last_text_row_at_end
== NULL
)
17467 /* Displayed to end of window, but no line containing text was
17468 displayed. Lines were deleted at the end of the window. */
17469 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
17470 int vpos
= XFASTINT (w
->window_end_vpos
);
17471 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
17472 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
17475 row
== NULL
&& vpos
>= first_vpos
;
17476 --vpos
, --current_row
, --desired_row
)
17478 if (desired_row
->enabled_p
)
17480 if (desired_row
->displays_text_p
)
17483 else if (current_row
->displays_text_p
)
17487 xassert (row
!= NULL
);
17488 w
->window_end_vpos
= make_number (vpos
+ 1);
17489 w
->window_end_pos
= make_number (Z
- MATRIX_ROW_END_CHARPOS (row
));
17490 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17491 xassert (w
->window_end_bytepos
>= 0);
17492 IF_DEBUG (debug_method_add (w
, "C"));
17497 IF_DEBUG (debug_end_pos
= XFASTINT (w
->window_end_pos
);
17498 debug_end_vpos
= XFASTINT (w
->window_end_vpos
));
17500 /* Record that display has not been completed. */
17501 w
->window_end_valid
= Qnil
;
17502 w
->desired_matrix
->no_scrolling_p
= 1;
17510 /***********************************************************************
17511 More debugging support
17512 ***********************************************************************/
17516 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
17517 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
17518 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
17521 /* Dump the contents of glyph matrix MATRIX on stderr.
17523 GLYPHS 0 means don't show glyph contents.
17524 GLYPHS 1 means show glyphs in short form
17525 GLYPHS > 1 means show glyphs in long form. */
17528 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
17531 for (i
= 0; i
< matrix
->nrows
; ++i
)
17532 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
17536 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
17537 the glyph row and area where the glyph comes from. */
17540 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
17542 if (glyph
->type
== CHAR_GLYPH
)
17545 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17546 glyph
- row
->glyphs
[TEXT_AREA
],
17549 (BUFFERP (glyph
->object
)
17551 : (STRINGP (glyph
->object
)
17554 glyph
->pixel_width
,
17556 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
17560 glyph
->left_box_line_p
,
17561 glyph
->right_box_line_p
);
17563 else if (glyph
->type
== STRETCH_GLYPH
)
17566 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17567 glyph
- row
->glyphs
[TEXT_AREA
],
17570 (BUFFERP (glyph
->object
)
17572 : (STRINGP (glyph
->object
)
17575 glyph
->pixel_width
,
17579 glyph
->left_box_line_p
,
17580 glyph
->right_box_line_p
);
17582 else if (glyph
->type
== IMAGE_GLYPH
)
17585 " %5td %4c %6"pI
"d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
17586 glyph
- row
->glyphs
[TEXT_AREA
],
17589 (BUFFERP (glyph
->object
)
17591 : (STRINGP (glyph
->object
)
17594 glyph
->pixel_width
,
17598 glyph
->left_box_line_p
,
17599 glyph
->right_box_line_p
);
17601 else if (glyph
->type
== COMPOSITE_GLYPH
)
17604 " %5td %4c %6"pI
"d %c %3d 0x%05x",
17605 glyph
- row
->glyphs
[TEXT_AREA
],
17608 (BUFFERP (glyph
->object
)
17610 : (STRINGP (glyph
->object
)
17613 glyph
->pixel_width
,
17615 if (glyph
->u
.cmp
.automatic
)
17618 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
17619 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
17621 glyph
->left_box_line_p
,
17622 glyph
->right_box_line_p
);
17627 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
17628 GLYPHS 0 means don't show glyph contents.
17629 GLYPHS 1 means show glyphs in short form
17630 GLYPHS > 1 means show glyphs in long form. */
17633 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
17637 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
17638 fprintf (stderr
, "======================================================================\n");
17640 fprintf (stderr
, "%3d %5"pI
"d %5"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
17641 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
17643 MATRIX_ROW_START_CHARPOS (row
),
17644 MATRIX_ROW_END_CHARPOS (row
),
17645 row
->used
[TEXT_AREA
],
17646 row
->contains_overlapping_glyphs_p
,
17648 row
->truncated_on_left_p
,
17649 row
->truncated_on_right_p
,
17651 MATRIX_ROW_CONTINUATION_LINE_P (row
),
17652 row
->displays_text_p
,
17655 row
->ends_in_middle_of_char_p
,
17656 row
->starts_in_middle_of_char_p
,
17662 row
->visible_height
,
17665 fprintf (stderr
, "%9d %5d\t%5d\n", row
->start
.overlay_string_index
,
17666 row
->end
.overlay_string_index
,
17667 row
->continuation_lines_width
);
17668 fprintf (stderr
, "%9"pI
"d %5"pI
"d\n",
17669 CHARPOS (row
->start
.string_pos
),
17670 CHARPOS (row
->end
.string_pos
));
17671 fprintf (stderr
, "%9d %5d\n", row
->start
.dpvec_index
,
17672 row
->end
.dpvec_index
);
17679 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17681 struct glyph
*glyph
= row
->glyphs
[area
];
17682 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
17684 /* Glyph for a line end in text. */
17685 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
17688 if (glyph
< glyph_end
)
17689 fprintf (stderr
, " Glyph Type Pos O W Code C Face LR\n");
17691 for (; glyph
< glyph_end
; ++glyph
)
17692 dump_glyph (row
, glyph
, area
);
17695 else if (glyphs
== 1)
17699 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17701 char *s
= (char *) alloca (row
->used
[area
] + 1);
17704 for (i
= 0; i
< row
->used
[area
]; ++i
)
17706 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
17707 if (glyph
->type
== CHAR_GLYPH
17708 && glyph
->u
.ch
< 0x80
17709 && glyph
->u
.ch
>= ' ')
17710 s
[i
] = glyph
->u
.ch
;
17716 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
17722 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
17723 Sdump_glyph_matrix
, 0, 1, "p",
17724 doc
: /* Dump the current matrix of the selected window to stderr.
17725 Shows contents of glyph row structures. With non-nil
17726 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
17727 glyphs in short form, otherwise show glyphs in long form. */)
17728 (Lisp_Object glyphs
)
17730 struct window
*w
= XWINDOW (selected_window
);
17731 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17733 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
17734 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
17735 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
17736 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
17737 fprintf (stderr
, "=============================================\n");
17738 dump_glyph_matrix (w
->current_matrix
,
17739 NILP (glyphs
) ? 0 : XINT (glyphs
));
17744 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
17745 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
17748 struct frame
*f
= XFRAME (selected_frame
);
17749 dump_glyph_matrix (f
->current_matrix
, 1);
17754 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
17755 doc
: /* Dump glyph row ROW to stderr.
17756 GLYPH 0 means don't dump glyphs.
17757 GLYPH 1 means dump glyphs in short form.
17758 GLYPH > 1 or omitted means dump glyphs in long form. */)
17759 (Lisp_Object row
, Lisp_Object glyphs
)
17761 struct glyph_matrix
*matrix
;
17764 CHECK_NUMBER (row
);
17765 matrix
= XWINDOW (selected_window
)->current_matrix
;
17767 if (vpos
>= 0 && vpos
< matrix
->nrows
)
17768 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
17770 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17775 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
17776 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
17777 GLYPH 0 means don't dump glyphs.
17778 GLYPH 1 means dump glyphs in short form.
17779 GLYPH > 1 or omitted means dump glyphs in long form. */)
17780 (Lisp_Object row
, Lisp_Object glyphs
)
17782 struct frame
*sf
= SELECTED_FRAME ();
17783 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
17786 CHECK_NUMBER (row
);
17788 if (vpos
>= 0 && vpos
< m
->nrows
)
17789 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
17790 INTEGERP (glyphs
) ? XINT (glyphs
) : 2);
17795 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
17796 doc
: /* Toggle tracing of redisplay.
17797 With ARG, turn tracing on if and only if ARG is positive. */)
17801 trace_redisplay_p
= !trace_redisplay_p
;
17804 arg
= Fprefix_numeric_value (arg
);
17805 trace_redisplay_p
= XINT (arg
) > 0;
17812 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
17813 doc
: /* Like `format', but print result to stderr.
17814 usage: (trace-to-stderr STRING &rest OBJECTS) */)
17815 (ptrdiff_t nargs
, Lisp_Object
*args
)
17817 Lisp_Object s
= Fformat (nargs
, args
);
17818 fprintf (stderr
, "%s", SDATA (s
));
17822 #endif /* GLYPH_DEBUG */
17826 /***********************************************************************
17827 Building Desired Matrix Rows
17828 ***********************************************************************/
17830 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
17831 Used for non-window-redisplay windows, and for windows w/o left fringe. */
17833 static struct glyph_row
*
17834 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
17836 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
17837 struct buffer
*buffer
= XBUFFER (w
->buffer
);
17838 struct buffer
*old
= current_buffer
;
17839 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
17840 int arrow_len
= SCHARS (overlay_arrow_string
);
17841 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
17842 const unsigned char *p
;
17845 int n_glyphs_before
;
17847 set_buffer_temp (buffer
);
17848 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
17849 it
.glyph_row
->used
[TEXT_AREA
] = 0;
17850 SET_TEXT_POS (it
.position
, 0, 0);
17852 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
17854 while (p
< arrow_end
)
17856 Lisp_Object face
, ilisp
;
17858 /* Get the next character. */
17860 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
17863 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
17864 if (! ASCII_CHAR_P (it
.c
))
17865 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
17869 /* Get its face. */
17870 ilisp
= make_number (p
- arrow_string
);
17871 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
17872 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
17874 /* Compute its width, get its glyphs. */
17875 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
17876 SET_TEXT_POS (it
.position
, -1, -1);
17877 PRODUCE_GLYPHS (&it
);
17879 /* If this character doesn't fit any more in the line, we have
17880 to remove some glyphs. */
17881 if (it
.current_x
> it
.last_visible_x
)
17883 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
17888 set_buffer_temp (old
);
17889 return it
.glyph_row
;
17893 /* Insert truncation glyphs at the start of IT->glyph_row. Truncation
17894 glyphs are only inserted for terminal frames since we can't really
17895 win with truncation glyphs when partially visible glyphs are
17896 involved. Which glyphs to insert is determined by
17897 produce_special_glyphs. */
17900 insert_left_trunc_glyphs (struct it
*it
)
17902 struct it truncate_it
;
17903 struct glyph
*from
, *end
, *to
, *toend
;
17905 xassert (!FRAME_WINDOW_P (it
->f
));
17907 /* Get the truncation glyphs. */
17909 truncate_it
.current_x
= 0;
17910 truncate_it
.face_id
= DEFAULT_FACE_ID
;
17911 truncate_it
.glyph_row
= &scratch_glyph_row
;
17912 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
17913 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
17914 truncate_it
.object
= make_number (0);
17915 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
17917 /* Overwrite glyphs from IT with truncation glyphs. */
17918 if (!it
->glyph_row
->reversed_p
)
17920 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17921 end
= from
+ truncate_it
.glyph_row
->used
[TEXT_AREA
];
17922 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17923 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
17928 /* There may be padding glyphs left over. Overwrite them too. */
17929 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
17931 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17937 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
17941 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
17942 that back to front. */
17943 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
17944 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17945 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17946 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17948 while (from
>= end
&& to
>= toend
)
17950 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
17953 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
17954 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
17955 while (from
>= end
&& to
>= toend
)
17960 /* Need to free some room before prepending additional
17962 int move_by
= from
- end
+ 1;
17963 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
17964 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
17966 for ( ; g
>= g0
; g
--)
17968 while (from
>= end
)
17970 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
17975 /* Compute the hash code for ROW. */
17977 row_hash (struct glyph_row
*row
)
17980 unsigned hashval
= 0;
17982 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
17983 for (k
= 0; k
< row
->used
[area
]; ++k
)
17984 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
17985 + row
->glyphs
[area
][k
].u
.val
17986 + row
->glyphs
[area
][k
].face_id
17987 + row
->glyphs
[area
][k
].padding_p
17988 + (row
->glyphs
[area
][k
].type
<< 2));
17993 /* Compute the pixel height and width of IT->glyph_row.
17995 Most of the time, ascent and height of a display line will be equal
17996 to the max_ascent and max_height values of the display iterator
17997 structure. This is not the case if
17999 1. We hit ZV without displaying anything. In this case, max_ascent
18000 and max_height will be zero.
18002 2. We have some glyphs that don't contribute to the line height.
18003 (The glyph row flag contributes_to_line_height_p is for future
18004 pixmap extensions).
18006 The first case is easily covered by using default values because in
18007 these cases, the line height does not really matter, except that it
18008 must not be zero. */
18011 compute_line_metrics (struct it
*it
)
18013 struct glyph_row
*row
= it
->glyph_row
;
18015 if (FRAME_WINDOW_P (it
->f
))
18017 int i
, min_y
, max_y
;
18019 /* The line may consist of one space only, that was added to
18020 place the cursor on it. If so, the row's height hasn't been
18022 if (row
->height
== 0)
18024 if (it
->max_ascent
+ it
->max_descent
== 0)
18025 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18026 row
->ascent
= it
->max_ascent
;
18027 row
->height
= it
->max_ascent
+ it
->max_descent
;
18028 row
->phys_ascent
= it
->max_phys_ascent
;
18029 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18030 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18033 /* Compute the width of this line. */
18034 row
->pixel_width
= row
->x
;
18035 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18036 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18038 xassert (row
->pixel_width
>= 0);
18039 xassert (row
->ascent
>= 0 && row
->height
> 0);
18041 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18042 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18044 /* If first line's physical ascent is larger than its logical
18045 ascent, use the physical ascent, and make the row taller.
18046 This makes accented characters fully visible. */
18047 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18048 && row
->phys_ascent
> row
->ascent
)
18050 row
->height
+= row
->phys_ascent
- row
->ascent
;
18051 row
->ascent
= row
->phys_ascent
;
18054 /* Compute how much of the line is visible. */
18055 row
->visible_height
= row
->height
;
18057 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18058 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18060 if (row
->y
< min_y
)
18061 row
->visible_height
-= min_y
- row
->y
;
18062 if (row
->y
+ row
->height
> max_y
)
18063 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18067 row
->pixel_width
= row
->used
[TEXT_AREA
];
18068 if (row
->continued_p
)
18069 row
->pixel_width
-= it
->continuation_pixel_width
;
18070 else if (row
->truncated_on_right_p
)
18071 row
->pixel_width
-= it
->truncation_pixel_width
;
18072 row
->ascent
= row
->phys_ascent
= 0;
18073 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18074 row
->extra_line_spacing
= 0;
18077 /* Compute a hash code for this row. */
18078 row
->hash
= row_hash (row
);
18080 it
->max_ascent
= it
->max_descent
= 0;
18081 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18085 /* Append one space to the glyph row of iterator IT if doing a
18086 window-based redisplay. The space has the same face as
18087 IT->face_id. Value is non-zero if a space was added.
18089 This function is called to make sure that there is always one glyph
18090 at the end of a glyph row that the cursor can be set on under
18091 window-systems. (If there weren't such a glyph we would not know
18092 how wide and tall a box cursor should be displayed).
18094 At the same time this space let's a nicely handle clearing to the
18095 end of the line if the row ends in italic text. */
18098 append_space_for_newline (struct it
*it
, int default_face_p
)
18100 if (FRAME_WINDOW_P (it
->f
))
18102 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18104 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18105 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18107 /* Save some values that must not be changed.
18108 Must save IT->c and IT->len because otherwise
18109 ITERATOR_AT_END_P wouldn't work anymore after
18110 append_space_for_newline has been called. */
18111 enum display_element_type saved_what
= it
->what
;
18112 int saved_c
= it
->c
, saved_len
= it
->len
;
18113 int saved_char_to_display
= it
->char_to_display
;
18114 int saved_x
= it
->current_x
;
18115 int saved_face_id
= it
->face_id
;
18116 struct text_pos saved_pos
;
18117 Lisp_Object saved_object
;
18120 saved_object
= it
->object
;
18121 saved_pos
= it
->position
;
18123 it
->what
= IT_CHARACTER
;
18124 memset (&it
->position
, 0, sizeof it
->position
);
18125 it
->object
= make_number (0);
18126 it
->c
= it
->char_to_display
= ' ';
18129 if (default_face_p
)
18130 it
->face_id
= DEFAULT_FACE_ID
;
18131 else if (it
->face_before_selective_p
)
18132 it
->face_id
= it
->saved_face_id
;
18133 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
18134 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
18136 PRODUCE_GLYPHS (it
);
18138 it
->override_ascent
= -1;
18139 it
->constrain_row_ascent_descent_p
= 0;
18140 it
->current_x
= saved_x
;
18141 it
->object
= saved_object
;
18142 it
->position
= saved_pos
;
18143 it
->what
= saved_what
;
18144 it
->face_id
= saved_face_id
;
18145 it
->len
= saved_len
;
18147 it
->char_to_display
= saved_char_to_display
;
18156 /* Extend the face of the last glyph in the text area of IT->glyph_row
18157 to the end of the display line. Called from display_line. If the
18158 glyph row is empty, add a space glyph to it so that we know the
18159 face to draw. Set the glyph row flag fill_line_p. If the glyph
18160 row is R2L, prepend a stretch glyph to cover the empty space to the
18161 left of the leftmost glyph. */
18164 extend_face_to_end_of_line (struct it
*it
)
18167 struct frame
*f
= it
->f
;
18169 /* If line is already filled, do nothing. Non window-system frames
18170 get a grace of one more ``pixel'' because their characters are
18171 1-``pixel'' wide, so they hit the equality too early. This grace
18172 is needed only for R2L rows that are not continued, to produce
18173 one extra blank where we could display the cursor. */
18174 if (it
->current_x
>= it
->last_visible_x
18175 + (!FRAME_WINDOW_P (f
)
18176 && it
->glyph_row
->reversed_p
18177 && !it
->glyph_row
->continued_p
))
18180 /* Face extension extends the background and box of IT->face_id
18181 to the end of the line. If the background equals the background
18182 of the frame, we don't have to do anything. */
18183 if (it
->face_before_selective_p
)
18184 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
18186 face
= FACE_FROM_ID (f
, it
->face_id
);
18188 if (FRAME_WINDOW_P (f
)
18189 && it
->glyph_row
->displays_text_p
18190 && face
->box
== FACE_NO_BOX
18191 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
18193 && !it
->glyph_row
->reversed_p
)
18196 /* Set the glyph row flag indicating that the face of the last glyph
18197 in the text area has to be drawn to the end of the text area. */
18198 it
->glyph_row
->fill_line_p
= 1;
18200 /* If current character of IT is not ASCII, make sure we have the
18201 ASCII face. This will be automatically undone the next time
18202 get_next_display_element returns a multibyte character. Note
18203 that the character will always be single byte in unibyte
18205 if (!ASCII_CHAR_P (it
->c
))
18207 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
18210 if (FRAME_WINDOW_P (f
))
18212 /* If the row is empty, add a space with the current face of IT,
18213 so that we know which face to draw. */
18214 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
18216 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
18217 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= it
->face_id
;
18218 it
->glyph_row
->used
[TEXT_AREA
] = 1;
18220 #ifdef HAVE_WINDOW_SYSTEM
18221 if (it
->glyph_row
->reversed_p
)
18223 /* Prepend a stretch glyph to the row, such that the
18224 rightmost glyph will be drawn flushed all the way to the
18225 right margin of the window. The stretch glyph that will
18226 occupy the empty space, if any, to the left of the
18228 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
18229 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18230 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
18232 int row_width
, stretch_ascent
, stretch_width
;
18233 struct text_pos saved_pos
;
18234 int saved_face_id
, saved_avoid_cursor
;
18236 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
18237 row_width
+= g
->pixel_width
;
18238 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
18239 if (stretch_width
> 0)
18242 (((it
->ascent
+ it
->descent
)
18243 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
18244 saved_pos
= it
->position
;
18245 memset (&it
->position
, 0, sizeof it
->position
);
18246 saved_avoid_cursor
= it
->avoid_cursor_p
;
18247 it
->avoid_cursor_p
= 1;
18248 saved_face_id
= it
->face_id
;
18249 /* The last row's stretch glyph should get the default
18250 face, to avoid painting the rest of the window with
18251 the region face, if the region ends at ZV. */
18252 if (it
->glyph_row
->ends_at_zv_p
)
18253 it
->face_id
= DEFAULT_FACE_ID
;
18255 it
->face_id
= face
->id
;
18256 append_stretch_glyph (it
, make_number (0), stretch_width
,
18257 it
->ascent
+ it
->descent
, stretch_ascent
);
18258 it
->position
= saved_pos
;
18259 it
->avoid_cursor_p
= saved_avoid_cursor
;
18260 it
->face_id
= saved_face_id
;
18263 #endif /* HAVE_WINDOW_SYSTEM */
18267 /* Save some values that must not be changed. */
18268 int saved_x
= it
->current_x
;
18269 struct text_pos saved_pos
;
18270 Lisp_Object saved_object
;
18271 enum display_element_type saved_what
= it
->what
;
18272 int saved_face_id
= it
->face_id
;
18274 saved_object
= it
->object
;
18275 saved_pos
= it
->position
;
18277 it
->what
= IT_CHARACTER
;
18278 memset (&it
->position
, 0, sizeof it
->position
);
18279 it
->object
= make_number (0);
18280 it
->c
= it
->char_to_display
= ' ';
18282 /* The last row's blank glyphs should get the default face, to
18283 avoid painting the rest of the window with the region face,
18284 if the region ends at ZV. */
18285 if (it
->glyph_row
->ends_at_zv_p
)
18286 it
->face_id
= DEFAULT_FACE_ID
;
18288 it
->face_id
= face
->id
;
18290 PRODUCE_GLYPHS (it
);
18292 while (it
->current_x
<= it
->last_visible_x
)
18293 PRODUCE_GLYPHS (it
);
18295 /* Don't count these blanks really. It would let us insert a left
18296 truncation glyph below and make us set the cursor on them, maybe. */
18297 it
->current_x
= saved_x
;
18298 it
->object
= saved_object
;
18299 it
->position
= saved_pos
;
18300 it
->what
= saved_what
;
18301 it
->face_id
= saved_face_id
;
18306 /* Value is non-zero if text starting at CHARPOS in current_buffer is
18307 trailing whitespace. */
18310 trailing_whitespace_p (EMACS_INT charpos
)
18312 EMACS_INT bytepos
= CHAR_TO_BYTE (charpos
);
18315 while (bytepos
< ZV_BYTE
18316 && (c
= FETCH_CHAR (bytepos
),
18317 c
== ' ' || c
== '\t'))
18320 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
18322 if (bytepos
!= PT_BYTE
)
18329 /* Highlight trailing whitespace, if any, in ROW. */
18332 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
18334 int used
= row
->used
[TEXT_AREA
];
18338 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
18339 struct glyph
*glyph
= start
+ used
- 1;
18341 if (row
->reversed_p
)
18343 /* Right-to-left rows need to be processed in the opposite
18344 direction, so swap the edge pointers. */
18346 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
18349 /* Skip over glyphs inserted to display the cursor at the
18350 end of a line, for extending the face of the last glyph
18351 to the end of the line on terminals, and for truncation
18352 and continuation glyphs. */
18353 if (!row
->reversed_p
)
18355 while (glyph
>= start
18356 && glyph
->type
== CHAR_GLYPH
18357 && INTEGERP (glyph
->object
))
18362 while (glyph
<= start
18363 && glyph
->type
== CHAR_GLYPH
18364 && INTEGERP (glyph
->object
))
18368 /* If last glyph is a space or stretch, and it's trailing
18369 whitespace, set the face of all trailing whitespace glyphs in
18370 IT->glyph_row to `trailing-whitespace'. */
18371 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
18372 && BUFFERP (glyph
->object
)
18373 && (glyph
->type
== STRETCH_GLYPH
18374 || (glyph
->type
== CHAR_GLYPH
18375 && glyph
->u
.ch
== ' '))
18376 && trailing_whitespace_p (glyph
->charpos
))
18378 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
18382 if (!row
->reversed_p
)
18384 while (glyph
>= start
18385 && BUFFERP (glyph
->object
)
18386 && (glyph
->type
== STRETCH_GLYPH
18387 || (glyph
->type
== CHAR_GLYPH
18388 && glyph
->u
.ch
== ' ')))
18389 (glyph
--)->face_id
= face_id
;
18393 while (glyph
<= start
18394 && BUFFERP (glyph
->object
)
18395 && (glyph
->type
== STRETCH_GLYPH
18396 || (glyph
->type
== CHAR_GLYPH
18397 && glyph
->u
.ch
== ' ')))
18398 (glyph
++)->face_id
= face_id
;
18405 /* Value is non-zero if glyph row ROW should be
18406 used to hold the cursor. */
18409 cursor_row_p (struct glyph_row
*row
)
18413 if (PT
== CHARPOS (row
->end
.pos
)
18414 || PT
== MATRIX_ROW_END_CHARPOS (row
))
18416 /* Suppose the row ends on a string.
18417 Unless the row is continued, that means it ends on a newline
18418 in the string. If it's anything other than a display string
18419 (e.g. a before-string from an overlay), we don't want the
18420 cursor there. (This heuristic seems to give the optimal
18421 behavior for the various types of multi-line strings.) */
18422 if (CHARPOS (row
->end
.string_pos
) >= 0)
18424 if (row
->continued_p
)
18428 /* Check for `display' property. */
18429 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
18430 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
18431 struct glyph
*glyph
;
18434 for (glyph
= end
; glyph
>= beg
; --glyph
)
18435 if (STRINGP (glyph
->object
))
18438 = Fget_char_property (make_number (PT
),
18442 && display_prop_string_p (prop
, glyph
->object
));
18447 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
18449 /* If the row ends in middle of a real character,
18450 and the line is continued, we want the cursor here.
18451 That's because CHARPOS (ROW->end.pos) would equal
18452 PT if PT is before the character. */
18453 if (!row
->ends_in_ellipsis_p
)
18454 result
= row
->continued_p
;
18456 /* If the row ends in an ellipsis, then
18457 CHARPOS (ROW->end.pos) will equal point after the
18458 invisible text. We want that position to be displayed
18459 after the ellipsis. */
18462 /* If the row ends at ZV, display the cursor at the end of that
18463 row instead of at the start of the row below. */
18464 else if (row
->ends_at_zv_p
)
18475 /* Push the property PROP so that it will be rendered at the current
18476 position in IT. Return 1 if PROP was successfully pushed, 0
18477 otherwise. Called from handle_line_prefix to handle the
18478 `line-prefix' and `wrap-prefix' properties. */
18481 push_display_prop (struct it
*it
, Lisp_Object prop
)
18483 struct text_pos pos
=
18484 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
18486 xassert (it
->method
== GET_FROM_BUFFER
18487 || it
->method
== GET_FROM_DISPLAY_VECTOR
18488 || it
->method
== GET_FROM_STRING
);
18490 /* We need to save the current buffer/string position, so it will be
18491 restored by pop_it, because iterate_out_of_display_property
18492 depends on that being set correctly, but some situations leave
18493 it->position not yet set when this function is called. */
18494 push_it (it
, &pos
);
18496 if (STRINGP (prop
))
18498 if (SCHARS (prop
) == 0)
18505 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
18506 it
->current
.overlay_string_index
= -1;
18507 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
18508 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
18509 it
->method
= GET_FROM_STRING
;
18510 it
->stop_charpos
= 0;
18512 it
->base_level_stop
= 0;
18514 /* Force paragraph direction to be that of the parent
18516 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
18517 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
18519 it
->paragraph_embedding
= L2R
;
18521 /* Set up the bidi iterator for this display string. */
18524 it
->bidi_it
.string
.lstring
= it
->string
;
18525 it
->bidi_it
.string
.s
= NULL
;
18526 it
->bidi_it
.string
.schars
= it
->end_charpos
;
18527 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
18528 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
18529 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
18530 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
18533 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
18535 it
->method
= GET_FROM_STRETCH
;
18538 #ifdef HAVE_WINDOW_SYSTEM
18539 else if (IMAGEP (prop
))
18541 it
->what
= IT_IMAGE
;
18542 it
->image_id
= lookup_image (it
->f
, prop
);
18543 it
->method
= GET_FROM_IMAGE
;
18545 #endif /* HAVE_WINDOW_SYSTEM */
18548 pop_it (it
); /* bogus display property, give up */
18555 /* Return the character-property PROP at the current position in IT. */
18558 get_it_property (struct it
*it
, Lisp_Object prop
)
18560 Lisp_Object position
;
18562 if (STRINGP (it
->object
))
18563 position
= make_number (IT_STRING_CHARPOS (*it
));
18564 else if (BUFFERP (it
->object
))
18565 position
= make_number (IT_CHARPOS (*it
));
18569 return Fget_char_property (position
, prop
, it
->object
);
18572 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
18575 handle_line_prefix (struct it
*it
)
18577 Lisp_Object prefix
;
18579 if (it
->continuation_lines_width
> 0)
18581 prefix
= get_it_property (it
, Qwrap_prefix
);
18583 prefix
= Vwrap_prefix
;
18587 prefix
= get_it_property (it
, Qline_prefix
);
18589 prefix
= Vline_prefix
;
18591 if (! NILP (prefix
) && push_display_prop (it
, prefix
))
18593 /* If the prefix is wider than the window, and we try to wrap
18594 it, it would acquire its own wrap prefix, and so on till the
18595 iterator stack overflows. So, don't wrap the prefix. */
18596 it
->line_wrap
= TRUNCATE
;
18597 it
->avoid_cursor_p
= 1;
18603 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
18604 only for R2L lines from display_line and display_string, when they
18605 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
18606 the line/string needs to be continued on the next glyph row. */
18608 unproduce_glyphs (struct it
*it
, int n
)
18610 struct glyph
*glyph
, *end
;
18612 xassert (it
->glyph_row
);
18613 xassert (it
->glyph_row
->reversed_p
);
18614 xassert (it
->area
== TEXT_AREA
);
18615 xassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
18617 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
18618 n
= it
->glyph_row
->used
[TEXT_AREA
];
18619 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
18620 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
18621 for ( ; glyph
< end
; glyph
++)
18622 glyph
[-n
] = *glyph
;
18625 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
18626 and ROW->maxpos. */
18628 find_row_edges (struct it
*it
, struct glyph_row
*row
,
18629 EMACS_INT min_pos
, EMACS_INT min_bpos
,
18630 EMACS_INT max_pos
, EMACS_INT max_bpos
)
18632 /* FIXME: Revisit this when glyph ``spilling'' in continuation
18633 lines' rows is implemented for bidi-reordered rows. */
18635 /* ROW->minpos is the value of min_pos, the minimal buffer position
18636 we have in ROW, or ROW->start.pos if that is smaller. */
18637 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
18638 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
18640 /* We didn't find buffer positions smaller than ROW->start, or
18641 didn't find _any_ valid buffer positions in any of the glyphs,
18642 so we must trust the iterator's computed positions. */
18643 row
->minpos
= row
->start
.pos
;
18646 max_pos
= CHARPOS (it
->current
.pos
);
18647 max_bpos
= BYTEPOS (it
->current
.pos
);
18650 /* Here are the various use-cases for ending the row, and the
18651 corresponding values for ROW->maxpos:
18653 Line ends in a newline from buffer eol_pos + 1
18654 Line is continued from buffer max_pos + 1
18655 Line is truncated on right it->current.pos
18656 Line ends in a newline from string max_pos + 1(*)
18657 (*) + 1 only when line ends in a forward scan
18658 Line is continued from string max_pos
18659 Line is continued from display vector max_pos
18660 Line is entirely from a string min_pos == max_pos
18661 Line is entirely from a display vector min_pos == max_pos
18662 Line that ends at ZV ZV
18664 If you discover other use-cases, please add them here as
18666 if (row
->ends_at_zv_p
)
18667 row
->maxpos
= it
->current
.pos
;
18668 else if (row
->used
[TEXT_AREA
])
18670 int seen_this_string
= 0;
18671 struct glyph_row
*r1
= row
- 1;
18673 /* Did we see the same display string on the previous row? */
18674 if (STRINGP (it
->object
)
18675 /* this is not the first row */
18676 && row
> it
->w
->desired_matrix
->rows
18677 /* previous row is not the header line */
18678 && !r1
->mode_line_p
18679 /* previous row also ends in a newline from a string */
18680 && r1
->ends_in_newline_from_string_p
)
18682 struct glyph
*start
, *end
;
18684 /* Search for the last glyph of the previous row that came
18685 from buffer or string. Depending on whether the row is
18686 L2R or R2L, we need to process it front to back or the
18687 other way round. */
18688 if (!r1
->reversed_p
)
18690 start
= r1
->glyphs
[TEXT_AREA
];
18691 end
= start
+ r1
->used
[TEXT_AREA
];
18692 /* Glyphs inserted by redisplay have an integer (zero)
18693 as their object. */
18695 && INTEGERP ((end
- 1)->object
)
18696 && (end
- 1)->charpos
<= 0)
18700 if (EQ ((end
- 1)->object
, it
->object
))
18701 seen_this_string
= 1;
18704 /* If all the glyphs of the previous row were inserted
18705 by redisplay, it means the previous row was
18706 produced from a single newline, which is only
18707 possible if that newline came from the same string
18708 as the one which produced this ROW. */
18709 seen_this_string
= 1;
18713 end
= r1
->glyphs
[TEXT_AREA
] - 1;
18714 start
= end
+ r1
->used
[TEXT_AREA
];
18716 && INTEGERP ((end
+ 1)->object
)
18717 && (end
+ 1)->charpos
<= 0)
18721 if (EQ ((end
+ 1)->object
, it
->object
))
18722 seen_this_string
= 1;
18725 seen_this_string
= 1;
18728 /* Take note of each display string that covers a newline only
18729 once, the first time we see it. This is for when a display
18730 string includes more than one newline in it. */
18731 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
18733 /* If we were scanning the buffer forward when we displayed
18734 the string, we want to account for at least one buffer
18735 position that belongs to this row (position covered by
18736 the display string), so that cursor positioning will
18737 consider this row as a candidate when point is at the end
18738 of the visual line represented by this row. This is not
18739 required when scanning back, because max_pos will already
18740 have a much larger value. */
18741 if (CHARPOS (row
->end
.pos
) > max_pos
)
18742 INC_BOTH (max_pos
, max_bpos
);
18743 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18745 else if (CHARPOS (it
->eol_pos
) > 0)
18746 SET_TEXT_POS (row
->maxpos
,
18747 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
18748 else if (row
->continued_p
)
18750 /* If max_pos is different from IT's current position, it
18751 means IT->method does not belong to the display element
18752 at max_pos. However, it also means that the display
18753 element at max_pos was displayed in its entirety on this
18754 line, which is equivalent to saying that the next line
18755 starts at the next buffer position. */
18756 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
18757 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18760 INC_BOTH (max_pos
, max_bpos
);
18761 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
18764 else if (row
->truncated_on_right_p
)
18765 /* display_line already called reseat_at_next_visible_line_start,
18766 which puts the iterator at the beginning of the next line, in
18767 the logical order. */
18768 row
->maxpos
= it
->current
.pos
;
18769 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
18770 /* A line that is entirely from a string/image/stretch... */
18771 row
->maxpos
= row
->minpos
;
18776 row
->maxpos
= it
->current
.pos
;
18779 /* Construct the glyph row IT->glyph_row in the desired matrix of
18780 IT->w from text at the current position of IT. See dispextern.h
18781 for an overview of struct it. Value is non-zero if
18782 IT->glyph_row displays text, as opposed to a line displaying ZV
18786 display_line (struct it
*it
)
18788 struct glyph_row
*row
= it
->glyph_row
;
18789 Lisp_Object overlay_arrow_string
;
18791 void *wrap_data
= NULL
;
18792 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
18793 int wrap_row_used
= -1;
18794 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
18795 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
18796 int wrap_row_extra_line_spacing
IF_LINT (= 0);
18797 EMACS_INT wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
18798 EMACS_INT wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
18800 EMACS_INT min_pos
= ZV
+ 1, max_pos
= 0;
18801 EMACS_INT min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
18803 /* We always start displaying at hpos zero even if hscrolled. */
18804 xassert (it
->hpos
== 0 && it
->current_x
== 0);
18806 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
18807 >= it
->w
->desired_matrix
->nrows
)
18809 it
->w
->nrows_scale_factor
++;
18810 fonts_changed_p
= 1;
18814 /* Is IT->w showing the region? */
18815 it
->w
->region_showing
= it
->region_beg_charpos
> 0 ? Qt
: Qnil
;
18817 /* Clear the result glyph row and enable it. */
18818 prepare_desired_row (row
);
18820 row
->y
= it
->current_y
;
18821 row
->start
= it
->start
;
18822 row
->continuation_lines_width
= it
->continuation_lines_width
;
18823 row
->displays_text_p
= 1;
18824 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
18825 it
->starts_in_middle_of_char_p
= 0;
18827 /* Arrange the overlays nicely for our purposes. Usually, we call
18828 display_line on only one line at a time, in which case this
18829 can't really hurt too much, or we call it on lines which appear
18830 one after another in the buffer, in which case all calls to
18831 recenter_overlay_lists but the first will be pretty cheap. */
18832 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
18834 /* Move over display elements that are not visible because we are
18835 hscrolled. This may stop at an x-position < IT->first_visible_x
18836 if the first glyph is partially visible or if we hit a line end. */
18837 if (it
->current_x
< it
->first_visible_x
)
18839 this_line_min_pos
= row
->start
.pos
;
18840 move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
18841 MOVE_TO_POS
| MOVE_TO_X
);
18842 /* Record the smallest positions seen while we moved over
18843 display elements that are not visible. This is needed by
18844 redisplay_internal for optimizing the case where the cursor
18845 stays inside the same line. The rest of this function only
18846 considers positions that are actually displayed, so
18847 RECORD_MAX_MIN_POS will not otherwise record positions that
18848 are hscrolled to the left of the left edge of the window. */
18849 min_pos
= CHARPOS (this_line_min_pos
);
18850 min_bpos
= BYTEPOS (this_line_min_pos
);
18854 /* We only do this when not calling `move_it_in_display_line_to'
18855 above, because move_it_in_display_line_to calls
18856 handle_line_prefix itself. */
18857 handle_line_prefix (it
);
18860 /* Get the initial row height. This is either the height of the
18861 text hscrolled, if there is any, or zero. */
18862 row
->ascent
= it
->max_ascent
;
18863 row
->height
= it
->max_ascent
+ it
->max_descent
;
18864 row
->phys_ascent
= it
->max_phys_ascent
;
18865 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18866 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18868 /* Utility macro to record max and min buffer positions seen until now. */
18869 #define RECORD_MAX_MIN_POS(IT) \
18872 int composition_p = (IT)->what == IT_COMPOSITION; \
18873 EMACS_INT current_pos = \
18874 composition_p ? (IT)->cmp_it.charpos \
18875 : IT_CHARPOS (*(IT)); \
18876 EMACS_INT current_bpos = \
18877 composition_p ? CHAR_TO_BYTE (current_pos) \
18878 : IT_BYTEPOS (*(IT)); \
18879 if (current_pos < min_pos) \
18881 min_pos = current_pos; \
18882 min_bpos = current_bpos; \
18884 if (IT_CHARPOS (*it) > max_pos) \
18886 max_pos = IT_CHARPOS (*it); \
18887 max_bpos = IT_BYTEPOS (*it); \
18892 /* Loop generating characters. The loop is left with IT on the next
18893 character to display. */
18896 int n_glyphs_before
, hpos_before
, x_before
;
18898 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
18900 /* Retrieve the next thing to display. Value is zero if end of
18902 if (!get_next_display_element (it
))
18904 /* Maybe add a space at the end of this line that is used to
18905 display the cursor there under X. Set the charpos of the
18906 first glyph of blank lines not corresponding to any text
18908 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
18909 row
->exact_window_width_line_p
= 1;
18910 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
18911 || row
->used
[TEXT_AREA
] == 0)
18913 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
18914 row
->displays_text_p
= 0;
18916 if (!NILP (BVAR (XBUFFER (it
->w
->buffer
), indicate_empty_lines
))
18917 && (!MINI_WINDOW_P (it
->w
)
18918 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
18919 row
->indicate_empty_line_p
= 1;
18922 it
->continuation_lines_width
= 0;
18923 row
->ends_at_zv_p
= 1;
18924 /* A row that displays right-to-left text must always have
18925 its last face extended all the way to the end of line,
18926 even if this row ends in ZV, because we still write to
18927 the screen left to right. */
18928 if (row
->reversed_p
)
18929 extend_face_to_end_of_line (it
);
18933 /* Now, get the metrics of what we want to display. This also
18934 generates glyphs in `row' (which is IT->glyph_row). */
18935 n_glyphs_before
= row
->used
[TEXT_AREA
];
18938 /* Remember the line height so far in case the next element doesn't
18939 fit on the line. */
18940 if (it
->line_wrap
!= TRUNCATE
)
18942 ascent
= it
->max_ascent
;
18943 descent
= it
->max_descent
;
18944 phys_ascent
= it
->max_phys_ascent
;
18945 phys_descent
= it
->max_phys_descent
;
18947 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
18949 if (IT_DISPLAYING_WHITESPACE (it
))
18953 SAVE_IT (wrap_it
, *it
, wrap_data
);
18955 wrap_row_used
= row
->used
[TEXT_AREA
];
18956 wrap_row_ascent
= row
->ascent
;
18957 wrap_row_height
= row
->height
;
18958 wrap_row_phys_ascent
= row
->phys_ascent
;
18959 wrap_row_phys_height
= row
->phys_height
;
18960 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
18961 wrap_row_min_pos
= min_pos
;
18962 wrap_row_min_bpos
= min_bpos
;
18963 wrap_row_max_pos
= max_pos
;
18964 wrap_row_max_bpos
= max_bpos
;
18970 PRODUCE_GLYPHS (it
);
18972 /* If this display element was in marginal areas, continue with
18974 if (it
->area
!= TEXT_AREA
)
18976 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
18977 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
18978 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
18979 row
->phys_height
= max (row
->phys_height
,
18980 it
->max_phys_ascent
+ it
->max_phys_descent
);
18981 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
18982 it
->max_extra_line_spacing
);
18983 set_iterator_to_next (it
, 1);
18987 /* Does the display element fit on the line? If we truncate
18988 lines, we should draw past the right edge of the window. If
18989 we don't truncate, we want to stop so that we can display the
18990 continuation glyph before the right margin. If lines are
18991 continued, there are two possible strategies for characters
18992 resulting in more than 1 glyph (e.g. tabs): Display as many
18993 glyphs as possible in this line and leave the rest for the
18994 continuation line, or display the whole element in the next
18995 line. Original redisplay did the former, so we do it also. */
18996 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
18997 hpos_before
= it
->hpos
;
19000 if (/* Not a newline. */
19002 /* Glyphs produced fit entirely in the line. */
19003 && it
->current_x
< it
->last_visible_x
)
19005 it
->hpos
+= nglyphs
;
19006 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19007 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19008 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19009 row
->phys_height
= max (row
->phys_height
,
19010 it
->max_phys_ascent
+ it
->max_phys_descent
);
19011 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19012 it
->max_extra_line_spacing
);
19013 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
19014 row
->x
= x
- it
->first_visible_x
;
19015 /* Record the maximum and minimum buffer positions seen so
19016 far in glyphs that will be displayed by this row. */
19018 RECORD_MAX_MIN_POS (it
);
19023 struct glyph
*glyph
;
19025 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
19027 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
19028 new_x
= x
+ glyph
->pixel_width
;
19030 if (/* Lines are continued. */
19031 it
->line_wrap
!= TRUNCATE
19032 && (/* Glyph doesn't fit on the line. */
19033 new_x
> it
->last_visible_x
19034 /* Or it fits exactly on a window system frame. */
19035 || (new_x
== it
->last_visible_x
19036 && FRAME_WINDOW_P (it
->f
))))
19038 /* End of a continued line. */
19041 || (new_x
== it
->last_visible_x
19042 && FRAME_WINDOW_P (it
->f
)))
19044 /* Current glyph is the only one on the line or
19045 fits exactly on the line. We must continue
19046 the line because we can't draw the cursor
19047 after the glyph. */
19048 row
->continued_p
= 1;
19049 it
->current_x
= new_x
;
19050 it
->continuation_lines_width
+= new_x
;
19052 if (i
== nglyphs
- 1)
19054 /* If line-wrap is on, check if a previous
19055 wrap point was found. */
19056 if (wrap_row_used
> 0
19057 /* Even if there is a previous wrap
19058 point, continue the line here as
19059 usual, if (i) the previous character
19060 was a space or tab AND (ii) the
19061 current character is not. */
19063 || IT_DISPLAYING_WHITESPACE (it
)))
19066 /* Record the maximum and minimum buffer
19067 positions seen so far in glyphs that will be
19068 displayed by this row. */
19070 RECORD_MAX_MIN_POS (it
);
19071 set_iterator_to_next (it
, 1);
19072 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19074 if (!get_next_display_element (it
))
19076 row
->exact_window_width_line_p
= 1;
19077 it
->continuation_lines_width
= 0;
19078 row
->continued_p
= 0;
19079 row
->ends_at_zv_p
= 1;
19081 else if (ITERATOR_AT_END_OF_LINE_P (it
))
19083 row
->continued_p
= 0;
19084 row
->exact_window_width_line_p
= 1;
19088 else if (it
->bidi_p
)
19089 RECORD_MAX_MIN_POS (it
);
19091 else if (CHAR_GLYPH_PADDING_P (*glyph
)
19092 && !FRAME_WINDOW_P (it
->f
))
19094 /* A padding glyph that doesn't fit on this line.
19095 This means the whole character doesn't fit
19097 if (row
->reversed_p
)
19098 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19099 - n_glyphs_before
);
19100 row
->used
[TEXT_AREA
] = n_glyphs_before
;
19102 /* Fill the rest of the row with continuation
19103 glyphs like in 20.x. */
19104 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
19105 < row
->glyphs
[1 + TEXT_AREA
])
19106 produce_special_glyphs (it
, IT_CONTINUATION
);
19108 row
->continued_p
= 1;
19109 it
->current_x
= x_before
;
19110 it
->continuation_lines_width
+= x_before
;
19112 /* Restore the height to what it was before the
19113 element not fitting on the line. */
19114 it
->max_ascent
= ascent
;
19115 it
->max_descent
= descent
;
19116 it
->max_phys_ascent
= phys_ascent
;
19117 it
->max_phys_descent
= phys_descent
;
19119 else if (wrap_row_used
> 0)
19122 if (row
->reversed_p
)
19123 unproduce_glyphs (it
,
19124 row
->used
[TEXT_AREA
] - wrap_row_used
);
19125 RESTORE_IT (it
, &wrap_it
, wrap_data
);
19126 it
->continuation_lines_width
+= wrap_x
;
19127 row
->used
[TEXT_AREA
] = wrap_row_used
;
19128 row
->ascent
= wrap_row_ascent
;
19129 row
->height
= wrap_row_height
;
19130 row
->phys_ascent
= wrap_row_phys_ascent
;
19131 row
->phys_height
= wrap_row_phys_height
;
19132 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
19133 min_pos
= wrap_row_min_pos
;
19134 min_bpos
= wrap_row_min_bpos
;
19135 max_pos
= wrap_row_max_pos
;
19136 max_bpos
= wrap_row_max_bpos
;
19137 row
->continued_p
= 1;
19138 row
->ends_at_zv_p
= 0;
19139 row
->exact_window_width_line_p
= 0;
19140 it
->continuation_lines_width
+= x
;
19142 /* Make sure that a non-default face is extended
19143 up to the right margin of the window. */
19144 extend_face_to_end_of_line (it
);
19146 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
19148 /* A TAB that extends past the right edge of the
19149 window. This produces a single glyph on
19150 window system frames. We leave the glyph in
19151 this row and let it fill the row, but don't
19152 consume the TAB. */
19153 it
->continuation_lines_width
+= it
->last_visible_x
;
19154 row
->ends_in_middle_of_char_p
= 1;
19155 row
->continued_p
= 1;
19156 glyph
->pixel_width
= it
->last_visible_x
- x
;
19157 it
->starts_in_middle_of_char_p
= 1;
19161 /* Something other than a TAB that draws past
19162 the right edge of the window. Restore
19163 positions to values before the element. */
19164 if (row
->reversed_p
)
19165 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
19166 - (n_glyphs_before
+ i
));
19167 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
19169 /* Display continuation glyphs. */
19170 if (!FRAME_WINDOW_P (it
->f
))
19171 produce_special_glyphs (it
, IT_CONTINUATION
);
19172 row
->continued_p
= 1;
19174 it
->current_x
= x_before
;
19175 it
->continuation_lines_width
+= x
;
19176 extend_face_to_end_of_line (it
);
19178 if (nglyphs
> 1 && i
> 0)
19180 row
->ends_in_middle_of_char_p
= 1;
19181 it
->starts_in_middle_of_char_p
= 1;
19184 /* Restore the height to what it was before the
19185 element not fitting on the line. */
19186 it
->max_ascent
= ascent
;
19187 it
->max_descent
= descent
;
19188 it
->max_phys_ascent
= phys_ascent
;
19189 it
->max_phys_descent
= phys_descent
;
19194 else if (new_x
> it
->first_visible_x
)
19196 /* Increment number of glyphs actually displayed. */
19199 /* Record the maximum and minimum buffer positions
19200 seen so far in glyphs that will be displayed by
19203 RECORD_MAX_MIN_POS (it
);
19205 if (x
< it
->first_visible_x
)
19206 /* Glyph is partially visible, i.e. row starts at
19207 negative X position. */
19208 row
->x
= x
- it
->first_visible_x
;
19212 /* Glyph is completely off the left margin of the
19213 window. This should not happen because of the
19214 move_it_in_display_line at the start of this
19215 function, unless the text display area of the
19216 window is empty. */
19217 xassert (it
->first_visible_x
<= it
->last_visible_x
);
19220 /* Even if this display element produced no glyphs at all,
19221 we want to record its position. */
19222 if (it
->bidi_p
&& nglyphs
== 0)
19223 RECORD_MAX_MIN_POS (it
);
19225 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
19226 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
19227 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
19228 row
->phys_height
= max (row
->phys_height
,
19229 it
->max_phys_ascent
+ it
->max_phys_descent
);
19230 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
19231 it
->max_extra_line_spacing
);
19233 /* End of this display line if row is continued. */
19234 if (row
->continued_p
|| row
->ends_at_zv_p
)
19239 /* Is this a line end? If yes, we're also done, after making
19240 sure that a non-default face is extended up to the right
19241 margin of the window. */
19242 if (ITERATOR_AT_END_OF_LINE_P (it
))
19244 int used_before
= row
->used
[TEXT_AREA
];
19246 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
19248 /* Add a space at the end of the line that is used to
19249 display the cursor there. */
19250 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19251 append_space_for_newline (it
, 0);
19253 /* Extend the face to the end of the line. */
19254 extend_face_to_end_of_line (it
);
19256 /* Make sure we have the position. */
19257 if (used_before
== 0)
19258 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
19260 /* Record the position of the newline, for use in
19262 it
->eol_pos
= it
->current
.pos
;
19264 /* Consume the line end. This skips over invisible lines. */
19265 set_iterator_to_next (it
, 1);
19266 it
->continuation_lines_width
= 0;
19270 /* Proceed with next display element. Note that this skips
19271 over lines invisible because of selective display. */
19272 set_iterator_to_next (it
, 1);
19274 /* If we truncate lines, we are done when the last displayed
19275 glyphs reach past the right margin of the window. */
19276 if (it
->line_wrap
== TRUNCATE
19277 && (FRAME_WINDOW_P (it
->f
)
19278 ? (it
->current_x
>= it
->last_visible_x
)
19279 : (it
->current_x
> it
->last_visible_x
)))
19281 /* Maybe add truncation glyphs. */
19282 if (!FRAME_WINDOW_P (it
->f
))
19286 if (!row
->reversed_p
)
19288 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
19289 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19294 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
19295 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
19297 /* Remove any padding glyphs at the front of ROW, to
19298 make room for the truncation glyphs we will be
19299 adding below. The loop below always inserts at
19300 least one truncation glyph, so also remove the
19301 last glyph added to ROW. */
19302 unproduce_glyphs (it
, i
+ 1);
19303 /* Adjust i for the loop below. */
19304 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
19307 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
19309 row
->used
[TEXT_AREA
] = i
;
19310 produce_special_glyphs (it
, IT_TRUNCATION
);
19313 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19315 /* Don't truncate if we can overflow newline into fringe. */
19316 if (!get_next_display_element (it
))
19318 it
->continuation_lines_width
= 0;
19319 row
->ends_at_zv_p
= 1;
19320 row
->exact_window_width_line_p
= 1;
19323 if (ITERATOR_AT_END_OF_LINE_P (it
))
19325 row
->exact_window_width_line_p
= 1;
19326 goto at_end_of_line
;
19330 row
->truncated_on_right_p
= 1;
19331 it
->continuation_lines_width
= 0;
19332 reseat_at_next_visible_line_start (it
, 0);
19333 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
19334 it
->hpos
= hpos_before
;
19335 it
->current_x
= x_before
;
19341 bidi_unshelve_cache (wrap_data
, 1);
19343 /* If line is not empty and hscrolled, maybe insert truncation glyphs
19344 at the left window margin. */
19345 if (it
->first_visible_x
19346 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
19348 if (!FRAME_WINDOW_P (it
->f
))
19349 insert_left_trunc_glyphs (it
);
19350 row
->truncated_on_left_p
= 1;
19353 /* Remember the position at which this line ends.
19355 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
19356 cannot be before the call to find_row_edges below, since that is
19357 where these positions are determined. */
19358 row
->end
= it
->current
;
19361 row
->minpos
= row
->start
.pos
;
19362 row
->maxpos
= row
->end
.pos
;
19366 /* ROW->minpos and ROW->maxpos must be the smallest and
19367 `1 + the largest' buffer positions in ROW. But if ROW was
19368 bidi-reordered, these two positions can be anywhere in the
19369 row, so we must determine them now. */
19370 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
19373 /* If the start of this line is the overlay arrow-position, then
19374 mark this glyph row as the one containing the overlay arrow.
19375 This is clearly a mess with variable size fonts. It would be
19376 better to let it be displayed like cursors under X. */
19377 if ((row
->displays_text_p
|| !overlay_arrow_seen
)
19378 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
19379 !NILP (overlay_arrow_string
)))
19381 /* Overlay arrow in window redisplay is a fringe bitmap. */
19382 if (STRINGP (overlay_arrow_string
))
19384 struct glyph_row
*arrow_row
19385 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
19386 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
19387 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
19388 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
19389 struct glyph
*p2
, *end
;
19391 /* Copy the arrow glyphs. */
19392 while (glyph
< arrow_end
)
19395 /* Throw away padding glyphs. */
19397 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
19398 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
19404 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
19409 xassert (INTEGERP (overlay_arrow_string
));
19410 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
19412 overlay_arrow_seen
= 1;
19415 /* Highlight trailing whitespace. */
19416 if (!NILP (Vshow_trailing_whitespace
))
19417 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
19419 /* Compute pixel dimensions of this line. */
19420 compute_line_metrics (it
);
19422 /* Implementation note: No changes in the glyphs of ROW or in their
19423 faces can be done past this point, because compute_line_metrics
19424 computes ROW's hash value and stores it within the glyph_row
19427 /* Record whether this row ends inside an ellipsis. */
19428 row
->ends_in_ellipsis_p
19429 = (it
->method
== GET_FROM_DISPLAY_VECTOR
19430 && it
->ellipsis_p
);
19432 /* Save fringe bitmaps in this row. */
19433 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
19434 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
19435 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
19436 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
19438 it
->left_user_fringe_bitmap
= 0;
19439 it
->left_user_fringe_face_id
= 0;
19440 it
->right_user_fringe_bitmap
= 0;
19441 it
->right_user_fringe_face_id
= 0;
19443 /* Maybe set the cursor. */
19444 cvpos
= it
->w
->cursor
.vpos
;
19446 /* In bidi-reordered rows, keep checking for proper cursor
19447 position even if one has been found already, because buffer
19448 positions in such rows change non-linearly with ROW->VPOS,
19449 when a line is continued. One exception: when we are at ZV,
19450 display cursor on the first suitable glyph row, since all
19451 the empty rows after that also have their position set to ZV. */
19452 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19453 lines' rows is implemented for bidi-reordered rows. */
19455 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
19456 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
19457 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
19458 && cursor_row_p (row
))
19459 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
19461 /* Prepare for the next line. This line starts horizontally at (X
19462 HPOS) = (0 0). Vertical positions are incremented. As a
19463 convenience for the caller, IT->glyph_row is set to the next
19465 it
->current_x
= it
->hpos
= 0;
19466 it
->current_y
+= row
->height
;
19467 SET_TEXT_POS (it
->eol_pos
, 0, 0);
19470 /* The next row should by default use the same value of the
19471 reversed_p flag as this one. set_iterator_to_next decides when
19472 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
19473 the flag accordingly. */
19474 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
19475 it
->glyph_row
->reversed_p
= row
->reversed_p
;
19476 it
->start
= row
->end
;
19477 return row
->displays_text_p
;
19479 #undef RECORD_MAX_MIN_POS
19482 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
19483 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
19484 doc
: /* Return paragraph direction at point in BUFFER.
19485 Value is either `left-to-right' or `right-to-left'.
19486 If BUFFER is omitted or nil, it defaults to the current buffer.
19488 Paragraph direction determines how the text in the paragraph is displayed.
19489 In left-to-right paragraphs, text begins at the left margin of the window
19490 and the reading direction is generally left to right. In right-to-left
19491 paragraphs, text begins at the right margin and is read from right to left.
19493 See also `bidi-paragraph-direction'. */)
19494 (Lisp_Object buffer
)
19496 struct buffer
*buf
= current_buffer
;
19497 struct buffer
*old
= buf
;
19499 if (! NILP (buffer
))
19501 CHECK_BUFFER (buffer
);
19502 buf
= XBUFFER (buffer
);
19505 if (NILP (BVAR (buf
, bidi_display_reordering
))
19506 || NILP (BVAR (buf
, enable_multibyte_characters
))
19507 /* When we are loading loadup.el, the character property tables
19508 needed for bidi iteration are not yet available. */
19509 || !NILP (Vpurify_flag
))
19510 return Qleft_to_right
;
19511 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
19512 return BVAR (buf
, bidi_paragraph_direction
);
19515 /* Determine the direction from buffer text. We could try to
19516 use current_matrix if it is up to date, but this seems fast
19517 enough as it is. */
19518 struct bidi_it itb
;
19519 EMACS_INT pos
= BUF_PT (buf
);
19520 EMACS_INT bytepos
= BUF_PT_BYTE (buf
);
19522 void *itb_data
= bidi_shelve_cache ();
19524 set_buffer_temp (buf
);
19525 /* bidi_paragraph_init finds the base direction of the paragraph
19526 by searching forward from paragraph start. We need the base
19527 direction of the current or _previous_ paragraph, so we need
19528 to make sure we are within that paragraph. To that end, find
19529 the previous non-empty line. */
19530 if (pos
>= ZV
&& pos
> BEGV
)
19533 bytepos
= CHAR_TO_BYTE (pos
);
19535 if (fast_looking_at (build_string ("[\f\t ]*\n"),
19536 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
19538 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
19539 || c
== ' ' || c
== '\t' || c
== '\f')
19541 if (bytepos
<= BEGV_BYTE
)
19546 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
19549 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
19550 itb
.paragraph_dir
= NEUTRAL_DIR
;
19551 itb
.string
.s
= NULL
;
19552 itb
.string
.lstring
= Qnil
;
19553 itb
.string
.bufpos
= 0;
19554 itb
.string
.unibyte
= 0;
19555 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
19556 bidi_unshelve_cache (itb_data
, 0);
19557 set_buffer_temp (old
);
19558 switch (itb
.paragraph_dir
)
19561 return Qleft_to_right
;
19564 return Qright_to_left
;
19574 /***********************************************************************
19576 ***********************************************************************/
19578 /* Redisplay the menu bar in the frame for window W.
19580 The menu bar of X frames that don't have X toolkit support is
19581 displayed in a special window W->frame->menu_bar_window.
19583 The menu bar of terminal frames is treated specially as far as
19584 glyph matrices are concerned. Menu bar lines are not part of
19585 windows, so the update is done directly on the frame matrix rows
19586 for the menu bar. */
19589 display_menu_bar (struct window
*w
)
19591 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
19596 /* Don't do all this for graphical frames. */
19598 if (FRAME_W32_P (f
))
19601 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
19607 if (FRAME_NS_P (f
))
19609 #endif /* HAVE_NS */
19611 #ifdef USE_X_TOOLKIT
19612 xassert (!FRAME_WINDOW_P (f
));
19613 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
19614 it
.first_visible_x
= 0;
19615 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19616 #else /* not USE_X_TOOLKIT */
19617 if (FRAME_WINDOW_P (f
))
19619 /* Menu bar lines are displayed in the desired matrix of the
19620 dummy window menu_bar_window. */
19621 struct window
*menu_w
;
19622 xassert (WINDOWP (f
->menu_bar_window
));
19623 menu_w
= XWINDOW (f
->menu_bar_window
);
19624 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
19626 it
.first_visible_x
= 0;
19627 it
.last_visible_x
= FRAME_TOTAL_COLS (f
) * FRAME_COLUMN_WIDTH (f
);
19631 /* This is a TTY frame, i.e. character hpos/vpos are used as
19633 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
19635 it
.first_visible_x
= 0;
19636 it
.last_visible_x
= FRAME_COLS (f
);
19638 #endif /* not USE_X_TOOLKIT */
19640 /* FIXME: This should be controlled by a user option. See the
19641 comments in redisplay_tool_bar and display_mode_line about
19643 it
.paragraph_embedding
= L2R
;
19645 if (! mode_line_inverse_video
)
19646 /* Force the menu-bar to be displayed in the default face. */
19647 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19649 /* Clear all rows of the menu bar. */
19650 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
19652 struct glyph_row
*row
= it
.glyph_row
+ i
;
19653 clear_glyph_row (row
);
19654 row
->enabled_p
= 1;
19655 row
->full_width_p
= 1;
19658 /* Display all items of the menu bar. */
19659 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
19660 for (i
= 0; i
< ASIZE (items
); i
+= 4)
19662 Lisp_Object string
;
19664 /* Stop at nil string. */
19665 string
= AREF (items
, i
+ 1);
19669 /* Remember where item was displayed. */
19670 ASET (items
, i
+ 3, make_number (it
.hpos
));
19672 /* Display the item, pad with one space. */
19673 if (it
.current_x
< it
.last_visible_x
)
19674 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
19675 SCHARS (string
) + 1, 0, 0, -1);
19678 /* Fill out the line with spaces. */
19679 if (it
.current_x
< it
.last_visible_x
)
19680 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
19682 /* Compute the total height of the lines. */
19683 compute_line_metrics (&it
);
19688 /***********************************************************************
19690 ***********************************************************************/
19692 /* Redisplay mode lines in the window tree whose root is WINDOW. If
19693 FORCE is non-zero, redisplay mode lines unconditionally.
19694 Otherwise, redisplay only mode lines that are garbaged. Value is
19695 the number of windows whose mode lines were redisplayed. */
19698 redisplay_mode_lines (Lisp_Object window
, int force
)
19702 while (!NILP (window
))
19704 struct window
*w
= XWINDOW (window
);
19706 if (WINDOWP (w
->hchild
))
19707 nwindows
+= redisplay_mode_lines (w
->hchild
, force
);
19708 else if (WINDOWP (w
->vchild
))
19709 nwindows
+= redisplay_mode_lines (w
->vchild
, force
);
19711 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
19712 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
19714 struct text_pos lpoint
;
19715 struct buffer
*old
= current_buffer
;
19717 /* Set the window's buffer for the mode line display. */
19718 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
19719 set_buffer_internal_1 (XBUFFER (w
->buffer
));
19721 /* Point refers normally to the selected window. For any
19722 other window, set up appropriate value. */
19723 if (!EQ (window
, selected_window
))
19725 struct text_pos pt
;
19727 SET_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
19728 if (CHARPOS (pt
) < BEGV
)
19729 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
19730 else if (CHARPOS (pt
) > (ZV
- 1))
19731 TEMP_SET_PT_BOTH (ZV
, ZV_BYTE
);
19733 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
19736 /* Display mode lines. */
19737 clear_glyph_matrix (w
->desired_matrix
);
19738 if (display_mode_lines (w
))
19741 w
->must_be_updated_p
= 1;
19744 /* Restore old settings. */
19745 set_buffer_internal_1 (old
);
19746 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
19756 /* Display the mode and/or header line of window W. Value is the
19757 sum number of mode lines and header lines displayed. */
19760 display_mode_lines (struct window
*w
)
19762 Lisp_Object old_selected_window
, old_selected_frame
;
19765 old_selected_frame
= selected_frame
;
19766 selected_frame
= w
->frame
;
19767 old_selected_window
= selected_window
;
19768 XSETWINDOW (selected_window
, w
);
19770 /* These will be set while the mode line specs are processed. */
19771 line_number_displayed
= 0;
19772 w
->column_number_displayed
= Qnil
;
19774 if (WINDOW_WANTS_MODELINE_P (w
))
19776 struct window
*sel_w
= XWINDOW (old_selected_window
);
19778 /* Select mode line face based on the real selected window. */
19779 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
19780 BVAR (current_buffer
, mode_line_format
));
19784 if (WINDOW_WANTS_HEADER_LINE_P (w
))
19786 display_mode_line (w
, HEADER_LINE_FACE_ID
,
19787 BVAR (current_buffer
, header_line_format
));
19791 selected_frame
= old_selected_frame
;
19792 selected_window
= old_selected_window
;
19797 /* Display mode or header line of window W. FACE_ID specifies which
19798 line to display; it is either MODE_LINE_FACE_ID or
19799 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
19800 display. Value is the pixel height of the mode/header line
19804 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
19808 int count
= SPECPDL_INDEX ();
19810 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
19811 /* Don't extend on a previously drawn mode-line.
19812 This may happen if called from pos_visible_p. */
19813 it
.glyph_row
->enabled_p
= 0;
19814 prepare_desired_row (it
.glyph_row
);
19816 it
.glyph_row
->mode_line_p
= 1;
19818 if (! mode_line_inverse_video
)
19819 /* Force the mode-line to be displayed in the default face. */
19820 it
.base_face_id
= it
.face_id
= DEFAULT_FACE_ID
;
19822 /* FIXME: This should be controlled by a user option. But
19823 supporting such an option is not trivial, since the mode line is
19824 made up of many separate strings. */
19825 it
.paragraph_embedding
= L2R
;
19827 record_unwind_protect (unwind_format_mode_line
,
19828 format_mode_line_unwind_data (NULL
, Qnil
, 0));
19830 mode_line_target
= MODE_LINE_DISPLAY
;
19832 /* Temporarily make frame's keyboard the current kboard so that
19833 kboard-local variables in the mode_line_format will get the right
19835 push_kboard (FRAME_KBOARD (it
.f
));
19836 record_unwind_save_match_data ();
19837 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
19840 unbind_to (count
, Qnil
);
19842 /* Fill up with spaces. */
19843 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
19845 compute_line_metrics (&it
);
19846 it
.glyph_row
->full_width_p
= 1;
19847 it
.glyph_row
->continued_p
= 0;
19848 it
.glyph_row
->truncated_on_left_p
= 0;
19849 it
.glyph_row
->truncated_on_right_p
= 0;
19851 /* Make a 3D mode-line have a shadow at its right end. */
19852 face
= FACE_FROM_ID (it
.f
, face_id
);
19853 extend_face_to_end_of_line (&it
);
19854 if (face
->box
!= FACE_NO_BOX
)
19856 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
19857 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
19858 last
->right_box_line_p
= 1;
19861 return it
.glyph_row
->height
;
19864 /* Move element ELT in LIST to the front of LIST.
19865 Return the updated list. */
19868 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
19870 register Lisp_Object tail
, prev
;
19871 register Lisp_Object tem
;
19875 while (CONSP (tail
))
19881 /* Splice out the link TAIL. */
19883 list
= XCDR (tail
);
19885 Fsetcdr (prev
, XCDR (tail
));
19887 /* Now make it the first. */
19888 Fsetcdr (tail
, list
);
19893 tail
= XCDR (tail
);
19897 /* Not found--return unchanged LIST. */
19901 /* Contribute ELT to the mode line for window IT->w. How it
19902 translates into text depends on its data type.
19904 IT describes the display environment in which we display, as usual.
19906 DEPTH is the depth in recursion. It is used to prevent
19907 infinite recursion here.
19909 FIELD_WIDTH is the number of characters the display of ELT should
19910 occupy in the mode line, and PRECISION is the maximum number of
19911 characters to display from ELT's representation. See
19912 display_string for details.
19914 Returns the hpos of the end of the text generated by ELT.
19916 PROPS is a property list to add to any string we encounter.
19918 If RISKY is nonzero, remove (disregard) any properties in any string
19919 we encounter, and ignore :eval and :propertize.
19921 The global variable `mode_line_target' determines whether the
19922 output is passed to `store_mode_line_noprop',
19923 `store_mode_line_string', or `display_string'. */
19926 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
19927 Lisp_Object elt
, Lisp_Object props
, int risky
)
19929 int n
= 0, field
, prec
;
19934 elt
= build_string ("*too-deep*");
19938 switch (SWITCH_ENUM_CAST (XTYPE (elt
)))
19942 /* A string: output it and check for %-constructs within it. */
19944 EMACS_INT offset
= 0;
19946 if (SCHARS (elt
) > 0
19947 && (!NILP (props
) || risky
))
19949 Lisp_Object oprops
, aelt
;
19950 oprops
= Ftext_properties_at (make_number (0), elt
);
19952 /* If the starting string's properties are not what
19953 we want, translate the string. Also, if the string
19954 is risky, do that anyway. */
19956 if (NILP (Fequal (props
, oprops
)) || risky
)
19958 /* If the starting string has properties,
19959 merge the specified ones onto the existing ones. */
19960 if (! NILP (oprops
) && !risky
)
19964 oprops
= Fcopy_sequence (oprops
);
19966 while (CONSP (tem
))
19968 oprops
= Fplist_put (oprops
, XCAR (tem
),
19969 XCAR (XCDR (tem
)));
19970 tem
= XCDR (XCDR (tem
));
19975 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
19976 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
19978 /* AELT is what we want. Move it to the front
19979 without consing. */
19981 mode_line_proptrans_alist
19982 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
19988 /* If AELT has the wrong props, it is useless.
19989 so get rid of it. */
19991 mode_line_proptrans_alist
19992 = Fdelq (aelt
, mode_line_proptrans_alist
);
19994 elt
= Fcopy_sequence (elt
);
19995 Fset_text_properties (make_number (0), Flength (elt
),
19997 /* Add this item to mode_line_proptrans_alist. */
19998 mode_line_proptrans_alist
19999 = Fcons (Fcons (elt
, props
),
20000 mode_line_proptrans_alist
);
20001 /* Truncate mode_line_proptrans_alist
20002 to at most 50 elements. */
20003 tem
= Fnthcdr (make_number (50),
20004 mode_line_proptrans_alist
);
20006 XSETCDR (tem
, Qnil
);
20015 prec
= precision
- n
;
20016 switch (mode_line_target
)
20018 case MODE_LINE_NOPROP
:
20019 case MODE_LINE_TITLE
:
20020 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
20022 case MODE_LINE_STRING
:
20023 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
20025 case MODE_LINE_DISPLAY
:
20026 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
20027 0, prec
, 0, STRING_MULTIBYTE (elt
));
20034 /* Handle the non-literal case. */
20036 while ((precision
<= 0 || n
< precision
)
20037 && SREF (elt
, offset
) != 0
20038 && (mode_line_target
!= MODE_LINE_DISPLAY
20039 || it
->current_x
< it
->last_visible_x
))
20041 EMACS_INT last_offset
= offset
;
20043 /* Advance to end of string or next format specifier. */
20044 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
20047 if (offset
- 1 != last_offset
)
20049 EMACS_INT nchars
, nbytes
;
20051 /* Output to end of string or up to '%'. Field width
20052 is length of string. Don't output more than
20053 PRECISION allows us. */
20056 prec
= c_string_width (SDATA (elt
) + last_offset
,
20057 offset
- last_offset
, precision
- n
,
20060 switch (mode_line_target
)
20062 case MODE_LINE_NOPROP
:
20063 case MODE_LINE_TITLE
:
20064 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
20066 case MODE_LINE_STRING
:
20068 EMACS_INT bytepos
= last_offset
;
20069 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20070 EMACS_INT endpos
= (precision
<= 0
20071 ? string_byte_to_char (elt
, offset
)
20072 : charpos
+ nchars
);
20074 n
+= store_mode_line_string (NULL
,
20075 Fsubstring (elt
, make_number (charpos
),
20076 make_number (endpos
)),
20080 case MODE_LINE_DISPLAY
:
20082 EMACS_INT bytepos
= last_offset
;
20083 EMACS_INT charpos
= string_byte_to_char (elt
, bytepos
);
20085 if (precision
<= 0)
20086 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
20087 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
20089 STRING_MULTIBYTE (elt
));
20094 else /* c == '%' */
20096 EMACS_INT percent_position
= offset
;
20098 /* Get the specified minimum width. Zero means
20101 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
20102 field
= field
* 10 + c
- '0';
20104 /* Don't pad beyond the total padding allowed. */
20105 if (field_width
- n
> 0 && field
> field_width
- n
)
20106 field
= field_width
- n
;
20108 /* Note that either PRECISION <= 0 or N < PRECISION. */
20109 prec
= precision
- n
;
20112 n
+= display_mode_element (it
, depth
, field
, prec
,
20113 Vglobal_mode_string
, props
,
20118 EMACS_INT bytepos
, charpos
;
20120 Lisp_Object string
;
20122 bytepos
= percent_position
;
20123 charpos
= (STRING_MULTIBYTE (elt
)
20124 ? string_byte_to_char (elt
, bytepos
)
20126 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
20127 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
20129 switch (mode_line_target
)
20131 case MODE_LINE_NOPROP
:
20132 case MODE_LINE_TITLE
:
20133 n
+= store_mode_line_noprop (spec
, field
, prec
);
20135 case MODE_LINE_STRING
:
20137 Lisp_Object tem
= build_string (spec
);
20138 props
= Ftext_properties_at (make_number (charpos
), elt
);
20139 /* Should only keep face property in props */
20140 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
20143 case MODE_LINE_DISPLAY
:
20145 int nglyphs_before
, nwritten
;
20147 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
20148 nwritten
= display_string (spec
, string
, elt
,
20153 /* Assign to the glyphs written above the
20154 string where the `%x' came from, position
20158 struct glyph
*glyph
20159 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
20163 for (i
= 0; i
< nwritten
; ++i
)
20165 glyph
[i
].object
= elt
;
20166 glyph
[i
].charpos
= charpos
;
20183 /* A symbol: process the value of the symbol recursively
20184 as if it appeared here directly. Avoid error if symbol void.
20185 Special case: if value of symbol is a string, output the string
20188 register Lisp_Object tem
;
20190 /* If the variable is not marked as risky to set
20191 then its contents are risky to use. */
20192 if (NILP (Fget (elt
, Qrisky_local_variable
)))
20195 tem
= Fboundp (elt
);
20198 tem
= Fsymbol_value (elt
);
20199 /* If value is a string, output that string literally:
20200 don't check for % within it. */
20204 if (!EQ (tem
, elt
))
20206 /* Give up right away for nil or t. */
20216 register Lisp_Object car
, tem
;
20218 /* A cons cell: five distinct cases.
20219 If first element is :eval or :propertize, do something special.
20220 If first element is a string or a cons, process all the elements
20221 and effectively concatenate them.
20222 If first element is a negative number, truncate displaying cdr to
20223 at most that many characters. If positive, pad (with spaces)
20224 to at least that many characters.
20225 If first element is a symbol, process the cadr or caddr recursively
20226 according to whether the symbol's value is non-nil or nil. */
20228 if (EQ (car
, QCeval
))
20230 /* An element of the form (:eval FORM) means evaluate FORM
20231 and use the result as mode line elements. */
20236 if (CONSP (XCDR (elt
)))
20239 spec
= safe_eval (XCAR (XCDR (elt
)));
20240 n
+= display_mode_element (it
, depth
, field_width
- n
,
20241 precision
- n
, spec
, props
,
20245 else if (EQ (car
, QCpropertize
))
20247 /* An element of the form (:propertize ELT PROPS...)
20248 means display ELT but applying properties PROPS. */
20253 if (CONSP (XCDR (elt
)))
20254 n
+= display_mode_element (it
, depth
, field_width
- n
,
20255 precision
- n
, XCAR (XCDR (elt
)),
20256 XCDR (XCDR (elt
)), risky
);
20258 else if (SYMBOLP (car
))
20260 tem
= Fboundp (car
);
20264 /* elt is now the cdr, and we know it is a cons cell.
20265 Use its car if CAR has a non-nil value. */
20268 tem
= Fsymbol_value (car
);
20275 /* Symbol's value is nil (or symbol is unbound)
20276 Get the cddr of the original list
20277 and if possible find the caddr and use that. */
20281 else if (!CONSP (elt
))
20286 else if (INTEGERP (car
))
20288 register int lim
= XINT (car
);
20292 /* Negative int means reduce maximum width. */
20293 if (precision
<= 0)
20296 precision
= min (precision
, -lim
);
20300 /* Padding specified. Don't let it be more than
20301 current maximum. */
20303 lim
= min (precision
, lim
);
20305 /* If that's more padding than already wanted, queue it.
20306 But don't reduce padding already specified even if
20307 that is beyond the current truncation point. */
20308 field_width
= max (lim
, field_width
);
20312 else if (STRINGP (car
) || CONSP (car
))
20314 Lisp_Object halftail
= elt
;
20318 && (precision
<= 0 || n
< precision
))
20320 n
+= display_mode_element (it
, depth
,
20321 /* Do padding only after the last
20322 element in the list. */
20323 (! CONSP (XCDR (elt
))
20326 precision
- n
, XCAR (elt
),
20330 if ((len
& 1) == 0)
20331 halftail
= XCDR (halftail
);
20332 /* Check for cycle. */
20333 if (EQ (halftail
, elt
))
20342 elt
= build_string ("*invalid*");
20346 /* Pad to FIELD_WIDTH. */
20347 if (field_width
> 0 && n
< field_width
)
20349 switch (mode_line_target
)
20351 case MODE_LINE_NOPROP
:
20352 case MODE_LINE_TITLE
:
20353 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
20355 case MODE_LINE_STRING
:
20356 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
20358 case MODE_LINE_DISPLAY
:
20359 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
20368 /* Store a mode-line string element in mode_line_string_list.
20370 If STRING is non-null, display that C string. Otherwise, the Lisp
20371 string LISP_STRING is displayed.
20373 FIELD_WIDTH is the minimum number of output glyphs to produce.
20374 If STRING has fewer characters than FIELD_WIDTH, pad to the right
20375 with spaces. FIELD_WIDTH <= 0 means don't pad.
20377 PRECISION is the maximum number of characters to output from
20378 STRING. PRECISION <= 0 means don't truncate the string.
20380 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
20381 properties to the string.
20383 PROPS are the properties to add to the string.
20384 The mode_line_string_face face property is always added to the string.
20388 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
20389 int field_width
, int precision
, Lisp_Object props
)
20394 if (string
!= NULL
)
20396 len
= strlen (string
);
20397 if (precision
> 0 && len
> precision
)
20399 lisp_string
= make_string (string
, len
);
20401 props
= mode_line_string_face_prop
;
20402 else if (!NILP (mode_line_string_face
))
20404 Lisp_Object face
= Fplist_get (props
, Qface
);
20405 props
= Fcopy_sequence (props
);
20407 face
= mode_line_string_face
;
20409 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20410 props
= Fplist_put (props
, Qface
, face
);
20412 Fadd_text_properties (make_number (0), make_number (len
),
20413 props
, lisp_string
);
20417 len
= XFASTINT (Flength (lisp_string
));
20418 if (precision
> 0 && len
> precision
)
20421 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
20424 if (!NILP (mode_line_string_face
))
20428 props
= Ftext_properties_at (make_number (0), lisp_string
);
20429 face
= Fplist_get (props
, Qface
);
20431 face
= mode_line_string_face
;
20433 face
= Fcons (face
, Fcons (mode_line_string_face
, Qnil
));
20434 props
= Fcons (Qface
, Fcons (face
, Qnil
));
20436 lisp_string
= Fcopy_sequence (lisp_string
);
20439 Fadd_text_properties (make_number (0), make_number (len
),
20440 props
, lisp_string
);
20445 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20449 if (field_width
> len
)
20451 field_width
-= len
;
20452 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
20454 Fadd_text_properties (make_number (0), make_number (field_width
),
20455 props
, lisp_string
);
20456 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
20464 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
20466 doc
: /* Format a string out of a mode line format specification.
20467 First arg FORMAT specifies the mode line format (see `mode-line-format'
20468 for details) to use.
20470 By default, the format is evaluated for the currently selected window.
20472 Optional second arg FACE specifies the face property to put on all
20473 characters for which no face is specified. The value nil means the
20474 default face. The value t means whatever face the window's mode line
20475 currently uses (either `mode-line' or `mode-line-inactive',
20476 depending on whether the window is the selected window or not).
20477 An integer value means the value string has no text
20480 Optional third and fourth args WINDOW and BUFFER specify the window
20481 and buffer to use as the context for the formatting (defaults
20482 are the selected window and the WINDOW's buffer). */)
20483 (Lisp_Object format
, Lisp_Object face
,
20484 Lisp_Object window
, Lisp_Object buffer
)
20489 struct buffer
*old_buffer
= NULL
;
20491 int no_props
= INTEGERP (face
);
20492 int count
= SPECPDL_INDEX ();
20494 int string_start
= 0;
20497 window
= selected_window
;
20498 CHECK_WINDOW (window
);
20499 w
= XWINDOW (window
);
20502 buffer
= w
->buffer
;
20503 CHECK_BUFFER (buffer
);
20505 /* Make formatting the modeline a non-op when noninteractive, otherwise
20506 there will be problems later caused by a partially initialized frame. */
20507 if (NILP (format
) || noninteractive
)
20508 return empty_unibyte_string
;
20513 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
20514 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
20515 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
20516 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
20517 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
20518 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
20519 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
20522 if (XBUFFER (buffer
) != current_buffer
)
20523 old_buffer
= current_buffer
;
20525 /* Save things including mode_line_proptrans_alist,
20526 and set that to nil so that we don't alter the outer value. */
20527 record_unwind_protect (unwind_format_mode_line
,
20528 format_mode_line_unwind_data
20529 (old_buffer
, selected_window
, 1));
20530 mode_line_proptrans_alist
= Qnil
;
20532 Fselect_window (window
, Qt
);
20534 set_buffer_internal_1 (XBUFFER (buffer
));
20536 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
20540 mode_line_target
= MODE_LINE_NOPROP
;
20541 mode_line_string_face_prop
= Qnil
;
20542 mode_line_string_list
= Qnil
;
20543 string_start
= MODE_LINE_NOPROP_LEN (0);
20547 mode_line_target
= MODE_LINE_STRING
;
20548 mode_line_string_list
= Qnil
;
20549 mode_line_string_face
= face
;
20550 mode_line_string_face_prop
20551 = (NILP (face
) ? Qnil
: Fcons (Qface
, Fcons (face
, Qnil
)));
20554 push_kboard (FRAME_KBOARD (it
.f
));
20555 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
20560 len
= MODE_LINE_NOPROP_LEN (string_start
);
20561 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
20565 mode_line_string_list
= Fnreverse (mode_line_string_list
);
20566 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
20567 empty_unibyte_string
);
20570 unbind_to (count
, Qnil
);
20574 /* Write a null-terminated, right justified decimal representation of
20575 the positive integer D to BUF using a minimal field width WIDTH. */
20578 pint2str (register char *buf
, register int width
, register EMACS_INT d
)
20580 register char *p
= buf
;
20588 *p
++ = d
% 10 + '0';
20593 for (width
-= (int) (p
- buf
); width
> 0; --width
)
20604 /* Write a null-terminated, right justified decimal and "human
20605 readable" representation of the nonnegative integer D to BUF using
20606 a minimal field width WIDTH. D should be smaller than 999.5e24. */
20608 static const char power_letter
[] =
20622 pint2hrstr (char *buf
, int width
, EMACS_INT d
)
20624 /* We aim to represent the nonnegative integer D as
20625 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
20626 EMACS_INT quotient
= d
;
20628 /* -1 means: do not use TENTHS. */
20632 /* Length of QUOTIENT.TENTHS as a string. */
20638 if (1000 <= quotient
)
20640 /* Scale to the appropriate EXPONENT. */
20643 remainder
= quotient
% 1000;
20647 while (1000 <= quotient
);
20649 /* Round to nearest and decide whether to use TENTHS or not. */
20652 tenths
= remainder
/ 100;
20653 if (50 <= remainder
% 100)
20660 if (quotient
== 10)
20668 if (500 <= remainder
)
20670 if (quotient
< 999)
20681 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
20682 if (tenths
== -1 && quotient
<= 99)
20689 p
= psuffix
= buf
+ max (width
, length
);
20691 /* Print EXPONENT. */
20692 *psuffix
++ = power_letter
[exponent
];
20695 /* Print TENTHS. */
20698 *--p
= '0' + tenths
;
20702 /* Print QUOTIENT. */
20705 int digit
= quotient
% 10;
20706 *--p
= '0' + digit
;
20708 while ((quotient
/= 10) != 0);
20710 /* Print leading spaces. */
20715 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
20716 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
20717 type of CODING_SYSTEM. Return updated pointer into BUF. */
20719 static unsigned char invalid_eol_type
[] = "(*invalid*)";
20722 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
20725 int multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
20726 const unsigned char *eol_str
;
20728 /* The EOL conversion we are using. */
20729 Lisp_Object eoltype
;
20731 val
= CODING_SYSTEM_SPEC (coding_system
);
20734 if (!VECTORP (val
)) /* Not yet decided. */
20739 eoltype
= eol_mnemonic_undecided
;
20740 /* Don't mention EOL conversion if it isn't decided. */
20745 Lisp_Object eolvalue
;
20747 attrs
= AREF (val
, 0);
20748 eolvalue
= AREF (val
, 2);
20751 *buf
++ = XFASTINT (CODING_ATTR_MNEMONIC (attrs
));
20755 /* The EOL conversion that is normal on this system. */
20757 if (NILP (eolvalue
)) /* Not yet decided. */
20758 eoltype
= eol_mnemonic_undecided
;
20759 else if (VECTORP (eolvalue
)) /* Not yet decided. */
20760 eoltype
= eol_mnemonic_undecided
;
20761 else /* eolvalue is Qunix, Qdos, or Qmac. */
20762 eoltype
= (EQ (eolvalue
, Qunix
)
20763 ? eol_mnemonic_unix
20764 : (EQ (eolvalue
, Qdos
) == 1
20765 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
20771 /* Mention the EOL conversion if it is not the usual one. */
20772 if (STRINGP (eoltype
))
20774 eol_str
= SDATA (eoltype
);
20775 eol_str_len
= SBYTES (eoltype
);
20777 else if (CHARACTERP (eoltype
))
20779 unsigned char *tmp
= (unsigned char *) alloca (MAX_MULTIBYTE_LENGTH
);
20780 int c
= XFASTINT (eoltype
);
20781 eol_str_len
= CHAR_STRING (c
, tmp
);
20786 eol_str
= invalid_eol_type
;
20787 eol_str_len
= sizeof (invalid_eol_type
) - 1;
20789 memcpy (buf
, eol_str
, eol_str_len
);
20790 buf
+= eol_str_len
;
20796 /* Return a string for the output of a mode line %-spec for window W,
20797 generated by character C. FIELD_WIDTH > 0 means pad the string
20798 returned with spaces to that value. Return a Lisp string in
20799 *STRING if the resulting string is taken from that Lisp string.
20801 Note we operate on the current buffer for most purposes,
20802 the exception being w->base_line_pos. */
20804 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
20806 static const char *
20807 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
20808 Lisp_Object
*string
)
20811 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
20812 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
20813 struct buffer
*b
= current_buffer
;
20821 if (!NILP (BVAR (b
, read_only
)))
20823 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20828 /* This differs from %* only for a modified read-only buffer. */
20829 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20831 if (!NILP (BVAR (b
, read_only
)))
20836 /* This differs from %* in ignoring read-only-ness. */
20837 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
20849 if (command_loop_level
> 5)
20851 p
= decode_mode_spec_buf
;
20852 for (i
= 0; i
< command_loop_level
; i
++)
20855 return decode_mode_spec_buf
;
20863 if (command_loop_level
> 5)
20865 p
= decode_mode_spec_buf
;
20866 for (i
= 0; i
< command_loop_level
; i
++)
20869 return decode_mode_spec_buf
;
20876 /* Let lots_of_dashes be a string of infinite length. */
20877 if (mode_line_target
== MODE_LINE_NOPROP
||
20878 mode_line_target
== MODE_LINE_STRING
)
20880 if (field_width
<= 0
20881 || field_width
> sizeof (lots_of_dashes
))
20883 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
20884 decode_mode_spec_buf
[i
] = '-';
20885 decode_mode_spec_buf
[i
] = '\0';
20886 return decode_mode_spec_buf
;
20889 return lots_of_dashes
;
20893 obj
= BVAR (b
, name
);
20897 /* %c and %l are ignored in `frame-title-format'.
20898 (In redisplay_internal, the frame title is drawn _before_ the
20899 windows are updated, so the stuff which depends on actual
20900 window contents (such as %l) may fail to render properly, or
20901 even crash emacs.) */
20902 if (mode_line_target
== MODE_LINE_TITLE
)
20906 EMACS_INT col
= current_column ();
20907 w
->column_number_displayed
= make_number (col
);
20908 pint2str (decode_mode_spec_buf
, field_width
, col
);
20909 return decode_mode_spec_buf
;
20913 #ifndef SYSTEM_MALLOC
20915 if (NILP (Vmemory_full
))
20918 return "!MEM FULL! ";
20925 /* %F displays the frame name. */
20926 if (!NILP (f
->title
))
20927 return SSDATA (f
->title
);
20928 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
20929 return SSDATA (f
->name
);
20933 obj
= BVAR (b
, filename
);
20938 EMACS_INT size
= ZV
- BEGV
;
20939 pint2str (decode_mode_spec_buf
, field_width
, size
);
20940 return decode_mode_spec_buf
;
20945 EMACS_INT size
= ZV
- BEGV
;
20946 pint2hrstr (decode_mode_spec_buf
, field_width
, size
);
20947 return decode_mode_spec_buf
;
20952 EMACS_INT startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
20953 EMACS_INT topline
, nlines
, height
;
20956 /* %c and %l are ignored in `frame-title-format'. */
20957 if (mode_line_target
== MODE_LINE_TITLE
)
20960 startpos
= XMARKER (w
->start
)->charpos
;
20961 startpos_byte
= marker_byte_position (w
->start
);
20962 height
= WINDOW_TOTAL_LINES (w
);
20964 /* If we decided that this buffer isn't suitable for line numbers,
20965 don't forget that too fast. */
20966 if (EQ (w
->base_line_pos
, w
->buffer
))
20968 /* But do forget it, if the window shows a different buffer now. */
20969 else if (BUFFERP (w
->base_line_pos
))
20970 w
->base_line_pos
= Qnil
;
20972 /* If the buffer is very big, don't waste time. */
20973 if (INTEGERP (Vline_number_display_limit
)
20974 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
20976 w
->base_line_pos
= Qnil
;
20977 w
->base_line_number
= Qnil
;
20981 if (INTEGERP (w
->base_line_number
)
20982 && INTEGERP (w
->base_line_pos
)
20983 && XFASTINT (w
->base_line_pos
) <= startpos
)
20985 line
= XFASTINT (w
->base_line_number
);
20986 linepos
= XFASTINT (w
->base_line_pos
);
20987 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
20992 linepos
= BUF_BEGV (b
);
20993 linepos_byte
= BUF_BEGV_BYTE (b
);
20996 /* Count lines from base line to window start position. */
20997 nlines
= display_count_lines (linepos_byte
,
21001 topline
= nlines
+ line
;
21003 /* Determine a new base line, if the old one is too close
21004 or too far away, or if we did not have one.
21005 "Too close" means it's plausible a scroll-down would
21006 go back past it. */
21007 if (startpos
== BUF_BEGV (b
))
21009 w
->base_line_number
= make_number (topline
);
21010 w
->base_line_pos
= make_number (BUF_BEGV (b
));
21012 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
21013 || linepos
== BUF_BEGV (b
))
21015 EMACS_INT limit
= BUF_BEGV (b
);
21016 EMACS_INT limit_byte
= BUF_BEGV_BYTE (b
);
21017 EMACS_INT position
;
21018 EMACS_INT distance
=
21019 (height
* 2 + 30) * line_number_display_limit_width
;
21021 if (startpos
- distance
> limit
)
21023 limit
= startpos
- distance
;
21024 limit_byte
= CHAR_TO_BYTE (limit
);
21027 nlines
= display_count_lines (startpos_byte
,
21029 - (height
* 2 + 30),
21031 /* If we couldn't find the lines we wanted within
21032 line_number_display_limit_width chars per line,
21033 give up on line numbers for this window. */
21034 if (position
== limit_byte
&& limit
== startpos
- distance
)
21036 w
->base_line_pos
= w
->buffer
;
21037 w
->base_line_number
= Qnil
;
21041 w
->base_line_number
= make_number (topline
- nlines
);
21042 w
->base_line_pos
= make_number (BYTE_TO_CHAR (position
));
21045 /* Now count lines from the start pos to point. */
21046 nlines
= display_count_lines (startpos_byte
,
21047 PT_BYTE
, PT
, &junk
);
21049 /* Record that we did display the line number. */
21050 line_number_displayed
= 1;
21052 /* Make the string to show. */
21053 pint2str (decode_mode_spec_buf
, field_width
, topline
+ nlines
);
21054 return decode_mode_spec_buf
;
21057 char* p
= decode_mode_spec_buf
;
21058 int pad
= field_width
- 2;
21064 return decode_mode_spec_buf
;
21070 obj
= BVAR (b
, mode_name
);
21074 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
21080 EMACS_INT pos
= marker_position (w
->start
);
21081 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21083 if (XFASTINT (w
->window_end_pos
) <= BUF_Z (b
) - BUF_ZV (b
))
21085 if (pos
<= BUF_BEGV (b
))
21090 else if (pos
<= BUF_BEGV (b
))
21094 if (total
> 1000000)
21095 /* Do it differently for a large value, to avoid overflow. */
21096 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21098 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21099 /* We can't normally display a 3-digit number,
21100 so get us a 2-digit number that is close. */
21103 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21104 return decode_mode_spec_buf
;
21108 /* Display percentage of size above the bottom of the screen. */
21111 EMACS_INT toppos
= marker_position (w
->start
);
21112 EMACS_INT botpos
= BUF_Z (b
) - XFASTINT (w
->window_end_pos
);
21113 EMACS_INT total
= BUF_ZV (b
) - BUF_BEGV (b
);
21115 if (botpos
>= BUF_ZV (b
))
21117 if (toppos
<= BUF_BEGV (b
))
21124 if (total
> 1000000)
21125 /* Do it differently for a large value, to avoid overflow. */
21126 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
21128 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
21129 /* We can't normally display a 3-digit number,
21130 so get us a 2-digit number that is close. */
21133 if (toppos
<= BUF_BEGV (b
))
21134 sprintf (decode_mode_spec_buf
, "Top%2"pI
"d%%", total
);
21136 sprintf (decode_mode_spec_buf
, "%2"pI
"d%%", total
);
21137 return decode_mode_spec_buf
;
21142 /* status of process */
21143 obj
= Fget_buffer_process (Fcurrent_buffer ());
21145 return "no process";
21147 obj
= Fsymbol_name (Fprocess_status (obj
));
21153 int count
= inhibit_garbage_collection ();
21154 Lisp_Object val
= call1 (intern ("file-remote-p"),
21155 BVAR (current_buffer
, directory
));
21156 unbind_to (count
, Qnil
);
21164 case 't': /* indicate TEXT or BINARY */
21168 /* coding-system (not including end-of-line format) */
21170 /* coding-system (including end-of-line type) */
21172 int eol_flag
= (c
== 'Z');
21173 char *p
= decode_mode_spec_buf
;
21175 if (! FRAME_WINDOW_P (f
))
21177 /* No need to mention EOL here--the terminal never needs
21178 to do EOL conversion. */
21179 p
= decode_mode_spec_coding (CODING_ID_NAME
21180 (FRAME_KEYBOARD_CODING (f
)->id
),
21182 p
= decode_mode_spec_coding (CODING_ID_NAME
21183 (FRAME_TERMINAL_CODING (f
)->id
),
21186 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
21189 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
21190 #ifdef subprocesses
21191 obj
= Fget_buffer_process (Fcurrent_buffer ());
21192 if (PROCESSP (obj
))
21194 p
= decode_mode_spec_coding (XPROCESS (obj
)->decode_coding_system
,
21196 p
= decode_mode_spec_coding (XPROCESS (obj
)->encode_coding_system
,
21199 #endif /* subprocesses */
21202 return decode_mode_spec_buf
;
21209 return SSDATA (obj
);
21216 /* Count up to COUNT lines starting from START_BYTE.
21217 But don't go beyond LIMIT_BYTE.
21218 Return the number of lines thus found (always nonnegative).
21220 Set *BYTE_POS_PTR to 1 if we found COUNT lines, 0 if we hit LIMIT. */
21223 display_count_lines (EMACS_INT start_byte
,
21224 EMACS_INT limit_byte
, EMACS_INT count
,
21225 EMACS_INT
*byte_pos_ptr
)
21227 register unsigned char *cursor
;
21228 unsigned char *base
;
21230 register EMACS_INT ceiling
;
21231 register unsigned char *ceiling_addr
;
21232 EMACS_INT orig_count
= count
;
21234 /* If we are not in selective display mode,
21235 check only for newlines. */
21236 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
21237 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
21241 while (start_byte
< limit_byte
)
21243 ceiling
= BUFFER_CEILING_OF (start_byte
);
21244 ceiling
= min (limit_byte
- 1, ceiling
);
21245 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
21246 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
21249 if (selective_display
)
21250 while (*cursor
!= '\n' && *cursor
!= 015 && ++cursor
!= ceiling_addr
)
21253 while (*cursor
!= '\n' && ++cursor
!= ceiling_addr
)
21256 if (cursor
!= ceiling_addr
)
21260 start_byte
+= cursor
- base
+ 1;
21261 *byte_pos_ptr
= start_byte
;
21265 if (++cursor
== ceiling_addr
)
21271 start_byte
+= cursor
- base
;
21276 while (start_byte
> limit_byte
)
21278 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
21279 ceiling
= max (limit_byte
, ceiling
);
21280 ceiling_addr
= BYTE_POS_ADDR (ceiling
) - 1;
21281 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
21284 if (selective_display
)
21285 while (--cursor
!= ceiling_addr
21286 && *cursor
!= '\n' && *cursor
!= 015)
21289 while (--cursor
!= ceiling_addr
&& *cursor
!= '\n')
21292 if (cursor
!= ceiling_addr
)
21296 start_byte
+= cursor
- base
+ 1;
21297 *byte_pos_ptr
= start_byte
;
21298 /* When scanning backwards, we should
21299 not count the newline posterior to which we stop. */
21300 return - orig_count
- 1;
21306 /* Here we add 1 to compensate for the last decrement
21307 of CURSOR, which took it past the valid range. */
21308 start_byte
+= cursor
- base
+ 1;
21312 *byte_pos_ptr
= limit_byte
;
21315 return - orig_count
+ count
;
21316 return orig_count
- count
;
21322 /***********************************************************************
21324 ***********************************************************************/
21326 /* Display a NUL-terminated string, starting with index START.
21328 If STRING is non-null, display that C string. Otherwise, the Lisp
21329 string LISP_STRING is displayed. There's a case that STRING is
21330 non-null and LISP_STRING is not nil. It means STRING is a string
21331 data of LISP_STRING. In that case, we display LISP_STRING while
21332 ignoring its text properties.
21334 If FACE_STRING is not nil, FACE_STRING_POS is a position in
21335 FACE_STRING. Display STRING or LISP_STRING with the face at
21336 FACE_STRING_POS in FACE_STRING:
21338 Display the string in the environment given by IT, but use the
21339 standard display table, temporarily.
21341 FIELD_WIDTH is the minimum number of output glyphs to produce.
21342 If STRING has fewer characters than FIELD_WIDTH, pad to the right
21343 with spaces. If STRING has more characters, more than FIELD_WIDTH
21344 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
21346 PRECISION is the maximum number of characters to output from
21347 STRING. PRECISION < 0 means don't truncate the string.
21349 This is roughly equivalent to printf format specifiers:
21351 FIELD_WIDTH PRECISION PRINTF
21352 ----------------------------------------
21358 MULTIBYTE zero means do not display multibyte chars, > 0 means do
21359 display them, and < 0 means obey the current buffer's value of
21360 enable_multibyte_characters.
21362 Value is the number of columns displayed. */
21365 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
21366 EMACS_INT face_string_pos
, EMACS_INT start
, struct it
*it
,
21367 int field_width
, int precision
, int max_x
, int multibyte
)
21369 int hpos_at_start
= it
->hpos
;
21370 int saved_face_id
= it
->face_id
;
21371 struct glyph_row
*row
= it
->glyph_row
;
21372 EMACS_INT it_charpos
;
21374 /* Initialize the iterator IT for iteration over STRING beginning
21375 with index START. */
21376 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
21377 precision
, field_width
, multibyte
);
21378 if (string
&& STRINGP (lisp_string
))
21379 /* LISP_STRING is the one returned by decode_mode_spec. We should
21380 ignore its text properties. */
21381 it
->stop_charpos
= it
->end_charpos
;
21383 /* If displaying STRING, set up the face of the iterator from
21384 FACE_STRING, if that's given. */
21385 if (STRINGP (face_string
))
21391 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
21392 0, it
->region_beg_charpos
,
21393 it
->region_end_charpos
,
21394 &endptr
, it
->base_face_id
, 0);
21395 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
21396 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
21399 /* Set max_x to the maximum allowed X position. Don't let it go
21400 beyond the right edge of the window. */
21402 max_x
= it
->last_visible_x
;
21404 max_x
= min (max_x
, it
->last_visible_x
);
21406 /* Skip over display elements that are not visible. because IT->w is
21408 if (it
->current_x
< it
->first_visible_x
)
21409 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
21410 MOVE_TO_POS
| MOVE_TO_X
);
21412 row
->ascent
= it
->max_ascent
;
21413 row
->height
= it
->max_ascent
+ it
->max_descent
;
21414 row
->phys_ascent
= it
->max_phys_ascent
;
21415 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
21416 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
21418 if (STRINGP (it
->string
))
21419 it_charpos
= IT_STRING_CHARPOS (*it
);
21421 it_charpos
= IT_CHARPOS (*it
);
21423 /* This condition is for the case that we are called with current_x
21424 past last_visible_x. */
21425 while (it
->current_x
< max_x
)
21427 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
21429 /* Get the next display element. */
21430 if (!get_next_display_element (it
))
21433 /* Produce glyphs. */
21434 x_before
= it
->current_x
;
21435 n_glyphs_before
= row
->used
[TEXT_AREA
];
21436 PRODUCE_GLYPHS (it
);
21438 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
21441 while (i
< nglyphs
)
21443 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
21445 if (it
->line_wrap
!= TRUNCATE
21446 && x
+ glyph
->pixel_width
> max_x
)
21448 /* End of continued line or max_x reached. */
21449 if (CHAR_GLYPH_PADDING_P (*glyph
))
21451 /* A wide character is unbreakable. */
21452 if (row
->reversed_p
)
21453 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21454 - n_glyphs_before
);
21455 row
->used
[TEXT_AREA
] = n_glyphs_before
;
21456 it
->current_x
= x_before
;
21460 if (row
->reversed_p
)
21461 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
21462 - (n_glyphs_before
+ i
));
21463 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
21468 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
21470 /* Glyph is at least partially visible. */
21472 if (x
< it
->first_visible_x
)
21473 row
->x
= x
- it
->first_visible_x
;
21477 /* Glyph is off the left margin of the display area.
21478 Should not happen. */
21482 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
21483 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
21484 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
21485 row
->phys_height
= max (row
->phys_height
,
21486 it
->max_phys_ascent
+ it
->max_phys_descent
);
21487 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
21488 it
->max_extra_line_spacing
);
21489 x
+= glyph
->pixel_width
;
21493 /* Stop if max_x reached. */
21497 /* Stop at line ends. */
21498 if (ITERATOR_AT_END_OF_LINE_P (it
))
21500 it
->continuation_lines_width
= 0;
21504 set_iterator_to_next (it
, 1);
21505 if (STRINGP (it
->string
))
21506 it_charpos
= IT_STRING_CHARPOS (*it
);
21508 it_charpos
= IT_CHARPOS (*it
);
21510 /* Stop if truncating at the right edge. */
21511 if (it
->line_wrap
== TRUNCATE
21512 && it
->current_x
>= it
->last_visible_x
)
21514 /* Add truncation mark, but don't do it if the line is
21515 truncated at a padding space. */
21516 if (it_charpos
< it
->string_nchars
)
21518 if (!FRAME_WINDOW_P (it
->f
))
21522 if (it
->current_x
> it
->last_visible_x
)
21524 if (!row
->reversed_p
)
21526 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
21527 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21532 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
21533 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
21535 unproduce_glyphs (it
, ii
+ 1);
21536 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
21538 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
21540 row
->used
[TEXT_AREA
] = ii
;
21541 produce_special_glyphs (it
, IT_TRUNCATION
);
21544 produce_special_glyphs (it
, IT_TRUNCATION
);
21546 row
->truncated_on_right_p
= 1;
21552 /* Maybe insert a truncation at the left. */
21553 if (it
->first_visible_x
21556 if (!FRAME_WINDOW_P (it
->f
))
21557 insert_left_trunc_glyphs (it
);
21558 row
->truncated_on_left_p
= 1;
21561 it
->face_id
= saved_face_id
;
21563 /* Value is number of columns displayed. */
21564 return it
->hpos
- hpos_at_start
;
21569 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
21570 appears as an element of LIST or as the car of an element of LIST.
21571 If PROPVAL is a list, compare each element against LIST in that
21572 way, and return 1/2 if any element of PROPVAL is found in LIST.
21573 Otherwise return 0. This function cannot quit.
21574 The return value is 2 if the text is invisible but with an ellipsis
21575 and 1 if it's invisible and without an ellipsis. */
21578 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
21580 register Lisp_Object tail
, proptail
;
21582 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21584 register Lisp_Object tem
;
21586 if (EQ (propval
, tem
))
21588 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
21589 return NILP (XCDR (tem
)) ? 1 : 2;
21592 if (CONSP (propval
))
21594 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
21596 Lisp_Object propelt
;
21597 propelt
= XCAR (proptail
);
21598 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
21600 register Lisp_Object tem
;
21602 if (EQ (propelt
, tem
))
21604 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
21605 return NILP (XCDR (tem
)) ? 1 : 2;
21613 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
21614 doc
: /* Non-nil if the property makes the text invisible.
21615 POS-OR-PROP can be a marker or number, in which case it is taken to be
21616 a position in the current buffer and the value of the `invisible' property
21617 is checked; or it can be some other value, which is then presumed to be the
21618 value of the `invisible' property of the text of interest.
21619 The non-nil value returned can be t for truly invisible text or something
21620 else if the text is replaced by an ellipsis. */)
21621 (Lisp_Object pos_or_prop
)
21624 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
21625 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
21627 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
21628 return (invis
== 0 ? Qnil
21630 : make_number (invis
));
21633 /* Calculate a width or height in pixels from a specification using
21634 the following elements:
21637 NUM - a (fractional) multiple of the default font width/height
21638 (NUM) - specifies exactly NUM pixels
21639 UNIT - a fixed number of pixels, see below.
21640 ELEMENT - size of a display element in pixels, see below.
21641 (NUM . SPEC) - equals NUM * SPEC
21642 (+ SPEC SPEC ...) - add pixel values
21643 (- SPEC SPEC ...) - subtract pixel values
21644 (- SPEC) - negate pixel value
21647 INT or FLOAT - a number constant
21648 SYMBOL - use symbol's (buffer local) variable binding.
21651 in - pixels per inch *)
21652 mm - pixels per 1/1000 meter *)
21653 cm - pixels per 1/100 meter *)
21654 width - width of current font in pixels.
21655 height - height of current font in pixels.
21657 *) using the ratio(s) defined in display-pixels-per-inch.
21661 left-fringe - left fringe width in pixels
21662 right-fringe - right fringe width in pixels
21664 left-margin - left margin width in pixels
21665 right-margin - right margin width in pixels
21667 scroll-bar - scroll-bar area width in pixels
21671 Pixels corresponding to 5 inches:
21674 Total width of non-text areas on left side of window (if scroll-bar is on left):
21675 '(space :width (+ left-fringe left-margin scroll-bar))
21677 Align to first text column (in header line):
21678 '(space :align-to 0)
21680 Align to middle of text area minus half the width of variable `my-image'
21681 containing a loaded image:
21682 '(space :align-to (0.5 . (- text my-image)))
21684 Width of left margin minus width of 1 character in the default font:
21685 '(space :width (- left-margin 1))
21687 Width of left margin minus width of 2 characters in the current font:
21688 '(space :width (- left-margin (2 . width)))
21690 Center 1 character over left-margin (in header line):
21691 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
21693 Different ways to express width of left fringe plus left margin minus one pixel:
21694 '(space :width (- (+ left-fringe left-margin) (1)))
21695 '(space :width (+ left-fringe left-margin (- (1))))
21696 '(space :width (+ left-fringe left-margin (-1)))
21700 #define NUMVAL(X) \
21701 ((INTEGERP (X) || FLOATP (X)) \
21706 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
21707 struct font
*font
, int width_p
, int *align_to
)
21711 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
21712 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
21715 return OK_PIXELS (0);
21717 xassert (FRAME_LIVE_P (it
->f
));
21719 if (SYMBOLP (prop
))
21721 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
21723 char *unit
= SSDATA (SYMBOL_NAME (prop
));
21725 if (unit
[0] == 'i' && unit
[1] == 'n')
21727 else if (unit
[0] == 'm' && unit
[1] == 'm')
21729 else if (unit
[0] == 'c' && unit
[1] == 'm')
21736 #ifdef HAVE_WINDOW_SYSTEM
21737 if (FRAME_WINDOW_P (it
->f
)
21739 ? FRAME_X_DISPLAY_INFO (it
->f
)->resx
21740 : FRAME_X_DISPLAY_INFO (it
->f
)->resy
),
21742 return OK_PIXELS (ppi
/ pixels
);
21745 if ((ppi
= NUMVAL (Vdisplay_pixels_per_inch
), ppi
> 0)
21746 || (CONSP (Vdisplay_pixels_per_inch
)
21748 ? NUMVAL (XCAR (Vdisplay_pixels_per_inch
))
21749 : NUMVAL (XCDR (Vdisplay_pixels_per_inch
))),
21751 return OK_PIXELS (ppi
/ pixels
);
21757 #ifdef HAVE_WINDOW_SYSTEM
21758 if (EQ (prop
, Qheight
))
21759 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
21760 if (EQ (prop
, Qwidth
))
21761 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
21763 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
21764 return OK_PIXELS (1);
21767 if (EQ (prop
, Qtext
))
21768 return OK_PIXELS (width_p
21769 ? window_box_width (it
->w
, TEXT_AREA
)
21770 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
21772 if (align_to
&& *align_to
< 0)
21775 if (EQ (prop
, Qleft
))
21776 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
21777 if (EQ (prop
, Qright
))
21778 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
21779 if (EQ (prop
, Qcenter
))
21780 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
21781 + window_box_width (it
->w
, TEXT_AREA
) / 2);
21782 if (EQ (prop
, Qleft_fringe
))
21783 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21784 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
21785 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
21786 if (EQ (prop
, Qright_fringe
))
21787 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21788 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21789 : window_box_right_offset (it
->w
, TEXT_AREA
));
21790 if (EQ (prop
, Qleft_margin
))
21791 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
21792 if (EQ (prop
, Qright_margin
))
21793 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
21794 if (EQ (prop
, Qscroll_bar
))
21795 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
21797 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
21798 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
21799 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
21804 if (EQ (prop
, Qleft_fringe
))
21805 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
21806 if (EQ (prop
, Qright_fringe
))
21807 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
21808 if (EQ (prop
, Qleft_margin
))
21809 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
21810 if (EQ (prop
, Qright_margin
))
21811 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
21812 if (EQ (prop
, Qscroll_bar
))
21813 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
21816 prop
= Fbuffer_local_value (prop
, it
->w
->buffer
);
21819 if (INTEGERP (prop
) || FLOATP (prop
))
21821 int base_unit
= (width_p
21822 ? FRAME_COLUMN_WIDTH (it
->f
)
21823 : FRAME_LINE_HEIGHT (it
->f
));
21824 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
21829 Lisp_Object car
= XCAR (prop
);
21830 Lisp_Object cdr
= XCDR (prop
);
21834 #ifdef HAVE_WINDOW_SYSTEM
21835 if (FRAME_WINDOW_P (it
->f
)
21836 && valid_image_p (prop
))
21838 ptrdiff_t id
= lookup_image (it
->f
, prop
);
21839 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
21841 return OK_PIXELS (width_p
? img
->width
: img
->height
);
21844 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
21850 while (CONSP (cdr
))
21852 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
21853 font
, width_p
, align_to
))
21856 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
21861 if (EQ (car
, Qminus
))
21863 return OK_PIXELS (pixels
);
21866 car
= Fbuffer_local_value (car
, it
->w
->buffer
);
21869 if (INTEGERP (car
) || FLOATP (car
))
21872 pixels
= XFLOATINT (car
);
21874 return OK_PIXELS (pixels
);
21875 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
21876 font
, width_p
, align_to
))
21877 return OK_PIXELS (pixels
* fact
);
21888 /***********************************************************************
21890 ***********************************************************************/
21892 #ifdef HAVE_WINDOW_SYSTEM
21897 dump_glyph_string (struct glyph_string
*s
)
21899 fprintf (stderr
, "glyph string\n");
21900 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
21901 s
->x
, s
->y
, s
->width
, s
->height
);
21902 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
21903 fprintf (stderr
, " hl = %d\n", s
->hl
);
21904 fprintf (stderr
, " left overhang = %d, right = %d\n",
21905 s
->left_overhang
, s
->right_overhang
);
21906 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
21907 fprintf (stderr
, " extends to end of line = %d\n",
21908 s
->extends_to_end_of_line_p
);
21909 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
21910 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
21913 #endif /* GLYPH_DEBUG */
21915 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
21916 of XChar2b structures for S; it can't be allocated in
21917 init_glyph_string because it must be allocated via `alloca'. W
21918 is the window on which S is drawn. ROW and AREA are the glyph row
21919 and area within the row from which S is constructed. START is the
21920 index of the first glyph structure covered by S. HL is a
21921 face-override for drawing S. */
21924 #define OPTIONAL_HDC(hdc) HDC hdc,
21925 #define DECLARE_HDC(hdc) HDC hdc;
21926 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
21927 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
21930 #ifndef OPTIONAL_HDC
21931 #define OPTIONAL_HDC(hdc)
21932 #define DECLARE_HDC(hdc)
21933 #define ALLOCATE_HDC(hdc, f)
21934 #define RELEASE_HDC(hdc, f)
21938 init_glyph_string (struct glyph_string
*s
,
21940 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
21941 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
21943 memset (s
, 0, sizeof *s
);
21945 s
->f
= XFRAME (w
->frame
);
21949 s
->display
= FRAME_X_DISPLAY (s
->f
);
21950 s
->window
= FRAME_X_WINDOW (s
->f
);
21951 s
->char2b
= char2b
;
21955 s
->first_glyph
= row
->glyphs
[area
] + start
;
21956 s
->height
= row
->height
;
21957 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
21958 s
->ybase
= s
->y
+ row
->ascent
;
21962 /* Append the list of glyph strings with head H and tail T to the list
21963 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
21966 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21967 struct glyph_string
*h
, struct glyph_string
*t
)
21981 /* Prepend the list of glyph strings with head H and tail T to the
21982 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
21986 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
21987 struct glyph_string
*h
, struct glyph_string
*t
)
22001 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
22002 Set *HEAD and *TAIL to the resulting list. */
22005 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
22006 struct glyph_string
*s
)
22008 s
->next
= s
->prev
= NULL
;
22009 append_glyph_string_lists (head
, tail
, s
, s
);
22013 /* Get face and two-byte form of character C in face FACE_ID on frame F.
22014 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
22015 make sure that X resources for the face returned are allocated.
22016 Value is a pointer to a realized face that is ready for display if
22017 DISPLAY_P is non-zero. */
22019 static inline struct face
*
22020 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
22021 XChar2b
*char2b
, int display_p
)
22023 struct face
*face
= FACE_FROM_ID (f
, face_id
);
22027 unsigned code
= face
->font
->driver
->encode_char (face
->font
, c
);
22029 if (code
!= FONT_INVALID_CODE
)
22030 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22032 STORE_XCHAR2B (char2b
, 0, 0);
22035 /* Make sure X resources of the face are allocated. */
22036 #ifdef HAVE_X_WINDOWS
22040 xassert (face
!= NULL
);
22041 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22048 /* Get face and two-byte form of character glyph GLYPH on frame F.
22049 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
22050 a pointer to a realized face that is ready for display. */
22052 static inline struct face
*
22053 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
22054 XChar2b
*char2b
, int *two_byte_p
)
22058 xassert (glyph
->type
== CHAR_GLYPH
);
22059 face
= FACE_FROM_ID (f
, glyph
->face_id
);
22068 if (CHAR_BYTE8_P (glyph
->u
.ch
))
22069 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
22071 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
22073 if (code
!= FONT_INVALID_CODE
)
22074 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22076 STORE_XCHAR2B (char2b
, 0, 0);
22079 /* Make sure X resources of the face are allocated. */
22080 xassert (face
!= NULL
);
22081 PREPARE_FACE_FOR_DISPLAY (f
, face
);
22086 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
22087 Return 1 if FONT has a glyph for C, otherwise return 0. */
22090 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
22094 if (CHAR_BYTE8_P (c
))
22095 code
= CHAR_TO_BYTE8 (c
);
22097 code
= font
->driver
->encode_char (font
, c
);
22099 if (code
== FONT_INVALID_CODE
)
22101 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
22106 /* Fill glyph string S with composition components specified by S->cmp.
22108 BASE_FACE is the base face of the composition.
22109 S->cmp_from is the index of the first component for S.
22111 OVERLAPS non-zero means S should draw the foreground only, and use
22112 its physical height for clipping. See also draw_glyphs.
22114 Value is the index of a component not in S. */
22117 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
22121 /* For all glyphs of this composition, starting at the offset
22122 S->cmp_from, until we reach the end of the definition or encounter a
22123 glyph that requires the different face, add it to S. */
22128 s
->for_overlaps
= overlaps
;
22131 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
22133 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
22135 /* TAB in a composition means display glyphs with padding space
22136 on the left or right. */
22139 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
22142 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
22149 s
->font
= s
->face
->font
;
22151 else if (s
->face
!= face
)
22159 if (s
->face
== NULL
)
22161 s
->face
= base_face
->ascii_face
;
22162 s
->font
= s
->face
->font
;
22165 /* All glyph strings for the same composition has the same width,
22166 i.e. the width set for the first component of the composition. */
22167 s
->width
= s
->first_glyph
->pixel_width
;
22169 /* If the specified font could not be loaded, use the frame's
22170 default font, but record the fact that we couldn't load it in
22171 the glyph string so that we can draw rectangles for the
22172 characters of the glyph string. */
22173 if (s
->font
== NULL
)
22175 s
->font_not_found_p
= 1;
22176 s
->font
= FRAME_FONT (s
->f
);
22179 /* Adjust base line for subscript/superscript text. */
22180 s
->ybase
+= s
->first_glyph
->voffset
;
22182 /* This glyph string must always be drawn with 16-bit functions. */
22189 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
22190 int start
, int end
, int overlaps
)
22192 struct glyph
*glyph
, *last
;
22193 Lisp_Object lgstring
;
22196 s
->for_overlaps
= overlaps
;
22197 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22198 last
= s
->row
->glyphs
[s
->area
] + end
;
22199 s
->cmp_id
= glyph
->u
.cmp
.id
;
22200 s
->cmp_from
= glyph
->slice
.cmp
.from
;
22201 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
22202 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22203 lgstring
= composition_gstring_from_id (s
->cmp_id
);
22204 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
22206 while (glyph
< last
22207 && glyph
->u
.cmp
.automatic
22208 && glyph
->u
.cmp
.id
== s
->cmp_id
22209 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
22210 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
22212 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
22214 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
22215 unsigned code
= LGLYPH_CODE (lglyph
);
22217 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
22219 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
22220 return glyph
- s
->row
->glyphs
[s
->area
];
22224 /* Fill glyph string S from a sequence glyphs for glyphless characters.
22225 See the comment of fill_glyph_string for arguments.
22226 Value is the index of the first glyph not in S. */
22230 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
22231 int start
, int end
, int overlaps
)
22233 struct glyph
*glyph
, *last
;
22236 xassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
22237 s
->for_overlaps
= overlaps
;
22238 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22239 last
= s
->row
->glyphs
[s
->area
] + end
;
22240 voffset
= glyph
->voffset
;
22241 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22242 s
->font
= s
->face
->font
;
22244 s
->width
= glyph
->pixel_width
;
22246 while (glyph
< last
22247 && glyph
->type
== GLYPHLESS_GLYPH
22248 && glyph
->voffset
== voffset
22249 && glyph
->face_id
== face_id
)
22252 s
->width
+= glyph
->pixel_width
;
22255 s
->ybase
+= voffset
;
22256 return glyph
- s
->row
->glyphs
[s
->area
];
22260 /* Fill glyph string S from a sequence of character glyphs.
22262 FACE_ID is the face id of the string. START is the index of the
22263 first glyph to consider, END is the index of the last + 1.
22264 OVERLAPS non-zero means S should draw the foreground only, and use
22265 its physical height for clipping. See also draw_glyphs.
22267 Value is the index of the first glyph not in S. */
22270 fill_glyph_string (struct glyph_string
*s
, int face_id
,
22271 int start
, int end
, int overlaps
)
22273 struct glyph
*glyph
, *last
;
22275 int glyph_not_available_p
;
22277 xassert (s
->f
== XFRAME (s
->w
->frame
));
22278 xassert (s
->nchars
== 0);
22279 xassert (start
>= 0 && end
> start
);
22281 s
->for_overlaps
= overlaps
;
22282 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22283 last
= s
->row
->glyphs
[s
->area
] + end
;
22284 voffset
= glyph
->voffset
;
22285 s
->padding_p
= glyph
->padding_p
;
22286 glyph_not_available_p
= glyph
->glyph_not_available_p
;
22288 while (glyph
< last
22289 && glyph
->type
== CHAR_GLYPH
22290 && glyph
->voffset
== voffset
22291 /* Same face id implies same font, nowadays. */
22292 && glyph
->face_id
== face_id
22293 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
22297 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
22298 s
->char2b
+ s
->nchars
,
22300 s
->two_byte_p
= two_byte_p
;
22302 xassert (s
->nchars
<= end
- start
);
22303 s
->width
+= glyph
->pixel_width
;
22304 if (glyph
++->padding_p
!= s
->padding_p
)
22308 s
->font
= s
->face
->font
;
22310 /* If the specified font could not be loaded, use the frame's font,
22311 but record the fact that we couldn't load it in
22312 S->font_not_found_p so that we can draw rectangles for the
22313 characters of the glyph string. */
22314 if (s
->font
== NULL
|| glyph_not_available_p
)
22316 s
->font_not_found_p
= 1;
22317 s
->font
= FRAME_FONT (s
->f
);
22320 /* Adjust base line for subscript/superscript text. */
22321 s
->ybase
+= voffset
;
22323 xassert (s
->face
&& s
->face
->gc
);
22324 return glyph
- s
->row
->glyphs
[s
->area
];
22328 /* Fill glyph string S from image glyph S->first_glyph. */
22331 fill_image_glyph_string (struct glyph_string
*s
)
22333 xassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
22334 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
22336 s
->slice
= s
->first_glyph
->slice
.img
;
22337 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
22338 s
->font
= s
->face
->font
;
22339 s
->width
= s
->first_glyph
->pixel_width
;
22341 /* Adjust base line for subscript/superscript text. */
22342 s
->ybase
+= s
->first_glyph
->voffset
;
22346 /* Fill glyph string S from a sequence of stretch glyphs.
22348 START is the index of the first glyph to consider,
22349 END is the index of the last + 1.
22351 Value is the index of the first glyph not in S. */
22354 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
22356 struct glyph
*glyph
, *last
;
22357 int voffset
, face_id
;
22359 xassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
22361 glyph
= s
->row
->glyphs
[s
->area
] + start
;
22362 last
= s
->row
->glyphs
[s
->area
] + end
;
22363 face_id
= glyph
->face_id
;
22364 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
22365 s
->font
= s
->face
->font
;
22366 s
->width
= glyph
->pixel_width
;
22368 voffset
= glyph
->voffset
;
22372 && glyph
->type
== STRETCH_GLYPH
22373 && glyph
->voffset
== voffset
22374 && glyph
->face_id
== face_id
);
22376 s
->width
+= glyph
->pixel_width
;
22378 /* Adjust base line for subscript/superscript text. */
22379 s
->ybase
+= voffset
;
22381 /* The case that face->gc == 0 is handled when drawing the glyph
22382 string by calling PREPARE_FACE_FOR_DISPLAY. */
22384 return glyph
- s
->row
->glyphs
[s
->area
];
22387 static struct font_metrics
*
22388 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
22390 static struct font_metrics metrics
;
22391 unsigned code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
22393 if (! font
|| code
== FONT_INVALID_CODE
)
22395 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
22400 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
22401 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
22402 assumed to be zero. */
22405 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
22407 *left
= *right
= 0;
22409 if (glyph
->type
== CHAR_GLYPH
)
22413 struct font_metrics
*pcm
;
22415 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
22416 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
22418 if (pcm
->rbearing
> pcm
->width
)
22419 *right
= pcm
->rbearing
- pcm
->width
;
22420 if (pcm
->lbearing
< 0)
22421 *left
= -pcm
->lbearing
;
22424 else if (glyph
->type
== COMPOSITE_GLYPH
)
22426 if (! glyph
->u
.cmp
.automatic
)
22428 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
22430 if (cmp
->rbearing
> cmp
->pixel_width
)
22431 *right
= cmp
->rbearing
- cmp
->pixel_width
;
22432 if (cmp
->lbearing
< 0)
22433 *left
= - cmp
->lbearing
;
22437 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
22438 struct font_metrics metrics
;
22440 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
22441 glyph
->slice
.cmp
.to
+ 1, &metrics
);
22442 if (metrics
.rbearing
> metrics
.width
)
22443 *right
= metrics
.rbearing
- metrics
.width
;
22444 if (metrics
.lbearing
< 0)
22445 *left
= - metrics
.lbearing
;
22451 /* Return the index of the first glyph preceding glyph string S that
22452 is overwritten by S because of S's left overhang. Value is -1
22453 if no glyphs are overwritten. */
22456 left_overwritten (struct glyph_string
*s
)
22460 if (s
->left_overhang
)
22463 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22464 int first
= s
->first_glyph
- glyphs
;
22466 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
22467 x
-= glyphs
[i
].pixel_width
;
22478 /* Return the index of the first glyph preceding glyph string S that
22479 is overwriting S because of its right overhang. Value is -1 if no
22480 glyph in front of S overwrites S. */
22483 left_overwriting (struct glyph_string
*s
)
22486 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22487 int first
= s
->first_glyph
- glyphs
;
22491 for (i
= first
- 1; i
>= 0; --i
)
22494 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22497 x
-= glyphs
[i
].pixel_width
;
22504 /* Return the index of the last glyph following glyph string S that is
22505 overwritten by S because of S's right overhang. Value is -1 if
22506 no such glyph is found. */
22509 right_overwritten (struct glyph_string
*s
)
22513 if (s
->right_overhang
)
22516 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22517 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22518 int end
= s
->row
->used
[s
->area
];
22520 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
22521 x
+= glyphs
[i
].pixel_width
;
22530 /* Return the index of the last glyph following glyph string S that
22531 overwrites S because of its left overhang. Value is negative
22532 if no such glyph is found. */
22535 right_overwriting (struct glyph_string
*s
)
22538 int end
= s
->row
->used
[s
->area
];
22539 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
22540 int first
= (s
->first_glyph
- glyphs
) + (s
->cmp
? 1 : s
->nchars
);
22544 for (i
= first
; i
< end
; ++i
)
22547 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
22550 x
+= glyphs
[i
].pixel_width
;
22557 /* Set background width of glyph string S. START is the index of the
22558 first glyph following S. LAST_X is the right-most x-position + 1
22559 in the drawing area. */
22562 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
22564 /* If the face of this glyph string has to be drawn to the end of
22565 the drawing area, set S->extends_to_end_of_line_p. */
22567 if (start
== s
->row
->used
[s
->area
]
22568 && s
->area
== TEXT_AREA
22569 && ((s
->row
->fill_line_p
22570 && (s
->hl
== DRAW_NORMAL_TEXT
22571 || s
->hl
== DRAW_IMAGE_RAISED
22572 || s
->hl
== DRAW_IMAGE_SUNKEN
))
22573 || s
->hl
== DRAW_MOUSE_FACE
))
22574 s
->extends_to_end_of_line_p
= 1;
22576 /* If S extends its face to the end of the line, set its
22577 background_width to the distance to the right edge of the drawing
22579 if (s
->extends_to_end_of_line_p
)
22580 s
->background_width
= last_x
- s
->x
+ 1;
22582 s
->background_width
= s
->width
;
22586 /* Compute overhangs and x-positions for glyph string S and its
22587 predecessors, or successors. X is the starting x-position for S.
22588 BACKWARD_P non-zero means process predecessors. */
22591 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
22597 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22598 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22608 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
22609 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
22619 /* The following macros are only called from draw_glyphs below.
22620 They reference the following parameters of that function directly:
22621 `w', `row', `area', and `overlap_p'
22622 as well as the following local variables:
22623 `s', `f', and `hdc' (in W32) */
22626 /* On W32, silently add local `hdc' variable to argument list of
22627 init_glyph_string. */
22628 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22629 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
22631 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
22632 init_glyph_string (s, char2b, w, row, area, start, hl)
22635 /* Add a glyph string for a stretch glyph to the list of strings
22636 between HEAD and TAIL. START is the index of the stretch glyph in
22637 row area AREA of glyph row ROW. END is the index of the last glyph
22638 in that glyph row area. X is the current output position assigned
22639 to the new glyph string constructed. HL overrides that face of the
22640 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22641 is the right-most x-position of the drawing area. */
22643 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
22644 and below -- keep them on one line. */
22645 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22648 s = (struct glyph_string *) alloca (sizeof *s); \
22649 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22650 START = fill_stretch_glyph_string (s, START, END); \
22651 append_glyph_string (&HEAD, &TAIL, s); \
22657 /* Add a glyph string for an image glyph to the list of strings
22658 between HEAD and TAIL. START is the index of the image glyph in
22659 row area AREA of glyph row ROW. END is the index of the last glyph
22660 in that glyph row area. X is the current output position assigned
22661 to the new glyph string constructed. HL overrides that face of the
22662 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
22663 is the right-most x-position of the drawing area. */
22665 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22668 s = (struct glyph_string *) alloca (sizeof *s); \
22669 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22670 fill_image_glyph_string (s); \
22671 append_glyph_string (&HEAD, &TAIL, s); \
22678 /* Add a glyph string for a sequence of character glyphs to the list
22679 of strings between HEAD and TAIL. START is the index of the first
22680 glyph in row area AREA of glyph row ROW that is part of the new
22681 glyph string. END is the index of the last glyph in that glyph row
22682 area. X is the current output position assigned to the new glyph
22683 string constructed. HL overrides that face of the glyph; e.g. it
22684 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
22685 right-most x-position of the drawing area. */
22687 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22693 face_id = (row)->glyphs[area][START].face_id; \
22695 s = (struct glyph_string *) alloca (sizeof *s); \
22696 char2b = (XChar2b *) alloca ((END - START) * sizeof *char2b); \
22697 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22698 append_glyph_string (&HEAD, &TAIL, s); \
22700 START = fill_glyph_string (s, face_id, START, END, overlaps); \
22705 /* Add a glyph string for a composite sequence to the list of strings
22706 between HEAD and TAIL. START is the index of the first glyph in
22707 row area AREA of glyph row ROW that is part of the new glyph
22708 string. END is the index of the last glyph in that glyph row area.
22709 X is the current output position assigned to the new glyph string
22710 constructed. HL overrides that face of the glyph; e.g. it is
22711 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
22712 x-position of the drawing area. */
22714 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22716 int face_id = (row)->glyphs[area][START].face_id; \
22717 struct face *base_face = FACE_FROM_ID (f, face_id); \
22718 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
22719 struct composition *cmp = composition_table[cmp_id]; \
22721 struct glyph_string *first_s IF_LINT (= NULL); \
22724 char2b = (XChar2b *) alloca ((sizeof *char2b) * cmp->glyph_len); \
22726 /* Make glyph_strings for each glyph sequence that is drawable by \
22727 the same face, and append them to HEAD/TAIL. */ \
22728 for (n = 0; n < cmp->glyph_len;) \
22730 s = (struct glyph_string *) alloca (sizeof *s); \
22731 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22732 append_glyph_string (&(HEAD), &(TAIL), s); \
22738 n = fill_composite_glyph_string (s, base_face, overlaps); \
22746 /* Add a glyph string for a glyph-string sequence to the list of strings
22747 between HEAD and TAIL. */
22749 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22753 Lisp_Object gstring; \
22755 face_id = (row)->glyphs[area][START].face_id; \
22756 gstring = (composition_gstring_from_id \
22757 ((row)->glyphs[area][START].u.cmp.id)); \
22758 s = (struct glyph_string *) alloca (sizeof *s); \
22759 char2b = (XChar2b *) alloca ((sizeof *char2b) \
22760 * LGSTRING_GLYPH_LEN (gstring)); \
22761 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
22762 append_glyph_string (&(HEAD), &(TAIL), s); \
22764 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
22768 /* Add a glyph string for a sequence of glyphless character's glyphs
22769 to the list of strings between HEAD and TAIL. The meanings of
22770 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
22772 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
22777 face_id = (row)->glyphs[area][START].face_id; \
22779 s = (struct glyph_string *) alloca (sizeof *s); \
22780 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
22781 append_glyph_string (&HEAD, &TAIL, s); \
22783 START = fill_glyphless_glyph_string (s, face_id, START, END, \
22789 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
22790 of AREA of glyph row ROW on window W between indices START and END.
22791 HL overrides the face for drawing glyph strings, e.g. it is
22792 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
22793 x-positions of the drawing area.
22795 This is an ugly monster macro construct because we must use alloca
22796 to allocate glyph strings (because draw_glyphs can be called
22797 asynchronously). */
22799 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
22802 HEAD = TAIL = NULL; \
22803 while (START < END) \
22805 struct glyph *first_glyph = (row)->glyphs[area] + START; \
22806 switch (first_glyph->type) \
22809 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
22813 case COMPOSITE_GLYPH: \
22814 if (first_glyph->u.cmp.automatic) \
22815 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
22818 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
22822 case STRETCH_GLYPH: \
22823 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
22827 case IMAGE_GLYPH: \
22828 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
22832 case GLYPHLESS_GLYPH: \
22833 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
22843 set_glyph_string_background_width (s, START, LAST_X); \
22850 /* Draw glyphs between START and END in AREA of ROW on window W,
22851 starting at x-position X. X is relative to AREA in W. HL is a
22852 face-override with the following meaning:
22854 DRAW_NORMAL_TEXT draw normally
22855 DRAW_CURSOR draw in cursor face
22856 DRAW_MOUSE_FACE draw in mouse face.
22857 DRAW_INVERSE_VIDEO draw in mode line face
22858 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
22859 DRAW_IMAGE_RAISED draw an image with a raised relief around it
22861 If OVERLAPS is non-zero, draw only the foreground of characters and
22862 clip to the physical height of ROW. Non-zero value also defines
22863 the overlapping part to be drawn:
22865 OVERLAPS_PRED overlap with preceding rows
22866 OVERLAPS_SUCC overlap with succeeding rows
22867 OVERLAPS_BOTH overlap with both preceding/succeeding rows
22868 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
22870 Value is the x-position reached, relative to AREA of W. */
22873 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
22874 enum glyph_row_area area
, EMACS_INT start
, EMACS_INT end
,
22875 enum draw_glyphs_face hl
, int overlaps
)
22877 struct glyph_string
*head
, *tail
;
22878 struct glyph_string
*s
;
22879 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
22880 int i
, j
, x_reached
, last_x
, area_left
= 0;
22881 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22884 ALLOCATE_HDC (hdc
, f
);
22886 /* Let's rather be paranoid than getting a SEGV. */
22887 end
= min (end
, row
->used
[area
]);
22888 start
= max (0, start
);
22889 start
= min (end
, start
);
22891 /* Translate X to frame coordinates. Set last_x to the right
22892 end of the drawing area. */
22893 if (row
->full_width_p
)
22895 /* X is relative to the left edge of W, without scroll bars
22897 area_left
= WINDOW_LEFT_EDGE_X (w
);
22898 last_x
= WINDOW_LEFT_EDGE_X (w
) + WINDOW_TOTAL_WIDTH (w
);
22902 area_left
= window_box_left (w
, area
);
22903 last_x
= area_left
+ window_box_width (w
, area
);
22907 /* Build a doubly-linked list of glyph_string structures between
22908 head and tail from what we have to draw. Note that the macro
22909 BUILD_GLYPH_STRINGS will modify its start parameter. That's
22910 the reason we use a separate variable `i'. */
22912 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
22914 x_reached
= tail
->x
+ tail
->background_width
;
22918 /* If there are any glyphs with lbearing < 0 or rbearing > width in
22919 the row, redraw some glyphs in front or following the glyph
22920 strings built above. */
22921 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
22923 struct glyph_string
*h
, *t
;
22924 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
22925 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
22926 int check_mouse_face
= 0;
22929 /* If mouse highlighting is on, we may need to draw adjacent
22930 glyphs using mouse-face highlighting. */
22931 if (area
== TEXT_AREA
&& row
->mouse_face_p
)
22933 struct glyph_row
*mouse_beg_row
, *mouse_end_row
;
22935 mouse_beg_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
22936 mouse_end_row
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
22938 if (row
>= mouse_beg_row
&& row
<= mouse_end_row
)
22940 check_mouse_face
= 1;
22941 mouse_beg_col
= (row
== mouse_beg_row
)
22942 ? hlinfo
->mouse_face_beg_col
: 0;
22943 mouse_end_col
= (row
== mouse_end_row
)
22944 ? hlinfo
->mouse_face_end_col
22945 : row
->used
[TEXT_AREA
];
22949 /* Compute overhangs for all glyph strings. */
22950 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
22951 for (s
= head
; s
; s
= s
->next
)
22952 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
22954 /* Prepend glyph strings for glyphs in front of the first glyph
22955 string that are overwritten because of the first glyph
22956 string's left overhang. The background of all strings
22957 prepended must be drawn because the first glyph string
22959 i
= left_overwritten (head
);
22962 enum draw_glyphs_face overlap_hl
;
22964 /* If this row contains mouse highlighting, attempt to draw
22965 the overlapped glyphs with the correct highlight. This
22966 code fails if the overlap encompasses more than one glyph
22967 and mouse-highlight spans only some of these glyphs.
22968 However, making it work perfectly involves a lot more
22969 code, and I don't know if the pathological case occurs in
22970 practice, so we'll stick to this for now. --- cyd */
22971 if (check_mouse_face
22972 && mouse_beg_col
< start
&& mouse_end_col
> i
)
22973 overlap_hl
= DRAW_MOUSE_FACE
;
22975 overlap_hl
= DRAW_NORMAL_TEXT
;
22978 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
22979 overlap_hl
, dummy_x
, last_x
);
22981 compute_overhangs_and_x (t
, head
->x
, 1);
22982 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
22986 /* Prepend glyph strings for glyphs in front of the first glyph
22987 string that overwrite that glyph string because of their
22988 right overhang. For these strings, only the foreground must
22989 be drawn, because it draws over the glyph string at `head'.
22990 The background must not be drawn because this would overwrite
22991 right overhangs of preceding glyphs for which no glyph
22993 i
= left_overwriting (head
);
22996 enum draw_glyphs_face overlap_hl
;
22998 if (check_mouse_face
22999 && mouse_beg_col
< start
&& mouse_end_col
> i
)
23000 overlap_hl
= DRAW_MOUSE_FACE
;
23002 overlap_hl
= DRAW_NORMAL_TEXT
;
23005 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
23006 overlap_hl
, dummy_x
, last_x
);
23007 for (s
= h
; s
; s
= s
->next
)
23008 s
->background_filled_p
= 1;
23009 compute_overhangs_and_x (t
, head
->x
, 1);
23010 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
23013 /* Append glyphs strings for glyphs following the last glyph
23014 string tail that are overwritten by tail. The background of
23015 these strings has to be drawn because tail's foreground draws
23017 i
= right_overwritten (tail
);
23020 enum draw_glyphs_face overlap_hl
;
23022 if (check_mouse_face
23023 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23024 overlap_hl
= DRAW_MOUSE_FACE
;
23026 overlap_hl
= DRAW_NORMAL_TEXT
;
23028 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23029 overlap_hl
, x
, last_x
);
23030 /* Because BUILD_GLYPH_STRINGS updates the first argument,
23031 we don't have `end = i;' here. */
23032 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23033 append_glyph_string_lists (&head
, &tail
, h
, t
);
23037 /* Append glyph strings for glyphs following the last glyph
23038 string tail that overwrite tail. The foreground of such
23039 glyphs has to be drawn because it writes into the background
23040 of tail. The background must not be drawn because it could
23041 paint over the foreground of following glyphs. */
23042 i
= right_overwriting (tail
);
23045 enum draw_glyphs_face overlap_hl
;
23046 if (check_mouse_face
23047 && mouse_beg_col
< i
&& mouse_end_col
> end
)
23048 overlap_hl
= DRAW_MOUSE_FACE
;
23050 overlap_hl
= DRAW_NORMAL_TEXT
;
23053 i
++; /* We must include the Ith glyph. */
23054 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
23055 overlap_hl
, x
, last_x
);
23056 for (s
= h
; s
; s
= s
->next
)
23057 s
->background_filled_p
= 1;
23058 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
23059 append_glyph_string_lists (&head
, &tail
, h
, t
);
23061 if (clip_head
|| clip_tail
)
23062 for (s
= head
; s
; s
= s
->next
)
23064 s
->clip_head
= clip_head
;
23065 s
->clip_tail
= clip_tail
;
23069 /* Draw all strings. */
23070 for (s
= head
; s
; s
= s
->next
)
23071 FRAME_RIF (f
)->draw_glyph_string (s
);
23074 /* When focus a sole frame and move horizontally, this sets on_p to 0
23075 causing a failure to erase prev cursor position. */
23076 if (area
== TEXT_AREA
23077 && !row
->full_width_p
23078 /* When drawing overlapping rows, only the glyph strings'
23079 foreground is drawn, which doesn't erase a cursor
23083 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
23084 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
23085 : (tail
? tail
->x
+ tail
->background_width
: x
));
23089 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
23090 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
23094 /* Value is the x-position up to which drawn, relative to AREA of W.
23095 This doesn't include parts drawn because of overhangs. */
23096 if (row
->full_width_p
)
23097 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
23099 x_reached
-= area_left
;
23101 RELEASE_HDC (hdc
, f
);
23106 /* Expand row matrix if too narrow. Don't expand if area
23109 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
23111 if (!fonts_changed_p \
23112 && (it->glyph_row->glyphs[area] \
23113 < it->glyph_row->glyphs[area + 1])) \
23115 it->w->ncols_scale_factor++; \
23116 fonts_changed_p = 1; \
23120 /* Store one glyph for IT->char_to_display in IT->glyph_row.
23121 Called from x_produce_glyphs when IT->glyph_row is non-null. */
23124 append_glyph (struct it
*it
)
23126 struct glyph
*glyph
;
23127 enum glyph_row_area area
= it
->area
;
23129 xassert (it
->glyph_row
);
23130 xassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
23132 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23133 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23135 /* If the glyph row is reversed, we need to prepend the glyph
23136 rather than append it. */
23137 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23141 /* Make room for the additional glyph. */
23142 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23144 glyph
= it
->glyph_row
->glyphs
[area
];
23146 glyph
->charpos
= CHARPOS (it
->position
);
23147 glyph
->object
= it
->object
;
23148 if (it
->pixel_width
> 0)
23150 glyph
->pixel_width
= it
->pixel_width
;
23151 glyph
->padding_p
= 0;
23155 /* Assure at least 1-pixel width. Otherwise, cursor can't
23156 be displayed correctly. */
23157 glyph
->pixel_width
= 1;
23158 glyph
->padding_p
= 1;
23160 glyph
->ascent
= it
->ascent
;
23161 glyph
->descent
= it
->descent
;
23162 glyph
->voffset
= it
->voffset
;
23163 glyph
->type
= CHAR_GLYPH
;
23164 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23165 glyph
->multibyte_p
= it
->multibyte_p
;
23166 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23167 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23168 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23169 || it
->phys_descent
> it
->descent
);
23170 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
23171 glyph
->face_id
= it
->face_id
;
23172 glyph
->u
.ch
= it
->char_to_display
;
23173 glyph
->slice
.img
= null_glyph_slice
;
23174 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23177 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23178 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23180 glyph
->bidi_type
= it
->bidi_it
.type
;
23184 glyph
->resolved_level
= 0;
23185 glyph
->bidi_type
= UNKNOWN_BT
;
23187 ++it
->glyph_row
->used
[area
];
23190 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23193 /* Store one glyph for the composition IT->cmp_it.id in
23194 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
23198 append_composite_glyph (struct it
*it
)
23200 struct glyph
*glyph
;
23201 enum glyph_row_area area
= it
->area
;
23203 xassert (it
->glyph_row
);
23205 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23206 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23208 /* If the glyph row is reversed, we need to prepend the glyph
23209 rather than append it. */
23210 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
23214 /* Make room for the new glyph. */
23215 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
23217 glyph
= it
->glyph_row
->glyphs
[it
->area
];
23219 glyph
->charpos
= it
->cmp_it
.charpos
;
23220 glyph
->object
= it
->object
;
23221 glyph
->pixel_width
= it
->pixel_width
;
23222 glyph
->ascent
= it
->ascent
;
23223 glyph
->descent
= it
->descent
;
23224 glyph
->voffset
= it
->voffset
;
23225 glyph
->type
= COMPOSITE_GLYPH
;
23226 if (it
->cmp_it
.ch
< 0)
23228 glyph
->u
.cmp
.automatic
= 0;
23229 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23230 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
23234 glyph
->u
.cmp
.automatic
= 1;
23235 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
23236 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
23237 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
23239 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23240 glyph
->multibyte_p
= it
->multibyte_p
;
23241 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23242 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23243 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23244 || it
->phys_descent
> it
->descent
);
23245 glyph
->padding_p
= 0;
23246 glyph
->glyph_not_available_p
= 0;
23247 glyph
->face_id
= it
->face_id
;
23248 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23251 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23252 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23254 glyph
->bidi_type
= it
->bidi_it
.type
;
23256 ++it
->glyph_row
->used
[area
];
23259 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23263 /* Change IT->ascent and IT->height according to the setting of
23267 take_vertical_position_into_account (struct it
*it
)
23271 if (it
->voffset
< 0)
23272 /* Increase the ascent so that we can display the text higher
23274 it
->ascent
-= it
->voffset
;
23276 /* Increase the descent so that we can display the text lower
23278 it
->descent
+= it
->voffset
;
23283 /* Produce glyphs/get display metrics for the image IT is loaded with.
23284 See the description of struct display_iterator in dispextern.h for
23285 an overview of struct display_iterator. */
23288 produce_image_glyph (struct it
*it
)
23292 int glyph_ascent
, crop
;
23293 struct glyph_slice slice
;
23295 xassert (it
->what
== IT_IMAGE
);
23297 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23299 /* Make sure X resources of the face is loaded. */
23300 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23302 if (it
->image_id
< 0)
23304 /* Fringe bitmap. */
23305 it
->ascent
= it
->phys_ascent
= 0;
23306 it
->descent
= it
->phys_descent
= 0;
23307 it
->pixel_width
= 0;
23312 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
23314 /* Make sure X resources of the image is loaded. */
23315 prepare_image_for_display (it
->f
, img
);
23317 slice
.x
= slice
.y
= 0;
23318 slice
.width
= img
->width
;
23319 slice
.height
= img
->height
;
23321 if (INTEGERP (it
->slice
.x
))
23322 slice
.x
= XINT (it
->slice
.x
);
23323 else if (FLOATP (it
->slice
.x
))
23324 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
23326 if (INTEGERP (it
->slice
.y
))
23327 slice
.y
= XINT (it
->slice
.y
);
23328 else if (FLOATP (it
->slice
.y
))
23329 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
23331 if (INTEGERP (it
->slice
.width
))
23332 slice
.width
= XINT (it
->slice
.width
);
23333 else if (FLOATP (it
->slice
.width
))
23334 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
23336 if (INTEGERP (it
->slice
.height
))
23337 slice
.height
= XINT (it
->slice
.height
);
23338 else if (FLOATP (it
->slice
.height
))
23339 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
23341 if (slice
.x
>= img
->width
)
23342 slice
.x
= img
->width
;
23343 if (slice
.y
>= img
->height
)
23344 slice
.y
= img
->height
;
23345 if (slice
.x
+ slice
.width
>= img
->width
)
23346 slice
.width
= img
->width
- slice
.x
;
23347 if (slice
.y
+ slice
.height
> img
->height
)
23348 slice
.height
= img
->height
- slice
.y
;
23350 if (slice
.width
== 0 || slice
.height
== 0)
23353 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
23355 it
->descent
= slice
.height
- glyph_ascent
;
23357 it
->descent
+= img
->vmargin
;
23358 if (slice
.y
+ slice
.height
== img
->height
)
23359 it
->descent
+= img
->vmargin
;
23360 it
->phys_descent
= it
->descent
;
23362 it
->pixel_width
= slice
.width
;
23364 it
->pixel_width
+= img
->hmargin
;
23365 if (slice
.x
+ slice
.width
== img
->width
)
23366 it
->pixel_width
+= img
->hmargin
;
23368 /* It's quite possible for images to have an ascent greater than
23369 their height, so don't get confused in that case. */
23370 if (it
->descent
< 0)
23375 if (face
->box
!= FACE_NO_BOX
)
23377 if (face
->box_line_width
> 0)
23380 it
->ascent
+= face
->box_line_width
;
23381 if (slice
.y
+ slice
.height
== img
->height
)
23382 it
->descent
+= face
->box_line_width
;
23385 if (it
->start_of_box_run_p
&& slice
.x
== 0)
23386 it
->pixel_width
+= eabs (face
->box_line_width
);
23387 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
23388 it
->pixel_width
+= eabs (face
->box_line_width
);
23391 take_vertical_position_into_account (it
);
23393 /* Automatically crop wide image glyphs at right edge so we can
23394 draw the cursor on same display row. */
23395 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
23396 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
23398 it
->pixel_width
-= crop
;
23399 slice
.width
-= crop
;
23404 struct glyph
*glyph
;
23405 enum glyph_row_area area
= it
->area
;
23407 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23408 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23410 glyph
->charpos
= CHARPOS (it
->position
);
23411 glyph
->object
= it
->object
;
23412 glyph
->pixel_width
= it
->pixel_width
;
23413 glyph
->ascent
= glyph_ascent
;
23414 glyph
->descent
= it
->descent
;
23415 glyph
->voffset
= it
->voffset
;
23416 glyph
->type
= IMAGE_GLYPH
;
23417 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23418 glyph
->multibyte_p
= it
->multibyte_p
;
23419 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23420 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23421 glyph
->overlaps_vertically_p
= 0;
23422 glyph
->padding_p
= 0;
23423 glyph
->glyph_not_available_p
= 0;
23424 glyph
->face_id
= it
->face_id
;
23425 glyph
->u
.img_id
= img
->id
;
23426 glyph
->slice
.img
= slice
;
23427 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23430 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23431 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23433 glyph
->bidi_type
= it
->bidi_it
.type
;
23435 ++it
->glyph_row
->used
[area
];
23438 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23443 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
23444 of the glyph, WIDTH and HEIGHT are the width and height of the
23445 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
23448 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
23449 int width
, int height
, int ascent
)
23451 struct glyph
*glyph
;
23452 enum glyph_row_area area
= it
->area
;
23454 xassert (ascent
>= 0 && ascent
<= height
);
23456 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23457 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23459 /* If the glyph row is reversed, we need to prepend the glyph
23460 rather than append it. */
23461 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23465 /* Make room for the additional glyph. */
23466 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23468 glyph
= it
->glyph_row
->glyphs
[area
];
23470 glyph
->charpos
= CHARPOS (it
->position
);
23471 glyph
->object
= object
;
23472 glyph
->pixel_width
= width
;
23473 glyph
->ascent
= ascent
;
23474 glyph
->descent
= height
- ascent
;
23475 glyph
->voffset
= it
->voffset
;
23476 glyph
->type
= STRETCH_GLYPH
;
23477 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23478 glyph
->multibyte_p
= it
->multibyte_p
;
23479 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23480 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23481 glyph
->overlaps_vertically_p
= 0;
23482 glyph
->padding_p
= 0;
23483 glyph
->glyph_not_available_p
= 0;
23484 glyph
->face_id
= it
->face_id
;
23485 glyph
->u
.stretch
.ascent
= ascent
;
23486 glyph
->u
.stretch
.height
= height
;
23487 glyph
->slice
.img
= null_glyph_slice
;
23488 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23491 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23492 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23494 glyph
->bidi_type
= it
->bidi_it
.type
;
23498 glyph
->resolved_level
= 0;
23499 glyph
->bidi_type
= UNKNOWN_BT
;
23501 ++it
->glyph_row
->used
[area
];
23504 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23507 #endif /* HAVE_WINDOW_SYSTEM */
23509 /* Produce a stretch glyph for iterator IT. IT->object is the value
23510 of the glyph property displayed. The value must be a list
23511 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
23514 1. `:width WIDTH' specifies that the space should be WIDTH *
23515 canonical char width wide. WIDTH may be an integer or floating
23518 2. `:relative-width FACTOR' specifies that the width of the stretch
23519 should be computed from the width of the first character having the
23520 `glyph' property, and should be FACTOR times that width.
23522 3. `:align-to HPOS' specifies that the space should be wide enough
23523 to reach HPOS, a value in canonical character units.
23525 Exactly one of the above pairs must be present.
23527 4. `:height HEIGHT' specifies that the height of the stretch produced
23528 should be HEIGHT, measured in canonical character units.
23530 5. `:relative-height FACTOR' specifies that the height of the
23531 stretch should be FACTOR times the height of the characters having
23532 the glyph property.
23534 Either none or exactly one of 4 or 5 must be present.
23536 6. `:ascent ASCENT' specifies that ASCENT percent of the height
23537 of the stretch should be used for the ascent of the stretch.
23538 ASCENT must be in the range 0 <= ASCENT <= 100. */
23541 produce_stretch_glyph (struct it
*it
)
23543 /* (space :width WIDTH :height HEIGHT ...) */
23544 Lisp_Object prop
, plist
;
23545 int width
= 0, height
= 0, align_to
= -1;
23546 int zero_width_ok_p
= 0;
23549 struct face
*face
= NULL
;
23550 struct font
*font
= NULL
;
23552 #ifdef HAVE_WINDOW_SYSTEM
23553 int zero_height_ok_p
= 0;
23555 if (FRAME_WINDOW_P (it
->f
))
23557 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23558 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23559 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23563 /* List should start with `space'. */
23564 xassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
23565 plist
= XCDR (it
->object
);
23567 /* Compute the width of the stretch. */
23568 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
23569 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
23571 /* Absolute width `:width WIDTH' specified and valid. */
23572 zero_width_ok_p
= 1;
23575 #ifdef HAVE_WINDOW_SYSTEM
23576 else if (FRAME_WINDOW_P (it
->f
)
23577 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
23579 /* Relative width `:relative-width FACTOR' specified and valid.
23580 Compute the width of the characters having the `glyph'
23583 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
23586 if (it
->multibyte_p
)
23587 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
23590 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
23591 if (! ASCII_CHAR_P (it2
.c
))
23592 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
23595 it2
.glyph_row
= NULL
;
23596 it2
.what
= IT_CHARACTER
;
23597 x_produce_glyphs (&it2
);
23598 width
= NUMVAL (prop
) * it2
.pixel_width
;
23600 #endif /* HAVE_WINDOW_SYSTEM */
23601 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
23602 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
23604 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
23605 align_to
= (align_to
< 0
23607 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
23608 else if (align_to
< 0)
23609 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
23610 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
23611 zero_width_ok_p
= 1;
23614 /* Nothing specified -> width defaults to canonical char width. */
23615 width
= FRAME_COLUMN_WIDTH (it
->f
);
23617 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
23620 #ifdef HAVE_WINDOW_SYSTEM
23621 /* Compute height. */
23622 if (FRAME_WINDOW_P (it
->f
))
23624 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
23625 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23628 zero_height_ok_p
= 1;
23630 else if (prop
= Fplist_get (plist
, QCrelative_height
),
23632 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
23634 height
= FONT_HEIGHT (font
);
23636 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
23639 /* Compute percentage of height used for ascent. If
23640 `:ascent ASCENT' is present and valid, use that. Otherwise,
23641 derive the ascent from the font in use. */
23642 if (prop
= Fplist_get (plist
, QCascent
),
23643 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
23644 ascent
= height
* NUMVAL (prop
) / 100.0;
23645 else if (!NILP (prop
)
23646 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
23647 ascent
= min (max (0, (int)tem
), height
);
23649 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
23652 #endif /* HAVE_WINDOW_SYSTEM */
23655 if (width
> 0 && it
->line_wrap
!= TRUNCATE
23656 && it
->current_x
+ width
> it
->last_visible_x
)
23658 width
= it
->last_visible_x
- it
->current_x
;
23659 #ifdef HAVE_WINDOW_SYSTEM
23660 /* Subtract one more pixel from the stretch width, but only on
23661 GUI frames, since on a TTY each glyph is one "pixel" wide. */
23662 width
-= FRAME_WINDOW_P (it
->f
);
23666 if (width
> 0 && height
> 0 && it
->glyph_row
)
23668 Lisp_Object o_object
= it
->object
;
23669 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
23672 if (!STRINGP (object
))
23673 object
= it
->w
->buffer
;
23674 #ifdef HAVE_WINDOW_SYSTEM
23675 if (FRAME_WINDOW_P (it
->f
))
23676 append_stretch_glyph (it
, object
, width
, height
, ascent
);
23680 it
->object
= object
;
23681 it
->char_to_display
= ' ';
23682 it
->pixel_width
= it
->len
= 1;
23684 tty_append_glyph (it
);
23685 it
->object
= o_object
;
23689 it
->pixel_width
= width
;
23690 #ifdef HAVE_WINDOW_SYSTEM
23691 if (FRAME_WINDOW_P (it
->f
))
23693 it
->ascent
= it
->phys_ascent
= ascent
;
23694 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
23695 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
23696 take_vertical_position_into_account (it
);
23700 it
->nglyphs
= width
;
23703 #ifdef HAVE_WINDOW_SYSTEM
23705 /* Calculate line-height and line-spacing properties.
23706 An integer value specifies explicit pixel value.
23707 A float value specifies relative value to current face height.
23708 A cons (float . face-name) specifies relative value to
23709 height of specified face font.
23711 Returns height in pixels, or nil. */
23715 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
23716 int boff
, int override
)
23718 Lisp_Object face_name
= Qnil
;
23719 int ascent
, descent
, height
;
23721 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
23726 face_name
= XCAR (val
);
23728 if (!NUMBERP (val
))
23729 val
= make_number (1);
23730 if (NILP (face_name
))
23732 height
= it
->ascent
+ it
->descent
;
23737 if (NILP (face_name
))
23739 font
= FRAME_FONT (it
->f
);
23740 boff
= FRAME_BASELINE_OFFSET (it
->f
);
23742 else if (EQ (face_name
, Qt
))
23751 face_id
= lookup_named_face (it
->f
, face_name
, 0);
23753 return make_number (-1);
23755 face
= FACE_FROM_ID (it
->f
, face_id
);
23758 return make_number (-1);
23759 boff
= font
->baseline_offset
;
23760 if (font
->vertical_centering
)
23761 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
23764 ascent
= FONT_BASE (font
) + boff
;
23765 descent
= FONT_DESCENT (font
) - boff
;
23769 it
->override_ascent
= ascent
;
23770 it
->override_descent
= descent
;
23771 it
->override_boff
= boff
;
23774 height
= ascent
+ descent
;
23778 height
= (int)(XFLOAT_DATA (val
) * height
);
23779 else if (INTEGERP (val
))
23780 height
*= XINT (val
);
23782 return make_number (height
);
23786 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
23787 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
23788 and only if this is for a character for which no font was found.
23790 If the display method (it->glyphless_method) is
23791 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
23792 length of the acronym or the hexadecimal string, UPPER_XOFF and
23793 UPPER_YOFF are pixel offsets for the upper part of the string,
23794 LOWER_XOFF and LOWER_YOFF are for the lower part.
23796 For the other display methods, LEN through LOWER_YOFF are zero. */
23799 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
23800 short upper_xoff
, short upper_yoff
,
23801 short lower_xoff
, short lower_yoff
)
23803 struct glyph
*glyph
;
23804 enum glyph_row_area area
= it
->area
;
23806 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
23807 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
23809 /* If the glyph row is reversed, we need to prepend the glyph
23810 rather than append it. */
23811 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
23815 /* Make room for the additional glyph. */
23816 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
23818 glyph
= it
->glyph_row
->glyphs
[area
];
23820 glyph
->charpos
= CHARPOS (it
->position
);
23821 glyph
->object
= it
->object
;
23822 glyph
->pixel_width
= it
->pixel_width
;
23823 glyph
->ascent
= it
->ascent
;
23824 glyph
->descent
= it
->descent
;
23825 glyph
->voffset
= it
->voffset
;
23826 glyph
->type
= GLYPHLESS_GLYPH
;
23827 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
23828 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
23829 glyph
->u
.glyphless
.len
= len
;
23830 glyph
->u
.glyphless
.ch
= it
->c
;
23831 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
23832 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
23833 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
23834 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
23835 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
23836 glyph
->multibyte_p
= it
->multibyte_p
;
23837 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
23838 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
23839 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
23840 || it
->phys_descent
> it
->descent
);
23841 glyph
->padding_p
= 0;
23842 glyph
->glyph_not_available_p
= 0;
23843 glyph
->face_id
= face_id
;
23844 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
23847 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
23848 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
23850 glyph
->bidi_type
= it
->bidi_it
.type
;
23852 ++it
->glyph_row
->used
[area
];
23855 IT_EXPAND_MATRIX_WIDTH (it
, area
);
23859 /* Produce a glyph for a glyphless character for iterator IT.
23860 IT->glyphless_method specifies which method to use for displaying
23861 the character. See the description of enum
23862 glyphless_display_method in dispextern.h for the detail.
23864 FOR_NO_FONT is nonzero if and only if this is for a character for
23865 which no font was found. ACRONYM, if non-nil, is an acronym string
23866 for the character. */
23869 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
23874 int base_width
, base_height
, width
, height
;
23875 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
23878 /* Get the metrics of the base font. We always refer to the current
23880 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
23881 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23882 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
23883 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
23884 base_height
= it
->ascent
+ it
->descent
;
23885 base_width
= font
->average_width
;
23887 /* Get a face ID for the glyph by utilizing a cache (the same way as
23888 done for `escape-glyph' in get_next_display_element). */
23889 if (it
->f
== last_glyphless_glyph_frame
23890 && it
->face_id
== last_glyphless_glyph_face_id
)
23892 face_id
= last_glyphless_glyph_merged_face_id
;
23896 /* Merge the `glyphless-char' face into the current face. */
23897 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
23898 last_glyphless_glyph_frame
= it
->f
;
23899 last_glyphless_glyph_face_id
= it
->face_id
;
23900 last_glyphless_glyph_merged_face_id
= face_id
;
23903 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
23905 it
->pixel_width
= THIN_SPACE_WIDTH
;
23907 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23909 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
23911 width
= CHAR_WIDTH (it
->c
);
23914 else if (width
> 4)
23916 it
->pixel_width
= base_width
* width
;
23918 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
23924 unsigned int code
[6];
23926 int ascent
, descent
;
23927 struct font_metrics metrics_upper
, metrics_lower
;
23929 face
= FACE_FROM_ID (it
->f
, face_id
);
23930 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
23931 PREPARE_FACE_FOR_DISPLAY (it
->f
, face
);
23933 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
23935 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
23936 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
23937 if (CONSP (acronym
))
23938 acronym
= XCAR (acronym
);
23939 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
23943 xassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
23944 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
23947 for (len
= 0; str
[len
] && ASCII_BYTE_P (str
[len
]); len
++)
23948 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
23949 upper_len
= (len
+ 1) / 2;
23950 font
->driver
->text_extents (font
, code
, upper_len
,
23952 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
23957 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
23958 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
23959 upper_xoff
= upper_yoff
= 2; /* the typical case */
23960 if (base_width
>= width
)
23962 /* Align the upper to the left, the lower to the right. */
23963 it
->pixel_width
= base_width
;
23964 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
23968 /* Center the shorter one. */
23969 it
->pixel_width
= width
;
23970 if (metrics_upper
.width
>= metrics_lower
.width
)
23971 lower_xoff
= (width
- metrics_lower
.width
) / 2;
23974 /* FIXME: This code doesn't look right. It formerly was
23975 missing the "lower_xoff = 0;", which couldn't have
23976 been right since it left lower_xoff uninitialized. */
23978 upper_xoff
= (width
- metrics_upper
.width
) / 2;
23982 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
23983 top, bottom, and between upper and lower strings. */
23984 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
23985 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
23986 /* Center vertically.
23987 H:base_height, D:base_descent
23988 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
23990 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
23991 descent = D - H/2 + h/2;
23992 lower_yoff = descent - 2 - ld;
23993 upper_yoff = lower_yoff - la - 1 - ud; */
23994 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
23995 descent
= it
->descent
- (base_height
- height
) / 2;
23996 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
23997 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
23998 - metrics_upper
.descent
);
23999 /* Don't make the height shorter than the base height. */
24000 if (height
> base_height
)
24002 it
->ascent
= ascent
;
24003 it
->descent
= descent
;
24007 it
->phys_ascent
= it
->ascent
;
24008 it
->phys_descent
= it
->descent
;
24010 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
24011 upper_xoff
, upper_yoff
,
24012 lower_xoff
, lower_yoff
);
24014 take_vertical_position_into_account (it
);
24019 Produce glyphs/get display metrics for the display element IT is
24020 loaded with. See the description of struct it in dispextern.h
24021 for an overview of struct it. */
24024 x_produce_glyphs (struct it
*it
)
24026 int extra_line_spacing
= it
->extra_line_spacing
;
24028 it
->glyph_not_available_p
= 0;
24030 if (it
->what
== IT_CHARACTER
)
24033 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24034 struct font
*font
= face
->font
;
24035 struct font_metrics
*pcm
= NULL
;
24036 int boff
; /* baseline offset */
24040 /* When no suitable font is found, display this character by
24041 the method specified in the first extra slot of
24042 Vglyphless_char_display. */
24043 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
24045 xassert (it
->what
== IT_GLYPHLESS
);
24046 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
24050 boff
= font
->baseline_offset
;
24051 if (font
->vertical_centering
)
24052 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24054 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
24060 if (it
->override_ascent
>= 0)
24062 it
->ascent
= it
->override_ascent
;
24063 it
->descent
= it
->override_descent
;
24064 boff
= it
->override_boff
;
24068 it
->ascent
= FONT_BASE (font
) + boff
;
24069 it
->descent
= FONT_DESCENT (font
) - boff
;
24072 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
24074 pcm
= get_per_char_metric (font
, &char2b
);
24075 if (pcm
->width
== 0
24076 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
24082 it
->phys_ascent
= pcm
->ascent
+ boff
;
24083 it
->phys_descent
= pcm
->descent
- boff
;
24084 it
->pixel_width
= pcm
->width
;
24088 it
->glyph_not_available_p
= 1;
24089 it
->phys_ascent
= it
->ascent
;
24090 it
->phys_descent
= it
->descent
;
24091 it
->pixel_width
= font
->space_width
;
24094 if (it
->constrain_row_ascent_descent_p
)
24096 if (it
->descent
> it
->max_descent
)
24098 it
->ascent
+= it
->descent
- it
->max_descent
;
24099 it
->descent
= it
->max_descent
;
24101 if (it
->ascent
> it
->max_ascent
)
24103 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24104 it
->ascent
= it
->max_ascent
;
24106 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24107 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24108 extra_line_spacing
= 0;
24111 /* If this is a space inside a region of text with
24112 `space-width' property, change its width. */
24113 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
24115 it
->pixel_width
*= XFLOATINT (it
->space_width
);
24117 /* If face has a box, add the box thickness to the character
24118 height. If character has a box line to the left and/or
24119 right, add the box line width to the character's width. */
24120 if (face
->box
!= FACE_NO_BOX
)
24122 int thick
= face
->box_line_width
;
24126 it
->ascent
+= thick
;
24127 it
->descent
+= thick
;
24132 if (it
->start_of_box_run_p
)
24133 it
->pixel_width
+= thick
;
24134 if (it
->end_of_box_run_p
)
24135 it
->pixel_width
+= thick
;
24138 /* If face has an overline, add the height of the overline
24139 (1 pixel) and a 1 pixel margin to the character height. */
24140 if (face
->overline_p
)
24141 it
->ascent
+= overline_margin
;
24143 if (it
->constrain_row_ascent_descent_p
)
24145 if (it
->ascent
> it
->max_ascent
)
24146 it
->ascent
= it
->max_ascent
;
24147 if (it
->descent
> it
->max_descent
)
24148 it
->descent
= it
->max_descent
;
24151 take_vertical_position_into_account (it
);
24153 /* If we have to actually produce glyphs, do it. */
24158 /* Translate a space with a `space-width' property
24159 into a stretch glyph. */
24160 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
24161 / FONT_HEIGHT (font
));
24162 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24163 it
->ascent
+ it
->descent
, ascent
);
24168 /* If characters with lbearing or rbearing are displayed
24169 in this line, record that fact in a flag of the
24170 glyph row. This is used to optimize X output code. */
24171 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
24172 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24174 if (! stretched_p
&& it
->pixel_width
== 0)
24175 /* We assure that all visible glyphs have at least 1-pixel
24177 it
->pixel_width
= 1;
24179 else if (it
->char_to_display
== '\n')
24181 /* A newline has no width, but we need the height of the
24182 line. But if previous part of the line sets a height,
24183 don't increase that height */
24185 Lisp_Object height
;
24186 Lisp_Object total_height
= Qnil
;
24188 it
->override_ascent
= -1;
24189 it
->pixel_width
= 0;
24192 height
= get_it_property (it
, Qline_height
);
24193 /* Split (line-height total-height) list */
24195 && CONSP (XCDR (height
))
24196 && NILP (XCDR (XCDR (height
))))
24198 total_height
= XCAR (XCDR (height
));
24199 height
= XCAR (height
);
24201 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
24203 if (it
->override_ascent
>= 0)
24205 it
->ascent
= it
->override_ascent
;
24206 it
->descent
= it
->override_descent
;
24207 boff
= it
->override_boff
;
24211 it
->ascent
= FONT_BASE (font
) + boff
;
24212 it
->descent
= FONT_DESCENT (font
) - boff
;
24215 if (EQ (height
, Qt
))
24217 if (it
->descent
> it
->max_descent
)
24219 it
->ascent
+= it
->descent
- it
->max_descent
;
24220 it
->descent
= it
->max_descent
;
24222 if (it
->ascent
> it
->max_ascent
)
24224 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
24225 it
->ascent
= it
->max_ascent
;
24227 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
24228 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
24229 it
->constrain_row_ascent_descent_p
= 1;
24230 extra_line_spacing
= 0;
24234 Lisp_Object spacing
;
24236 it
->phys_ascent
= it
->ascent
;
24237 it
->phys_descent
= it
->descent
;
24239 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
24240 && face
->box
!= FACE_NO_BOX
24241 && face
->box_line_width
> 0)
24243 it
->ascent
+= face
->box_line_width
;
24244 it
->descent
+= face
->box_line_width
;
24247 && XINT (height
) > it
->ascent
+ it
->descent
)
24248 it
->ascent
= XINT (height
) - it
->descent
;
24250 if (!NILP (total_height
))
24251 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
24254 spacing
= get_it_property (it
, Qline_spacing
);
24255 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
24257 if (INTEGERP (spacing
))
24259 extra_line_spacing
= XINT (spacing
);
24260 if (!NILP (total_height
))
24261 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
24265 else /* i.e. (it->char_to_display == '\t') */
24267 if (font
->space_width
> 0)
24269 int tab_width
= it
->tab_width
* font
->space_width
;
24270 int x
= it
->current_x
+ it
->continuation_lines_width
;
24271 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
24273 /* If the distance from the current position to the next tab
24274 stop is less than a space character width, use the
24275 tab stop after that. */
24276 if (next_tab_x
- x
< font
->space_width
)
24277 next_tab_x
+= tab_width
;
24279 it
->pixel_width
= next_tab_x
- x
;
24281 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
24282 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
24286 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
24287 it
->ascent
+ it
->descent
, it
->ascent
);
24292 it
->pixel_width
= 0;
24297 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
24299 /* A static composition.
24301 Note: A composition is represented as one glyph in the
24302 glyph matrix. There are no padding glyphs.
24304 Important note: pixel_width, ascent, and descent are the
24305 values of what is drawn by draw_glyphs (i.e. the values of
24306 the overall glyphs composed). */
24307 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24308 int boff
; /* baseline offset */
24309 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
24310 int glyph_len
= cmp
->glyph_len
;
24311 struct font
*font
= face
->font
;
24315 /* If we have not yet calculated pixel size data of glyphs of
24316 the composition for the current face font, calculate them
24317 now. Theoretically, we have to check all fonts for the
24318 glyphs, but that requires much time and memory space. So,
24319 here we check only the font of the first glyph. This may
24320 lead to incorrect display, but it's very rare, and C-l
24321 (recenter-top-bottom) can correct the display anyway. */
24322 if (! cmp
->font
|| cmp
->font
!= font
)
24324 /* Ascent and descent of the font of the first character
24325 of this composition (adjusted by baseline offset).
24326 Ascent and descent of overall glyphs should not be less
24327 than these, respectively. */
24328 int font_ascent
, font_descent
, font_height
;
24329 /* Bounding box of the overall glyphs. */
24330 int leftmost
, rightmost
, lowest
, highest
;
24331 int lbearing
, rbearing
;
24332 int i
, width
, ascent
, descent
;
24333 int left_padded
= 0, right_padded
= 0;
24334 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
24336 struct font_metrics
*pcm
;
24337 int font_not_found_p
;
24340 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
24341 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
24343 if (glyph_len
< cmp
->glyph_len
)
24345 for (i
= 0; i
< glyph_len
; i
++)
24347 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
24349 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24354 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
24355 : IT_CHARPOS (*it
));
24356 /* If no suitable font is found, use the default font. */
24357 font_not_found_p
= font
== NULL
;
24358 if (font_not_found_p
)
24360 face
= face
->ascii_face
;
24363 boff
= font
->baseline_offset
;
24364 if (font
->vertical_centering
)
24365 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
24366 font_ascent
= FONT_BASE (font
) + boff
;
24367 font_descent
= FONT_DESCENT (font
) - boff
;
24368 font_height
= FONT_HEIGHT (font
);
24370 cmp
->font
= (void *) font
;
24373 if (! font_not_found_p
)
24375 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
24377 pcm
= get_per_char_metric (font
, &char2b
);
24380 /* Initialize the bounding box. */
24383 width
= pcm
->width
;
24384 ascent
= pcm
->ascent
;
24385 descent
= pcm
->descent
;
24386 lbearing
= pcm
->lbearing
;
24387 rbearing
= pcm
->rbearing
;
24391 width
= font
->space_width
;
24392 ascent
= FONT_BASE (font
);
24393 descent
= FONT_DESCENT (font
);
24400 lowest
= - descent
+ boff
;
24401 highest
= ascent
+ boff
;
24403 if (! font_not_found_p
24404 && font
->default_ascent
24405 && CHAR_TABLE_P (Vuse_default_ascent
)
24406 && !NILP (Faref (Vuse_default_ascent
,
24407 make_number (it
->char_to_display
))))
24408 highest
= font
->default_ascent
+ boff
;
24410 /* Draw the first glyph at the normal position. It may be
24411 shifted to right later if some other glyphs are drawn
24413 cmp
->offsets
[i
* 2] = 0;
24414 cmp
->offsets
[i
* 2 + 1] = boff
;
24415 cmp
->lbearing
= lbearing
;
24416 cmp
->rbearing
= rbearing
;
24418 /* Set cmp->offsets for the remaining glyphs. */
24419 for (i
++; i
< glyph_len
; i
++)
24421 int left
, right
, btm
, top
;
24422 int ch
= COMPOSITION_GLYPH (cmp
, i
);
24424 struct face
*this_face
;
24428 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
24429 this_face
= FACE_FROM_ID (it
->f
, face_id
);
24430 font
= this_face
->font
;
24436 get_char_face_and_encoding (it
->f
, ch
, face_id
,
24438 pcm
= get_per_char_metric (font
, &char2b
);
24441 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
24444 width
= pcm
->width
;
24445 ascent
= pcm
->ascent
;
24446 descent
= pcm
->descent
;
24447 lbearing
= pcm
->lbearing
;
24448 rbearing
= pcm
->rbearing
;
24449 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
24451 /* Relative composition with or without
24452 alternate chars. */
24453 left
= (leftmost
+ rightmost
- width
) / 2;
24454 btm
= - descent
+ boff
;
24455 if (font
->relative_compose
24456 && (! CHAR_TABLE_P (Vignore_relative_composition
)
24457 || NILP (Faref (Vignore_relative_composition
,
24458 make_number (ch
)))))
24461 if (- descent
>= font
->relative_compose
)
24462 /* One extra pixel between two glyphs. */
24464 else if (ascent
<= 0)
24465 /* One extra pixel between two glyphs. */
24466 btm
= lowest
- 1 - ascent
- descent
;
24471 /* A composition rule is specified by an integer
24472 value that encodes global and new reference
24473 points (GREF and NREF). GREF and NREF are
24474 specified by numbers as below:
24476 0---1---2 -- ascent
24480 9--10--11 -- center
24482 ---3---4---5--- baseline
24484 6---7---8 -- descent
24486 int rule
= COMPOSITION_RULE (cmp
, i
);
24487 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
24489 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
24490 grefx
= gref
% 3, nrefx
= nref
% 3;
24491 grefy
= gref
/ 3, nrefy
= nref
/ 3;
24493 xoff
= font_height
* (xoff
- 128) / 256;
24495 yoff
= font_height
* (yoff
- 128) / 256;
24498 + grefx
* (rightmost
- leftmost
) / 2
24499 - nrefx
* width
/ 2
24502 btm
= ((grefy
== 0 ? highest
24504 : grefy
== 2 ? lowest
24505 : (highest
+ lowest
) / 2)
24506 - (nrefy
== 0 ? ascent
+ descent
24507 : nrefy
== 1 ? descent
- boff
24509 : (ascent
+ descent
) / 2)
24513 cmp
->offsets
[i
* 2] = left
;
24514 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
24516 /* Update the bounding box of the overall glyphs. */
24519 right
= left
+ width
;
24520 if (left
< leftmost
)
24522 if (right
> rightmost
)
24525 top
= btm
+ descent
+ ascent
;
24531 if (cmp
->lbearing
> left
+ lbearing
)
24532 cmp
->lbearing
= left
+ lbearing
;
24533 if (cmp
->rbearing
< left
+ rbearing
)
24534 cmp
->rbearing
= left
+ rbearing
;
24538 /* If there are glyphs whose x-offsets are negative,
24539 shift all glyphs to the right and make all x-offsets
24543 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24544 cmp
->offsets
[i
* 2] -= leftmost
;
24545 rightmost
-= leftmost
;
24546 cmp
->lbearing
-= leftmost
;
24547 cmp
->rbearing
-= leftmost
;
24550 if (left_padded
&& cmp
->lbearing
< 0)
24552 for (i
= 0; i
< cmp
->glyph_len
; i
++)
24553 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
24554 rightmost
-= cmp
->lbearing
;
24555 cmp
->rbearing
-= cmp
->lbearing
;
24558 if (right_padded
&& rightmost
< cmp
->rbearing
)
24560 rightmost
= cmp
->rbearing
;
24563 cmp
->pixel_width
= rightmost
;
24564 cmp
->ascent
= highest
;
24565 cmp
->descent
= - lowest
;
24566 if (cmp
->ascent
< font_ascent
)
24567 cmp
->ascent
= font_ascent
;
24568 if (cmp
->descent
< font_descent
)
24569 cmp
->descent
= font_descent
;
24573 && (cmp
->lbearing
< 0
24574 || cmp
->rbearing
> cmp
->pixel_width
))
24575 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24577 it
->pixel_width
= cmp
->pixel_width
;
24578 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
24579 it
->descent
= it
->phys_descent
= cmp
->descent
;
24580 if (face
->box
!= FACE_NO_BOX
)
24582 int thick
= face
->box_line_width
;
24586 it
->ascent
+= thick
;
24587 it
->descent
+= thick
;
24592 if (it
->start_of_box_run_p
)
24593 it
->pixel_width
+= thick
;
24594 if (it
->end_of_box_run_p
)
24595 it
->pixel_width
+= thick
;
24598 /* If face has an overline, add the height of the overline
24599 (1 pixel) and a 1 pixel margin to the character height. */
24600 if (face
->overline_p
)
24601 it
->ascent
+= overline_margin
;
24603 take_vertical_position_into_account (it
);
24604 if (it
->ascent
< 0)
24606 if (it
->descent
< 0)
24610 append_composite_glyph (it
);
24612 else if (it
->what
== IT_COMPOSITION
)
24614 /* A dynamic (automatic) composition. */
24615 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24616 Lisp_Object gstring
;
24617 struct font_metrics metrics
;
24621 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
24623 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
24626 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
24627 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
24628 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
24629 it
->descent
= it
->phys_descent
= metrics
.descent
;
24630 if (face
->box
!= FACE_NO_BOX
)
24632 int thick
= face
->box_line_width
;
24636 it
->ascent
+= thick
;
24637 it
->descent
+= thick
;
24642 if (it
->start_of_box_run_p
)
24643 it
->pixel_width
+= thick
;
24644 if (it
->end_of_box_run_p
)
24645 it
->pixel_width
+= thick
;
24647 /* If face has an overline, add the height of the overline
24648 (1 pixel) and a 1 pixel margin to the character height. */
24649 if (face
->overline_p
)
24650 it
->ascent
+= overline_margin
;
24651 take_vertical_position_into_account (it
);
24652 if (it
->ascent
< 0)
24654 if (it
->descent
< 0)
24658 append_composite_glyph (it
);
24660 else if (it
->what
== IT_GLYPHLESS
)
24661 produce_glyphless_glyph (it
, 0, Qnil
);
24662 else if (it
->what
== IT_IMAGE
)
24663 produce_image_glyph (it
);
24664 else if (it
->what
== IT_STRETCH
)
24665 produce_stretch_glyph (it
);
24668 /* Accumulate dimensions. Note: can't assume that it->descent > 0
24669 because this isn't true for images with `:ascent 100'. */
24670 xassert (it
->ascent
>= 0 && it
->descent
>= 0);
24671 if (it
->area
== TEXT_AREA
)
24672 it
->current_x
+= it
->pixel_width
;
24674 if (extra_line_spacing
> 0)
24676 it
->descent
+= extra_line_spacing
;
24677 if (extra_line_spacing
> it
->max_extra_line_spacing
)
24678 it
->max_extra_line_spacing
= extra_line_spacing
;
24681 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
24682 it
->max_descent
= max (it
->max_descent
, it
->descent
);
24683 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
24684 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
24688 Output LEN glyphs starting at START at the nominal cursor position.
24689 Advance the nominal cursor over the text. The global variable
24690 updated_window contains the window being updated, updated_row is
24691 the glyph row being updated, and updated_area is the area of that
24692 row being updated. */
24695 x_write_glyphs (struct glyph
*start
, int len
)
24697 int x
, hpos
, chpos
= updated_window
->phys_cursor
.hpos
;
24699 xassert (updated_window
&& updated_row
);
24700 /* When the window is hscrolled, cursor hpos can legitimately be out
24701 of bounds, but we draw the cursor at the corresponding window
24702 margin in that case. */
24703 if (!updated_row
->reversed_p
&& chpos
< 0)
24705 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
24706 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
24710 /* Write glyphs. */
24712 hpos
= start
- updated_row
->glyphs
[updated_area
];
24713 x
= draw_glyphs (updated_window
, output_cursor
.x
,
24714 updated_row
, updated_area
,
24716 DRAW_NORMAL_TEXT
, 0);
24718 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
24719 if (updated_area
== TEXT_AREA
24720 && updated_window
->phys_cursor_on_p
24721 && updated_window
->phys_cursor
.vpos
== output_cursor
.vpos
24723 && chpos
< hpos
+ len
)
24724 updated_window
->phys_cursor_on_p
= 0;
24728 /* Advance the output cursor. */
24729 output_cursor
.hpos
+= len
;
24730 output_cursor
.x
= x
;
24735 Insert LEN glyphs from START at the nominal cursor position. */
24738 x_insert_glyphs (struct glyph
*start
, int len
)
24742 int line_height
, shift_by_width
, shifted_region_width
;
24743 struct glyph_row
*row
;
24744 struct glyph
*glyph
;
24745 int frame_x
, frame_y
;
24748 xassert (updated_window
&& updated_row
);
24750 w
= updated_window
;
24751 f
= XFRAME (WINDOW_FRAME (w
));
24753 /* Get the height of the line we are in. */
24755 line_height
= row
->height
;
24757 /* Get the width of the glyphs to insert. */
24758 shift_by_width
= 0;
24759 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
24760 shift_by_width
+= glyph
->pixel_width
;
24762 /* Get the width of the region to shift right. */
24763 shifted_region_width
= (window_box_width (w
, updated_area
)
24768 frame_x
= window_box_left (w
, updated_area
) + output_cursor
.x
;
24769 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, output_cursor
.y
);
24771 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
24772 line_height
, shift_by_width
);
24774 /* Write the glyphs. */
24775 hpos
= start
- row
->glyphs
[updated_area
];
24776 draw_glyphs (w
, output_cursor
.x
, row
, updated_area
,
24778 DRAW_NORMAL_TEXT
, 0);
24780 /* Advance the output cursor. */
24781 output_cursor
.hpos
+= len
;
24782 output_cursor
.x
+= shift_by_width
;
24788 Erase the current text line from the nominal cursor position
24789 (inclusive) to pixel column TO_X (exclusive). The idea is that
24790 everything from TO_X onward is already erased.
24792 TO_X is a pixel position relative to updated_area of
24793 updated_window. TO_X == -1 means clear to the end of this area. */
24796 x_clear_end_of_line (int to_x
)
24799 struct window
*w
= updated_window
;
24800 int max_x
, min_y
, max_y
;
24801 int from_x
, from_y
, to_y
;
24803 xassert (updated_window
&& updated_row
);
24804 f
= XFRAME (w
->frame
);
24806 if (updated_row
->full_width_p
)
24807 max_x
= WINDOW_TOTAL_WIDTH (w
);
24809 max_x
= window_box_width (w
, updated_area
);
24810 max_y
= window_text_bottom_y (w
);
24812 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
24813 of window. For TO_X > 0, truncate to end of drawing area. */
24819 to_x
= min (to_x
, max_x
);
24821 to_y
= min (max_y
, output_cursor
.y
+ updated_row
->height
);
24823 /* Notice if the cursor will be cleared by this operation. */
24824 if (!updated_row
->full_width_p
)
24825 notice_overwritten_cursor (w
, updated_area
,
24826 output_cursor
.x
, -1,
24828 MATRIX_ROW_BOTTOM_Y (updated_row
));
24830 from_x
= output_cursor
.x
;
24832 /* Translate to frame coordinates. */
24833 if (updated_row
->full_width_p
)
24835 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
24836 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
24840 int area_left
= window_box_left (w
, updated_area
);
24841 from_x
+= area_left
;
24845 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
24846 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, output_cursor
.y
));
24847 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
24849 /* Prevent inadvertently clearing to end of the X window. */
24850 if (to_x
> from_x
&& to_y
> from_y
)
24853 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
24854 to_x
- from_x
, to_y
- from_y
);
24859 #endif /* HAVE_WINDOW_SYSTEM */
24863 /***********************************************************************
24865 ***********************************************************************/
24867 /* Value is the internal representation of the specified cursor type
24868 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
24869 of the bar cursor. */
24871 static enum text_cursor_kinds
24872 get_specified_cursor_type (Lisp_Object arg
, int *width
)
24874 enum text_cursor_kinds type
;
24879 if (EQ (arg
, Qbox
))
24880 return FILLED_BOX_CURSOR
;
24882 if (EQ (arg
, Qhollow
))
24883 return HOLLOW_BOX_CURSOR
;
24885 if (EQ (arg
, Qbar
))
24892 && EQ (XCAR (arg
), Qbar
)
24893 && INTEGERP (XCDR (arg
))
24894 && XINT (XCDR (arg
)) >= 0)
24896 *width
= XINT (XCDR (arg
));
24900 if (EQ (arg
, Qhbar
))
24903 return HBAR_CURSOR
;
24907 && EQ (XCAR (arg
), Qhbar
)
24908 && INTEGERP (XCDR (arg
))
24909 && XINT (XCDR (arg
)) >= 0)
24911 *width
= XINT (XCDR (arg
));
24912 return HBAR_CURSOR
;
24915 /* Treat anything unknown as "hollow box cursor".
24916 It was bad to signal an error; people have trouble fixing
24917 .Xdefaults with Emacs, when it has something bad in it. */
24918 type
= HOLLOW_BOX_CURSOR
;
24923 /* Set the default cursor types for specified frame. */
24925 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
24930 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
24931 FRAME_CURSOR_WIDTH (f
) = width
;
24933 /* By default, set up the blink-off state depending on the on-state. */
24935 tem
= Fassoc (arg
, Vblink_cursor_alist
);
24938 FRAME_BLINK_OFF_CURSOR (f
)
24939 = get_specified_cursor_type (XCDR (tem
), &width
);
24940 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
24943 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
24947 #ifdef HAVE_WINDOW_SYSTEM
24949 /* Return the cursor we want to be displayed in window W. Return
24950 width of bar/hbar cursor through WIDTH arg. Return with
24951 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
24952 (i.e. if the `system caret' should track this cursor).
24954 In a mini-buffer window, we want the cursor only to appear if we
24955 are reading input from this window. For the selected window, we
24956 want the cursor type given by the frame parameter or buffer local
24957 setting of cursor-type. If explicitly marked off, draw no cursor.
24958 In all other cases, we want a hollow box cursor. */
24960 static enum text_cursor_kinds
24961 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
24962 int *active_cursor
)
24964 struct frame
*f
= XFRAME (w
->frame
);
24965 struct buffer
*b
= XBUFFER (w
->buffer
);
24966 int cursor_type
= DEFAULT_CURSOR
;
24967 Lisp_Object alt_cursor
;
24968 int non_selected
= 0;
24970 *active_cursor
= 1;
24973 if (cursor_in_echo_area
24974 && FRAME_HAS_MINIBUF_P (f
)
24975 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
24977 if (w
== XWINDOW (echo_area_window
))
24979 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
24981 *width
= FRAME_CURSOR_WIDTH (f
);
24982 return FRAME_DESIRED_CURSOR (f
);
24985 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
24988 *active_cursor
= 0;
24992 /* Detect a nonselected window or nonselected frame. */
24993 else if (w
!= XWINDOW (f
->selected_window
)
24994 || f
!= FRAME_X_DISPLAY_INFO (f
)->x_highlight_frame
)
24996 *active_cursor
= 0;
24998 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
25004 /* Never display a cursor in a window in which cursor-type is nil. */
25005 if (NILP (BVAR (b
, cursor_type
)))
25008 /* Get the normal cursor type for this window. */
25009 if (EQ (BVAR (b
, cursor_type
), Qt
))
25011 cursor_type
= FRAME_DESIRED_CURSOR (f
);
25012 *width
= FRAME_CURSOR_WIDTH (f
);
25015 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
25017 /* Use cursor-in-non-selected-windows instead
25018 for non-selected window or frame. */
25021 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
25022 if (!EQ (Qt
, alt_cursor
))
25023 return get_specified_cursor_type (alt_cursor
, width
);
25024 /* t means modify the normal cursor type. */
25025 if (cursor_type
== FILLED_BOX_CURSOR
)
25026 cursor_type
= HOLLOW_BOX_CURSOR
;
25027 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
25029 return cursor_type
;
25032 /* Use normal cursor if not blinked off. */
25033 if (!w
->cursor_off_p
)
25035 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
25037 if (cursor_type
== FILLED_BOX_CURSOR
)
25039 /* Using a block cursor on large images can be very annoying.
25040 So use a hollow cursor for "large" images.
25041 If image is not transparent (no mask), also use hollow cursor. */
25042 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
25043 if (img
!= NULL
&& IMAGEP (img
->spec
))
25045 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
25046 where N = size of default frame font size.
25047 This should cover most of the "tiny" icons people may use. */
25049 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
25050 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
25051 cursor_type
= HOLLOW_BOX_CURSOR
;
25054 else if (cursor_type
!= NO_CURSOR
)
25056 /* Display current only supports BOX and HOLLOW cursors for images.
25057 So for now, unconditionally use a HOLLOW cursor when cursor is
25058 not a solid box cursor. */
25059 cursor_type
= HOLLOW_BOX_CURSOR
;
25062 return cursor_type
;
25065 /* Cursor is blinked off, so determine how to "toggle" it. */
25067 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
25068 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
25069 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
25071 /* Then see if frame has specified a specific blink off cursor type. */
25072 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
25074 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
25075 return FRAME_BLINK_OFF_CURSOR (f
);
25079 /* Some people liked having a permanently visible blinking cursor,
25080 while others had very strong opinions against it. So it was
25081 decided to remove it. KFS 2003-09-03 */
25083 /* Finally perform built-in cursor blinking:
25084 filled box <-> hollow box
25085 wide [h]bar <-> narrow [h]bar
25086 narrow [h]bar <-> no cursor
25087 other type <-> no cursor */
25089 if (cursor_type
== FILLED_BOX_CURSOR
)
25090 return HOLLOW_BOX_CURSOR
;
25092 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
25095 return cursor_type
;
25103 /* Notice when the text cursor of window W has been completely
25104 overwritten by a drawing operation that outputs glyphs in AREA
25105 starting at X0 and ending at X1 in the line starting at Y0 and
25106 ending at Y1. X coordinates are area-relative. X1 < 0 means all
25107 the rest of the line after X0 has been written. Y coordinates
25108 are window-relative. */
25111 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
25112 int x0
, int x1
, int y0
, int y1
)
25114 int cx0
, cx1
, cy0
, cy1
;
25115 struct glyph_row
*row
;
25117 if (!w
->phys_cursor_on_p
)
25119 if (area
!= TEXT_AREA
)
25122 if (w
->phys_cursor
.vpos
< 0
25123 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
25124 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
25125 !(row
->enabled_p
&& row
->displays_text_p
)))
25128 if (row
->cursor_in_fringe_p
)
25130 row
->cursor_in_fringe_p
= 0;
25131 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
25132 w
->phys_cursor_on_p
= 0;
25136 cx0
= w
->phys_cursor
.x
;
25137 cx1
= cx0
+ w
->phys_cursor_width
;
25138 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
25141 /* The cursor image will be completely removed from the
25142 screen if the output area intersects the cursor area in
25143 y-direction. When we draw in [y0 y1[, and some part of
25144 the cursor is at y < y0, that part must have been drawn
25145 before. When scrolling, the cursor is erased before
25146 actually scrolling, so we don't come here. When not
25147 scrolling, the rows above the old cursor row must have
25148 changed, and in this case these rows must have written
25149 over the cursor image.
25151 Likewise if part of the cursor is below y1, with the
25152 exception of the cursor being in the first blank row at
25153 the buffer and window end because update_text_area
25154 doesn't draw that row. (Except when it does, but
25155 that's handled in update_text_area.) */
25157 cy0
= w
->phys_cursor
.y
;
25158 cy1
= cy0
+ w
->phys_cursor_height
;
25159 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
25162 w
->phys_cursor_on_p
= 0;
25165 #endif /* HAVE_WINDOW_SYSTEM */
25168 /************************************************************************
25170 ************************************************************************/
25172 #ifdef HAVE_WINDOW_SYSTEM
25175 Fix the display of area AREA of overlapping row ROW in window W
25176 with respect to the overlapping part OVERLAPS. */
25179 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
25180 enum glyph_row_area area
, int overlaps
)
25187 for (i
= 0; i
< row
->used
[area
];)
25189 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
25191 int start
= i
, start_x
= x
;
25195 x
+= row
->glyphs
[area
][i
].pixel_width
;
25198 while (i
< row
->used
[area
]
25199 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
25201 draw_glyphs (w
, start_x
, row
, area
,
25203 DRAW_NORMAL_TEXT
, overlaps
);
25207 x
+= row
->glyphs
[area
][i
].pixel_width
;
25217 Draw the cursor glyph of window W in glyph row ROW. See the
25218 comment of draw_glyphs for the meaning of HL. */
25221 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
25222 enum draw_glyphs_face hl
)
25224 /* If cursor hpos is out of bounds, don't draw garbage. This can
25225 happen in mini-buffer windows when switching between echo area
25226 glyphs and mini-buffer. */
25227 if ((row
->reversed_p
25228 ? (w
->phys_cursor
.hpos
>= 0)
25229 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
25231 int on_p
= w
->phys_cursor_on_p
;
25233 int hpos
= w
->phys_cursor
.hpos
;
25235 /* When the window is hscrolled, cursor hpos can legitimately be
25236 out of bounds, but we draw the cursor at the corresponding
25237 window margin in that case. */
25238 if (!row
->reversed_p
&& hpos
< 0)
25240 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25241 hpos
= row
->used
[TEXT_AREA
] - 1;
25243 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
25245 w
->phys_cursor_on_p
= on_p
;
25247 if (hl
== DRAW_CURSOR
)
25248 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25249 /* When we erase the cursor, and ROW is overlapped by other
25250 rows, make sure that these overlapping parts of other rows
25252 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
25254 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
25256 if (row
> w
->current_matrix
->rows
25257 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
25258 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
25259 OVERLAPS_ERASED_CURSOR
);
25261 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
25262 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
25263 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
25264 OVERLAPS_ERASED_CURSOR
);
25271 Erase the image of a cursor of window W from the screen. */
25274 erase_phys_cursor (struct window
*w
)
25276 struct frame
*f
= XFRAME (w
->frame
);
25277 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25278 int hpos
= w
->phys_cursor
.hpos
;
25279 int vpos
= w
->phys_cursor
.vpos
;
25280 int mouse_face_here_p
= 0;
25281 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
25282 struct glyph_row
*cursor_row
;
25283 struct glyph
*cursor_glyph
;
25284 enum draw_glyphs_face hl
;
25286 /* No cursor displayed or row invalidated => nothing to do on the
25288 if (w
->phys_cursor_type
== NO_CURSOR
)
25289 goto mark_cursor_off
;
25291 /* VPOS >= active_glyphs->nrows means that window has been resized.
25292 Don't bother to erase the cursor. */
25293 if (vpos
>= active_glyphs
->nrows
)
25294 goto mark_cursor_off
;
25296 /* If row containing cursor is marked invalid, there is nothing we
25298 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
25299 if (!cursor_row
->enabled_p
)
25300 goto mark_cursor_off
;
25302 /* If line spacing is > 0, old cursor may only be partially visible in
25303 window after split-window. So adjust visible height. */
25304 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
25305 window_text_bottom_y (w
) - cursor_row
->y
);
25307 /* If row is completely invisible, don't attempt to delete a cursor which
25308 isn't there. This can happen if cursor is at top of a window, and
25309 we switch to a buffer with a header line in that window. */
25310 if (cursor_row
->visible_height
<= 0)
25311 goto mark_cursor_off
;
25313 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
25314 if (cursor_row
->cursor_in_fringe_p
)
25316 cursor_row
->cursor_in_fringe_p
= 0;
25317 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
25318 goto mark_cursor_off
;
25321 /* This can happen when the new row is shorter than the old one.
25322 In this case, either draw_glyphs or clear_end_of_line
25323 should have cleared the cursor. Note that we wouldn't be
25324 able to erase the cursor in this case because we don't have a
25325 cursor glyph at hand. */
25326 if ((cursor_row
->reversed_p
25327 ? (w
->phys_cursor
.hpos
< 0)
25328 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
25329 goto mark_cursor_off
;
25331 /* When the window is hscrolled, cursor hpos can legitimately be out
25332 of bounds, but we draw the cursor at the corresponding window
25333 margin in that case. */
25334 if (!cursor_row
->reversed_p
&& hpos
< 0)
25336 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
25337 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
25339 /* If the cursor is in the mouse face area, redisplay that when
25340 we clear the cursor. */
25341 if (! NILP (hlinfo
->mouse_face_window
)
25342 && coords_in_mouse_face_p (w
, hpos
, vpos
)
25343 /* Don't redraw the cursor's spot in mouse face if it is at the
25344 end of a line (on a newline). The cursor appears there, but
25345 mouse highlighting does not. */
25346 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
25347 mouse_face_here_p
= 1;
25349 /* Maybe clear the display under the cursor. */
25350 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
25353 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
25356 cursor_glyph
= get_phys_cursor_glyph (w
);
25357 if (cursor_glyph
== NULL
)
25358 goto mark_cursor_off
;
25360 width
= cursor_glyph
->pixel_width
;
25361 left_x
= window_box_left_offset (w
, TEXT_AREA
);
25362 x
= w
->phys_cursor
.x
;
25364 width
-= left_x
- x
;
25365 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
25366 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
25367 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
25370 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
25373 /* Erase the cursor by redrawing the character underneath it. */
25374 if (mouse_face_here_p
)
25375 hl
= DRAW_MOUSE_FACE
;
25377 hl
= DRAW_NORMAL_TEXT
;
25378 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
25381 w
->phys_cursor_on_p
= 0;
25382 w
->phys_cursor_type
= NO_CURSOR
;
25387 Display or clear cursor of window W. If ON is zero, clear the
25388 cursor. If it is non-zero, display the cursor. If ON is nonzero,
25389 where to put the cursor is specified by HPOS, VPOS, X and Y. */
25392 display_and_set_cursor (struct window
*w
, int on
,
25393 int hpos
, int vpos
, int x
, int y
)
25395 struct frame
*f
= XFRAME (w
->frame
);
25396 int new_cursor_type
;
25397 int new_cursor_width
;
25399 struct glyph_row
*glyph_row
;
25400 struct glyph
*glyph
;
25402 /* This is pointless on invisible frames, and dangerous on garbaged
25403 windows and frames; in the latter case, the frame or window may
25404 be in the midst of changing its size, and x and y may be off the
25406 if (! FRAME_VISIBLE_P (f
)
25407 || FRAME_GARBAGED_P (f
)
25408 || vpos
>= w
->current_matrix
->nrows
25409 || hpos
>= w
->current_matrix
->matrix_w
)
25412 /* If cursor is off and we want it off, return quickly. */
25413 if (!on
&& !w
->phys_cursor_on_p
)
25416 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25417 /* If cursor row is not enabled, we don't really know where to
25418 display the cursor. */
25419 if (!glyph_row
->enabled_p
)
25421 w
->phys_cursor_on_p
= 0;
25426 if (!glyph_row
->exact_window_width_line_p
25427 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
25428 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
25430 xassert (interrupt_input_blocked
);
25432 /* Set new_cursor_type to the cursor we want to be displayed. */
25433 new_cursor_type
= get_window_cursor_type (w
, glyph
,
25434 &new_cursor_width
, &active_cursor
);
25436 /* If cursor is currently being shown and we don't want it to be or
25437 it is in the wrong place, or the cursor type is not what we want,
25439 if (w
->phys_cursor_on_p
25441 || w
->phys_cursor
.x
!= x
25442 || w
->phys_cursor
.y
!= y
25443 || new_cursor_type
!= w
->phys_cursor_type
25444 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
25445 && new_cursor_width
!= w
->phys_cursor_width
)))
25446 erase_phys_cursor (w
);
25448 /* Don't check phys_cursor_on_p here because that flag is only set
25449 to zero in some cases where we know that the cursor has been
25450 completely erased, to avoid the extra work of erasing the cursor
25451 twice. In other words, phys_cursor_on_p can be 1 and the cursor
25452 still not be visible, or it has only been partly erased. */
25455 w
->phys_cursor_ascent
= glyph_row
->ascent
;
25456 w
->phys_cursor_height
= glyph_row
->height
;
25458 /* Set phys_cursor_.* before x_draw_.* is called because some
25459 of them may need the information. */
25460 w
->phys_cursor
.x
= x
;
25461 w
->phys_cursor
.y
= glyph_row
->y
;
25462 w
->phys_cursor
.hpos
= hpos
;
25463 w
->phys_cursor
.vpos
= vpos
;
25466 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
25467 new_cursor_type
, new_cursor_width
,
25468 on
, active_cursor
);
25472 /* Switch the display of W's cursor on or off, according to the value
25476 update_window_cursor (struct window
*w
, int on
)
25478 /* Don't update cursor in windows whose frame is in the process
25479 of being deleted. */
25480 if (w
->current_matrix
)
25482 int hpos
= w
->phys_cursor
.hpos
;
25483 int vpos
= w
->phys_cursor
.vpos
;
25484 struct glyph_row
*row
;
25486 if (vpos
>= w
->current_matrix
->nrows
25487 || hpos
>= w
->current_matrix
->matrix_w
)
25490 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25492 /* When the window is hscrolled, cursor hpos can legitimately be
25493 out of bounds, but we draw the cursor at the corresponding
25494 window margin in that case. */
25495 if (!row
->reversed_p
&& hpos
< 0)
25497 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25498 hpos
= row
->used
[TEXT_AREA
] - 1;
25501 display_and_set_cursor (w
, on
, hpos
, vpos
,
25502 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25508 /* Call update_window_cursor with parameter ON_P on all leaf windows
25509 in the window tree rooted at W. */
25512 update_cursor_in_window_tree (struct window
*w
, int on_p
)
25516 if (!NILP (w
->hchild
))
25517 update_cursor_in_window_tree (XWINDOW (w
->hchild
), on_p
);
25518 else if (!NILP (w
->vchild
))
25519 update_cursor_in_window_tree (XWINDOW (w
->vchild
), on_p
);
25521 update_window_cursor (w
, on_p
);
25523 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
25529 Display the cursor on window W, or clear it, according to ON_P.
25530 Don't change the cursor's position. */
25533 x_update_cursor (struct frame
*f
, int on_p
)
25535 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
25540 Clear the cursor of window W to background color, and mark the
25541 cursor as not shown. This is used when the text where the cursor
25542 is about to be rewritten. */
25545 x_clear_cursor (struct window
*w
)
25547 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
25548 update_window_cursor (w
, 0);
25551 #endif /* HAVE_WINDOW_SYSTEM */
25553 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
25556 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
25557 int start_hpos
, int end_hpos
,
25558 enum draw_glyphs_face draw
)
25560 #ifdef HAVE_WINDOW_SYSTEM
25561 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
25563 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
25567 #if defined (HAVE_GPM) || defined (MSDOS)
25568 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
25572 /* Display the active region described by mouse_face_* according to DRAW. */
25575 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
25577 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
25578 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
25580 if (/* If window is in the process of being destroyed, don't bother
25582 w
->current_matrix
!= NULL
25583 /* Don't update mouse highlight if hidden */
25584 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
25585 /* Recognize when we are called to operate on rows that don't exist
25586 anymore. This can happen when a window is split. */
25587 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
25589 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
25590 struct glyph_row
*row
, *first
, *last
;
25592 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
25593 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
25595 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
25597 int start_hpos
, end_hpos
, start_x
;
25599 /* For all but the first row, the highlight starts at column 0. */
25602 /* R2L rows have BEG and END in reversed order, but the
25603 screen drawing geometry is always left to right. So
25604 we need to mirror the beginning and end of the
25605 highlighted area in R2L rows. */
25606 if (!row
->reversed_p
)
25608 start_hpos
= hlinfo
->mouse_face_beg_col
;
25609 start_x
= hlinfo
->mouse_face_beg_x
;
25611 else if (row
== last
)
25613 start_hpos
= hlinfo
->mouse_face_end_col
;
25614 start_x
= hlinfo
->mouse_face_end_x
;
25622 else if (row
->reversed_p
&& row
== last
)
25624 start_hpos
= hlinfo
->mouse_face_end_col
;
25625 start_x
= hlinfo
->mouse_face_end_x
;
25635 if (!row
->reversed_p
)
25636 end_hpos
= hlinfo
->mouse_face_end_col
;
25637 else if (row
== first
)
25638 end_hpos
= hlinfo
->mouse_face_beg_col
;
25641 end_hpos
= row
->used
[TEXT_AREA
];
25642 if (draw
== DRAW_NORMAL_TEXT
)
25643 row
->fill_line_p
= 1; /* Clear to end of line */
25646 else if (row
->reversed_p
&& row
== first
)
25647 end_hpos
= hlinfo
->mouse_face_beg_col
;
25650 end_hpos
= row
->used
[TEXT_AREA
];
25651 if (draw
== DRAW_NORMAL_TEXT
)
25652 row
->fill_line_p
= 1; /* Clear to end of line */
25655 if (end_hpos
> start_hpos
)
25657 draw_row_with_mouse_face (w
, start_x
, row
,
25658 start_hpos
, end_hpos
, draw
);
25661 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
25665 #ifdef HAVE_WINDOW_SYSTEM
25666 /* When we've written over the cursor, arrange for it to
25667 be displayed again. */
25668 if (FRAME_WINDOW_P (f
)
25669 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
25671 int hpos
= w
->phys_cursor
.hpos
;
25673 /* When the window is hscrolled, cursor hpos can legitimately be
25674 out of bounds, but we draw the cursor at the corresponding
25675 window margin in that case. */
25676 if (!row
->reversed_p
&& hpos
< 0)
25678 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25679 hpos
= row
->used
[TEXT_AREA
] - 1;
25682 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
25683 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
25686 #endif /* HAVE_WINDOW_SYSTEM */
25689 #ifdef HAVE_WINDOW_SYSTEM
25690 /* Change the mouse cursor. */
25691 if (FRAME_WINDOW_P (f
))
25693 if (draw
== DRAW_NORMAL_TEXT
25694 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
25695 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
25696 else if (draw
== DRAW_MOUSE_FACE
)
25697 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
25699 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
25701 #endif /* HAVE_WINDOW_SYSTEM */
25705 Clear out the mouse-highlighted active region.
25706 Redraw it un-highlighted first. Value is non-zero if mouse
25707 face was actually drawn unhighlighted. */
25710 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
25714 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
25716 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
25720 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
25721 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
25722 hlinfo
->mouse_face_window
= Qnil
;
25723 hlinfo
->mouse_face_overlay
= Qnil
;
25727 /* Return non-zero if the coordinates HPOS and VPOS on windows W are
25728 within the mouse face on that window. */
25730 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
25732 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
25734 /* Quickly resolve the easy cases. */
25735 if (!(WINDOWP (hlinfo
->mouse_face_window
)
25736 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
25738 if (vpos
< hlinfo
->mouse_face_beg_row
25739 || vpos
> hlinfo
->mouse_face_end_row
)
25741 if (vpos
> hlinfo
->mouse_face_beg_row
25742 && vpos
< hlinfo
->mouse_face_end_row
)
25745 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
25747 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25749 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
25752 else if ((vpos
== hlinfo
->mouse_face_beg_row
25753 && hpos
>= hlinfo
->mouse_face_beg_col
)
25754 || (vpos
== hlinfo
->mouse_face_end_row
25755 && hpos
< hlinfo
->mouse_face_end_col
))
25760 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
25762 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
25765 else if ((vpos
== hlinfo
->mouse_face_beg_row
25766 && hpos
<= hlinfo
->mouse_face_beg_col
)
25767 || (vpos
== hlinfo
->mouse_face_end_row
25768 && hpos
> hlinfo
->mouse_face_end_col
))
25776 Non-zero if physical cursor of window W is within mouse face. */
25779 cursor_in_mouse_face_p (struct window
*w
)
25781 int hpos
= w
->phys_cursor
.hpos
;
25782 int vpos
= w
->phys_cursor
.vpos
;
25783 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
25785 /* When the window is hscrolled, cursor hpos can legitimately be out
25786 of bounds, but we draw the cursor at the corresponding window
25787 margin in that case. */
25788 if (!row
->reversed_p
&& hpos
< 0)
25790 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
25791 hpos
= row
->used
[TEXT_AREA
] - 1;
25793 return coords_in_mouse_face_p (w
, hpos
, vpos
);
25798 /* Find the glyph rows START_ROW and END_ROW of window W that display
25799 characters between buffer positions START_CHARPOS and END_CHARPOS
25800 (excluding END_CHARPOS). This is similar to row_containing_pos,
25801 but is more accurate when bidi reordering makes buffer positions
25802 change non-linearly with glyph rows. */
25804 rows_from_pos_range (struct window
*w
,
25805 EMACS_INT start_charpos
, EMACS_INT end_charpos
,
25806 struct glyph_row
**start
, struct glyph_row
**end
)
25808 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25809 int last_y
= window_text_bottom_y (w
);
25810 struct glyph_row
*row
;
25815 while (!first
->enabled_p
25816 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
25819 /* Find the START row. */
25821 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
25824 /* A row can potentially be the START row if the range of the
25825 characters it displays intersects the range
25826 [START_CHARPOS..END_CHARPOS). */
25827 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
25828 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
25829 /* See the commentary in row_containing_pos, for the
25830 explanation of the complicated way to check whether
25831 some position is beyond the end of the characters
25832 displayed by a row. */
25833 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25834 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25835 && !row
->ends_at_zv_p
25836 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
25837 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
25838 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
25839 && !row
->ends_at_zv_p
25840 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
25842 /* Found a candidate row. Now make sure at least one of the
25843 glyphs it displays has a charpos from the range
25844 [START_CHARPOS..END_CHARPOS).
25846 This is not obvious because bidi reordering could make
25847 buffer positions of a row be 1,2,3,102,101,100, and if we
25848 want to highlight characters in [50..60), we don't want
25849 this row, even though [50..60) does intersect [1..103),
25850 the range of character positions given by the row's start
25851 and end positions. */
25852 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
25853 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
25857 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25858 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25867 /* Find the END row. */
25869 /* If the last row is partially visible, start looking for END
25870 from that row, instead of starting from FIRST. */
25871 && !(row
->enabled_p
25872 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
25874 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
25876 struct glyph_row
*next
= row
+ 1;
25878 if (!next
->enabled_p
25879 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
25880 /* The first row >= START whose range of displayed characters
25881 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
25882 is the row END + 1. */
25883 || (start_charpos
< MATRIX_ROW_START_CHARPOS (next
)
25884 && end_charpos
< MATRIX_ROW_START_CHARPOS (next
))
25885 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25886 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25887 && !next
->ends_at_zv_p
25888 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
25889 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
25890 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
25891 && !next
->ends_at_zv_p
25892 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
25899 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
25900 but none of the characters it displays are in the range, it is
25902 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
25903 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
25907 if ((BUFFERP (g
->object
) || INTEGERP (g
->object
))
25908 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
25921 /* This function sets the mouse_face_* elements of HLINFO, assuming
25922 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
25923 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
25924 for the overlay or run of text properties specifying the mouse
25925 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
25926 before-string and after-string that must also be highlighted.
25927 DISP_STRING, if non-nil, is a display string that may cover some
25928 or all of the highlighted text. */
25931 mouse_face_from_buffer_pos (Lisp_Object window
,
25932 Mouse_HLInfo
*hlinfo
,
25933 EMACS_INT mouse_charpos
,
25934 EMACS_INT start_charpos
,
25935 EMACS_INT end_charpos
,
25936 Lisp_Object before_string
,
25937 Lisp_Object after_string
,
25938 Lisp_Object disp_string
)
25940 struct window
*w
= XWINDOW (window
);
25941 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
25942 struct glyph_row
*r1
, *r2
;
25943 struct glyph
*glyph
, *end
;
25944 EMACS_INT ignore
, pos
;
25947 xassert (NILP (disp_string
) || STRINGP (disp_string
));
25948 xassert (NILP (before_string
) || STRINGP (before_string
));
25949 xassert (NILP (after_string
) || STRINGP (after_string
));
25951 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
25952 rows_from_pos_range (w
, start_charpos
, end_charpos
, &r1
, &r2
);
25954 r1
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25955 /* If the before-string or display-string contains newlines,
25956 rows_from_pos_range skips to its last row. Move back. */
25957 if (!NILP (before_string
) || !NILP (disp_string
))
25959 struct glyph_row
*prev
;
25960 while ((prev
= r1
- 1, prev
>= first
)
25961 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
25962 && prev
->used
[TEXT_AREA
] > 0)
25964 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
25965 glyph
= beg
+ prev
->used
[TEXT_AREA
];
25966 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
25968 || !(EQ (glyph
->object
, before_string
)
25969 || EQ (glyph
->object
, disp_string
)))
25976 r2
= MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25977 hlinfo
->mouse_face_past_end
= 1;
25979 else if (!NILP (after_string
))
25981 /* If the after-string has newlines, advance to its last row. */
25982 struct glyph_row
*next
;
25983 struct glyph_row
*last
25984 = MATRIX_ROW (w
->current_matrix
, XFASTINT (w
->window_end_vpos
));
25986 for (next
= r2
+ 1;
25988 && next
->used
[TEXT_AREA
] > 0
25989 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
25993 /* The rest of the display engine assumes that mouse_face_beg_row is
25994 either above mouse_face_end_row or identical to it. But with
25995 bidi-reordered continued lines, the row for START_CHARPOS could
25996 be below the row for END_CHARPOS. If so, swap the rows and store
25997 them in correct order. */
26000 struct glyph_row
*tem
= r2
;
26006 hlinfo
->mouse_face_beg_y
= r1
->y
;
26007 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
26008 hlinfo
->mouse_face_end_y
= r2
->y
;
26009 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
26011 /* For a bidi-reordered row, the positions of BEFORE_STRING,
26012 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
26013 could be anywhere in the row and in any order. The strategy
26014 below is to find the leftmost and the rightmost glyph that
26015 belongs to either of these 3 strings, or whose position is
26016 between START_CHARPOS and END_CHARPOS, and highlight all the
26017 glyphs between those two. This may cover more than just the text
26018 between START_CHARPOS and END_CHARPOS if the range of characters
26019 strides the bidi level boundary, e.g. if the beginning is in R2L
26020 text while the end is in L2R text or vice versa. */
26021 if (!r1
->reversed_p
)
26023 /* This row is in a left to right paragraph. Scan it left to
26025 glyph
= r1
->glyphs
[TEXT_AREA
];
26026 end
= glyph
+ r1
->used
[TEXT_AREA
];
26029 /* Skip truncation glyphs at the start of the glyph row. */
26030 if (r1
->displays_text_p
)
26032 && INTEGERP (glyph
->object
)
26033 && glyph
->charpos
< 0;
26035 x
+= glyph
->pixel_width
;
26037 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26038 or DISP_STRING, and the first glyph from buffer whose
26039 position is between START_CHARPOS and END_CHARPOS. */
26041 && !INTEGERP (glyph
->object
)
26042 && !EQ (glyph
->object
, disp_string
)
26043 && !(BUFFERP (glyph
->object
)
26044 && (glyph
->charpos
>= start_charpos
26045 && glyph
->charpos
< end_charpos
));
26048 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26049 are present at buffer positions between START_CHARPOS and
26050 END_CHARPOS, or if they come from an overlay. */
26051 if (EQ (glyph
->object
, before_string
))
26053 pos
= string_buffer_position (before_string
,
26055 /* If pos == 0, it means before_string came from an
26056 overlay, not from a buffer position. */
26057 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26060 else if (EQ (glyph
->object
, after_string
))
26062 pos
= string_buffer_position (after_string
, end_charpos
);
26063 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26066 x
+= glyph
->pixel_width
;
26068 hlinfo
->mouse_face_beg_x
= x
;
26069 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26073 /* This row is in a right to left paragraph. Scan it right to
26077 end
= r1
->glyphs
[TEXT_AREA
] - 1;
26078 glyph
= end
+ r1
->used
[TEXT_AREA
];
26080 /* Skip truncation glyphs at the start of the glyph row. */
26081 if (r1
->displays_text_p
)
26083 && INTEGERP (glyph
->object
)
26084 && glyph
->charpos
< 0;
26088 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
26089 or DISP_STRING, and the first glyph from buffer whose
26090 position is between START_CHARPOS and END_CHARPOS. */
26092 && !INTEGERP (glyph
->object
)
26093 && !EQ (glyph
->object
, disp_string
)
26094 && !(BUFFERP (glyph
->object
)
26095 && (glyph
->charpos
>= start_charpos
26096 && glyph
->charpos
< end_charpos
));
26099 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26100 are present at buffer positions between START_CHARPOS and
26101 END_CHARPOS, or if they come from an overlay. */
26102 if (EQ (glyph
->object
, before_string
))
26104 pos
= string_buffer_position (before_string
, start_charpos
);
26105 /* If pos == 0, it means before_string came from an
26106 overlay, not from a buffer position. */
26107 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26110 else if (EQ (glyph
->object
, after_string
))
26112 pos
= string_buffer_position (after_string
, end_charpos
);
26113 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26118 glyph
++; /* first glyph to the right of the highlighted area */
26119 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
26120 x
+= g
->pixel_width
;
26121 hlinfo
->mouse_face_beg_x
= x
;
26122 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
26125 /* If the highlight ends in a different row, compute GLYPH and END
26126 for the end row. Otherwise, reuse the values computed above for
26127 the row where the highlight begins. */
26130 if (!r2
->reversed_p
)
26132 glyph
= r2
->glyphs
[TEXT_AREA
];
26133 end
= glyph
+ r2
->used
[TEXT_AREA
];
26138 end
= r2
->glyphs
[TEXT_AREA
] - 1;
26139 glyph
= end
+ r2
->used
[TEXT_AREA
];
26143 if (!r2
->reversed_p
)
26145 /* Skip truncation and continuation glyphs near the end of the
26146 row, and also blanks and stretch glyphs inserted by
26147 extend_face_to_end_of_line. */
26149 && INTEGERP ((end
- 1)->object
))
26151 /* Scan the rest of the glyph row from the end, looking for the
26152 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26153 DISP_STRING, or whose position is between START_CHARPOS
26157 && !INTEGERP (end
->object
)
26158 && !EQ (end
->object
, disp_string
)
26159 && !(BUFFERP (end
->object
)
26160 && (end
->charpos
>= start_charpos
26161 && end
->charpos
< end_charpos
));
26164 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26165 are present at buffer positions between START_CHARPOS and
26166 END_CHARPOS, or if they come from an overlay. */
26167 if (EQ (end
->object
, before_string
))
26169 pos
= string_buffer_position (before_string
, start_charpos
);
26170 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26173 else if (EQ (end
->object
, after_string
))
26175 pos
= string_buffer_position (after_string
, end_charpos
);
26176 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26180 /* Find the X coordinate of the last glyph to be highlighted. */
26181 for (; glyph
<= end
; ++glyph
)
26182 x
+= glyph
->pixel_width
;
26184 hlinfo
->mouse_face_end_x
= x
;
26185 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
26189 /* Skip truncation and continuation glyphs near the end of the
26190 row, and also blanks and stretch glyphs inserted by
26191 extend_face_to_end_of_line. */
26195 && INTEGERP (end
->object
))
26197 x
+= end
->pixel_width
;
26200 /* Scan the rest of the glyph row from the end, looking for the
26201 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
26202 DISP_STRING, or whose position is between START_CHARPOS
26206 && !INTEGERP (end
->object
)
26207 && !EQ (end
->object
, disp_string
)
26208 && !(BUFFERP (end
->object
)
26209 && (end
->charpos
>= start_charpos
26210 && end
->charpos
< end_charpos
));
26213 /* BEFORE_STRING or AFTER_STRING are only relevant if they
26214 are present at buffer positions between START_CHARPOS and
26215 END_CHARPOS, or if they come from an overlay. */
26216 if (EQ (end
->object
, before_string
))
26218 pos
= string_buffer_position (before_string
, start_charpos
);
26219 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26222 else if (EQ (end
->object
, after_string
))
26224 pos
= string_buffer_position (after_string
, end_charpos
);
26225 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
26228 x
+= end
->pixel_width
;
26230 hlinfo
->mouse_face_end_x
= x
;
26231 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
26234 hlinfo
->mouse_face_window
= window
;
26235 hlinfo
->mouse_face_face_id
26236 = face_at_buffer_position (w
, mouse_charpos
, 0, 0, &ignore
,
26238 !hlinfo
->mouse_face_hidden
, -1);
26239 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26242 /* The following function is not used anymore (replaced with
26243 mouse_face_from_string_pos), but I leave it here for the time
26244 being, in case someone would. */
26246 #if 0 /* not used */
26248 /* Find the position of the glyph for position POS in OBJECT in
26249 window W's current matrix, and return in *X, *Y the pixel
26250 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
26252 RIGHT_P non-zero means return the position of the right edge of the
26253 glyph, RIGHT_P zero means return the left edge position.
26255 If no glyph for POS exists in the matrix, return the position of
26256 the glyph with the next smaller position that is in the matrix, if
26257 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
26258 exists in the matrix, return the position of the glyph with the
26259 next larger position in OBJECT.
26261 Value is non-zero if a glyph was found. */
26264 fast_find_string_pos (struct window
*w
, EMACS_INT pos
, Lisp_Object object
,
26265 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
26267 int yb
= window_text_bottom_y (w
);
26268 struct glyph_row
*r
;
26269 struct glyph
*best_glyph
= NULL
;
26270 struct glyph_row
*best_row
= NULL
;
26273 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26274 r
->enabled_p
&& r
->y
< yb
;
26277 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
26278 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
26281 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26282 if (EQ (g
->object
, object
))
26284 if (g
->charpos
== pos
)
26291 else if (best_glyph
== NULL
26292 || ((eabs (g
->charpos
- pos
)
26293 < eabs (best_glyph
->charpos
- pos
))
26296 : g
->charpos
> pos
)))
26310 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
26314 *x
+= best_glyph
->pixel_width
;
26319 *vpos
= best_row
- w
->current_matrix
->rows
;
26322 return best_glyph
!= NULL
;
26324 #endif /* not used */
26326 /* Find the positions of the first and the last glyphs in window W's
26327 current matrix that occlude positions [STARTPOS..ENDPOS] in OBJECT
26328 (assumed to be a string), and return in HLINFO's mouse_face_*
26329 members the pixel and column/row coordinates of those glyphs. */
26332 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
26333 Lisp_Object object
,
26334 EMACS_INT startpos
, EMACS_INT endpos
)
26336 int yb
= window_text_bottom_y (w
);
26337 struct glyph_row
*r
;
26338 struct glyph
*g
, *e
;
26342 /* Find the glyph row with at least one position in the range
26343 [STARTPOS..ENDPOS], and the first glyph in that row whose
26344 position belongs to that range. */
26345 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
26346 r
->enabled_p
&& r
->y
< yb
;
26349 if (!r
->reversed_p
)
26351 g
= r
->glyphs
[TEXT_AREA
];
26352 e
= g
+ r
->used
[TEXT_AREA
];
26353 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
26354 if (EQ (g
->object
, object
)
26355 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26357 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26358 hlinfo
->mouse_face_beg_y
= r
->y
;
26359 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26360 hlinfo
->mouse_face_beg_x
= gx
;
26369 e
= r
->glyphs
[TEXT_AREA
];
26370 g
= e
+ r
->used
[TEXT_AREA
];
26371 for ( ; g
> e
; --g
)
26372 if (EQ ((g
-1)->object
, object
)
26373 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
<= endpos
)
26375 hlinfo
->mouse_face_beg_row
= r
- w
->current_matrix
->rows
;
26376 hlinfo
->mouse_face_beg_y
= r
->y
;
26377 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
26378 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
26379 gx
+= g1
->pixel_width
;
26380 hlinfo
->mouse_face_beg_x
= gx
;
26392 /* Starting with the next row, look for the first row which does NOT
26393 include any glyphs whose positions are in the range. */
26394 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
26396 g
= r
->glyphs
[TEXT_AREA
];
26397 e
= g
+ r
->used
[TEXT_AREA
];
26399 for ( ; g
< e
; ++g
)
26400 if (EQ (g
->object
, object
)
26401 && startpos
<= g
->charpos
&& g
->charpos
<= endpos
)
26410 /* The highlighted region ends on the previous row. */
26413 /* Set the end row and its vertical pixel coordinate. */
26414 hlinfo
->mouse_face_end_row
= r
- w
->current_matrix
->rows
;
26415 hlinfo
->mouse_face_end_y
= r
->y
;
26417 /* Compute and set the end column and the end column's horizontal
26418 pixel coordinate. */
26419 if (!r
->reversed_p
)
26421 g
= r
->glyphs
[TEXT_AREA
];
26422 e
= g
+ r
->used
[TEXT_AREA
];
26423 for ( ; e
> g
; --e
)
26424 if (EQ ((e
-1)->object
, object
)
26425 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
<= endpos
)
26427 hlinfo
->mouse_face_end_col
= e
- g
;
26429 for (gx
= r
->x
; g
< e
; ++g
)
26430 gx
+= g
->pixel_width
;
26431 hlinfo
->mouse_face_end_x
= gx
;
26435 e
= r
->glyphs
[TEXT_AREA
];
26436 g
= e
+ r
->used
[TEXT_AREA
];
26437 for (gx
= r
->x
; e
< g
; ++e
)
26439 if (EQ (e
->object
, object
)
26440 && startpos
<= e
->charpos
&& e
->charpos
<= endpos
)
26442 gx
+= e
->pixel_width
;
26444 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
26445 hlinfo
->mouse_face_end_x
= gx
;
26449 #ifdef HAVE_WINDOW_SYSTEM
26451 /* See if position X, Y is within a hot-spot of an image. */
26454 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
26456 if (!CONSP (hot_spot
))
26459 if (EQ (XCAR (hot_spot
), Qrect
))
26461 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
26462 Lisp_Object rect
= XCDR (hot_spot
);
26466 if (!CONSP (XCAR (rect
)))
26468 if (!CONSP (XCDR (rect
)))
26470 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
26472 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
26474 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
26476 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
26480 else if (EQ (XCAR (hot_spot
), Qcircle
))
26482 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
26483 Lisp_Object circ
= XCDR (hot_spot
);
26484 Lisp_Object lr
, lx0
, ly0
;
26486 && CONSP (XCAR (circ
))
26487 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
26488 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
26489 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
26491 double r
= XFLOATINT (lr
);
26492 double dx
= XINT (lx0
) - x
;
26493 double dy
= XINT (ly0
) - y
;
26494 return (dx
* dx
+ dy
* dy
<= r
* r
);
26497 else if (EQ (XCAR (hot_spot
), Qpoly
))
26499 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
26500 if (VECTORP (XCDR (hot_spot
)))
26502 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
26503 Lisp_Object
*poly
= v
->contents
;
26504 int n
= v
->header
.size
;
26507 Lisp_Object lx
, ly
;
26510 /* Need an even number of coordinates, and at least 3 edges. */
26511 if (n
< 6 || n
& 1)
26514 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
26515 If count is odd, we are inside polygon. Pixels on edges
26516 may or may not be included depending on actual geometry of the
26518 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
26519 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
26521 x0
= XINT (lx
), y0
= XINT (ly
);
26522 for (i
= 0; i
< n
; i
+= 2)
26524 int x1
= x0
, y1
= y0
;
26525 if ((lx
= poly
[i
], !INTEGERP (lx
))
26526 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
26528 x0
= XINT (lx
), y0
= XINT (ly
);
26530 /* Does this segment cross the X line? */
26538 if (y
> y0
&& y
> y1
)
26540 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
26550 find_hot_spot (Lisp_Object map
, int x
, int y
)
26552 while (CONSP (map
))
26554 if (CONSP (XCAR (map
))
26555 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
26563 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
26565 doc
: /* Lookup in image map MAP coordinates X and Y.
26566 An image map is an alist where each element has the format (AREA ID PLIST).
26567 An AREA is specified as either a rectangle, a circle, or a polygon:
26568 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
26569 pixel coordinates of the upper left and bottom right corners.
26570 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
26571 and the radius of the circle; r may be a float or integer.
26572 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
26573 vector describes one corner in the polygon.
26574 Returns the alist element for the first matching AREA in MAP. */)
26575 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
26583 return find_hot_spot (map
, XINT (x
), XINT (y
));
26587 /* Display frame CURSOR, optionally using shape defined by POINTER. */
26589 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
26591 /* Do not change cursor shape while dragging mouse. */
26592 if (!NILP (do_mouse_tracking
))
26595 if (!NILP (pointer
))
26597 if (EQ (pointer
, Qarrow
))
26598 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26599 else if (EQ (pointer
, Qhand
))
26600 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
26601 else if (EQ (pointer
, Qtext
))
26602 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
26603 else if (EQ (pointer
, intern ("hdrag")))
26604 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26605 #ifdef HAVE_X_WINDOWS
26606 else if (EQ (pointer
, intern ("vdrag")))
26607 cursor
= FRAME_X_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
26609 else if (EQ (pointer
, intern ("hourglass")))
26610 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
26611 else if (EQ (pointer
, Qmodeline
))
26612 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
26614 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26617 if (cursor
!= No_Cursor
)
26618 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
26621 #endif /* HAVE_WINDOW_SYSTEM */
26623 /* Take proper action when mouse has moved to the mode or header line
26624 or marginal area AREA of window W, x-position X and y-position Y.
26625 X is relative to the start of the text display area of W, so the
26626 width of bitmap areas and scroll bars must be subtracted to get a
26627 position relative to the start of the mode line. */
26630 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
26631 enum window_part area
)
26633 struct window
*w
= XWINDOW (window
);
26634 struct frame
*f
= XFRAME (w
->frame
);
26635 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26636 #ifdef HAVE_WINDOW_SYSTEM
26637 Display_Info
*dpyinfo
;
26639 Cursor cursor
= No_Cursor
;
26640 Lisp_Object pointer
= Qnil
;
26641 int dx
, dy
, width
, height
;
26643 Lisp_Object string
, object
= Qnil
;
26644 Lisp_Object pos
, help
;
26646 Lisp_Object mouse_face
;
26647 int original_x_pixel
= x
;
26648 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
26649 struct glyph_row
*row
;
26651 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
26656 /* Kludge alert: mode_line_string takes X/Y in pixels, but
26657 returns them in row/column units! */
26658 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
26659 &object
, &dx
, &dy
, &width
, &height
);
26661 row
= (area
== ON_MODE_LINE
26662 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
26663 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
26665 /* Find the glyph under the mouse pointer. */
26666 if (row
->mode_line_p
&& row
->enabled_p
)
26668 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
26669 end
= glyph
+ row
->used
[TEXT_AREA
];
26671 for (x0
= original_x_pixel
;
26672 glyph
< end
&& x0
>= glyph
->pixel_width
;
26674 x0
-= glyph
->pixel_width
;
26682 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
26683 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
26684 returns them in row/column units! */
26685 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
26686 &object
, &dx
, &dy
, &width
, &height
);
26691 #ifdef HAVE_WINDOW_SYSTEM
26692 if (IMAGEP (object
))
26694 Lisp_Object image_map
, hotspot
;
26695 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
26697 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
26699 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
26703 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
26704 If so, we could look for mouse-enter, mouse-leave
26705 properties in PLIST (and do something...). */
26706 hotspot
= XCDR (hotspot
);
26707 if (CONSP (hotspot
)
26708 && (plist
= XCAR (hotspot
), CONSP (plist
)))
26710 pointer
= Fplist_get (plist
, Qpointer
);
26711 if (NILP (pointer
))
26713 help
= Fplist_get (plist
, Qhelp_echo
);
26716 help_echo_string
= help
;
26717 /* Is this correct? ++kfs */
26718 XSETWINDOW (help_echo_window
, w
);
26719 help_echo_object
= w
->buffer
;
26720 help_echo_pos
= charpos
;
26724 if (NILP (pointer
))
26725 pointer
= Fplist_get (XCDR (object
), QCpointer
);
26727 #endif /* HAVE_WINDOW_SYSTEM */
26729 if (STRINGP (string
))
26731 pos
= make_number (charpos
);
26732 /* If we're on a string with `help-echo' text property, arrange
26733 for the help to be displayed. This is done by setting the
26734 global variable help_echo_string to the help string. */
26737 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
26740 help_echo_string
= help
;
26741 XSETWINDOW (help_echo_window
, w
);
26742 help_echo_object
= string
;
26743 help_echo_pos
= charpos
;
26747 #ifdef HAVE_WINDOW_SYSTEM
26748 if (FRAME_WINDOW_P (f
))
26750 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
26751 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
26752 if (NILP (pointer
))
26753 pointer
= Fget_text_property (pos
, Qpointer
, string
);
26755 /* Change the mouse pointer according to what is under X/Y. */
26757 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
26760 map
= Fget_text_property (pos
, Qlocal_map
, string
);
26761 if (!KEYMAPP (map
))
26762 map
= Fget_text_property (pos
, Qkeymap
, string
);
26763 if (!KEYMAPP (map
))
26764 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
26769 /* Change the mouse face according to what is under X/Y. */
26770 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
26771 if (!NILP (mouse_face
)
26772 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26777 struct glyph
* tmp_glyph
;
26781 int total_pixel_width
;
26782 EMACS_INT begpos
, endpos
, ignore
;
26786 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
26787 Qmouse_face
, string
, Qnil
);
26793 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
26795 endpos
= SCHARS (string
);
26799 /* Calculate the glyph position GPOS of GLYPH in the
26800 displayed string, relative to the beginning of the
26801 highlighted part of the string.
26803 Note: GPOS is different from CHARPOS. CHARPOS is the
26804 position of GLYPH in the internal string object. A mode
26805 line string format has structures which are converted to
26806 a flattened string by the Emacs Lisp interpreter. The
26807 internal string is an element of those structures. The
26808 displayed string is the flattened string. */
26809 tmp_glyph
= row_start_glyph
;
26810 while (tmp_glyph
< glyph
26811 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26812 && begpos
<= tmp_glyph
->charpos
26813 && tmp_glyph
->charpos
< endpos
)))
26815 gpos
= glyph
- tmp_glyph
;
26817 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
26818 the highlighted part of the displayed string to which
26819 GLYPH belongs. Note: GSEQ_LENGTH is different from
26820 SCHARS (STRING), because the latter returns the length of
26821 the internal string. */
26822 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
26824 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
26825 && begpos
<= tmp_glyph
->charpos
26826 && tmp_glyph
->charpos
< endpos
));
26829 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
26831 /* Calculate the total pixel width of all the glyphs between
26832 the beginning of the highlighted area and GLYPH. */
26833 total_pixel_width
= 0;
26834 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
26835 total_pixel_width
+= tmp_glyph
->pixel_width
;
26837 /* Pre calculation of re-rendering position. Note: X is in
26838 column units here, after the call to mode_line_string or
26839 marginal_area_string. */
26841 vpos
= (area
== ON_MODE_LINE
26842 ? (w
->current_matrix
)->nrows
- 1
26845 /* If GLYPH's position is included in the region that is
26846 already drawn in mouse face, we have nothing to do. */
26847 if ( EQ (window
, hlinfo
->mouse_face_window
)
26848 && (!row
->reversed_p
26849 ? (hlinfo
->mouse_face_beg_col
<= hpos
26850 && hpos
< hlinfo
->mouse_face_end_col
)
26851 /* In R2L rows we swap BEG and END, see below. */
26852 : (hlinfo
->mouse_face_end_col
<= hpos
26853 && hpos
< hlinfo
->mouse_face_beg_col
))
26854 && hlinfo
->mouse_face_beg_row
== vpos
)
26857 if (clear_mouse_face (hlinfo
))
26858 cursor
= No_Cursor
;
26860 if (!row
->reversed_p
)
26862 hlinfo
->mouse_face_beg_col
= hpos
;
26863 hlinfo
->mouse_face_beg_x
= original_x_pixel
26864 - (total_pixel_width
+ dx
);
26865 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
26866 hlinfo
->mouse_face_end_x
= 0;
26870 /* In R2L rows, show_mouse_face expects BEG and END
26871 coordinates to be swapped. */
26872 hlinfo
->mouse_face_end_col
= hpos
;
26873 hlinfo
->mouse_face_end_x
= original_x_pixel
26874 - (total_pixel_width
+ dx
);
26875 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
26876 hlinfo
->mouse_face_beg_x
= 0;
26879 hlinfo
->mouse_face_beg_row
= vpos
;
26880 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
26881 hlinfo
->mouse_face_beg_y
= 0;
26882 hlinfo
->mouse_face_end_y
= 0;
26883 hlinfo
->mouse_face_past_end
= 0;
26884 hlinfo
->mouse_face_window
= window
;
26886 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
26892 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
26894 if (NILP (pointer
))
26897 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
26898 clear_mouse_face (hlinfo
);
26900 #ifdef HAVE_WINDOW_SYSTEM
26901 if (FRAME_WINDOW_P (f
))
26902 define_frame_cursor1 (f
, cursor
, pointer
);
26908 Take proper action when the mouse has moved to position X, Y on
26909 frame F as regards highlighting characters that have mouse-face
26910 properties. Also de-highlighting chars where the mouse was before.
26911 X and Y can be negative or out of range. */
26914 note_mouse_highlight (struct frame
*f
, int x
, int y
)
26916 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
26917 enum window_part part
= ON_NOTHING
;
26918 Lisp_Object window
;
26920 Cursor cursor
= No_Cursor
;
26921 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
26924 /* When a menu is active, don't highlight because this looks odd. */
26925 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
26926 if (popup_activated ())
26930 if (NILP (Vmouse_highlight
)
26931 || !f
->glyphs_initialized_p
26932 || f
->pointer_invisible
)
26935 hlinfo
->mouse_face_mouse_x
= x
;
26936 hlinfo
->mouse_face_mouse_y
= y
;
26937 hlinfo
->mouse_face_mouse_frame
= f
;
26939 if (hlinfo
->mouse_face_defer
)
26942 if (gc_in_progress
)
26944 hlinfo
->mouse_face_deferred_gc
= 1;
26948 /* Which window is that in? */
26949 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
26951 /* If displaying active text in another window, clear that. */
26952 if (! EQ (window
, hlinfo
->mouse_face_window
)
26953 /* Also clear if we move out of text area in same window. */
26954 || (!NILP (hlinfo
->mouse_face_window
)
26957 && part
!= ON_MODE_LINE
26958 && part
!= ON_HEADER_LINE
))
26959 clear_mouse_face (hlinfo
);
26961 /* Not on a window -> return. */
26962 if (!WINDOWP (window
))
26965 /* Reset help_echo_string. It will get recomputed below. */
26966 help_echo_string
= Qnil
;
26968 /* Convert to window-relative pixel coordinates. */
26969 w
= XWINDOW (window
);
26970 frame_to_window_pixel_xy (w
, &x
, &y
);
26972 #ifdef HAVE_WINDOW_SYSTEM
26973 /* Handle tool-bar window differently since it doesn't display a
26975 if (EQ (window
, f
->tool_bar_window
))
26977 note_tool_bar_highlight (f
, x
, y
);
26982 /* Mouse is on the mode, header line or margin? */
26983 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
26984 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
26986 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
26990 #ifdef HAVE_WINDOW_SYSTEM
26991 if (part
== ON_VERTICAL_BORDER
)
26993 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
26994 help_echo_string
= build_string ("drag-mouse-1: resize");
26996 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
26997 || part
== ON_SCROLL_BAR
)
26998 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27000 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
27003 /* Are we in a window whose display is up to date?
27004 And verify the buffer's text has not changed. */
27005 b
= XBUFFER (w
->buffer
);
27006 if (part
== ON_TEXT
27007 && EQ (w
->window_end_valid
, w
->buffer
)
27008 && XFASTINT (w
->last_modified
) == BUF_MODIFF (b
)
27009 && XFASTINT (w
->last_overlay_modified
) == BUF_OVERLAY_MODIFF (b
))
27011 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
27013 struct glyph
*glyph
;
27014 Lisp_Object object
;
27015 Lisp_Object mouse_face
= Qnil
, position
;
27016 Lisp_Object
*overlay_vec
= NULL
;
27017 ptrdiff_t i
, noverlays
;
27018 struct buffer
*obuf
;
27019 EMACS_INT obegv
, ozv
;
27022 /* Find the glyph under X/Y. */
27023 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
27025 #ifdef HAVE_WINDOW_SYSTEM
27026 /* Look for :pointer property on image. */
27027 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27029 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27030 if (img
!= NULL
&& IMAGEP (img
->spec
))
27032 Lisp_Object image_map
, hotspot
;
27033 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
27035 && (hotspot
= find_hot_spot (image_map
,
27036 glyph
->slice
.img
.x
+ dx
,
27037 glyph
->slice
.img
.y
+ dy
),
27039 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
27043 /* Could check XCAR (hotspot) to see if we enter/leave
27045 If so, we could look for mouse-enter, mouse-leave
27046 properties in PLIST (and do something...). */
27047 hotspot
= XCDR (hotspot
);
27048 if (CONSP (hotspot
)
27049 && (plist
= XCAR (hotspot
), CONSP (plist
)))
27051 pointer
= Fplist_get (plist
, Qpointer
);
27052 if (NILP (pointer
))
27054 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
27055 if (!NILP (help_echo_string
))
27057 help_echo_window
= window
;
27058 help_echo_object
= glyph
->object
;
27059 help_echo_pos
= glyph
->charpos
;
27063 if (NILP (pointer
))
27064 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
27067 #endif /* HAVE_WINDOW_SYSTEM */
27069 /* Clear mouse face if X/Y not over text. */
27071 || area
!= TEXT_AREA
27072 || !MATRIX_ROW (w
->current_matrix
, vpos
)->displays_text_p
27073 /* Glyph's OBJECT is an integer for glyphs inserted by the
27074 display engine for its internal purposes, like truncation
27075 and continuation glyphs and blanks beyond the end of
27076 line's text on text terminals. If we are over such a
27077 glyph, we are not over any text. */
27078 || INTEGERP (glyph
->object
)
27079 /* R2L rows have a stretch glyph at their front, which
27080 stands for no text, whereas L2R rows have no glyphs at
27081 all beyond the end of text. Treat such stretch glyphs
27082 like we do with NULL glyphs in L2R rows. */
27083 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
27084 && glyph
== MATRIX_ROW (w
->current_matrix
, vpos
)->glyphs
[TEXT_AREA
]
27085 && glyph
->type
== STRETCH_GLYPH
27086 && glyph
->avoid_cursor_p
))
27088 if (clear_mouse_face (hlinfo
))
27089 cursor
= No_Cursor
;
27090 #ifdef HAVE_WINDOW_SYSTEM
27091 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27093 if (area
!= TEXT_AREA
)
27094 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
27096 pointer
= Vvoid_text_area_pointer
;
27102 pos
= glyph
->charpos
;
27103 object
= glyph
->object
;
27104 if (!STRINGP (object
) && !BUFFERP (object
))
27107 /* If we get an out-of-range value, return now; avoid an error. */
27108 if (BUFFERP (object
) && pos
> BUF_Z (b
))
27111 /* Make the window's buffer temporarily current for
27112 overlays_at and compute_char_face. */
27113 obuf
= current_buffer
;
27114 current_buffer
= b
;
27120 /* Is this char mouse-active or does it have help-echo? */
27121 position
= make_number (pos
);
27123 if (BUFFERP (object
))
27125 /* Put all the overlays we want in a vector in overlay_vec. */
27126 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
27127 /* Sort overlays into increasing priority order. */
27128 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
27133 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
27136 cursor
= No_Cursor
;
27138 /* Check mouse-face highlighting. */
27140 /* If there exists an overlay with mouse-face overlapping
27141 the one we are currently highlighting, we have to
27142 check if we enter the overlapping overlay, and then
27143 highlight only that. */
27144 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
27145 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
27147 /* Find the highest priority overlay with a mouse-face. */
27148 Lisp_Object overlay
= Qnil
;
27149 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
27151 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
27152 if (!NILP (mouse_face
))
27153 overlay
= overlay_vec
[i
];
27156 /* If we're highlighting the same overlay as before, there's
27157 no need to do that again. */
27158 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
27159 goto check_help_echo
;
27160 hlinfo
->mouse_face_overlay
= overlay
;
27162 /* Clear the display of the old active region, if any. */
27163 if (clear_mouse_face (hlinfo
))
27164 cursor
= No_Cursor
;
27166 /* If no overlay applies, get a text property. */
27167 if (NILP (overlay
))
27168 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
27170 /* Next, compute the bounds of the mouse highlighting and
27172 if (!NILP (mouse_face
) && STRINGP (object
))
27174 /* The mouse-highlighting comes from a display string
27175 with a mouse-face. */
27179 s
= Fprevious_single_property_change
27180 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
27181 e
= Fnext_single_property_change
27182 (position
, Qmouse_face
, object
, Qnil
);
27184 s
= make_number (0);
27186 e
= make_number (SCHARS (object
) - 1);
27187 mouse_face_from_string_pos (w
, hlinfo
, object
,
27188 XINT (s
), XINT (e
));
27189 hlinfo
->mouse_face_past_end
= 0;
27190 hlinfo
->mouse_face_window
= window
;
27191 hlinfo
->mouse_face_face_id
27192 = face_at_string_position (w
, object
, pos
, 0, 0, 0, &ignore
,
27193 glyph
->face_id
, 1);
27194 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
27195 cursor
= No_Cursor
;
27199 /* The mouse-highlighting, if any, comes from an overlay
27200 or text property in the buffer. */
27201 Lisp_Object buffer
IF_LINT (= Qnil
);
27202 Lisp_Object disp_string
IF_LINT (= Qnil
);
27204 if (STRINGP (object
))
27206 /* If we are on a display string with no mouse-face,
27207 check if the text under it has one. */
27208 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
27209 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27210 pos
= string_buffer_position (object
, start
);
27213 mouse_face
= get_char_property_and_overlay
27214 (make_number (pos
), Qmouse_face
, w
->buffer
, &overlay
);
27215 buffer
= w
->buffer
;
27216 disp_string
= object
;
27222 disp_string
= Qnil
;
27225 if (!NILP (mouse_face
))
27227 Lisp_Object before
, after
;
27228 Lisp_Object before_string
, after_string
;
27229 /* To correctly find the limits of mouse highlight
27230 in a bidi-reordered buffer, we must not use the
27231 optimization of limiting the search in
27232 previous-single-property-change and
27233 next-single-property-change, because
27234 rows_from_pos_range needs the real start and end
27235 positions to DTRT in this case. That's because
27236 the first row visible in a window does not
27237 necessarily display the character whose position
27238 is the smallest. */
27240 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27241 ? Fmarker_position (w
->start
)
27244 NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
27245 ? make_number (BUF_Z (XBUFFER (buffer
))
27246 - XFASTINT (w
->window_end_pos
))
27249 if (NILP (overlay
))
27251 /* Handle the text property case. */
27252 before
= Fprevious_single_property_change
27253 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
27254 after
= Fnext_single_property_change
27255 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
27256 before_string
= after_string
= Qnil
;
27260 /* Handle the overlay case. */
27261 before
= Foverlay_start (overlay
);
27262 after
= Foverlay_end (overlay
);
27263 before_string
= Foverlay_get (overlay
, Qbefore_string
);
27264 after_string
= Foverlay_get (overlay
, Qafter_string
);
27266 if (!STRINGP (before_string
)) before_string
= Qnil
;
27267 if (!STRINGP (after_string
)) after_string
= Qnil
;
27270 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
27273 : XFASTINT (before
),
27275 ? BUF_Z (XBUFFER (buffer
))
27276 : XFASTINT (after
),
27277 before_string
, after_string
,
27279 cursor
= No_Cursor
;
27286 /* Look for a `help-echo' property. */
27287 if (NILP (help_echo_string
)) {
27288 Lisp_Object help
, overlay
;
27290 /* Check overlays first. */
27291 help
= overlay
= Qnil
;
27292 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
27294 overlay
= overlay_vec
[i
];
27295 help
= Foverlay_get (overlay
, Qhelp_echo
);
27300 help_echo_string
= help
;
27301 help_echo_window
= window
;
27302 help_echo_object
= overlay
;
27303 help_echo_pos
= pos
;
27307 Lisp_Object obj
= glyph
->object
;
27308 EMACS_INT charpos
= glyph
->charpos
;
27310 /* Try text properties. */
27313 && charpos
< SCHARS (obj
))
27315 help
= Fget_text_property (make_number (charpos
),
27319 /* If the string itself doesn't specify a help-echo,
27320 see if the buffer text ``under'' it does. */
27321 struct glyph_row
*r
27322 = MATRIX_ROW (w
->current_matrix
, vpos
);
27323 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27324 EMACS_INT p
= string_buffer_position (obj
, start
);
27327 help
= Fget_char_property (make_number (p
),
27328 Qhelp_echo
, w
->buffer
);
27337 else if (BUFFERP (obj
)
27340 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
27345 help_echo_string
= help
;
27346 help_echo_window
= window
;
27347 help_echo_object
= obj
;
27348 help_echo_pos
= charpos
;
27353 #ifdef HAVE_WINDOW_SYSTEM
27354 /* Look for a `pointer' property. */
27355 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
27357 /* Check overlays first. */
27358 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
27359 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
27361 if (NILP (pointer
))
27363 Lisp_Object obj
= glyph
->object
;
27364 EMACS_INT charpos
= glyph
->charpos
;
27366 /* Try text properties. */
27369 && charpos
< SCHARS (obj
))
27371 pointer
= Fget_text_property (make_number (charpos
),
27373 if (NILP (pointer
))
27375 /* If the string itself doesn't specify a pointer,
27376 see if the buffer text ``under'' it does. */
27377 struct glyph_row
*r
27378 = MATRIX_ROW (w
->current_matrix
, vpos
);
27379 EMACS_INT start
= MATRIX_ROW_START_CHARPOS (r
);
27380 EMACS_INT p
= string_buffer_position (obj
, start
);
27382 pointer
= Fget_char_property (make_number (p
),
27383 Qpointer
, w
->buffer
);
27386 else if (BUFFERP (obj
)
27389 pointer
= Fget_text_property (make_number (charpos
),
27393 #endif /* HAVE_WINDOW_SYSTEM */
27397 current_buffer
= obuf
;
27402 #ifdef HAVE_WINDOW_SYSTEM
27403 if (FRAME_WINDOW_P (f
))
27404 define_frame_cursor1 (f
, cursor
, pointer
);
27406 /* This is here to prevent a compiler error, about "label at end of
27407 compound statement". */
27414 Clear any mouse-face on window W. This function is part of the
27415 redisplay interface, and is called from try_window_id and similar
27416 functions to ensure the mouse-highlight is off. */
27419 x_clear_window_mouse_face (struct window
*w
)
27421 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27422 Lisp_Object window
;
27425 XSETWINDOW (window
, w
);
27426 if (EQ (window
, hlinfo
->mouse_face_window
))
27427 clear_mouse_face (hlinfo
);
27433 Just discard the mouse face information for frame F, if any.
27434 This is used when the size of F is changed. */
27437 cancel_mouse_face (struct frame
*f
)
27439 Lisp_Object window
;
27440 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27442 window
= hlinfo
->mouse_face_window
;
27443 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
27445 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27446 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27447 hlinfo
->mouse_face_window
= Qnil
;
27453 /***********************************************************************
27455 ***********************************************************************/
27457 #ifdef HAVE_WINDOW_SYSTEM
27459 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
27460 which intersects rectangle R. R is in window-relative coordinates. */
27463 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
27464 enum glyph_row_area area
)
27466 struct glyph
*first
= row
->glyphs
[area
];
27467 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
27468 struct glyph
*last
;
27469 int first_x
, start_x
, x
;
27471 if (area
== TEXT_AREA
&& row
->fill_line_p
)
27472 /* If row extends face to end of line write the whole line. */
27473 draw_glyphs (w
, 0, row
, area
,
27474 0, row
->used
[area
],
27475 DRAW_NORMAL_TEXT
, 0);
27478 /* Set START_X to the window-relative start position for drawing glyphs of
27479 AREA. The first glyph of the text area can be partially visible.
27480 The first glyphs of other areas cannot. */
27481 start_x
= window_box_left_offset (w
, area
);
27483 if (area
== TEXT_AREA
)
27486 /* Find the first glyph that must be redrawn. */
27488 && x
+ first
->pixel_width
< r
->x
)
27490 x
+= first
->pixel_width
;
27494 /* Find the last one. */
27498 && x
< r
->x
+ r
->width
)
27500 x
+= last
->pixel_width
;
27506 draw_glyphs (w
, first_x
- start_x
, row
, area
,
27507 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
27508 DRAW_NORMAL_TEXT
, 0);
27513 /* Redraw the parts of the glyph row ROW on window W intersecting
27514 rectangle R. R is in window-relative coordinates. Value is
27515 non-zero if mouse-face was overwritten. */
27518 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
27520 xassert (row
->enabled_p
);
27522 if (row
->mode_line_p
|| w
->pseudo_window_p
)
27523 draw_glyphs (w
, 0, row
, TEXT_AREA
,
27524 0, row
->used
[TEXT_AREA
],
27525 DRAW_NORMAL_TEXT
, 0);
27528 if (row
->used
[LEFT_MARGIN_AREA
])
27529 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
27530 if (row
->used
[TEXT_AREA
])
27531 expose_area (w
, row
, r
, TEXT_AREA
);
27532 if (row
->used
[RIGHT_MARGIN_AREA
])
27533 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
27534 draw_row_fringe_bitmaps (w
, row
);
27537 return row
->mouse_face_p
;
27541 /* Redraw those parts of glyphs rows during expose event handling that
27542 overlap other rows. Redrawing of an exposed line writes over parts
27543 of lines overlapping that exposed line; this function fixes that.
27545 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
27546 row in W's current matrix that is exposed and overlaps other rows.
27547 LAST_OVERLAPPING_ROW is the last such row. */
27550 expose_overlaps (struct window
*w
,
27551 struct glyph_row
*first_overlapping_row
,
27552 struct glyph_row
*last_overlapping_row
,
27555 struct glyph_row
*row
;
27557 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
27558 if (row
->overlapping_p
)
27560 xassert (row
->enabled_p
&& !row
->mode_line_p
);
27563 if (row
->used
[LEFT_MARGIN_AREA
])
27564 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
27566 if (row
->used
[TEXT_AREA
])
27567 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
27569 if (row
->used
[RIGHT_MARGIN_AREA
])
27570 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
27576 /* Return non-zero if W's cursor intersects rectangle R. */
27579 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
27581 XRectangle cr
, result
;
27582 struct glyph
*cursor_glyph
;
27583 struct glyph_row
*row
;
27585 if (w
->phys_cursor
.vpos
>= 0
27586 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
27587 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
27589 && row
->cursor_in_fringe_p
)
27591 /* Cursor is in the fringe. */
27592 cr
.x
= window_box_right_offset (w
,
27593 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
27594 ? RIGHT_MARGIN_AREA
27597 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
27598 cr
.height
= row
->height
;
27599 return x_intersect_rectangles (&cr
, r
, &result
);
27602 cursor_glyph
= get_phys_cursor_glyph (w
);
27605 /* r is relative to W's box, but w->phys_cursor.x is relative
27606 to left edge of W's TEXT area. Adjust it. */
27607 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
27608 cr
.y
= w
->phys_cursor
.y
;
27609 cr
.width
= cursor_glyph
->pixel_width
;
27610 cr
.height
= w
->phys_cursor_height
;
27611 /* ++KFS: W32 version used W32-specific IntersectRect here, but
27612 I assume the effect is the same -- and this is portable. */
27613 return x_intersect_rectangles (&cr
, r
, &result
);
27615 /* If we don't understand the format, pretend we're not in the hot-spot. */
27621 Draw a vertical window border to the right of window W if W doesn't
27622 have vertical scroll bars. */
27625 x_draw_vertical_border (struct window
*w
)
27627 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27629 /* We could do better, if we knew what type of scroll-bar the adjacent
27630 windows (on either side) have... But we don't :-(
27631 However, I think this works ok. ++KFS 2003-04-25 */
27633 /* Redraw borders between horizontally adjacent windows. Don't
27634 do it for frames with vertical scroll bars because either the
27635 right scroll bar of a window, or the left scroll bar of its
27636 neighbor will suffice as a border. */
27637 if (FRAME_HAS_VERTICAL_SCROLL_BARS (XFRAME (w
->frame
)))
27640 if (!WINDOW_RIGHTMOST_P (w
)
27641 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
27643 int x0
, x1
, y0
, y1
;
27645 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27648 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27651 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
27653 else if (!WINDOW_LEFTMOST_P (w
)
27654 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
27656 int x0
, x1
, y0
, y1
;
27658 window_box_edges (w
, -1, &x0
, &y0
, &x1
, &y1
);
27661 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
27664 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
27669 /* Redraw the part of window W intersection rectangle FR. Pixel
27670 coordinates in FR are frame-relative. Call this function with
27671 input blocked. Value is non-zero if the exposure overwrites
27675 expose_window (struct window
*w
, XRectangle
*fr
)
27677 struct frame
*f
= XFRAME (w
->frame
);
27679 int mouse_face_overwritten_p
= 0;
27681 /* If window is not yet fully initialized, do nothing. This can
27682 happen when toolkit scroll bars are used and a window is split.
27683 Reconfiguring the scroll bar will generate an expose for a newly
27685 if (w
->current_matrix
== NULL
)
27688 /* When we're currently updating the window, display and current
27689 matrix usually don't agree. Arrange for a thorough display
27691 if (w
== updated_window
)
27693 SET_FRAME_GARBAGED (f
);
27697 /* Frame-relative pixel rectangle of W. */
27698 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
27699 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
27700 wr
.width
= WINDOW_TOTAL_WIDTH (w
);
27701 wr
.height
= WINDOW_TOTAL_HEIGHT (w
);
27703 if (x_intersect_rectangles (fr
, &wr
, &r
))
27705 int yb
= window_text_bottom_y (w
);
27706 struct glyph_row
*row
;
27707 int cursor_cleared_p
, phys_cursor_on_p
;
27708 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
27710 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
27711 r
.x
, r
.y
, r
.width
, r
.height
));
27713 /* Convert to window coordinates. */
27714 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
27715 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
27717 /* Turn off the cursor. */
27718 if (!w
->pseudo_window_p
27719 && phys_cursor_in_rect_p (w
, &r
))
27721 x_clear_cursor (w
);
27722 cursor_cleared_p
= 1;
27725 cursor_cleared_p
= 0;
27727 /* If the row containing the cursor extends face to end of line,
27728 then expose_area might overwrite the cursor outside the
27729 rectangle and thus notice_overwritten_cursor might clear
27730 w->phys_cursor_on_p. We remember the original value and
27731 check later if it is changed. */
27732 phys_cursor_on_p
= w
->phys_cursor_on_p
;
27734 /* Update lines intersecting rectangle R. */
27735 first_overlapping_row
= last_overlapping_row
= NULL
;
27736 for (row
= w
->current_matrix
->rows
;
27741 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
27743 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
27744 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
27745 || (r
.y
>= y0
&& r
.y
< y1
)
27746 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
27748 /* A header line may be overlapping, but there is no need
27749 to fix overlapping areas for them. KFS 2005-02-12 */
27750 if (row
->overlapping_p
&& !row
->mode_line_p
)
27752 if (first_overlapping_row
== NULL
)
27753 first_overlapping_row
= row
;
27754 last_overlapping_row
= row
;
27758 if (expose_line (w
, row
, &r
))
27759 mouse_face_overwritten_p
= 1;
27762 else if (row
->overlapping_p
)
27764 /* We must redraw a row overlapping the exposed area. */
27766 ? y0
+ row
->phys_height
> r
.y
27767 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
27769 if (first_overlapping_row
== NULL
)
27770 first_overlapping_row
= row
;
27771 last_overlapping_row
= row
;
27779 /* Display the mode line if there is one. */
27780 if (WINDOW_WANTS_MODELINE_P (w
)
27781 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
27783 && row
->y
< r
.y
+ r
.height
)
27785 if (expose_line (w
, row
, &r
))
27786 mouse_face_overwritten_p
= 1;
27789 if (!w
->pseudo_window_p
)
27791 /* Fix the display of overlapping rows. */
27792 if (first_overlapping_row
)
27793 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
27796 /* Draw border between windows. */
27797 x_draw_vertical_border (w
);
27799 /* Turn the cursor on again. */
27800 if (cursor_cleared_p
27801 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
27802 update_window_cursor (w
, 1);
27806 return mouse_face_overwritten_p
;
27811 /* Redraw (parts) of all windows in the window tree rooted at W that
27812 intersect R. R contains frame pixel coordinates. Value is
27813 non-zero if the exposure overwrites mouse-face. */
27816 expose_window_tree (struct window
*w
, XRectangle
*r
)
27818 struct frame
*f
= XFRAME (w
->frame
);
27819 int mouse_face_overwritten_p
= 0;
27821 while (w
&& !FRAME_GARBAGED_P (f
))
27823 if (!NILP (w
->hchild
))
27824 mouse_face_overwritten_p
27825 |= expose_window_tree (XWINDOW (w
->hchild
), r
);
27826 else if (!NILP (w
->vchild
))
27827 mouse_face_overwritten_p
27828 |= expose_window_tree (XWINDOW (w
->vchild
), r
);
27830 mouse_face_overwritten_p
|= expose_window (w
, r
);
27832 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
27835 return mouse_face_overwritten_p
;
27840 Redisplay an exposed area of frame F. X and Y are the upper-left
27841 corner of the exposed rectangle. W and H are width and height of
27842 the exposed area. All are pixel values. W or H zero means redraw
27843 the entire frame. */
27846 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
27849 int mouse_face_overwritten_p
= 0;
27851 TRACE ((stderr
, "expose_frame "));
27853 /* No need to redraw if frame will be redrawn soon. */
27854 if (FRAME_GARBAGED_P (f
))
27856 TRACE ((stderr
, " garbaged\n"));
27860 /* If basic faces haven't been realized yet, there is no point in
27861 trying to redraw anything. This can happen when we get an expose
27862 event while Emacs is starting, e.g. by moving another window. */
27863 if (FRAME_FACE_CACHE (f
) == NULL
27864 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
27866 TRACE ((stderr
, " no faces\n"));
27870 if (w
== 0 || h
== 0)
27873 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
27874 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
27884 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
27885 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
27887 if (WINDOWP (f
->tool_bar_window
))
27888 mouse_face_overwritten_p
27889 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
27891 #ifdef HAVE_X_WINDOWS
27893 #ifndef USE_X_TOOLKIT
27894 if (WINDOWP (f
->menu_bar_window
))
27895 mouse_face_overwritten_p
27896 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
27897 #endif /* not USE_X_TOOLKIT */
27901 /* Some window managers support a focus-follows-mouse style with
27902 delayed raising of frames. Imagine a partially obscured frame,
27903 and moving the mouse into partially obscured mouse-face on that
27904 frame. The visible part of the mouse-face will be highlighted,
27905 then the WM raises the obscured frame. With at least one WM, KDE
27906 2.1, Emacs is not getting any event for the raising of the frame
27907 (even tried with SubstructureRedirectMask), only Expose events.
27908 These expose events will draw text normally, i.e. not
27909 highlighted. Which means we must redo the highlight here.
27910 Subsume it under ``we love X''. --gerd 2001-08-15 */
27911 /* Included in Windows version because Windows most likely does not
27912 do the right thing if any third party tool offers
27913 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
27914 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
27916 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27917 if (f
== hlinfo
->mouse_face_mouse_frame
)
27919 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
27920 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
27921 clear_mouse_face (hlinfo
);
27922 note_mouse_highlight (f
, mouse_x
, mouse_y
);
27929 Determine the intersection of two rectangles R1 and R2. Return
27930 the intersection in *RESULT. Value is non-zero if RESULT is not
27934 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
27936 XRectangle
*left
, *right
;
27937 XRectangle
*upper
, *lower
;
27938 int intersection_p
= 0;
27940 /* Rearrange so that R1 is the left-most rectangle. */
27942 left
= r1
, right
= r2
;
27944 left
= r2
, right
= r1
;
27946 /* X0 of the intersection is right.x0, if this is inside R1,
27947 otherwise there is no intersection. */
27948 if (right
->x
<= left
->x
+ left
->width
)
27950 result
->x
= right
->x
;
27952 /* The right end of the intersection is the minimum of
27953 the right ends of left and right. */
27954 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
27957 /* Same game for Y. */
27959 upper
= r1
, lower
= r2
;
27961 upper
= r2
, lower
= r1
;
27963 /* The upper end of the intersection is lower.y0, if this is inside
27964 of upper. Otherwise, there is no intersection. */
27965 if (lower
->y
<= upper
->y
+ upper
->height
)
27967 result
->y
= lower
->y
;
27969 /* The lower end of the intersection is the minimum of the lower
27970 ends of upper and lower. */
27971 result
->height
= (min (lower
->y
+ lower
->height
,
27972 upper
->y
+ upper
->height
)
27974 intersection_p
= 1;
27978 return intersection_p
;
27981 #endif /* HAVE_WINDOW_SYSTEM */
27984 /***********************************************************************
27986 ***********************************************************************/
27989 syms_of_xdisp (void)
27991 Vwith_echo_area_save_vector
= Qnil
;
27992 staticpro (&Vwith_echo_area_save_vector
);
27994 Vmessage_stack
= Qnil
;
27995 staticpro (&Vmessage_stack
);
27997 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
27999 message_dolog_marker1
= Fmake_marker ();
28000 staticpro (&message_dolog_marker1
);
28001 message_dolog_marker2
= Fmake_marker ();
28002 staticpro (&message_dolog_marker2
);
28003 message_dolog_marker3
= Fmake_marker ();
28004 staticpro (&message_dolog_marker3
);
28007 defsubr (&Sdump_frame_glyph_matrix
);
28008 defsubr (&Sdump_glyph_matrix
);
28009 defsubr (&Sdump_glyph_row
);
28010 defsubr (&Sdump_tool_bar_row
);
28011 defsubr (&Strace_redisplay
);
28012 defsubr (&Strace_to_stderr
);
28014 #ifdef HAVE_WINDOW_SYSTEM
28015 defsubr (&Stool_bar_lines_needed
);
28016 defsubr (&Slookup_image_map
);
28018 defsubr (&Sformat_mode_line
);
28019 defsubr (&Sinvisible_p
);
28020 defsubr (&Scurrent_bidi_paragraph_direction
);
28022 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
28023 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
28024 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
28025 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
28026 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
28027 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
28028 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
28029 DEFSYM (Qeval
, "eval");
28030 DEFSYM (QCdata
, ":data");
28031 DEFSYM (Qdisplay
, "display");
28032 DEFSYM (Qspace_width
, "space-width");
28033 DEFSYM (Qraise
, "raise");
28034 DEFSYM (Qslice
, "slice");
28035 DEFSYM (Qspace
, "space");
28036 DEFSYM (Qmargin
, "margin");
28037 DEFSYM (Qpointer
, "pointer");
28038 DEFSYM (Qleft_margin
, "left-margin");
28039 DEFSYM (Qright_margin
, "right-margin");
28040 DEFSYM (Qcenter
, "center");
28041 DEFSYM (Qline_height
, "line-height");
28042 DEFSYM (QCalign_to
, ":align-to");
28043 DEFSYM (QCrelative_width
, ":relative-width");
28044 DEFSYM (QCrelative_height
, ":relative-height");
28045 DEFSYM (QCeval
, ":eval");
28046 DEFSYM (QCpropertize
, ":propertize");
28047 DEFSYM (QCfile
, ":file");
28048 DEFSYM (Qfontified
, "fontified");
28049 DEFSYM (Qfontification_functions
, "fontification-functions");
28050 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
28051 DEFSYM (Qescape_glyph
, "escape-glyph");
28052 DEFSYM (Qnobreak_space
, "nobreak-space");
28053 DEFSYM (Qimage
, "image");
28054 DEFSYM (Qtext
, "text");
28055 DEFSYM (Qboth
, "both");
28056 DEFSYM (Qboth_horiz
, "both-horiz");
28057 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
28058 DEFSYM (QCmap
, ":map");
28059 DEFSYM (QCpointer
, ":pointer");
28060 DEFSYM (Qrect
, "rect");
28061 DEFSYM (Qcircle
, "circle");
28062 DEFSYM (Qpoly
, "poly");
28063 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
28064 DEFSYM (Qgrow_only
, "grow-only");
28065 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
28066 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
28067 DEFSYM (Qposition
, "position");
28068 DEFSYM (Qbuffer_position
, "buffer-position");
28069 DEFSYM (Qobject
, "object");
28070 DEFSYM (Qbar
, "bar");
28071 DEFSYM (Qhbar
, "hbar");
28072 DEFSYM (Qbox
, "box");
28073 DEFSYM (Qhollow
, "hollow");
28074 DEFSYM (Qhand
, "hand");
28075 DEFSYM (Qarrow
, "arrow");
28076 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
28078 list_of_error
= Fcons (Fcons (intern_c_string ("error"),
28079 Fcons (intern_c_string ("void-variable"), Qnil
)),
28081 staticpro (&list_of_error
);
28083 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
28084 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
28085 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
28086 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
28088 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
28089 staticpro (&echo_buffer
[0]);
28090 staticpro (&echo_buffer
[1]);
28092 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
28093 staticpro (&echo_area_buffer
[0]);
28094 staticpro (&echo_area_buffer
[1]);
28096 Vmessages_buffer_name
= make_pure_c_string ("*Messages*");
28097 staticpro (&Vmessages_buffer_name
);
28099 mode_line_proptrans_alist
= Qnil
;
28100 staticpro (&mode_line_proptrans_alist
);
28101 mode_line_string_list
= Qnil
;
28102 staticpro (&mode_line_string_list
);
28103 mode_line_string_face
= Qnil
;
28104 staticpro (&mode_line_string_face
);
28105 mode_line_string_face_prop
= Qnil
;
28106 staticpro (&mode_line_string_face_prop
);
28107 Vmode_line_unwind_vector
= Qnil
;
28108 staticpro (&Vmode_line_unwind_vector
);
28110 help_echo_string
= Qnil
;
28111 staticpro (&help_echo_string
);
28112 help_echo_object
= Qnil
;
28113 staticpro (&help_echo_object
);
28114 help_echo_window
= Qnil
;
28115 staticpro (&help_echo_window
);
28116 previous_help_echo_string
= Qnil
;
28117 staticpro (&previous_help_echo_string
);
28118 help_echo_pos
= -1;
28120 DEFSYM (Qright_to_left
, "right-to-left");
28121 DEFSYM (Qleft_to_right
, "left-to-right");
28123 #ifdef HAVE_WINDOW_SYSTEM
28124 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
28125 doc
: /* *Non-nil means draw block cursor as wide as the glyph under it.
28126 For example, if a block cursor is over a tab, it will be drawn as
28127 wide as that tab on the display. */);
28128 x_stretch_cursor_p
= 0;
28131 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
28132 doc
: /* *Non-nil means highlight trailing whitespace.
28133 The face used for trailing whitespace is `trailing-whitespace'. */);
28134 Vshow_trailing_whitespace
= Qnil
;
28136 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
28137 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
28138 If the value is t, Emacs highlights non-ASCII chars which have the
28139 same appearance as an ASCII space or hyphen, using the `nobreak-space'
28140 or `escape-glyph' face respectively.
28142 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
28143 U+2011 (non-breaking hyphen) are affected.
28145 Any other non-nil value means to display these characters as a escape
28146 glyph followed by an ordinary space or hyphen.
28148 A value of nil means no special handling of these characters. */);
28149 Vnobreak_char_display
= Qt
;
28151 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
28152 doc
: /* *The pointer shape to show in void text areas.
28153 A value of nil means to show the text pointer. Other options are `arrow',
28154 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
28155 Vvoid_text_area_pointer
= Qarrow
;
28157 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
28158 doc
: /* Non-nil means don't actually do any redisplay.
28159 This is used for internal purposes. */);
28160 Vinhibit_redisplay
= Qnil
;
28162 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
28163 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
28164 Vglobal_mode_string
= Qnil
;
28166 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
28167 doc
: /* Marker for where to display an arrow on top of the buffer text.
28168 This must be the beginning of a line in order to work.
28169 See also `overlay-arrow-string'. */);
28170 Voverlay_arrow_position
= Qnil
;
28172 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
28173 doc
: /* String to display as an arrow in non-window frames.
28174 See also `overlay-arrow-position'. */);
28175 Voverlay_arrow_string
= make_pure_c_string ("=>");
28177 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
28178 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
28179 The symbols on this list are examined during redisplay to determine
28180 where to display overlay arrows. */);
28181 Voverlay_arrow_variable_list
28182 = Fcons (intern_c_string ("overlay-arrow-position"), Qnil
);
28184 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
28185 doc
: /* *The number of lines to try scrolling a window by when point moves out.
28186 If that fails to bring point back on frame, point is centered instead.
28187 If this is zero, point is always centered after it moves off frame.
28188 If you want scrolling to always be a line at a time, you should set
28189 `scroll-conservatively' to a large value rather than set this to 1. */);
28191 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
28192 doc
: /* *Scroll up to this many lines, to bring point back on screen.
28193 If point moves off-screen, redisplay will scroll by up to
28194 `scroll-conservatively' lines in order to bring point just barely
28195 onto the screen again. If that cannot be done, then redisplay
28196 recenters point as usual.
28198 If the value is greater than 100, redisplay will never recenter point,
28199 but will always scroll just enough text to bring point into view, even
28200 if you move far away.
28202 A value of zero means always recenter point if it moves off screen. */);
28203 scroll_conservatively
= 0;
28205 DEFVAR_INT ("scroll-margin", scroll_margin
,
28206 doc
: /* *Number of lines of margin at the top and bottom of a window.
28207 Recenter the window whenever point gets within this many lines
28208 of the top or bottom of the window. */);
28211 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
28212 doc
: /* Pixels per inch value for non-window system displays.
28213 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
28214 Vdisplay_pixels_per_inch
= make_float (72.0);
28217 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
28220 DEFVAR_LISP ("truncate-partial-width-windows",
28221 Vtruncate_partial_width_windows
,
28222 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
28223 For an integer value, truncate lines in each window narrower than the
28224 full frame width, provided the window width is less than that integer;
28225 otherwise, respect the value of `truncate-lines'.
28227 For any other non-nil value, truncate lines in all windows that do
28228 not span the full frame width.
28230 A value of nil means to respect the value of `truncate-lines'.
28232 If `word-wrap' is enabled, you might want to reduce this. */);
28233 Vtruncate_partial_width_windows
= make_number (50);
28235 DEFVAR_BOOL ("mode-line-inverse-video", mode_line_inverse_video
,
28236 doc
: /* When nil, display the mode-line/header-line/menu-bar in the default face.
28237 Any other value means to use the appropriate face, `mode-line',
28238 `header-line', or `menu' respectively. */);
28239 mode_line_inverse_video
= 1;
28241 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
28242 doc
: /* *Maximum buffer size for which line number should be displayed.
28243 If the buffer is bigger than this, the line number does not appear
28244 in the mode line. A value of nil means no limit. */);
28245 Vline_number_display_limit
= Qnil
;
28247 DEFVAR_INT ("line-number-display-limit-width",
28248 line_number_display_limit_width
,
28249 doc
: /* *Maximum line width (in characters) for line number display.
28250 If the average length of the lines near point is bigger than this, then the
28251 line number may be omitted from the mode line. */);
28252 line_number_display_limit_width
= 200;
28254 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
28255 doc
: /* *Non-nil means highlight region even in nonselected windows. */);
28256 highlight_nonselected_windows
= 0;
28258 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
28259 doc
: /* Non-nil if more than one frame is visible on this display.
28260 Minibuffer-only frames don't count, but iconified frames do.
28261 This variable is not guaranteed to be accurate except while processing
28262 `frame-title-format' and `icon-title-format'. */);
28264 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
28265 doc
: /* Template for displaying the title bar of visible frames.
28266 \(Assuming the window manager supports this feature.)
28268 This variable has the same structure as `mode-line-format', except that
28269 the %c and %l constructs are ignored. It is used only on frames for
28270 which no explicit name has been set \(see `modify-frame-parameters'). */);
28272 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
28273 doc
: /* Template for displaying the title bar of an iconified frame.
28274 \(Assuming the window manager supports this feature.)
28275 This variable has the same structure as `mode-line-format' (which see),
28276 and is used only on frames for which no explicit name has been set
28277 \(see `modify-frame-parameters'). */);
28279 = Vframe_title_format
28280 = pure_cons (intern_c_string ("multiple-frames"),
28281 pure_cons (make_pure_c_string ("%b"),
28282 pure_cons (pure_cons (empty_unibyte_string
,
28283 pure_cons (intern_c_string ("invocation-name"),
28284 pure_cons (make_pure_c_string ("@"),
28285 pure_cons (intern_c_string ("system-name"),
28289 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
28290 doc
: /* Maximum number of lines to keep in the message log buffer.
28291 If nil, disable message logging. If t, log messages but don't truncate
28292 the buffer when it becomes large. */);
28293 Vmessage_log_max
= make_number (100);
28295 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
28296 doc
: /* Functions called before redisplay, if window sizes have changed.
28297 The value should be a list of functions that take one argument.
28298 Just before redisplay, for each frame, if any of its windows have changed
28299 size since the last redisplay, or have been split or deleted,
28300 all the functions in the list are called, with the frame as argument. */);
28301 Vwindow_size_change_functions
= Qnil
;
28303 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
28304 doc
: /* List of functions to call before redisplaying a window with scrolling.
28305 Each function is called with two arguments, the window and its new
28306 display-start position. Note that these functions are also called by
28307 `set-window-buffer'. Also note that the value of `window-end' is not
28308 valid when these functions are called. */);
28309 Vwindow_scroll_functions
= Qnil
;
28311 DEFVAR_LISP ("window-text-change-functions",
28312 Vwindow_text_change_functions
,
28313 doc
: /* Functions to call in redisplay when text in the window might change. */);
28314 Vwindow_text_change_functions
= Qnil
;
28316 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
28317 doc
: /* Functions called when redisplay of a window reaches the end trigger.
28318 Each function is called with two arguments, the window and the end trigger value.
28319 See `set-window-redisplay-end-trigger'. */);
28320 Vredisplay_end_trigger_functions
= Qnil
;
28322 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
28323 doc
: /* *Non-nil means autoselect window with mouse pointer.
28324 If nil, do not autoselect windows.
28325 A positive number means delay autoselection by that many seconds: a
28326 window is autoselected only after the mouse has remained in that
28327 window for the duration of the delay.
28328 A negative number has a similar effect, but causes windows to be
28329 autoselected only after the mouse has stopped moving. \(Because of
28330 the way Emacs compares mouse events, you will occasionally wait twice
28331 that time before the window gets selected.\)
28332 Any other value means to autoselect window instantaneously when the
28333 mouse pointer enters it.
28335 Autoselection selects the minibuffer only if it is active, and never
28336 unselects the minibuffer if it is active.
28338 When customizing this variable make sure that the actual value of
28339 `focus-follows-mouse' matches the behavior of your window manager. */);
28340 Vmouse_autoselect_window
= Qnil
;
28342 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
28343 doc
: /* *Non-nil means automatically resize tool-bars.
28344 This dynamically changes the tool-bar's height to the minimum height
28345 that is needed to make all tool-bar items visible.
28346 If value is `grow-only', the tool-bar's height is only increased
28347 automatically; to decrease the tool-bar height, use \\[recenter]. */);
28348 Vauto_resize_tool_bars
= Qt
;
28350 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
28351 doc
: /* *Non-nil means raise tool-bar buttons when the mouse moves over them. */);
28352 auto_raise_tool_bar_buttons_p
= 1;
28354 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
28355 doc
: /* *Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
28356 make_cursor_line_fully_visible_p
= 1;
28358 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
28359 doc
: /* *Border below tool-bar in pixels.
28360 If an integer, use it as the height of the border.
28361 If it is one of `internal-border-width' or `border-width', use the
28362 value of the corresponding frame parameter.
28363 Otherwise, no border is added below the tool-bar. */);
28364 Vtool_bar_border
= Qinternal_border_width
;
28366 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
28367 doc
: /* *Margin around tool-bar buttons in pixels.
28368 If an integer, use that for both horizontal and vertical margins.
28369 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
28370 HORZ specifying the horizontal margin, and VERT specifying the
28371 vertical margin. */);
28372 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
28374 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
28375 doc
: /* *Relief thickness of tool-bar buttons. */);
28376 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
28378 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
28379 doc
: /* Tool bar style to use.
28381 image - show images only
28382 text - show text only
28383 both - show both, text below image
28384 both-horiz - show text to the right of the image
28385 text-image-horiz - show text to the left of the image
28386 any other - use system default or image if no system default. */);
28387 Vtool_bar_style
= Qnil
;
28389 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
28390 doc
: /* *Maximum number of characters a label can have to be shown.
28391 The tool bar style must also show labels for this to have any effect, see
28392 `tool-bar-style'. */);
28393 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
28395 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
28396 doc
: /* List of functions to call to fontify regions of text.
28397 Each function is called with one argument POS. Functions must
28398 fontify a region starting at POS in the current buffer, and give
28399 fontified regions the property `fontified'. */);
28400 Vfontification_functions
= Qnil
;
28401 Fmake_variable_buffer_local (Qfontification_functions
);
28403 DEFVAR_BOOL ("unibyte-display-via-language-environment",
28404 unibyte_display_via_language_environment
,
28405 doc
: /* *Non-nil means display unibyte text according to language environment.
28406 Specifically, this means that raw bytes in the range 160-255 decimal
28407 are displayed by converting them to the equivalent multibyte characters
28408 according to the current language environment. As a result, they are
28409 displayed according to the current fontset.
28411 Note that this variable affects only how these bytes are displayed,
28412 but does not change the fact they are interpreted as raw bytes. */);
28413 unibyte_display_via_language_environment
= 0;
28415 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
28416 doc
: /* *Maximum height for resizing mini-windows (the minibuffer and the echo area).
28417 If a float, it specifies a fraction of the mini-window frame's height.
28418 If an integer, it specifies a number of lines. */);
28419 Vmax_mini_window_height
= make_float (0.25);
28421 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
28422 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
28423 A value of nil means don't automatically resize mini-windows.
28424 A value of t means resize them to fit the text displayed in them.
28425 A value of `grow-only', the default, means let mini-windows grow only;
28426 they return to their normal size when the minibuffer is closed, or the
28427 echo area becomes empty. */);
28428 Vresize_mini_windows
= Qgrow_only
;
28430 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
28431 doc
: /* Alist specifying how to blink the cursor off.
28432 Each element has the form (ON-STATE . OFF-STATE). Whenever the
28433 `cursor-type' frame-parameter or variable equals ON-STATE,
28434 comparing using `equal', Emacs uses OFF-STATE to specify
28435 how to blink it off. ON-STATE and OFF-STATE are values for
28436 the `cursor-type' frame parameter.
28438 If a frame's ON-STATE has no entry in this list,
28439 the frame's other specifications determine how to blink the cursor off. */);
28440 Vblink_cursor_alist
= Qnil
;
28442 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
28443 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
28444 If non-nil, windows are automatically scrolled horizontally to make
28445 point visible. */);
28446 automatic_hscrolling_p
= 1;
28447 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
28449 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
28450 doc
: /* *How many columns away from the window edge point is allowed to get
28451 before automatic hscrolling will horizontally scroll the window. */);
28452 hscroll_margin
= 5;
28454 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
28455 doc
: /* *How many columns to scroll the window when point gets too close to the edge.
28456 When point is less than `hscroll-margin' columns from the window
28457 edge, automatic hscrolling will scroll the window by the amount of columns
28458 determined by this variable. If its value is a positive integer, scroll that
28459 many columns. If it's a positive floating-point number, it specifies the
28460 fraction of the window's width to scroll. If it's nil or zero, point will be
28461 centered horizontally after the scroll. Any other value, including negative
28462 numbers, are treated as if the value were zero.
28464 Automatic hscrolling always moves point outside the scroll margin, so if
28465 point was more than scroll step columns inside the margin, the window will
28466 scroll more than the value given by the scroll step.
28468 Note that the lower bound for automatic hscrolling specified by `scroll-left'
28469 and `scroll-right' overrides this variable's effect. */);
28470 Vhscroll_step
= make_number (0);
28472 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
28473 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
28474 Bind this around calls to `message' to let it take effect. */);
28475 message_truncate_lines
= 0;
28477 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
28478 doc
: /* Normal hook run to update the menu bar definitions.
28479 Redisplay runs this hook before it redisplays the menu bar.
28480 This is used to update submenus such as Buffers,
28481 whose contents depend on various data. */);
28482 Vmenu_bar_update_hook
= Qnil
;
28484 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
28485 doc
: /* Frame for which we are updating a menu.
28486 The enable predicate for a menu binding should check this variable. */);
28487 Vmenu_updating_frame
= Qnil
;
28489 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
28490 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
28491 inhibit_menubar_update
= 0;
28493 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
28494 doc
: /* Prefix prepended to all continuation lines at display time.
28495 The value may be a string, an image, or a stretch-glyph; it is
28496 interpreted in the same way as the value of a `display' text property.
28498 This variable is overridden by any `wrap-prefix' text or overlay
28501 To add a prefix to non-continuation lines, use `line-prefix'. */);
28502 Vwrap_prefix
= Qnil
;
28503 DEFSYM (Qwrap_prefix
, "wrap-prefix");
28504 Fmake_variable_buffer_local (Qwrap_prefix
);
28506 DEFVAR_LISP ("line-prefix", Vline_prefix
,
28507 doc
: /* Prefix prepended to all non-continuation lines at display time.
28508 The value may be a string, an image, or a stretch-glyph; it is
28509 interpreted in the same way as the value of a `display' text property.
28511 This variable is overridden by any `line-prefix' text or overlay
28514 To add a prefix to continuation lines, use `wrap-prefix'. */);
28515 Vline_prefix
= Qnil
;
28516 DEFSYM (Qline_prefix
, "line-prefix");
28517 Fmake_variable_buffer_local (Qline_prefix
);
28519 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
28520 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
28521 inhibit_eval_during_redisplay
= 0;
28523 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
28524 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
28525 inhibit_free_realized_faces
= 0;
28528 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
28529 doc
: /* Inhibit try_window_id display optimization. */);
28530 inhibit_try_window_id
= 0;
28532 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
28533 doc
: /* Inhibit try_window_reusing display optimization. */);
28534 inhibit_try_window_reusing
= 0;
28536 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
28537 doc
: /* Inhibit try_cursor_movement display optimization. */);
28538 inhibit_try_cursor_movement
= 0;
28539 #endif /* GLYPH_DEBUG */
28541 DEFVAR_INT ("overline-margin", overline_margin
,
28542 doc
: /* *Space between overline and text, in pixels.
28543 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
28544 margin to the character height. */);
28545 overline_margin
= 2;
28547 DEFVAR_INT ("underline-minimum-offset",
28548 underline_minimum_offset
,
28549 doc
: /* Minimum distance between baseline and underline.
28550 This can improve legibility of underlined text at small font sizes,
28551 particularly when using variable `x-use-underline-position-properties'
28552 with fonts that specify an UNDERLINE_POSITION relatively close to the
28553 baseline. The default value is 1. */);
28554 underline_minimum_offset
= 1;
28556 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
28557 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
28558 This feature only works when on a window system that can change
28559 cursor shapes. */);
28560 display_hourglass_p
= 1;
28562 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
28563 doc
: /* *Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
28564 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
28566 hourglass_atimer
= NULL
;
28567 hourglass_shown_p
= 0;
28569 DEFSYM (Qglyphless_char
, "glyphless-char");
28570 DEFSYM (Qhex_code
, "hex-code");
28571 DEFSYM (Qempty_box
, "empty-box");
28572 DEFSYM (Qthin_space
, "thin-space");
28573 DEFSYM (Qzero_width
, "zero-width");
28575 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
28576 /* Intern this now in case it isn't already done.
28577 Setting this variable twice is harmless.
28578 But don't staticpro it here--that is done in alloc.c. */
28579 Qchar_table_extra_slots
= intern_c_string ("char-table-extra-slots");
28580 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
28582 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
28583 doc
: /* Char-table defining glyphless characters.
28584 Each element, if non-nil, should be one of the following:
28585 an ASCII acronym string: display this string in a box
28586 `hex-code': display the hexadecimal code of a character in a box
28587 `empty-box': display as an empty box
28588 `thin-space': display as 1-pixel width space
28589 `zero-width': don't display
28590 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
28591 display method for graphical terminals and text terminals respectively.
28592 GRAPHICAL and TEXT should each have one of the values listed above.
28594 The char-table has one extra slot to control the display of a character for
28595 which no font is found. This slot only takes effect on graphical terminals.
28596 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
28597 `thin-space'. The default is `empty-box'. */);
28598 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
28599 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
28604 /* Initialize this module when Emacs starts. */
28609 current_header_line_height
= current_mode_line_height
= -1;
28611 CHARPOS (this_line_start_pos
) = 0;
28613 if (!noninteractive
)
28615 struct window
*m
= XWINDOW (minibuf_window
);
28616 Lisp_Object frame
= m
->frame
;
28617 struct frame
*f
= XFRAME (frame
);
28618 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
28619 struct window
*r
= XWINDOW (root
);
28622 echo_area_window
= minibuf_window
;
28624 XSETFASTINT (r
->top_line
, FRAME_TOP_MARGIN (f
));
28625 XSETFASTINT (r
->total_lines
, FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
));
28626 XSETFASTINT (r
->total_cols
, FRAME_COLS (f
));
28627 XSETFASTINT (m
->top_line
, FRAME_LINES (f
) - 1);
28628 XSETFASTINT (m
->total_lines
, 1);
28629 XSETFASTINT (m
->total_cols
, FRAME_COLS (f
));
28631 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
28632 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
28633 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
28635 /* The default ellipsis glyphs `...'. */
28636 for (i
= 0; i
< 3; ++i
)
28637 default_invis_vector
[i
] = make_number ('.');
28641 /* Allocate the buffer for frame titles.
28642 Also used for `format-mode-line'. */
28644 mode_line_noprop_buf
= (char *) xmalloc (size
);
28645 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
28646 mode_line_noprop_ptr
= mode_line_noprop_buf
;
28647 mode_line_target
= MODE_LINE_DISPLAY
;
28650 help_echo_showing_p
= 0;
28653 /* Since w32 does not support atimers, it defines its own implementation of
28654 the following three functions in w32fns.c. */
28657 /* Platform-independent portion of hourglass implementation. */
28659 /* Return non-zero if houglass timer has been started or hourglass is shown. */
28661 hourglass_started (void)
28663 return hourglass_shown_p
|| hourglass_atimer
!= NULL
;
28666 /* Cancel a currently active hourglass timer, and start a new one. */
28668 start_hourglass (void)
28670 #if defined (HAVE_WINDOW_SYSTEM)
28672 int secs
, usecs
= 0;
28674 cancel_hourglass ();
28676 if (INTEGERP (Vhourglass_delay
)
28677 && XINT (Vhourglass_delay
) > 0)
28678 secs
= XFASTINT (Vhourglass_delay
);
28679 else if (FLOATP (Vhourglass_delay
)
28680 && XFLOAT_DATA (Vhourglass_delay
) > 0)
28683 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
28684 secs
= XFASTINT (tem
);
28685 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
28688 secs
= DEFAULT_HOURGLASS_DELAY
;
28690 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
28691 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
28692 show_hourglass
, NULL
);
28697 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
28700 cancel_hourglass (void)
28702 #if defined (HAVE_WINDOW_SYSTEM)
28703 if (hourglass_atimer
)
28705 cancel_atimer (hourglass_atimer
);
28706 hourglass_atimer
= NULL
;
28709 if (hourglass_shown_p
)
28713 #endif /* ! WINDOWSNT */